From 47e2bd191eb653300ba3f9dc07f52aab3de42924 Mon Sep 17 00:00:00 2001 From: Azure SDK for Python bot Date: Fri, 1 Mar 2019 13:33:03 -0800 Subject: [PATCH] Generated from 91d8e1718252bec320a012081c377adaf0133732 (#4798) Updated api-version path to '2018-01-01' from '2018-02-01'. --- lib/services/eventgrid/LICENSE.txt | 2 +- ...ppConfigurationKeyValueDeletedEventData.js | 72 + ...pConfigurationKeyValueModifiedEventData.js | 72 + .../containerRegistryArtifactEventData.js | 86 + .../containerRegistryArtifactEventTarget.js | 100 + .../containerRegistryChartDeletedEventData.js | 78 + .../containerRegistryChartPushedEventData.js | 78 + .../lib/models/containerRegistryEventActor.js | 2 +- .../lib/models/containerRegistryEventData.js | 59 +- .../models/containerRegistryEventRequest.js | 17 +- .../models/containerRegistryEventSource.js | 4 +- .../models/containerRegistryEventTarget.js | 18 +- .../models/deviceConnectionStateEventInfo.js | 9 +- .../deviceConnectionStateEventProperties.js | 18 +- .../models/deviceLifeCycleEventProperties.js | 65 +- .../eventgrid/lib/models/deviceTwinInfo.js | 54 +- .../lib/models/deviceTwinInfoProperties.js | 20 +- .../models/deviceTwinInfoX509Thumbprint.js | 4 +- .../lib/models/deviceTwinMetadata.js | 4 +- .../lib/models/deviceTwinProperties.js | 8 +- .../eventgrid/lib/models/eventGridEvent.js | 16 +- .../eventHubCaptureFileCreatedEventData.js | 18 +- lib/services/eventgrid/lib/models/index.d.ts | 2051 ++++++++++------- lib/services/eventgrid/lib/models/index.js | 12 + .../models/mapsGeofenceEnteredEventData.js | 99 + .../lib/models/mapsGeofenceEventProperties.js | 106 + .../lib/models/mapsGeofenceExitedEventData.js | 99 + .../lib/models/mapsGeofenceGeometry.js | 104 + .../lib/models/mapsGeofenceResultEventData.js | 99 + .../lib/models/mediaJobCanceledEventData.js | 2 +- .../eventgrid/lib/models/mediaJobError.js | 12 +- .../lib/models/mediaJobErrorDetail.js | 4 +- .../lib/models/mediaJobErroredEventData.js | 2 +- .../lib/models/mediaJobFinishedEventData.js | 2 +- .../eventgrid/lib/models/mediaJobOutput.js | 30 +- .../lib/models/mediaJobOutputAsset.js | 2 +- .../models/mediaJobOutputProgressEventData.js | 75 + .../mediaJobOutputStateChangeEventData.js | 36 +- .../models/mediaJobStateChangeEventData.js | 6 +- ...diaLiveEventConnectionRejectedEventData.js | 10 +- ...mediaLiveEventEncoderConnectedEventData.js | 8 +- ...iaLiveEventEncoderDisconnectedEventData.js | 10 +- ...eEventIncomingDataChunkDroppedEventData.js | 17 +- ...iveEventIncomingStreamReceivedEventData.js | 18 +- ...eEventIncomingStreamsOutOfSyncEventData.js | 16 +- ...tIncomingVideoStreamsOutOfSyncEventData.js | 14 +- .../mediaLiveEventIngestHeartbeatEventData.js | 26 +- ...ventTrackDiscontinuityDetectedEventData.js | 14 +- .../lib/models/resourceActionCancelData.js | 23 +- .../lib/models/resourceActionFailureData.js | 23 +- .../lib/models/resourceActionSuccessData.js | 23 +- .../lib/models/resourceDeleteCancelData.js | 23 +- .../lib/models/resourceDeleteFailureData.js | 23 +- .../lib/models/resourceDeleteSuccessData.js | 23 +- .../lib/models/resourceWriteCancelData.js | 23 +- .../lib/models/resourceWriteFailureData.js | 23 +- .../lib/models/resourceWriteSuccessData.js | 23 +- ...ssagesAvailableWithNoListenersEventData.js | 14 +- ...ssagesAvailableWithNoListenersEventData.js | 14 +- .../lib/models/storageBlobCreatedEventData.js | 24 +- .../lib/models/storageBlobDeletedEventData.js | 18 +- .../models/subscriptionDeletedEventData.js | 2 +- .../models/subscriptionValidationEventData.js | 6 +- .../models/subscriptionValidationResponse.js | 4 +- lib/services/eventgrid/package.json | 2 +- 65 files changed, 2662 insertions(+), 1307 deletions(-) create mode 100644 lib/services/eventgrid/lib/models/appConfigurationKeyValueDeletedEventData.js create mode 100644 lib/services/eventgrid/lib/models/appConfigurationKeyValueModifiedEventData.js create mode 100644 lib/services/eventgrid/lib/models/containerRegistryArtifactEventData.js create mode 100644 lib/services/eventgrid/lib/models/containerRegistryArtifactEventTarget.js create mode 100644 lib/services/eventgrid/lib/models/containerRegistryChartDeletedEventData.js create mode 100644 lib/services/eventgrid/lib/models/containerRegistryChartPushedEventData.js create mode 100644 lib/services/eventgrid/lib/models/mapsGeofenceEnteredEventData.js create mode 100644 lib/services/eventgrid/lib/models/mapsGeofenceEventProperties.js create mode 100644 lib/services/eventgrid/lib/models/mapsGeofenceExitedEventData.js create mode 100644 lib/services/eventgrid/lib/models/mapsGeofenceGeometry.js create mode 100644 lib/services/eventgrid/lib/models/mapsGeofenceResultEventData.js create mode 100644 lib/services/eventgrid/lib/models/mediaJobOutputProgressEventData.js diff --git a/lib/services/eventgrid/LICENSE.txt b/lib/services/eventgrid/LICENSE.txt index 5431ba98b9..8f3d856145 100644 --- a/lib/services/eventgrid/LICENSE.txt +++ b/lib/services/eventgrid/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2018 Microsoft +Copyright (c) 2019 Microsoft Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/lib/services/eventgrid/lib/models/appConfigurationKeyValueDeletedEventData.js b/lib/services/eventgrid/lib/models/appConfigurationKeyValueDeletedEventData.js new file mode 100644 index 0000000000..cb449266c5 --- /dev/null +++ b/lib/services/eventgrid/lib/models/appConfigurationKeyValueDeletedEventData.js @@ -0,0 +1,72 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Schema of the Data property of an EventGridEvent for an + * Microsoft.AppConfiguration.KeyValueDeleted event. + * + */ +class AppConfigurationKeyValueDeletedEventData { + /** + * Create a AppConfigurationKeyValueDeletedEventData. + * @property {string} [key] The key used to identify the key-value that was + * deleted. + * @property {string} [label] The label, if any, used to identify the + * key-value that was deleted. + * @property {string} [etag] The etag representing the key-value that was + * deleted. + */ + constructor() { + } + + /** + * Defines the metadata of AppConfigurationKeyValueDeletedEventData + * + * @returns {object} metadata of AppConfigurationKeyValueDeletedEventData + * + */ + mapper() { + return { + required: false, + serializedName: 'AppConfigurationKeyValueDeletedEventData', + type: { + name: 'Composite', + className: 'AppConfigurationKeyValueDeletedEventData', + modelProperties: { + key: { + required: false, + serializedName: 'key', + type: { + name: 'String' + } + }, + label: { + required: false, + serializedName: 'label', + type: { + name: 'String' + } + }, + etag: { + required: false, + serializedName: 'etag', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = AppConfigurationKeyValueDeletedEventData; diff --git a/lib/services/eventgrid/lib/models/appConfigurationKeyValueModifiedEventData.js b/lib/services/eventgrid/lib/models/appConfigurationKeyValueModifiedEventData.js new file mode 100644 index 0000000000..746a25a323 --- /dev/null +++ b/lib/services/eventgrid/lib/models/appConfigurationKeyValueModifiedEventData.js @@ -0,0 +1,72 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Schema of the Data property of an EventGridEvent for an + * Microsoft.AppConfiguration.KeyValueModified event. + * + */ +class AppConfigurationKeyValueModifiedEventData { + /** + * Create a AppConfigurationKeyValueModifiedEventData. + * @property {string} [key] The key used to identify the key-value that was + * modified. + * @property {string} [label] The label, if any, used to identify the + * key-value that was modified. + * @property {string} [etag] The etag representing the new state of the + * key-value. + */ + constructor() { + } + + /** + * Defines the metadata of AppConfigurationKeyValueModifiedEventData + * + * @returns {object} metadata of AppConfigurationKeyValueModifiedEventData + * + */ + mapper() { + return { + required: false, + serializedName: 'AppConfigurationKeyValueModifiedEventData', + type: { + name: 'Composite', + className: 'AppConfigurationKeyValueModifiedEventData', + modelProperties: { + key: { + required: false, + serializedName: 'key', + type: { + name: 'String' + } + }, + label: { + required: false, + serializedName: 'label', + type: { + name: 'String' + } + }, + etag: { + required: false, + serializedName: 'etag', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = AppConfigurationKeyValueModifiedEventData; diff --git a/lib/services/eventgrid/lib/models/containerRegistryArtifactEventData.js b/lib/services/eventgrid/lib/models/containerRegistryArtifactEventData.js new file mode 100644 index 0000000000..bb4bea1697 --- /dev/null +++ b/lib/services/eventgrid/lib/models/containerRegistryArtifactEventData.js @@ -0,0 +1,86 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The content of the event request message. + * + */ +class ContainerRegistryArtifactEventData { + /** + * Create a ContainerRegistryArtifactEventData. + * @property {string} [id] The event ID. + * @property {date} [timestamp] The time at which the event occurred. + * @property {string} [action] The action that encompasses the provided + * event. + * @property {object} [target] The target of the event. + * @property {string} [target.mediaType] The MIME type of the artifact. + * @property {number} [target.size] The size in bytes of the artifact. + * @property {string} [target.digest] The digest of the artifact. + * @property {string} [target.repository] The repository name of the + * artifact. + * @property {string} [target.tag] The tag of the artifact. + * @property {string} [target.name] The name of the artifact. + * @property {string} [target.version] The version of the artifact. + */ + constructor() { + } + + /** + * Defines the metadata of ContainerRegistryArtifactEventData + * + * @returns {object} metadata of ContainerRegistryArtifactEventData + * + */ + mapper() { + return { + required: false, + serializedName: 'ContainerRegistryArtifactEventData', + type: { + name: 'Composite', + className: 'ContainerRegistryArtifactEventData', + modelProperties: { + id: { + required: false, + serializedName: 'id', + type: { + name: 'String' + } + }, + timestamp: { + required: false, + serializedName: 'timestamp', + type: { + name: 'DateTime' + } + }, + action: { + required: false, + serializedName: 'action', + type: { + name: 'String' + } + }, + target: { + required: false, + serializedName: 'target', + type: { + name: 'Composite', + className: 'ContainerRegistryArtifactEventTarget' + } + } + } + } + }; + } +} + +module.exports = ContainerRegistryArtifactEventData; diff --git a/lib/services/eventgrid/lib/models/containerRegistryArtifactEventTarget.js b/lib/services/eventgrid/lib/models/containerRegistryArtifactEventTarget.js new file mode 100644 index 0000000000..628f7100ca --- /dev/null +++ b/lib/services/eventgrid/lib/models/containerRegistryArtifactEventTarget.js @@ -0,0 +1,100 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The target of the event. + * + */ +class ContainerRegistryArtifactEventTarget { + /** + * Create a ContainerRegistryArtifactEventTarget. + * @property {string} [mediaType] The MIME type of the artifact. + * @property {number} [size] The size in bytes of the artifact. + * @property {string} [digest] The digest of the artifact. + * @property {string} [repository] The repository name of the artifact. + * @property {string} [tag] The tag of the artifact. + * @property {string} [name] The name of the artifact. + * @property {string} [version] The version of the artifact. + */ + constructor() { + } + + /** + * Defines the metadata of ContainerRegistryArtifactEventTarget + * + * @returns {object} metadata of ContainerRegistryArtifactEventTarget + * + */ + mapper() { + return { + required: false, + serializedName: 'ContainerRegistryArtifactEventTarget', + type: { + name: 'Composite', + className: 'ContainerRegistryArtifactEventTarget', + modelProperties: { + mediaType: { + required: false, + serializedName: 'mediaType', + type: { + name: 'String' + } + }, + size: { + required: false, + serializedName: 'size', + type: { + name: 'Number' + } + }, + digest: { + required: false, + serializedName: 'digest', + type: { + name: 'String' + } + }, + repository: { + required: false, + serializedName: 'repository', + type: { + name: 'String' + } + }, + tag: { + required: false, + serializedName: 'tag', + type: { + name: 'String' + } + }, + name: { + required: false, + serializedName: 'name', + type: { + name: 'String' + } + }, + version: { + required: false, + serializedName: 'version', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = ContainerRegistryArtifactEventTarget; diff --git a/lib/services/eventgrid/lib/models/containerRegistryChartDeletedEventData.js b/lib/services/eventgrid/lib/models/containerRegistryChartDeletedEventData.js new file mode 100644 index 0000000000..735091ec31 --- /dev/null +++ b/lib/services/eventgrid/lib/models/containerRegistryChartDeletedEventData.js @@ -0,0 +1,78 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Schema of the Data property of an EventGridEvent for a + * Microsoft.ContainerRegistry.ChartDeleted event. + * + * @extends models['ContainerRegistryArtifactEventData'] + */ +class ContainerRegistryChartDeletedEventData extends models['ContainerRegistryArtifactEventData'] { + /** + * Create a ContainerRegistryChartDeletedEventData. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ContainerRegistryChartDeletedEventData + * + * @returns {object} metadata of ContainerRegistryChartDeletedEventData + * + */ + mapper() { + return { + required: false, + serializedName: 'ContainerRegistryChartDeletedEventData', + type: { + name: 'Composite', + className: 'ContainerRegistryChartDeletedEventData', + modelProperties: { + id: { + required: false, + serializedName: 'id', + type: { + name: 'String' + } + }, + timestamp: { + required: false, + serializedName: 'timestamp', + type: { + name: 'DateTime' + } + }, + action: { + required: false, + serializedName: 'action', + type: { + name: 'String' + } + }, + target: { + required: false, + serializedName: 'target', + type: { + name: 'Composite', + className: 'ContainerRegistryArtifactEventTarget' + } + } + } + } + }; + } +} + +module.exports = ContainerRegistryChartDeletedEventData; diff --git a/lib/services/eventgrid/lib/models/containerRegistryChartPushedEventData.js b/lib/services/eventgrid/lib/models/containerRegistryChartPushedEventData.js new file mode 100644 index 0000000000..778e0e9040 --- /dev/null +++ b/lib/services/eventgrid/lib/models/containerRegistryChartPushedEventData.js @@ -0,0 +1,78 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Schema of the Data property of an EventGridEvent for a + * Microsoft.ContainerRegistry.ChartPushed event. + * + * @extends models['ContainerRegistryArtifactEventData'] + */ +class ContainerRegistryChartPushedEventData extends models['ContainerRegistryArtifactEventData'] { + /** + * Create a ContainerRegistryChartPushedEventData. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ContainerRegistryChartPushedEventData + * + * @returns {object} metadata of ContainerRegistryChartPushedEventData + * + */ + mapper() { + return { + required: false, + serializedName: 'ContainerRegistryChartPushedEventData', + type: { + name: 'Composite', + className: 'ContainerRegistryChartPushedEventData', + modelProperties: { + id: { + required: false, + serializedName: 'id', + type: { + name: 'String' + } + }, + timestamp: { + required: false, + serializedName: 'timestamp', + type: { + name: 'DateTime' + } + }, + action: { + required: false, + serializedName: 'action', + type: { + name: 'String' + } + }, + target: { + required: false, + serializedName: 'target', + type: { + name: 'Composite', + className: 'ContainerRegistryArtifactEventTarget' + } + } + } + } + }; + } +} + +module.exports = ContainerRegistryChartPushedEventData; diff --git a/lib/services/eventgrid/lib/models/containerRegistryEventActor.js b/lib/services/eventgrid/lib/models/containerRegistryEventActor.js index f3338fdc29..c29703153c 100644 --- a/lib/services/eventgrid/lib/models/containerRegistryEventActor.js +++ b/lib/services/eventgrid/lib/models/containerRegistryEventActor.js @@ -18,7 +18,7 @@ class ContainerRegistryEventActor { /** * Create a ContainerRegistryEventActor. - * @member {string} [name] The subject or username associated with the + * @property {string} [name] The subject or username associated with the * request context that generated the event. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/containerRegistryEventData.js b/lib/services/eventgrid/lib/models/containerRegistryEventData.js index 71f470617d..315a11e29b 100644 --- a/lib/services/eventgrid/lib/models/containerRegistryEventData.js +++ b/lib/services/eventgrid/lib/models/containerRegistryEventData.js @@ -17,43 +17,46 @@ class ContainerRegistryEventData { /** * Create a ContainerRegistryEventData. - * @member {string} [id] The event ID. - * @member {date} [timestamp] The time at which the event occurred. - * @member {string} [action] The action that encompasses the provided event. - * @member {object} [target] The target of the event. - * @member {string} [target.mediaType] The MIME type of the referenced + * @property {string} [id] The event ID. + * @property {date} [timestamp] The time at which the event occurred. + * @property {string} [action] The action that encompasses the provided + * event. + * @property {object} [target] The target of the event. + * @property {string} [target.mediaType] The MIME type of the referenced * object. - * @member {number} [target.size] The number of bytes of the content. Same as - * Length field. - * @member {string} [target.digest] The digest of the content, as defined by - * the Registry V2 HTTP API Specification. - * @member {number} [target.length] The number of bytes of the content. Same - * as Size field. - * @member {string} [target.repository] The repository name. - * @member {string} [target.url] The direct URL to the content. - * @member {string} [target.tag] The tag name. - * @member {object} [request] The request that generated the event. - * @member {string} [request.id] The ID of the request that initiated the + * @property {number} [target.size] The number of bytes of the content. Same + * as Length field. + * @property {string} [target.digest] The digest of the content, as defined + * by the Registry V2 HTTP API Specification. + * @property {number} [target.length] The number of bytes of the content. + * Same as Size field. + * @property {string} [target.repository] The repository name. + * @property {string} [target.url] The direct URL to the content. + * @property {string} [target.tag] The tag name. + * @property {object} [request] The request that generated the event. + * @property {string} [request.id] The ID of the request that initiated the * event. - * @member {string} [request.addr] The IP or hostname and possibly port of + * @property {string} [request.addr] The IP or hostname and possibly port of * the client connection that initiated the event. This is the RemoteAddr * from the standard http request. - * @member {string} [request.host] The externally accessible hostname of the - * registry instance, as specified by the http host header on incoming + * @property {string} [request.host] The externally accessible hostname of + * the registry instance, as specified by the http host header on incoming * requests. - * @member {string} [request.method] The request method that generated the + * @property {string} [request.method] The request method that generated the * event. - * @member {string} [request.useragent] The user agent header of the request. - * @member {object} [actor] The agent that initiated the event. For most + * @property {string} [request.useragent] The user agent header of the + * request. + * @property {object} [actor] The agent that initiated the event. For most * situations, this could be from the authorization context of the request. - * @member {string} [actor.name] The subject or username associated with the - * request context that generated the event. - * @member {object} [source] The registry node that generated the event. Put - * differently, while the actor initiates the event, the source generates it. - * @member {string} [source.addr] The IP or hostname and the port of the + * @property {string} [actor.name] The subject or username associated with + * the request context that generated the event. + * @property {object} [source] The registry node that generated the event. + * Put differently, while the actor initiates the event, the source generates + * it. + * @property {string} [source.addr] The IP or hostname and the port of the * registry node that generated the event. Generally, this will be resolved * by os.Hostname() along with the running port. - * @member {string} [source.instanceID] The running instance of an + * @property {string} [source.instanceID] The running instance of an * application. Changes after each restart. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/containerRegistryEventRequest.js b/lib/services/eventgrid/lib/models/containerRegistryEventRequest.js index 7d1009327f..3da0fe2619 100644 --- a/lib/services/eventgrid/lib/models/containerRegistryEventRequest.js +++ b/lib/services/eventgrid/lib/models/containerRegistryEventRequest.js @@ -17,14 +17,15 @@ class ContainerRegistryEventRequest { /** * Create a ContainerRegistryEventRequest. - * @member {string} [id] The ID of the request that initiated the event. - * @member {string} [addr] The IP or hostname and possibly port of the client - * connection that initiated the event. This is the RemoteAddr from the - * standard http request. - * @member {string} [host] The externally accessible hostname of the registry - * instance, as specified by the http host header on incoming requests. - * @member {string} [method] The request method that generated the event. - * @member {string} [useragent] The user agent header of the request. + * @property {string} [id] The ID of the request that initiated the event. + * @property {string} [addr] The IP or hostname and possibly port of the + * client connection that initiated the event. This is the RemoteAddr from + * the standard http request. + * @property {string} [host] The externally accessible hostname of the + * registry instance, as specified by the http host header on incoming + * requests. + * @property {string} [method] The request method that generated the event. + * @property {string} [useragent] The user agent header of the request. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/containerRegistryEventSource.js b/lib/services/eventgrid/lib/models/containerRegistryEventSource.js index 0fc67384ce..8b69449068 100644 --- a/lib/services/eventgrid/lib/models/containerRegistryEventSource.js +++ b/lib/services/eventgrid/lib/models/containerRegistryEventSource.js @@ -18,10 +18,10 @@ class ContainerRegistryEventSource { /** * Create a ContainerRegistryEventSource. - * @member {string} [addr] The IP or hostname and the port of the registry + * @property {string} [addr] The IP or hostname and the port of the registry * node that generated the event. Generally, this will be resolved by * os.Hostname() along with the running port. - * @member {string} [instanceID] The running instance of an application. + * @property {string} [instanceID] The running instance of an application. * Changes after each restart. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/containerRegistryEventTarget.js b/lib/services/eventgrid/lib/models/containerRegistryEventTarget.js index 33f30257d7..a81b738239 100644 --- a/lib/services/eventgrid/lib/models/containerRegistryEventTarget.js +++ b/lib/services/eventgrid/lib/models/containerRegistryEventTarget.js @@ -17,16 +17,16 @@ class ContainerRegistryEventTarget { /** * Create a ContainerRegistryEventTarget. - * @member {string} [mediaType] The MIME type of the referenced object. - * @member {number} [size] The number of bytes of the content. Same as Length - * field. - * @member {string} [digest] The digest of the content, as defined by the + * @property {string} [mediaType] The MIME type of the referenced object. + * @property {number} [size] The number of bytes of the content. Same as + * Length field. + * @property {string} [digest] The digest of the content, as defined by the * Registry V2 HTTP API Specification. - * @member {number} [length] The number of bytes of the content. Same as Size - * field. - * @member {string} [repository] The repository name. - * @member {string} [url] The direct URL to the content. - * @member {string} [tag] The tag name. + * @property {number} [length] The number of bytes of the content. Same as + * Size field. + * @property {string} [repository] The repository name. + * @property {string} [url] The direct URL to the content. + * @property {string} [tag] The tag name. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/deviceConnectionStateEventInfo.js b/lib/services/eventgrid/lib/models/deviceConnectionStateEventInfo.js index 9536de0ec3..8241b02d40 100644 --- a/lib/services/eventgrid/lib/models/deviceConnectionStateEventInfo.js +++ b/lib/services/eventgrid/lib/models/deviceConnectionStateEventInfo.js @@ -17,10 +17,11 @@ class DeviceConnectionStateEventInfo { /** * Create a DeviceConnectionStateEventInfo. - * @member {string} [sequenceNumber] Sequence number is string representation - * of a hexadecimal number. string compare can be used to identify the larger - * number because both in ASCII and HEX numbers come after alphabets. If you - * are converting the string to hex, then the number is a 256 bit number. + * @property {string} [sequenceNumber] Sequence number is string + * representation of a hexadecimal number. string compare can be used to + * identify the larger number because both in ASCII and HEX numbers come + * after alphabets. If you are converting the string to hex, then the number + * is a 256 bit number. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/deviceConnectionStateEventProperties.js b/lib/services/eventgrid/lib/models/deviceConnectionStateEventProperties.js index e0688977a9..0ea2c7c03d 100644 --- a/lib/services/eventgrid/lib/models/deviceConnectionStateEventProperties.js +++ b/lib/services/eventgrid/lib/models/deviceConnectionStateEventProperties.js @@ -18,23 +18,23 @@ class DeviceConnectionStateEventProperties { /** * Create a DeviceConnectionStateEventProperties. - * @member {string} [deviceId] The unique identifier of the device. This + * @property {string} [deviceId] The unique identifier of the device. This * case-sensitive string can be up to 128 characters long, and supports ASCII * 7-bit alphanumeric characters plus the following special characters: - : . * + % _ # * ? ! ( ) , = @ ; $ '. - * @member {string} [moduleId] The unique identifier of the module. This + * @property {string} [moduleId] The unique identifier of the module. This * case-sensitive string can be up to 128 characters long, and supports ASCII * 7-bit alphanumeric characters plus the following special characters: - : . * + % _ # * ? ! ( ) , = @ ; $ '. - * @member {string} [hubName] Name of the IoT Hub where the device was + * @property {string} [hubName] Name of the IoT Hub where the device was * created or deleted. - * @member {object} [deviceConnectionStateEventInfo] Information about the + * @property {object} [deviceConnectionStateEventInfo] Information about the * device connection state event. - * @member {string} [deviceConnectionStateEventInfo.sequenceNumber] Sequence - * number is string representation of a hexadecimal number. string compare - * can be used to identify the larger number because both in ASCII and HEX - * numbers come after alphabets. If you are converting the string to hex, - * then the number is a 256 bit number. + * @property {string} [deviceConnectionStateEventInfo.sequenceNumber] + * Sequence number is string representation of a hexadecimal number. string + * compare can be used to identify the larger number because both in ASCII + * and HEX numbers come after alphabets. If you are converting the string to + * hex, then the number is a 256 bit number. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/deviceLifeCycleEventProperties.js b/lib/services/eventgrid/lib/models/deviceLifeCycleEventProperties.js index 8fbc3784b2..58f2a469f9 100644 --- a/lib/services/eventgrid/lib/models/deviceLifeCycleEventProperties.js +++ b/lib/services/eventgrid/lib/models/deviceLifeCycleEventProperties.js @@ -18,58 +18,59 @@ class DeviceLifeCycleEventProperties { /** * Create a DeviceLifeCycleEventProperties. - * @member {string} [deviceId] The unique identifier of the device. This + * @property {string} [deviceId] The unique identifier of the device. This * case-sensitive string can be up to 128 characters long, and supports ASCII * 7-bit alphanumeric characters plus the following special characters: - : . * + % _ # * ? ! ( ) , = @ ; $ '. - * @member {string} [hubName] Name of the IoT Hub where the device was + * @property {string} [hubName] Name of the IoT Hub where the device was * created or deleted. - * @member {object} [twin] Information about the device twin, which is the + * @property {object} [twin] Information about the device twin, which is the * cloud representation of application device metadata. - * @member {string} [twin.authenticationType] Authentication type used for + * @property {string} [twin.authenticationType] Authentication type used for * this device: either SAS, SelfSigned, or CertificateAuthority. - * @member {number} [twin.cloudToDeviceMessageCount] Count of cloud to device - * messages sent to this device. - * @member {string} [twin.connectionState] Whether the device is connected or - * disconnected. - * @member {string} [twin.deviceId] The unique identifier of the device twin. - * @member {string} [twin.etag] A piece of information that describes the + * @property {number} [twin.cloudToDeviceMessageCount] Count of cloud to + * device messages sent to this device. + * @property {string} [twin.connectionState] Whether the device is connected + * or disconnected. + * @property {string} [twin.deviceId] The unique identifier of the device + * twin. + * @property {string} [twin.etag] A piece of information that describes the * content of the device twin. Each etag is guaranteed to be unique per * device twin. - * @member {string} [twin.lastActivityTime] The ISO8601 timestamp of the last - * activity. - * @member {object} [twin.properties] Properties JSON element. - * @member {object} [twin.properties.desired] A portion of the properties + * @property {string} [twin.lastActivityTime] The ISO8601 timestamp of the + * last activity. + * @property {object} [twin.properties] Properties JSON element. + * @property {object} [twin.properties.desired] A portion of the properties * that can be written only by the application back-end, and read by the * device. - * @member {object} [twin.properties.desired.metadata] Metadata information + * @property {object} [twin.properties.desired.metadata] Metadata information * for the properties JSON document. - * @member {string} [twin.properties.desired.metadata.lastUpdated] The + * @property {string} [twin.properties.desired.metadata.lastUpdated] The * ISO8601 timestamp of the last time the properties were updated. - * @member {number} [twin.properties.desired.version] Version of device twin - * properties. - * @member {object} [twin.properties.reported] A portion of the properties + * @property {number} [twin.properties.desired.version] Version of device + * twin properties. + * @property {object} [twin.properties.reported] A portion of the properties * that can be written only by the device, and read by the application * back-end. - * @member {object} [twin.properties.reported.metadata] Metadata information - * for the properties JSON document. - * @member {string} [twin.properties.reported.metadata.lastUpdated] The + * @property {object} [twin.properties.reported.metadata] Metadata + * information for the properties JSON document. + * @property {string} [twin.properties.reported.metadata.lastUpdated] The * ISO8601 timestamp of the last time the properties were updated. - * @member {number} [twin.properties.reported.version] Version of device twin - * properties. - * @member {string} [twin.status] Whether the device twin is enabled or + * @property {number} [twin.properties.reported.version] Version of device + * twin properties. + * @property {string} [twin.status] Whether the device twin is enabled or * disabled. - * @member {string} [twin.statusUpdateTime] The ISO8601 timestamp of the last - * device twin status update. - * @member {number} [twin.version] An integer that is incremented by one each - * time the device twin is updated. - * @member {object} [twin.x509Thumbprint] The thumbprint is a unique value + * @property {string} [twin.statusUpdateTime] The ISO8601 timestamp of the + * last device twin status update. + * @property {number} [twin.version] An integer that is incremented by one + * each time the device twin is updated. + * @property {object} [twin.x509Thumbprint] The thumbprint is a unique value * for the x509 certificate, commonly used to find a particular certificate * in a certificate store. The thumbprint is dynamically generated using the * SHA1 algorithm, and does not physically exist in the certificate. - * @member {string} [twin.x509Thumbprint.primaryThumbprint] Primary + * @property {string} [twin.x509Thumbprint.primaryThumbprint] Primary * thumbprint for the x509 certificate. - * @member {string} [twin.x509Thumbprint.secondaryThumbprint] Secondary + * @property {string} [twin.x509Thumbprint.secondaryThumbprint] Secondary * thumbprint for the x509 certificate. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/deviceTwinInfo.js b/lib/services/eventgrid/lib/models/deviceTwinInfo.js index 5126abf014..98941d2361 100644 --- a/lib/services/eventgrid/lib/models/deviceTwinInfo.js +++ b/lib/services/eventgrid/lib/models/deviceTwinInfo.js @@ -18,47 +18,49 @@ class DeviceTwinInfo { /** * Create a DeviceTwinInfo. - * @member {string} [authenticationType] Authentication type used for this + * @property {string} [authenticationType] Authentication type used for this * device: either SAS, SelfSigned, or CertificateAuthority. - * @member {number} [cloudToDeviceMessageCount] Count of cloud to device + * @property {number} [cloudToDeviceMessageCount] Count of cloud to device * messages sent to this device. - * @member {string} [connectionState] Whether the device is connected or + * @property {string} [connectionState] Whether the device is connected or * disconnected. - * @member {string} [deviceId] The unique identifier of the device twin. - * @member {string} [etag] A piece of information that describes the content - * of the device twin. Each etag is guaranteed to be unique per device twin. - * @member {string} [lastActivityTime] The ISO8601 timestamp of the last + * @property {string} [deviceId] The unique identifier of the device twin. + * @property {string} [etag] A piece of information that describes the + * content of the device twin. Each etag is guaranteed to be unique per + * device twin. + * @property {string} [lastActivityTime] The ISO8601 timestamp of the last * activity. - * @member {object} [properties] Properties JSON element. - * @member {object} [properties.desired] A portion of the properties that can - * be written only by the application back-end, and read by the device. - * @member {object} [properties.desired.metadata] Metadata information for + * @property {object} [properties] Properties JSON element. + * @property {object} [properties.desired] A portion of the properties that + * can be written only by the application back-end, and read by the device. + * @property {object} [properties.desired.metadata] Metadata information for * the properties JSON document. - * @member {string} [properties.desired.metadata.lastUpdated] The ISO8601 + * @property {string} [properties.desired.metadata.lastUpdated] The ISO8601 * timestamp of the last time the properties were updated. - * @member {number} [properties.desired.version] Version of device twin + * @property {number} [properties.desired.version] Version of device twin * properties. - * @member {object} [properties.reported] A portion of the properties that + * @property {object} [properties.reported] A portion of the properties that * can be written only by the device, and read by the application back-end. - * @member {object} [properties.reported.metadata] Metadata information for + * @property {object} [properties.reported.metadata] Metadata information for * the properties JSON document. - * @member {string} [properties.reported.metadata.lastUpdated] The ISO8601 + * @property {string} [properties.reported.metadata.lastUpdated] The ISO8601 * timestamp of the last time the properties were updated. - * @member {number} [properties.reported.version] Version of device twin + * @property {number} [properties.reported.version] Version of device twin * properties. - * @member {string} [status] Whether the device twin is enabled or disabled. - * @member {string} [statusUpdateTime] The ISO8601 timestamp of the last + * @property {string} [status] Whether the device twin is enabled or + * disabled. + * @property {string} [statusUpdateTime] The ISO8601 timestamp of the last * device twin status update. - * @member {number} [version] An integer that is incremented by one each time - * the device twin is updated. - * @member {object} [x509Thumbprint] The thumbprint is a unique value for the - * x509 certificate, commonly used to find a particular certificate in a + * @property {number} [version] An integer that is incremented by one each + * time the device twin is updated. + * @property {object} [x509Thumbprint] The thumbprint is a unique value for + * the x509 certificate, commonly used to find a particular certificate in a * certificate store. The thumbprint is dynamically generated using the SHA1 * algorithm, and does not physically exist in the certificate. - * @member {string} [x509Thumbprint.primaryThumbprint] Primary thumbprint for - * the x509 certificate. - * @member {string} [x509Thumbprint.secondaryThumbprint] Secondary thumbprint + * @property {string} [x509Thumbprint.primaryThumbprint] Primary thumbprint * for the x509 certificate. + * @property {string} [x509Thumbprint.secondaryThumbprint] Secondary + * thumbprint for the x509 certificate. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/deviceTwinInfoProperties.js b/lib/services/eventgrid/lib/models/deviceTwinInfoProperties.js index 11571fd642..85df54eb58 100644 --- a/lib/services/eventgrid/lib/models/deviceTwinInfoProperties.js +++ b/lib/services/eventgrid/lib/models/deviceTwinInfoProperties.js @@ -17,20 +17,20 @@ class DeviceTwinInfoProperties { /** * Create a DeviceTwinInfoProperties. - * @member {object} [desired] A portion of the properties that can be written - * only by the application back-end, and read by the device. - * @member {object} [desired.metadata] Metadata information for the + * @property {object} [desired] A portion of the properties that can be + * written only by the application back-end, and read by the device. + * @property {object} [desired.metadata] Metadata information for the * properties JSON document. - * @member {string} [desired.metadata.lastUpdated] The ISO8601 timestamp of + * @property {string} [desired.metadata.lastUpdated] The ISO8601 timestamp of * the last time the properties were updated. - * @member {number} [desired.version] Version of device twin properties. - * @member {object} [reported] A portion of the properties that can be + * @property {number} [desired.version] Version of device twin properties. + * @property {object} [reported] A portion of the properties that can be * written only by the device, and read by the application back-end. - * @member {object} [reported.metadata] Metadata information for the + * @property {object} [reported.metadata] Metadata information for the * properties JSON document. - * @member {string} [reported.metadata.lastUpdated] The ISO8601 timestamp of - * the last time the properties were updated. - * @member {number} [reported.version] Version of device twin properties. + * @property {string} [reported.metadata.lastUpdated] The ISO8601 timestamp + * of the last time the properties were updated. + * @property {number} [reported.version] Version of device twin properties. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/deviceTwinInfoX509Thumbprint.js b/lib/services/eventgrid/lib/models/deviceTwinInfoX509Thumbprint.js index 6cce229146..f8f1148143 100644 --- a/lib/services/eventgrid/lib/models/deviceTwinInfoX509Thumbprint.js +++ b/lib/services/eventgrid/lib/models/deviceTwinInfoX509Thumbprint.js @@ -20,9 +20,9 @@ class DeviceTwinInfoX509Thumbprint { /** * Create a DeviceTwinInfoX509Thumbprint. - * @member {string} [primaryThumbprint] Primary thumbprint for the x509 + * @property {string} [primaryThumbprint] Primary thumbprint for the x509 * certificate. - * @member {string} [secondaryThumbprint] Secondary thumbprint for the x509 + * @property {string} [secondaryThumbprint] Secondary thumbprint for the x509 * certificate. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/deviceTwinMetadata.js b/lib/services/eventgrid/lib/models/deviceTwinMetadata.js index 20558d1cfc..0853158c38 100644 --- a/lib/services/eventgrid/lib/models/deviceTwinMetadata.js +++ b/lib/services/eventgrid/lib/models/deviceTwinMetadata.js @@ -17,8 +17,8 @@ class DeviceTwinMetadata { /** * Create a DeviceTwinMetadata. - * @member {string} [lastUpdated] The ISO8601 timestamp of the last time the - * properties were updated. + * @property {string} [lastUpdated] The ISO8601 timestamp of the last time + * the properties were updated. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/deviceTwinProperties.js b/lib/services/eventgrid/lib/models/deviceTwinProperties.js index fd9492a01f..b17a0d1733 100644 --- a/lib/services/eventgrid/lib/models/deviceTwinProperties.js +++ b/lib/services/eventgrid/lib/models/deviceTwinProperties.js @@ -18,11 +18,11 @@ class DeviceTwinProperties { /** * Create a DeviceTwinProperties. - * @member {object} [metadata] Metadata information for the properties JSON + * @property {object} [metadata] Metadata information for the properties JSON * document. - * @member {string} [metadata.lastUpdated] The ISO8601 timestamp of the last - * time the properties were updated. - * @member {number} [version] Version of device twin properties. + * @property {string} [metadata.lastUpdated] The ISO8601 timestamp of the + * last time the properties were updated. + * @property {number} [version] Version of device twin properties. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/eventGridEvent.js b/lib/services/eventgrid/lib/models/eventGridEvent.js index 1cca979661..c61ca32ecc 100644 --- a/lib/services/eventgrid/lib/models/eventGridEvent.js +++ b/lib/services/eventgrid/lib/models/eventGridEvent.js @@ -17,15 +17,15 @@ class EventGridEvent { /** * Create a EventGridEvent. - * @member {string} id An unique identifier for the event. - * @member {string} [topic] The resource path of the event source. - * @member {string} subject A resource path relative to the topic path. - * @member {object} data Event data specific to the event type. - * @member {string} eventType The type of the event that occurred. - * @member {date} eventTime The time (in UTC) the event was generated. - * @member {string} [metadataVersion] The schema version of the event + * @property {string} id An unique identifier for the event. + * @property {string} [topic] The resource path of the event source. + * @property {string} subject A resource path relative to the topic path. + * @property {object} data Event data specific to the event type. + * @property {string} eventType The type of the event that occurred. + * @property {date} eventTime The time (in UTC) the event was generated. + * @property {string} [metadataVersion] The schema version of the event * metadata. - * @member {string} dataVersion The schema version of the data object. + * @property {string} dataVersion The schema version of the data object. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/eventHubCaptureFileCreatedEventData.js b/lib/services/eventgrid/lib/models/eventHubCaptureFileCreatedEventData.js index 0b2b0f541f..6c3b07cc94 100644 --- a/lib/services/eventgrid/lib/models/eventHubCaptureFileCreatedEventData.js +++ b/lib/services/eventgrid/lib/models/eventHubCaptureFileCreatedEventData.js @@ -18,17 +18,17 @@ class EventHubCaptureFileCreatedEventData { /** * Create a EventHubCaptureFileCreatedEventData. - * @member {string} [fileurl] The path to the capture file. - * @member {string} [fileType] The file type of the capture file. - * @member {string} [partitionId] The shard ID. - * @member {number} [sizeInBytes] The file size. - * @member {number} [eventCount] The number of events in the file. - * @member {number} [firstSequenceNumber] The smallest sequence number from + * @property {string} [fileurl] The path to the capture file. + * @property {string} [fileType] The file type of the capture file. + * @property {string} [partitionId] The shard ID. + * @property {number} [sizeInBytes] The file size. + * @property {number} [eventCount] The number of events in the file. + * @property {number} [firstSequenceNumber] The smallest sequence number from * the queue. - * @member {number} [lastSequenceNumber] The last sequence number from the + * @property {number} [lastSequenceNumber] The last sequence number from the * queue. - * @member {date} [firstEnqueueTime] The first time from the queue. - * @member {date} [lastEnqueueTime] The last time from the queue. + * @property {date} [firstEnqueueTime] The first time from the queue. + * @property {date} [lastEnqueueTime] The last time from the queue. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/index.d.ts b/lib/services/eventgrid/lib/models/index.d.ts index 96c7542f8d..66e4354ba4 100644 --- a/lib/services/eventgrid/lib/models/index.d.ts +++ b/lib/services/eventgrid/lib/models/index.d.ts @@ -1,1547 +1,1804 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the StorageBlobCreatedEventData class. - * @constructor - * Schema of the Data property of an EventGridEvent for an - * Microsoft.Storage.BlobCreated event. - * - * @member {string} [api] The name of the API/operation that triggered this - * event. - * @member {string} [clientRequestId] A request id provided by the client of - * the storage API operation that triggered this event. - * @member {string} [requestId] The request id generated by the Storage service - * for the storage API operation that triggered this event. - * @member {string} [eTag] The etag of the object at the time this event was - * triggered. - * @member {string} [contentType] The content type of the blob. This is the - * same as what would be returned in the Content-Type header from the blob. - * @member {number} [contentLength] The size of the blob in bytes. This is the - * same as what would be returned in the Content-Length header from the blob. - * @member {string} [blobType] The type of blob. - * @member {string} [url] The path to the blob. - * @member {string} [sequencer] An opaque string value representing the logical - * sequence of events for any particular blob name. Users can use standard - * string comparison to understand the relative sequence of two events on the - * same blob name. - * @member {object} [storageDiagnostics] For service use only. Diagnostic data - * occasionally included by the Azure Storage service. This property should be - * ignored by event consumers. + * Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobCreated event. */ export interface StorageBlobCreatedEventData { + /** + * The name of the API/operation that triggered this event. + */ api?: string; + /** + * A request id provided by the client of the storage API operation that triggered this event. + */ clientRequestId?: string; + /** + * The request id generated by the Storage service for the storage API operation that triggered + * this event. + */ requestId?: string; + /** + * The etag of the object at the time this event was triggered. + */ eTag?: string; + /** + * The content type of the blob. This is the same as what would be returned in the Content-Type + * header from the blob. + */ contentType?: string; + /** + * The size of the blob in bytes. This is the same as what would be returned in the + * Content-Length header from the blob. + */ contentLength?: number; + /** + * The type of blob. + */ blobType?: string; + /** + * The path to the blob. + */ url?: string; + /** + * An opaque string value representing the logical sequence of events for any particular blob + * name. Users can use standard string comparison to understand the relative sequence of two + * events on the same blob name. + */ sequencer?: string; + /** + * For service use only. Diagnostic data occasionally included by the Azure Storage service. This + * property should be ignored by event consumers. + */ storageDiagnostics?: any; } /** - * @class - * Initializes a new instance of the StorageBlobDeletedEventData class. - * @constructor - * Schema of the Data property of an EventGridEvent for an - * Microsoft.Storage.BlobDeleted event. - * - * @member {string} [api] The name of the API/operation that triggered this - * event. - * @member {string} [clientRequestId] A request id provided by the client of - * the storage API operation that triggered this event. - * @member {string} [requestId] The request id generated by the Storage service - * for the storage API operation that triggered this event. - * @member {string} [contentType] The content type of the blob. This is the - * same as what would be returned in the Content-Type header from the blob. - * @member {string} [blobType] The type of blob. - * @member {string} [url] The path to the blob. - * @member {string} [sequencer] An opaque string value representing the logical - * sequence of events for any particular blob name. Users can use standard - * string comparison to understand the relative sequence of two events on the - * same blob name. - * @member {object} [storageDiagnostics] For service use only. Diagnostic data - * occasionally included by the Azure Storage service. This property should be - * ignored by event consumers. + * Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobDeleted event. */ export interface StorageBlobDeletedEventData { + /** + * The name of the API/operation that triggered this event. + */ api?: string; + /** + * A request id provided by the client of the storage API operation that triggered this event. + */ clientRequestId?: string; + /** + * The request id generated by the Storage service for the storage API operation that triggered + * this event. + */ requestId?: string; + /** + * The content type of the blob. This is the same as what would be returned in the Content-Type + * header from the blob. + */ contentType?: string; + /** + * The type of blob. + */ blobType?: string; + /** + * The path to the blob. + */ url?: string; + /** + * An opaque string value representing the logical sequence of events for any particular blob + * name. Users can use standard string comparison to understand the relative sequence of two + * events on the same blob name. + */ sequencer?: string; + /** + * For service use only. Diagnostic data occasionally included by the Azure Storage service. This + * property should be ignored by event consumers. + */ storageDiagnostics?: any; } /** - * @class - * Initializes a new instance of the EventHubCaptureFileCreatedEventData class. - * @constructor - * Schema of the Data property of an EventGridEvent for an - * Microsoft.EventHub.CaptureFileCreated event. - * - * @member {string} [fileurl] The path to the capture file. - * @member {string} [fileType] The file type of the capture file. - * @member {string} [partitionId] The shard ID. - * @member {number} [sizeInBytes] The file size. - * @member {number} [eventCount] The number of events in the file. - * @member {number} [firstSequenceNumber] The smallest sequence number from the - * queue. - * @member {number} [lastSequenceNumber] The last sequence number from the - * queue. - * @member {date} [firstEnqueueTime] The first time from the queue. - * @member {date} [lastEnqueueTime] The last time from the queue. + * Schema of the Data property of an EventGridEvent for an Microsoft.EventHub.CaptureFileCreated + * event. */ export interface EventHubCaptureFileCreatedEventData { + /** + * The path to the capture file. + */ fileurl?: string; + /** + * The file type of the capture file. + */ fileType?: string; + /** + * The shard ID. + */ partitionId?: string; + /** + * The file size. + */ sizeInBytes?: number; + /** + * The number of events in the file. + */ eventCount?: number; + /** + * The smallest sequence number from the queue. + */ firstSequenceNumber?: number; + /** + * The last sequence number from the queue. + */ lastSequenceNumber?: number; + /** + * The first time from the queue. + */ firstEnqueueTime?: Date; + /** + * The last time from the queue. + */ lastEnqueueTime?: Date; } /** - * @class - * Initializes a new instance of the ResourceWriteSuccessData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.Resources.ResourceWriteSuccess event. This is raised when a - * resource create or update operation succeeds. - * - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the - * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the - * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess + * event. This is raised when a resource create or update operation succeeds. */ export interface ResourceWriteSuccessData { + /** + * The tenant ID of the resource. + */ tenantId?: string; + /** + * The subscription ID of the resource. + */ subscriptionId?: string; + /** + * The resource group of the resource. + */ resourceGroup?: string; + /** + * The resource provider performing the operation. + */ resourceProvider?: string; + /** + * The URI of the resource in the operation. + */ resourceUri?: string; + /** + * The operation that was performed. + */ operationName?: string; + /** + * The status of the operation. + */ status?: string; + /** + * The requested authorization for the operation. + */ authorization?: string; + /** + * The properties of the claims. + */ claims?: string; + /** + * An operation ID used for troubleshooting. + */ correlationId?: string; + /** + * The details of the operation. + */ httpRequest?: string; } /** - * @class - * Initializes a new instance of the ResourceWriteFailureData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.Resources.ResourceWriteFailure event. This is raised when a - * resource create or update operation fails. - * - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the - * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the - * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure + * event. This is raised when a resource create or update operation fails. */ export interface ResourceWriteFailureData { + /** + * The tenant ID of the resource. + */ tenantId?: string; + /** + * The subscription ID of the resource. + */ subscriptionId?: string; + /** + * The resource group of the resource. + */ resourceGroup?: string; + /** + * The resource provider performing the operation. + */ resourceProvider?: string; + /** + * The URI of the resource in the operation. + */ resourceUri?: string; + /** + * The operation that was performed. + */ operationName?: string; + /** + * The status of the operation. + */ status?: string; + /** + * The requested authorization for the operation. + */ authorization?: string; + /** + * The properties of the claims. + */ claims?: string; + /** + * An operation ID used for troubleshooting. + */ correlationId?: string; + /** + * The details of the operation. + */ httpRequest?: string; } /** - * @class - * Initializes a new instance of the ResourceWriteCancelData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.Resources.ResourceWriteCancel event. This is raised when a - * resource create or update operation is canceled. - * - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the - * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the - * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel + * event. This is raised when a resource create or update operation is canceled. */ export interface ResourceWriteCancelData { + /** + * The tenant ID of the resource. + */ tenantId?: string; + /** + * The subscription ID of the resource. + */ subscriptionId?: string; + /** + * The resource group of the resource. + */ resourceGroup?: string; + /** + * The resource provider performing the operation. + */ resourceProvider?: string; + /** + * The URI of the resource in the operation. + */ resourceUri?: string; + /** + * The operation that was performed. + */ operationName?: string; + /** + * The status of the operation. + */ status?: string; + /** + * The requested authorization for the operation. + */ authorization?: string; + /** + * The properties of the claims. + */ claims?: string; + /** + * An operation ID used for troubleshooting. + */ correlationId?: string; + /** + * The details of the operation. + */ httpRequest?: string; } /** - * @class - * Initializes a new instance of the ResourceDeleteSuccessData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a - * resource delete operation succeeds. - * - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the - * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the - * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess + * event. This is raised when a resource delete operation succeeds. */ export interface ResourceDeleteSuccessData { + /** + * The tenant ID of the resource. + */ tenantId?: string; + /** + * The subscription ID of the resource. + */ subscriptionId?: string; + /** + * The resource group of the resource. + */ resourceGroup?: string; + /** + * The resource provider performing the operation. + */ resourceProvider?: string; + /** + * The URI of the resource in the operation. + */ resourceUri?: string; + /** + * The operation that was performed. + */ operationName?: string; + /** + * The status of the operation. + */ status?: string; + /** + * The requested authorization for the operation. + */ authorization?: string; + /** + * The properties of the claims. + */ claims?: string; + /** + * An operation ID used for troubleshooting. + */ correlationId?: string; + /** + * The details of the operation. + */ httpRequest?: string; } /** - * @class - * Initializes a new instance of the ResourceDeleteFailureData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.Resources.ResourceDeleteFailure event. This is raised when a - * resource delete operation fails. - * - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the - * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the - * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure + * event. This is raised when a resource delete operation fails. */ export interface ResourceDeleteFailureData { + /** + * The tenant ID of the resource. + */ tenantId?: string; + /** + * The subscription ID of the resource. + */ subscriptionId?: string; + /** + * The resource group of the resource. + */ resourceGroup?: string; + /** + * The resource provider performing the operation. + */ resourceProvider?: string; + /** + * The URI of the resource in the operation. + */ resourceUri?: string; + /** + * The operation that was performed. + */ operationName?: string; + /** + * The status of the operation. + */ status?: string; + /** + * The requested authorization for the operation. + */ authorization?: string; + /** + * The properties of the claims. + */ claims?: string; + /** + * An operation ID used for troubleshooting. + */ correlationId?: string; + /** + * The details of the operation. + */ httpRequest?: string; } /** - * @class - * Initializes a new instance of the ResourceDeleteCancelData class. - * @constructor - * Schema of the Data property of an EventGridEvent for an - * Microsoft.Resources.ResourceDeleteCancel event. This is raised when a - * resource delete operation is canceled. - * - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the - * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the - * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceDeleteCancel + * event. This is raised when a resource delete operation is canceled. */ export interface ResourceDeleteCancelData { + /** + * The tenant ID of the resource. + */ tenantId?: string; + /** + * The subscription ID of the resource. + */ subscriptionId?: string; + /** + * The resource group of the resource. + */ resourceGroup?: string; + /** + * The resource provider performing the operation. + */ resourceProvider?: string; + /** + * The URI of the resource in the operation. + */ resourceUri?: string; + /** + * The operation that was performed. + */ operationName?: string; + /** + * The status of the operation. + */ status?: string; + /** + * The requested authorization for the operation. + */ authorization?: string; + /** + * The properties of the claims. + */ claims?: string; + /** + * An operation ID used for troubleshooting. + */ correlationId?: string; + /** + * The details of the operation. + */ httpRequest?: string; } /** - * @class - * Initializes a new instance of the ResourceActionSuccessData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.Resources.ResourceActionSuccess event. This is raised when a - * resource action operation succeeds. - * - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the - * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the - * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess + * event. This is raised when a resource action operation succeeds. */ export interface ResourceActionSuccessData { + /** + * The tenant ID of the resource. + */ tenantId?: string; + /** + * The subscription ID of the resource. + */ subscriptionId?: string; + /** + * The resource group of the resource. + */ resourceGroup?: string; + /** + * The resource provider performing the operation. + */ resourceProvider?: string; + /** + * The URI of the resource in the operation. + */ resourceUri?: string; + /** + * The operation that was performed. + */ operationName?: string; + /** + * The status of the operation. + */ status?: string; + /** + * The requested authorization for the operation. + */ authorization?: string; + /** + * The properties of the claims. + */ claims?: string; + /** + * An operation ID used for troubleshooting. + */ correlationId?: string; + /** + * The details of the operation. + */ httpRequest?: string; } /** - * @class - * Initializes a new instance of the ResourceActionFailureData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.Resources.ResourceActionFailure event. This is raised when a - * resource action operation fails. - * - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the - * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the - * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure + * event. This is raised when a resource action operation fails. */ export interface ResourceActionFailureData { + /** + * The tenant ID of the resource. + */ tenantId?: string; + /** + * The subscription ID of the resource. + */ subscriptionId?: string; + /** + * The resource group of the resource. + */ resourceGroup?: string; + /** + * The resource provider performing the operation. + */ resourceProvider?: string; + /** + * The URI of the resource in the operation. + */ resourceUri?: string; + /** + * The operation that was performed. + */ operationName?: string; + /** + * The status of the operation. + */ status?: string; + /** + * The requested authorization for the operation. + */ authorization?: string; + /** + * The properties of the claims. + */ claims?: string; + /** + * An operation ID used for troubleshooting. + */ correlationId?: string; + /** + * The details of the operation. + */ httpRequest?: string; } /** - * @class - * Initializes a new instance of the ResourceActionCancelData class. - * @constructor - * Schema of the Data property of an EventGridEvent for an - * Microsoft.Resources.ResourceActionCancel event. This is raised when a - * resource action operation is canceled. - * - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the - * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the - * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceActionCancel + * event. This is raised when a resource action operation is canceled. */ export interface ResourceActionCancelData { + /** + * The tenant ID of the resource. + */ tenantId?: string; + /** + * The subscription ID of the resource. + */ subscriptionId?: string; + /** + * The resource group of the resource. + */ resourceGroup?: string; + /** + * The resource provider performing the operation. + */ resourceProvider?: string; + /** + * The URI of the resource in the operation. + */ resourceUri?: string; + /** + * The operation that was performed. + */ operationName?: string; + /** + * The status of the operation. + */ status?: string; + /** + * The requested authorization for the operation. + */ authorization?: string; + /** + * The properties of the claims. + */ claims?: string; + /** + * An operation ID used for troubleshooting. + */ correlationId?: string; + /** + * The details of the operation. + */ httpRequest?: string; } /** - * @class - * Initializes a new instance of the EventGridEvent class. - * @constructor * Properties of an event published to an Event Grid topic. - * - * @member {string} id An unique identifier for the event. - * @member {string} [topic] The resource path of the event source. - * @member {string} subject A resource path relative to the topic path. - * @member {object} data Event data specific to the event type. - * @member {string} eventType The type of the event that occurred. - * @member {date} eventTime The time (in UTC) the event was generated. - * @member {string} [metadataVersion] The schema version of the event metadata. - * @member {string} dataVersion The schema version of the data object. */ export interface EventGridEvent { + /** + * An unique identifier for the event. + */ id: string; + /** + * The resource path of the event source. + */ topic?: string; + /** + * A resource path relative to the topic path. + */ subject: string; + /** + * Event data specific to the event type. + */ data: any; + /** + * The type of the event that occurred. + */ eventType: string; + /** + * The time (in UTC) the event was generated. + */ eventTime: Date; + /** + * The schema version of the event metadata. + */ readonly metadataVersion?: string; + /** + * The schema version of the data object. + */ dataVersion: string; } /** - * @class - * Initializes a new instance of the SubscriptionValidationEventData class. - * @constructor * Schema of the Data property of an EventGridEvent for a * Microsoft.EventGrid.SubscriptionValidationEvent. - * - * @member {string} [validationCode] The validation code sent by Azure Event - * Grid to validate an event subscription. To complete the validation - * handshake, the subscriber must either respond with this validation code as - * part of the validation response, or perform a GET request on the - * validationUrl (available starting version 2018-05-01-preview). - * @member {string} [validationUrl] The validation URL sent by Azure Event Grid - * (available starting version 2018-05-01-preview). To complete the validation - * handshake, the subscriber must either respond with the validationCode as - * part of the validation response, or perform a GET request on the - * validationUrl (available starting version 2018-05-01-preview). */ export interface SubscriptionValidationEventData { + /** + * The validation code sent by Azure Event Grid to validate an event subscription. To complete + * the validation handshake, the subscriber must either respond with this validation code as part + * of the validation response, or perform a GET request on the validationUrl (available starting + * version 2018-05-01-preview). + */ readonly validationCode?: string; + /** + * The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview). + * To complete the validation handshake, the subscriber must either respond with the + * validationCode as part of the validation response, or perform a GET request on the + * validationUrl (available starting version 2018-05-01-preview). + */ readonly validationUrl?: string; } /** - * @class - * Initializes a new instance of the SubscriptionValidationResponse class. - * @constructor - * To complete an event subscription validation handshake, a subscriber can use - * either the validationCode or the validationUrl received in a - * SubscriptionValidationEvent. When the validationCode is used, the - * SubscriptionValidationResponse can be used to build the response. - * - * @member {string} [validationResponse] The validation response sent by the - * subscriber to Azure Event Grid to complete the validation of an event - * subscription. + * To complete an event subscription validation handshake, a subscriber can use either the + * validationCode or the validationUrl received in a SubscriptionValidationEvent. When the + * validationCode is used, the SubscriptionValidationResponse can be used to build the response. */ export interface SubscriptionValidationResponse { + /** + * The validation response sent by the subscriber to Azure Event Grid to complete the validation + * of an event subscription. + */ validationResponse?: string; } /** - * @class - * Initializes a new instance of the SubscriptionDeletedEventData class. - * @constructor * Schema of the Data property of an EventGridEvent for a * Microsoft.EventGrid.SubscriptionDeletedEvent. - * - * @member {string} [eventSubscriptionId] The Azure resource ID of the deleted - * event subscription. */ export interface SubscriptionDeletedEventData { + /** + * The Azure resource ID of the deleted event subscription. + */ readonly eventSubscriptionId?: string; } /** - * @class - * Initializes a new instance of the DeviceLifeCycleEventProperties class. - * @constructor - * Schema of the Data property of an EventGridEvent for a device life cycle - * event (DeviceCreated, DeviceDeleted). - * - * @member {string} [deviceId] The unique identifier of the device. This - * case-sensitive string can be up to 128 characters long, and supports ASCII - * 7-bit alphanumeric characters plus the following special characters: - : . + - * % _ # * ? ! ( ) , = @ ; $ '. - * @member {string} [hubName] Name of the IoT Hub where the device was created - * or deleted. - * @member {object} [twin] Information about the device twin, which is the - * cloud representation of application device metadata. - * @member {string} [twin.authenticationType] Authentication type used for this - * device: either SAS, SelfSigned, or CertificateAuthority. - * @member {number} [twin.cloudToDeviceMessageCount] Count of cloud to device - * messages sent to this device. - * @member {string} [twin.connectionState] Whether the device is connected or - * disconnected. - * @member {string} [twin.deviceId] The unique identifier of the device twin. - * @member {string} [twin.etag] A piece of information that describes the - * content of the device twin. Each etag is guaranteed to be unique per device - * twin. - * @member {string} [twin.lastActivityTime] The ISO8601 timestamp of the last - * activity. - * @member {object} [twin.properties] Properties JSON element. - * @member {object} [twin.properties.desired] A portion of the properties that - * can be written only by the application back-end, and read by the device. - * @member {object} [twin.properties.desired.metadata] Metadata information for - * the properties JSON document. - * @member {string} [twin.properties.desired.metadata.lastUpdated] The ISO8601 - * timestamp of the last time the properties were updated. - * @member {number} [twin.properties.desired.version] Version of device twin - * properties. - * @member {object} [twin.properties.reported] A portion of the properties that - * can be written only by the device, and read by the application back-end. - * @member {object} [twin.properties.reported.metadata] Metadata information - * for the properties JSON document. - * @member {string} [twin.properties.reported.metadata.lastUpdated] The ISO8601 - * timestamp of the last time the properties were updated. - * @member {number} [twin.properties.reported.version] Version of device twin - * properties. - * @member {string} [twin.status] Whether the device twin is enabled or - * disabled. - * @member {string} [twin.statusUpdateTime] The ISO8601 timestamp of the last - * device twin status update. - * @member {number} [twin.version] An integer that is incremented by one each - * time the device twin is updated. - * @member {object} [twin.x509Thumbprint] The thumbprint is a unique value for - * the x509 certificate, commonly used to find a particular certificate in a - * certificate store. The thumbprint is dynamically generated using the SHA1 - * algorithm, and does not physically exist in the certificate. - * @member {string} [twin.x509Thumbprint.primaryThumbprint] Primary thumbprint - * for the x509 certificate. - * @member {string} [twin.x509Thumbprint.secondaryThumbprint] Secondary - * thumbprint for the x509 certificate. + * Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, + * DeviceDeleted). */ export interface DeviceLifeCycleEventProperties { + /** + * The unique identifier of the device. This case-sensitive string can be up to 128 characters + * long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: + * - : . + % _ # * ? ! ( ) , = @ ; $ '. + */ deviceId?: string; + /** + * Name of the IoT Hub where the device was created or deleted. + */ hubName?: string; + /** + * Information about the device twin, which is the cloud representation of application device + * metadata. + */ twin?: DeviceTwinInfo; } /** - * @class - * Initializes a new instance of the IotHubDeviceCreatedEventData class. - * @constructor * Event data for Microsoft.Devices.DeviceCreated event. - * */ export interface IotHubDeviceCreatedEventData extends DeviceLifeCycleEventProperties { } /** - * @class - * Initializes a new instance of the IotHubDeviceDeletedEventData class. - * @constructor * Event data for Microsoft.Devices.DeviceDeleted event. - * */ export interface IotHubDeviceDeletedEventData extends DeviceLifeCycleEventProperties { } /** - * @class - * Initializes a new instance of the DeviceConnectionStateEventProperties class. - * @constructor - * Schema of the Data property of an EventGridEvent for a device connection - * state event (DeviceConnected, DeviceDisconnected). - * - * @member {string} [deviceId] The unique identifier of the device. This - * case-sensitive string can be up to 128 characters long, and supports ASCII - * 7-bit alphanumeric characters plus the following special characters: - : . + - * % _ # * ? ! ( ) , = @ ; $ '. - * @member {string} [moduleId] The unique identifier of the module. This - * case-sensitive string can be up to 128 characters long, and supports ASCII - * 7-bit alphanumeric characters plus the following special characters: - : . + - * % _ # * ? ! ( ) , = @ ; $ '. - * @member {string} [hubName] Name of the IoT Hub where the device was created - * or deleted. - * @member {object} [deviceConnectionStateEventInfo] Information about the - * device connection state event. - * @member {string} [deviceConnectionStateEventInfo.sequenceNumber] Sequence - * number is string representation of a hexadecimal number. string compare can - * be used to identify the larger number because both in ASCII and HEX numbers - * come after alphabets. If you are converting the string to hex, then the - * number is a 256 bit number. + * Schema of the Data property of an EventGridEvent for a device connection state event + * (DeviceConnected, DeviceDisconnected). */ export interface DeviceConnectionStateEventProperties { + /** + * The unique identifier of the device. This case-sensitive string can be up to 128 characters + * long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: + * - : . + % _ # * ? ! ( ) , = @ ; $ '. + */ deviceId?: string; + /** + * The unique identifier of the module. This case-sensitive string can be up to 128 characters + * long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: + * - : . + % _ # * ? ! ( ) , = @ ; $ '. + */ moduleId?: string; + /** + * Name of the IoT Hub where the device was created or deleted. + */ hubName?: string; + /** + * Information about the device connection state event. + */ deviceConnectionStateEventInfo?: DeviceConnectionStateEventInfo; } /** - * @class - * Initializes a new instance of the IotHubDeviceConnectedEventData class. - * @constructor * Event data for Microsoft.Devices.DeviceConnected event. - * */ export interface IotHubDeviceConnectedEventData extends DeviceConnectionStateEventProperties { } /** - * @class - * Initializes a new instance of the IotHubDeviceDisconnectedEventData class. - * @constructor * Event data for Microsoft.Devices.DeviceDisconnected event. - * */ export interface IotHubDeviceDisconnectedEventData extends DeviceConnectionStateEventProperties { } /** - * @class - * Initializes a new instance of the DeviceTwinMetadata class. - * @constructor * Metadata information for the properties JSON document. - * - * @member {string} [lastUpdated] The ISO8601 timestamp of the last time the - * properties were updated. */ export interface DeviceTwinMetadata { + /** + * The ISO8601 timestamp of the last time the properties were updated. + */ lastUpdated?: string; } /** - * @class - * Initializes a new instance of the DeviceTwinProperties class. - * @constructor - * A portion of the properties that can be written only by the application - * back-end, and read by the device. - * - * @member {object} [metadata] Metadata information for the properties JSON - * document. - * @member {string} [metadata.lastUpdated] The ISO8601 timestamp of the last - * time the properties were updated. - * @member {number} [version] Version of device twin properties. + * A portion of the properties that can be written only by the application back-end, and read by + * the device. */ export interface DeviceTwinProperties { + /** + * Metadata information for the properties JSON document. + */ metadata?: DeviceTwinMetadata; + /** + * Version of device twin properties. + */ version?: number; } /** - * @class - * Initializes a new instance of the DeviceTwinInfoProperties class. - * @constructor * Properties JSON element. - * - * @member {object} [desired] A portion of the properties that can be written - * only by the application back-end, and read by the device. - * @member {object} [desired.metadata] Metadata information for the properties - * JSON document. - * @member {string} [desired.metadata.lastUpdated] The ISO8601 timestamp of the - * last time the properties were updated. - * @member {number} [desired.version] Version of device twin properties. - * @member {object} [reported] A portion of the properties that can be written - * only by the device, and read by the application back-end. - * @member {object} [reported.metadata] Metadata information for the properties - * JSON document. - * @member {string} [reported.metadata.lastUpdated] The ISO8601 timestamp of - * the last time the properties were updated. - * @member {number} [reported.version] Version of device twin properties. */ export interface DeviceTwinInfoProperties { + /** + * A portion of the properties that can be written only by the application back-end, and read by + * the device. + */ desired?: DeviceTwinProperties; + /** + * A portion of the properties that can be written only by the device, and read by the + * application back-end. + */ reported?: DeviceTwinProperties; } /** - * @class - * Initializes a new instance of the DeviceTwinInfoX509Thumbprint class. - * @constructor - * The thumbprint is a unique value for the x509 certificate, commonly used to - * find a particular certificate in a certificate store. The thumbprint is - * dynamically generated using the SHA1 algorithm, and does not physically - * exist in the certificate. - * - * @member {string} [primaryThumbprint] Primary thumbprint for the x509 - * certificate. - * @member {string} [secondaryThumbprint] Secondary thumbprint for the x509 - * certificate. + * The thumbprint is a unique value for the x509 certificate, commonly used to find a particular + * certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 + * algorithm, and does not physically exist in the certificate. */ export interface DeviceTwinInfoX509Thumbprint { + /** + * Primary thumbprint for the x509 certificate. + */ primaryThumbprint?: string; + /** + * Secondary thumbprint for the x509 certificate. + */ secondaryThumbprint?: string; } /** - * @class - * Initializes a new instance of the DeviceTwinInfo class. - * @constructor - * Information about the device twin, which is the cloud representation of - * application device metadata. - * - * @member {string} [authenticationType] Authentication type used for this - * device: either SAS, SelfSigned, or CertificateAuthority. - * @member {number} [cloudToDeviceMessageCount] Count of cloud to device - * messages sent to this device. - * @member {string} [connectionState] Whether the device is connected or - * disconnected. - * @member {string} [deviceId] The unique identifier of the device twin. - * @member {string} [etag] A piece of information that describes the content of - * the device twin. Each etag is guaranteed to be unique per device twin. - * @member {string} [lastActivityTime] The ISO8601 timestamp of the last - * activity. - * @member {object} [properties] Properties JSON element. - * @member {object} [properties.desired] A portion of the properties that can - * be written only by the application back-end, and read by the device. - * @member {object} [properties.desired.metadata] Metadata information for the - * properties JSON document. - * @member {string} [properties.desired.metadata.lastUpdated] The ISO8601 - * timestamp of the last time the properties were updated. - * @member {number} [properties.desired.version] Version of device twin - * properties. - * @member {object} [properties.reported] A portion of the properties that can - * be written only by the device, and read by the application back-end. - * @member {object} [properties.reported.metadata] Metadata information for the - * properties JSON document. - * @member {string} [properties.reported.metadata.lastUpdated] The ISO8601 - * timestamp of the last time the properties were updated. - * @member {number} [properties.reported.version] Version of device twin - * properties. - * @member {string} [status] Whether the device twin is enabled or disabled. - * @member {string} [statusUpdateTime] The ISO8601 timestamp of the last device - * twin status update. - * @member {number} [version] An integer that is incremented by one each time - * the device twin is updated. - * @member {object} [x509Thumbprint] The thumbprint is a unique value for the - * x509 certificate, commonly used to find a particular certificate in a - * certificate store. The thumbprint is dynamically generated using the SHA1 - * algorithm, and does not physically exist in the certificate. - * @member {string} [x509Thumbprint.primaryThumbprint] Primary thumbprint for - * the x509 certificate. - * @member {string} [x509Thumbprint.secondaryThumbprint] Secondary thumbprint - * for the x509 certificate. + * Information about the device twin, which is the cloud representation of application device + * metadata. */ export interface DeviceTwinInfo { + /** + * Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority. + */ authenticationType?: string; + /** + * Count of cloud to device messages sent to this device. + */ cloudToDeviceMessageCount?: number; + /** + * Whether the device is connected or disconnected. + */ connectionState?: string; + /** + * The unique identifier of the device twin. + */ deviceId?: string; + /** + * A piece of information that describes the content of the device twin. Each etag is guaranteed + * to be unique per device twin. + */ etag?: string; + /** + * The ISO8601 timestamp of the last activity. + */ lastActivityTime?: string; + /** + * Properties JSON element. + */ properties?: DeviceTwinInfoProperties; + /** + * Whether the device twin is enabled or disabled. + */ status?: string; + /** + * The ISO8601 timestamp of the last device twin status update. + */ statusUpdateTime?: string; + /** + * An integer that is incremented by one each time the device twin is updated. + */ version?: number; + /** + * The thumbprint is a unique value for the x509 certificate, commonly used to find a particular + * certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 + * algorithm, and does not physically exist in the certificate. + */ x509Thumbprint?: DeviceTwinInfoX509Thumbprint; } /** - * @class - * Initializes a new instance of the DeviceConnectionStateEventInfo class. - * @constructor * Information about the device connection state event. - * - * @member {string} [sequenceNumber] Sequence number is string representation - * of a hexadecimal number. string compare can be used to identify the larger - * number because both in ASCII and HEX numbers come after alphabets. If you - * are converting the string to hex, then the number is a 256 bit number. */ export interface DeviceConnectionStateEventInfo { + /** + * Sequence number is string representation of a hexadecimal number. string compare can be used + * to identify the larger number because both in ASCII and HEX numbers come after alphabets. If + * you are converting the string to hex, then the number is a 256 bit number. + */ sequenceNumber?: string; } /** - * @class - * Initializes a new instance of the ContainerRegistryEventData class. - * @constructor * The content of the event request message. - * - * @member {string} [id] The event ID. - * @member {date} [timestamp] The time at which the event occurred. - * @member {string} [action] The action that encompasses the provided event. - * @member {object} [target] The target of the event. - * @member {string} [target.mediaType] The MIME type of the referenced object. - * @member {number} [target.size] The number of bytes of the content. Same as - * Length field. - * @member {string} [target.digest] The digest of the content, as defined by - * the Registry V2 HTTP API Specification. - * @member {number} [target.length] The number of bytes of the content. Same as - * Size field. - * @member {string} [target.repository] The repository name. - * @member {string} [target.url] The direct URL to the content. - * @member {string} [target.tag] The tag name. - * @member {object} [request] The request that generated the event. - * @member {string} [request.id] The ID of the request that initiated the - * event. - * @member {string} [request.addr] The IP or hostname and possibly port of the - * client connection that initiated the event. This is the RemoteAddr from the - * standard http request. - * @member {string} [request.host] The externally accessible hostname of the - * registry instance, as specified by the http host header on incoming - * requests. - * @member {string} [request.method] The request method that generated the - * event. - * @member {string} [request.useragent] The user agent header of the request. - * @member {object} [actor] The agent that initiated the event. For most - * situations, this could be from the authorization context of the request. - * @member {string} [actor.name] The subject or username associated with the - * request context that generated the event. - * @member {object} [source] The registry node that generated the event. Put - * differently, while the actor initiates the event, the source generates it. - * @member {string} [source.addr] The IP or hostname and the port of the - * registry node that generated the event. Generally, this will be resolved by - * os.Hostname() along with the running port. - * @member {string} [source.instanceID] The running instance of an application. - * Changes after each restart. */ export interface ContainerRegistryEventData { + /** + * The event ID. + */ id?: string; + /** + * The time at which the event occurred. + */ timestamp?: Date; + /** + * The action that encompasses the provided event. + */ action?: string; + /** + * The target of the event. + */ target?: ContainerRegistryEventTarget; + /** + * The request that generated the event. + */ request?: ContainerRegistryEventRequest; + /** + * The agent that initiated the event. For most situations, this could be from the authorization + * context of the request. + */ actor?: ContainerRegistryEventActor; + /** + * The registry node that generated the event. Put differently, while the actor initiates the + * event, the source generates it. + */ source?: ContainerRegistryEventSource; } /** - * @class - * Initializes a new instance of the ContainerRegistryImagePushedEventData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.ContainerRegistry.ImagePushed event. - * + * Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed + * event. */ export interface ContainerRegistryImagePushedEventData extends ContainerRegistryEventData { } /** - * @class - * Initializes a new instance of the ContainerRegistryImageDeletedEventData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.ContainerRegistry.ImageDeleted event. - * + * Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted + * event. */ export interface ContainerRegistryImageDeletedEventData extends ContainerRegistryEventData { } /** - * @class - * Initializes a new instance of the ContainerRegistryEventTarget class. - * @constructor + * The content of the event request message. + */ +export interface ContainerRegistryArtifactEventData { + /** + * The event ID. + */ + id?: string; + /** + * The time at which the event occurred. + */ + timestamp?: Date; + /** + * The action that encompasses the provided event. + */ + action?: string; + /** + * The target of the event. + */ + target?: ContainerRegistryArtifactEventTarget; +} + +/** + * Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed + * event. + */ +export interface ContainerRegistryChartPushedEventData extends ContainerRegistryArtifactEventData { +} + +/** + * Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted + * event. + */ +export interface ContainerRegistryChartDeletedEventData extends ContainerRegistryArtifactEventData { +} + +/** * The target of the event. - * - * @member {string} [mediaType] The MIME type of the referenced object. - * @member {number} [size] The number of bytes of the content. Same as Length - * field. - * @member {string} [digest] The digest of the content, as defined by the - * Registry V2 HTTP API Specification. - * @member {number} [length] The number of bytes of the content. Same as Size - * field. - * @member {string} [repository] The repository name. - * @member {string} [url] The direct URL to the content. - * @member {string} [tag] The tag name. */ export interface ContainerRegistryEventTarget { + /** + * The MIME type of the referenced object. + */ mediaType?: string; + /** + * The number of bytes of the content. Same as Length field. + */ size?: number; + /** + * The digest of the content, as defined by the Registry V2 HTTP API Specification. + */ digest?: string; + /** + * The number of bytes of the content. Same as Size field. + */ length?: number; + /** + * The repository name. + */ repository?: string; + /** + * The direct URL to the content. + */ url?: string; + /** + * The tag name. + */ tag?: string; } /** - * @class - * Initializes a new instance of the ContainerRegistryEventRequest class. - * @constructor * The request that generated the event. - * - * @member {string} [id] The ID of the request that initiated the event. - * @member {string} [addr] The IP or hostname and possibly port of the client - * connection that initiated the event. This is the RemoteAddr from the - * standard http request. - * @member {string} [host] The externally accessible hostname of the registry - * instance, as specified by the http host header on incoming requests. - * @member {string} [method] The request method that generated the event. - * @member {string} [useragent] The user agent header of the request. */ export interface ContainerRegistryEventRequest { + /** + * The ID of the request that initiated the event. + */ id?: string; + /** + * The IP or hostname and possibly port of the client connection that initiated the event. This + * is the RemoteAddr from the standard http request. + */ addr?: string; + /** + * The externally accessible hostname of the registry instance, as specified by the http host + * header on incoming requests. + */ host?: string; + /** + * The request method that generated the event. + */ method?: string; + /** + * The user agent header of the request. + */ useragent?: string; } /** - * @class - * Initializes a new instance of the ContainerRegistryEventActor class. - * @constructor - * The agent that initiated the event. For most situations, this could be from - * the authorization context of the request. - * - * @member {string} [name] The subject or username associated with the request - * context that generated the event. + * The agent that initiated the event. For most situations, this could be from the authorization + * context of the request. */ export interface ContainerRegistryEventActor { + /** + * The subject or username associated with the request context that generated the event. + */ name?: string; } /** - * @class - * Initializes a new instance of the ContainerRegistryEventSource class. - * @constructor - * The registry node that generated the event. Put differently, while the actor - * initiates the event, the source generates it. - * - * @member {string} [addr] The IP or hostname and the port of the registry node - * that generated the event. Generally, this will be resolved by os.Hostname() - * along with the running port. - * @member {string} [instanceID] The running instance of an application. - * Changes after each restart. + * The registry node that generated the event. Put differently, while the actor initiates the + * event, the source generates it. */ export interface ContainerRegistryEventSource { + /** + * The IP or hostname and the port of the registry node that generated the event. Generally, this + * will be resolved by os.Hostname() along with the running port. + */ addr?: string; + /** + * The running instance of an application. Changes after each restart. + */ instanceID?: string; } /** - * @class - * Initializes a new instance of the ServiceBusActiveMessagesAvailableWithNoListenersEventData class. - * @constructor + * The target of the event. + */ +export interface ContainerRegistryArtifactEventTarget { + /** + * The MIME type of the artifact. + */ + mediaType?: string; + /** + * The size in bytes of the artifact. + */ + size?: number; + /** + * The digest of the artifact. + */ + digest?: string; + /** + * The repository name of the artifact. + */ + repository?: string; + /** + * The tag of the artifact. + */ + tag?: string; + /** + * The name of the artifact. + */ + name?: string; + /** + * The version of the artifact. + */ + version?: string; +} + +/** * Schema of the Data property of an EventGridEvent for a * Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event. - * - * @member {string} [namespaceName] The namespace name of the - * Microsoft.ServiceBus resource. - * @member {string} [requestUri] The endpoint of the Microsoft.ServiceBus - * resource. - * @member {string} [entityType] The entity type of the Microsoft.ServiceBus - * resource. Could be one of 'queue' or 'subscriber'. - * @member {string} [queueName] The name of the Microsoft.ServiceBus queue. If - * the entity type is of type 'subscriber', then this value will be null. - * @member {string} [topicName] The name of the Microsoft.ServiceBus topic. If - * the entity type is of type 'queue', then this value will be null. - * @member {string} [subscriptionName] The name of the Microsoft.ServiceBus - * topic's subscription. If the entity type is of type 'queue', then this value - * will be null. */ export interface ServiceBusActiveMessagesAvailableWithNoListenersEventData { + /** + * The namespace name of the Microsoft.ServiceBus resource. + */ namespaceName?: string; + /** + * The endpoint of the Microsoft.ServiceBus resource. + */ requestUri?: string; + /** + * The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'. + */ entityType?: string; + /** + * The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then + * this value will be null. + */ queueName?: string; + /** + * The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this + * value will be null. + */ topicName?: string; + /** + * The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type + * 'queue', then this value will be null. + */ subscriptionName?: string; } /** - * @class - * Initializes a new instance of the ServiceBusDeadletterMessagesAvailableWithNoListenersEventData class. - * @constructor * Schema of the Data property of an EventGridEvent for a * Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListenersEvent event. - * - * @member {string} [namespaceName] The namespace name of the - * Microsoft.ServiceBus resource. - * @member {string} [requestUri] The endpoint of the Microsoft.ServiceBus - * resource. - * @member {string} [entityType] The entity type of the Microsoft.ServiceBus - * resource. Could be one of 'queue' or 'subscriber'. - * @member {string} [queueName] The name of the Microsoft.ServiceBus queue. If - * the entity type is of type 'subscriber', then this value will be null. - * @member {string} [topicName] The name of the Microsoft.ServiceBus topic. If - * the entity type is of type 'queue', then this value will be null. - * @member {string} [subscriptionName] The name of the Microsoft.ServiceBus - * topic's subscription. If the entity type is of type 'queue', then this value - * will be null. */ export interface ServiceBusDeadletterMessagesAvailableWithNoListenersEventData { + /** + * The namespace name of the Microsoft.ServiceBus resource. + */ namespaceName?: string; + /** + * The endpoint of the Microsoft.ServiceBus resource. + */ requestUri?: string; + /** + * The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'. + */ entityType?: string; + /** + * The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then + * this value will be null. + */ queueName?: string; + /** + * The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this + * value will be null. + */ topicName?: string; + /** + * The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type + * 'queue', then this value will be null. + */ subscriptionName?: string; } /** - * @class - * Initializes a new instance of the MediaJobStateChangeEventData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.Media.JobStateChange event. - * - * @member {string} [previousState] The previous state of the Job. Possible - * values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', - * 'Queued', 'Scheduled' - * @member {string} [state] The new state of the Job. Possible values include: - * 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', - * 'Scheduled' - * @member {object} [correlationData] Gets the Job correlation data. + * Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobStateChange event. */ export interface MediaJobStateChangeEventData { + /** + * The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', + * 'Finished', 'Processing', 'Queued', 'Scheduled' + */ readonly previousState?: string; + /** + * The new state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', + * 'Finished', 'Processing', 'Queued', 'Scheduled' + */ readonly state?: string; + /** + * Gets the Job correlation data. + */ correlationData?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the MediaJobErrorDetail class. - * @constructor * Details of JobOutput errors. - * - * @member {string} [code] Code describing the error detail. - * @member {string} [message] A human-readable representation of the error. */ export interface MediaJobErrorDetail { + /** + * Code describing the error detail. + */ readonly code?: string; + /** + * A human-readable representation of the error. + */ readonly message?: string; } /** - * @class - * Initializes a new instance of the MediaJobError class. - * @constructor * Details of JobOutput errors. - * - * @member {string} [code] Error code describing the error. Possible values - * include: 'ServiceError', 'ServiceTransientError', 'DownloadNotAccessible', - * 'DownloadTransientError', 'UploadNotAccessible', 'UploadTransientError', - * 'ConfigurationUnsupported', 'ContentMalformed', 'ContentUnsupported' - * @member {string} [message] A human-readable language-dependent - * representation of the error. - * @member {string} [category] Helps with categorization of errors. Possible - * values include: 'Service', 'Download', 'Upload', 'Configuration', 'Content' - * @member {string} [retry] Indicates that it may be possible to retry the Job. - * If retry is unsuccessful, please contact Azure support via Azure Portal. - * Possible values include: 'DoNotRetry', 'MayRetry' - * @member {array} [details] An array of details about specific errors that led - * to this reported error. */ export interface MediaJobError { + /** + * Error code describing the error. Possible values include: 'ServiceError', + * 'ServiceTransientError', 'DownloadNotAccessible', 'DownloadTransientError', + * 'UploadNotAccessible', 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', + * 'ContentUnsupported' + */ readonly code?: string; + /** + * A human-readable language-dependent representation of the error. + */ readonly message?: string; + /** + * Helps with categorization of errors. Possible values include: 'Service', 'Download', 'Upload', + * 'Configuration', 'Content' + */ readonly category?: string; + /** + * Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact + * Azure support via Azure Portal. Possible values include: 'DoNotRetry', 'MayRetry' + */ readonly retry?: string; + /** + * An array of details about specific errors that led to this reported error. + */ readonly details?: MediaJobErrorDetail[]; } /** - * @class - * Initializes a new instance of the MediaJobOutput class. - * @constructor * The event data for a Job output. - * - * @member {object} [error] Gets the Job output error. - * @member {string} [error.code] Error code describing the error. Possible - * values include: 'ServiceError', 'ServiceTransientError', - * 'DownloadNotAccessible', 'DownloadTransientError', 'UploadNotAccessible', - * 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', - * 'ContentUnsupported' - * @member {string} [error.message] A human-readable language-dependent - * representation of the error. - * @member {string} [error.category] Helps with categorization of errors. - * Possible values include: 'Service', 'Download', 'Upload', 'Configuration', - * 'Content' - * @member {string} [error.retry] Indicates that it may be possible to retry - * the Job. If retry is unsuccessful, please contact Azure support via Azure - * Portal. Possible values include: 'DoNotRetry', 'MayRetry' - * @member {array} [error.details] An array of details about specific errors - * that led to this reported error. - * @member {string} [label] Gets the Job output label. - * @member {number} progress Gets the Job output progress. - * @member {string} state Gets the Job output state. Possible values include: - * 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', - * 'Scheduled' - * @member {string} odatatype Polymorphic Discriminator */ export interface MediaJobOutput { + /** + * Gets the Job output error. + */ error?: MediaJobError; + /** + * Gets the Job output label. + */ label?: string; + /** + * Gets the Job output progress. + */ progress: number; + /** + * Gets the Job output state. Possible values include: 'Canceled', 'Canceling', 'Error', + * 'Finished', 'Processing', 'Queued', 'Scheduled' + */ state: string; + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the MediaJobOutputAsset class. - * @constructor * The event data for a Job output asset. - * - * @member {string} [assetName] Gets the Job output asset name. */ export interface MediaJobOutputAsset extends MediaJobOutput { + /** + * Gets the Job output asset name. + */ assetName?: string; } /** - * @class - * Initializes a new instance of the MediaJobOutputStateChangeEventData class. - * @constructor - * Schema of the Data property of an EventGridEvent for a - * Microsoft.Media.JobOutputStateChange event. - * - * @member {string} [previousState] The previous state of the Job. Possible - * values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', - * 'Queued', 'Scheduled' - * @member {object} [output] Gets the output. - * @member {object} [output.error] Gets the Job output error. - * @member {string} [output.error.code] Error code describing the error. - * Possible values include: 'ServiceError', 'ServiceTransientError', - * 'DownloadNotAccessible', 'DownloadTransientError', 'UploadNotAccessible', - * 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', - * 'ContentUnsupported' - * @member {string} [output.error.message] A human-readable language-dependent - * representation of the error. - * @member {string} [output.error.category] Helps with categorization of - * errors. Possible values include: 'Service', 'Download', 'Upload', - * 'Configuration', 'Content' - * @member {string} [output.error.retry] Indicates that it may be possible to - * retry the Job. If retry is unsuccessful, please contact Azure support via - * Azure Portal. Possible values include: 'DoNotRetry', 'MayRetry' - * @member {array} [output.error.details] An array of details about specific - * errors that led to this reported error. - * @member {string} [output.label] Gets the Job output label. - * @member {number} [output.progress] Gets the Job output progress. - * @member {string} [output.state] Gets the Job output state. Possible values - * include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', - * 'Queued', 'Scheduled' - * @member {string} [output.odatatype] Polymorphic Discriminator - * @member {object} [jobCorrelationData] Gets the Job correlation data. + * Job Output Progress Event Data. + */ +export interface MediaJobOutputProgressEventData { + /** + * Gets the Job output label. + */ + label?: string; + /** + * Gets the Job output progress. + */ + progress?: number; + /** + * Gets the Job correlation data. + */ + jobCorrelationData?: { [propertyName: string]: string }; +} + +/** + * Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputStateChange + * event. */ export interface MediaJobOutputStateChangeEventData { + /** + * The previous state of the Job. Possible values include: 'Canceled', 'Canceling', 'Error', + * 'Finished', 'Processing', 'Queued', 'Scheduled' + */ readonly previousState?: string; + /** + * Gets the output. + */ output?: MediaJobOutput; + /** + * Gets the Job correlation data. + */ jobCorrelationData?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the MediaJobScheduledEventData class. - * @constructor * Job scheduled event data - * */ export interface MediaJobScheduledEventData extends MediaJobStateChangeEventData { } /** - * @class - * Initializes a new instance of the MediaJobProcessingEventData class. - * @constructor * Job processing event data - * */ export interface MediaJobProcessingEventData extends MediaJobStateChangeEventData { } /** - * @class - * Initializes a new instance of the MediaJobCancelingEventData class. - * @constructor * Job canceling event data - * */ export interface MediaJobCancelingEventData extends MediaJobStateChangeEventData { } /** - * @class - * Initializes a new instance of the MediaJobFinishedEventData class. - * @constructor * Job finished event data - * - * @member {array} [outputs] Gets the Job outputs. */ export interface MediaJobFinishedEventData extends MediaJobStateChangeEventData { + /** + * Gets the Job outputs. + */ outputs?: MediaJobOutput[]; } /** - * @class - * Initializes a new instance of the MediaJobCanceledEventData class. - * @constructor * Job canceled event data - * - * @member {array} [outputs] Gets the Job outputs. */ export interface MediaJobCanceledEventData extends MediaJobStateChangeEventData { + /** + * Gets the Job outputs. + */ outputs?: MediaJobOutput[]; } /** - * @class - * Initializes a new instance of the MediaJobErroredEventData class. - * @constructor * Job error state event data - * - * @member {array} [outputs] Gets the Job outputs. */ export interface MediaJobErroredEventData extends MediaJobStateChangeEventData { + /** + * Gets the Job outputs. + */ outputs?: MediaJobOutput[]; } /** - * @class - * Initializes a new instance of the MediaJobOutputCanceledEventData class. - * @constructor * Job output canceled event data - * */ export interface MediaJobOutputCanceledEventData extends MediaJobOutputStateChangeEventData { } /** - * @class - * Initializes a new instance of the MediaJobOutputCancelingEventData class. - * @constructor * Job output canceling event data - * */ export interface MediaJobOutputCancelingEventData extends MediaJobOutputStateChangeEventData { } /** - * @class - * Initializes a new instance of the MediaJobOutputErroredEventData class. - * @constructor * Job output error event data - * */ export interface MediaJobOutputErroredEventData extends MediaJobOutputStateChangeEventData { } /** - * @class - * Initializes a new instance of the MediaJobOutputFinishedEventData class. - * @constructor * Job output finished event data - * */ export interface MediaJobOutputFinishedEventData extends MediaJobOutputStateChangeEventData { } /** - * @class - * Initializes a new instance of the MediaJobOutputProcessingEventData class. - * @constructor * Job output processing event data - * */ export interface MediaJobOutputProcessingEventData extends MediaJobOutputStateChangeEventData { } /** - * @class - * Initializes a new instance of the MediaJobOutputScheduledEventData class. - * @constructor * Job output scheduled event data - * */ export interface MediaJobOutputScheduledEventData extends MediaJobOutputStateChangeEventData { } /** - * @class - * Initializes a new instance of the MediaLiveEventEncoderConnectedEventData class. - * @constructor * Encoder connect event data. - * - * @member {string} [ingestUrl] Gets the ingest URL provided by the live event. - * @member {string} [streamId] Gets the stream Id. - * @member {string} [encoderIp] Gets the remote IP. - * @member {string} [encoderPort] Gets the remote port. */ export interface MediaLiveEventEncoderConnectedEventData { + /** + * Gets the ingest URL provided by the live event. + */ readonly ingestUrl?: string; + /** + * Gets the stream Id. + */ readonly streamId?: string; + /** + * Gets the remote IP. + */ readonly encoderIp?: string; + /** + * Gets the remote port. + */ readonly encoderPort?: string; } /** - * @class - * Initializes a new instance of the MediaLiveEventConnectionRejectedEventData class. - * @constructor * Encoder connection rejected event data. - * - * @member {string} [ingestUrl] Gets the ingest URL provided by the live event. - * @member {string} [streamId] Gets the stream Id. - * @member {string} [encoderIp] Gets the remote IP. - * @member {string} [encoderPort] Gets the remote port. - * @member {string} [resultCode] Gets the result code. */ export interface MediaLiveEventConnectionRejectedEventData { + /** + * Gets the ingest URL provided by the live event. + */ readonly ingestUrl?: string; + /** + * Gets the stream Id. + */ readonly streamId?: string; + /** + * Gets the remote IP. + */ readonly encoderIp?: string; + /** + * Gets the remote port. + */ readonly encoderPort?: string; + /** + * Gets the result code. + */ readonly resultCode?: string; } /** - * @class - * Initializes a new instance of the MediaLiveEventEncoderDisconnectedEventData class. - * @constructor * Encoder disconnected event data. - * - * @member {string} [ingestUrl] Gets the ingest URL provided by the live event. - * @member {string} [streamId] Gets the stream Id. - * @member {string} [encoderIp] Gets the remote IP. - * @member {string} [encoderPort] Gets the remote port. - * @member {string} [resultCode] Gets the result code. */ export interface MediaLiveEventEncoderDisconnectedEventData { + /** + * Gets the ingest URL provided by the live event. + */ readonly ingestUrl?: string; + /** + * Gets the stream Id. + */ readonly streamId?: string; + /** + * Gets the remote IP. + */ readonly encoderIp?: string; + /** + * Gets the remote port. + */ readonly encoderPort?: string; + /** + * Gets the result code. + */ readonly resultCode?: string; } /** - * @class - * Initializes a new instance of the MediaLiveEventIncomingStreamReceivedEventData class. - * @constructor * Encoder connect event data. - * - * @member {string} [ingestUrl] Gets the ingest URL provided by the live event. - * @member {string} [trackType] Gets the type of the track (Audio / Video). - * @member {string} [trackName] Gets the track name. - * @member {number} [bitrate] Gets the bitrate of the track. - * @member {string} [encoderIp] Gets the remote IP. - * @member {string} [encoderPort] Gets the remote port. - * @member {string} [timestamp] Gets the first timestamp of the data chunk - * received. - * @member {string} [duration] Gets the duration of the first data chunk. - * @member {string} [timescale] Gets the timescale in which timestamp is - * represented. */ export interface MediaLiveEventIncomingStreamReceivedEventData { + /** + * Gets the ingest URL provided by the live event. + */ readonly ingestUrl?: string; + /** + * Gets the type of the track (Audio / Video). + */ readonly trackType?: string; + /** + * Gets the track name. + */ readonly trackName?: string; + /** + * Gets the bitrate of the track. + */ readonly bitrate?: number; + /** + * Gets the remote IP. + */ readonly encoderIp?: string; + /** + * Gets the remote port. + */ readonly encoderPort?: string; + /** + * Gets the first timestamp of the data chunk received. + */ readonly timestamp?: string; + /** + * Gets the duration of the first data chunk. + */ readonly duration?: string; + /** + * Gets the timescale in which timestamp is represented. + */ readonly timescale?: string; } /** - * @class - * Initializes a new instance of the MediaLiveEventIncomingStreamsOutOfSyncEventData class. - * @constructor * Incoming streams out of sync event data. - * - * @member {string} [minLastTimestamp] Gets the minimum last timestamp - * received. - * @member {string} [typeOfStreamWithMinLastTimestamp] Gets the type of stream - * with minimum last timestamp. - * @member {string} [maxLastTimestamp] Gets the maximum timestamp among all the - * tracks (audio or video). - * @member {string} [typeOfStreamWithMaxLastTimestamp] Gets the type of stream - * with maximum last timestamp. - * @member {string} [timescaleOfMinLastTimestamp] Gets the timescale in which - * "MinLastTimestamp" is represented. - * @member {string} [timescaleOfMaxLastTimestamp] Gets the timescale in which - * "MaxLastTimestamp" is represented. */ export interface MediaLiveEventIncomingStreamsOutOfSyncEventData { + /** + * Gets the minimum last timestamp received. + */ readonly minLastTimestamp?: string; + /** + * Gets the type of stream with minimum last timestamp. + */ readonly typeOfStreamWithMinLastTimestamp?: string; + /** + * Gets the maximum timestamp among all the tracks (audio or video). + */ readonly maxLastTimestamp?: string; + /** + * Gets the type of stream with maximum last timestamp. + */ readonly typeOfStreamWithMaxLastTimestamp?: string; + /** + * Gets the timescale in which "MinLastTimestamp" is represented. + */ readonly timescaleOfMinLastTimestamp?: string; + /** + * Gets the timescale in which "MaxLastTimestamp" is represented. + */ readonly timescaleOfMaxLastTimestamp?: string; } /** - * @class - * Initializes a new instance of the MediaLiveEventIncomingVideoStreamsOutOfSyncEventData class. - * @constructor * Incoming video stream out of synch event data. - * - * @member {string} [firstTimestamp] Gets the first timestamp received for one - * of the quality levels. - * @member {string} [firstDuration] Gets the duration of the data chunk with - * first timestamp. - * @member {string} [secondTimestamp] Gets the timestamp received for some - * other quality levels. - * @member {string} [secondDuration] Gets the duration of the data chunk with - * second timestamp. - * @member {string} [timescale] Gets the timescale in which both the timestamps - * and durations are represented. */ export interface MediaLiveEventIncomingVideoStreamsOutOfSyncEventData { + /** + * Gets the first timestamp received for one of the quality levels. + */ readonly firstTimestamp?: string; + /** + * Gets the duration of the data chunk with first timestamp. + */ readonly firstDuration?: string; + /** + * Gets the timestamp received for some other quality levels. + */ readonly secondTimestamp?: string; + /** + * Gets the duration of the data chunk with second timestamp. + */ readonly secondDuration?: string; + /** + * Gets the timescale in which both the timestamps and durations are represented. + */ readonly timescale?: string; } /** - * @class - * Initializes a new instance of the MediaLiveEventIncomingDataChunkDroppedEventData class. - * @constructor - * Ingest fragment dropped event event data. - * - * @member {string} [timestamp] Gets the timestamp of the data chunk dropped. - * @member {string} [trackType] Gets the type of the track (Audio / Video). - * @member {number} [bitrate] Gets the bitrate of the track. - * @member {string} [timescale] Gets the timescale of the Timestamp. - * @member {string} [resultCode] Gets the result code for fragment drop - * operation. - * @member {string} [trackName] Gets the name of the track for which fragment - * is dropped. + * Ingest fragment dropped event data. */ export interface MediaLiveEventIncomingDataChunkDroppedEventData { + /** + * Gets the timestamp of the data chunk dropped. + */ readonly timestamp?: string; + /** + * Gets the type of the track (Audio / Video). + */ readonly trackType?: string; + /** + * Gets the bitrate of the track. + */ readonly bitrate?: number; + /** + * Gets the timescale of the Timestamp. + */ readonly timescale?: string; + /** + * Gets the result code for fragment drop operation. + */ readonly resultCode?: string; + /** + * Gets the name of the track for which fragment is dropped. + */ readonly trackName?: string; } /** - * @class - * Initializes a new instance of the MediaLiveEventIngestHeartbeatEventData class. - * @constructor - * Ingest fragment dropped event event data. - * - * @member {string} [trackType] Gets the type of the track (Audio / Video). - * @member {string} [trackName] Gets the track name. - * @member {number} [bitrate] Gets the bitrate of the track. - * @member {number} [incomingBitrate] Gets the incoming bitrate. - * @member {string} [lastTimestamp] Gets the last timestamp. - * @member {string} [timescale] Gets the timescale of the last timestamp. - * @member {number} [overlapCount] Gets the fragment Overlap count. - * @member {number} [discontinuityCount] Gets the fragment Discontinuity count. - * @member {number} [nonincreasingCount] Gets Non increasing count. - * @member {boolean} [unexpectedBitrate] Gets a value indicating whether - * unexpected bitrate is present or not. - * @member {string} [state] Gets the state of the live event. - * @member {boolean} [healthy] Gets a value indicating whether preview is - * healthy or not. + * Ingest fragment dropped event data. */ export interface MediaLiveEventIngestHeartbeatEventData { + /** + * Gets the type of the track (Audio / Video). + */ readonly trackType?: string; + /** + * Gets the track name. + */ readonly trackName?: string; + /** + * Gets the bitrate of the track. + */ readonly bitrate?: number; + /** + * Gets the incoming bitrate. + */ readonly incomingBitrate?: number; + /** + * Gets the last timestamp. + */ readonly lastTimestamp?: string; + /** + * Gets the timescale of the last timestamp. + */ readonly timescale?: string; + /** + * Gets the fragment Overlap count. + */ readonly overlapCount?: number; + /** + * Gets the fragment Discontinuity count. + */ readonly discontinuityCount?: number; + /** + * Gets Non increasing count. + */ readonly nonincreasingCount?: number; + /** + * Gets a value indicating whether unexpected bitrate is present or not. + */ readonly unexpectedBitrate?: boolean; + /** + * Gets the state of the live event. + */ readonly state?: string; + /** + * Gets a value indicating whether preview is healthy or not. + */ readonly healthy?: boolean; } /** - * @class - * Initializes a new instance of the MediaLiveEventTrackDiscontinuityDetectedEventData class. - * @constructor * Ingest track discontinuity detected event data. - * - * @member {string} [trackType] Gets the type of the track (Audio / Video). - * @member {string} [trackName] Gets the track name. - * @member {number} [bitrate] Gets the bitrate. - * @member {string} [previousTimestamp] Gets the timestamp of the previous - * fragment. - * @member {string} [newTimestamp] Gets the timestamp of the current fragment. - * @member {string} [timescale] Gets the timescale in which both timestamps and - * discontinuity gap are represented. - * @member {string} [discontinuityGap] Gets the discontinuity gap between - * PreviousTimestamp and NewTimestamp. */ export interface MediaLiveEventTrackDiscontinuityDetectedEventData { + /** + * Gets the type of the track (Audio / Video). + */ readonly trackType?: string; + /** + * Gets the track name. + */ readonly trackName?: string; + /** + * Gets the bitrate. + */ readonly bitrate?: number; + /** + * Gets the timestamp of the previous fragment. + */ readonly previousTimestamp?: string; + /** + * Gets the timestamp of the current fragment. + */ readonly newTimestamp?: string; + /** + * Gets the timescale in which both timestamps and discontinuity gap are represented. + */ readonly timescale?: string; + /** + * Gets the discontinuity gap between PreviousTimestamp and NewTimestamp. + */ readonly discontinuityGap?: string; } +/** + * Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, + * GeofenceExited, GeofenceResult). + */ +export interface MapsGeofenceEventProperties { + /** + * Lists of the geometry ID of the geofence which is expired relative to the user time in the + * request. + */ + expiredGeofenceGeometryId?: string[]; + /** + * Lists the fence geometries that either fully contain the coordinate position or have an + * overlap with the searchBuffer around the fence. + */ + geometries?: MapsGeofenceGeometry[]; + /** + * Lists of the geometry ID of the geofence which is in invalid period relative to the user time + * in the request. + */ + invalidPeriodGeofenceGeometryId?: string[]; + /** + * True if at least one event is published to the Azure Maps event subscriber, false if no event + * is published to the Azure Maps event subscriber. + */ + isEventPublished?: boolean; +} + +/** + * Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event. + */ +export interface MapsGeofenceEnteredEventData extends MapsGeofenceEventProperties { +} + +/** + * Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event. + */ +export interface MapsGeofenceExitedEventData extends MapsGeofenceEventProperties { +} + +/** + * Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event. + */ +export interface MapsGeofenceResultEventData extends MapsGeofenceEventProperties { +} + +/** + * The geofence geometry. + */ +export interface MapsGeofenceGeometry { + /** + * ID of the device. + */ + deviceId?: string; + /** + * Distance from the coordinate to the closest border of the geofence. Positive means the + * coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more + * than the value of searchBuffer away from the closest geofence border, then the value is 999. + * Negative means the coordinate is inside of the geofence. If the coordinate is inside the + * polygon, but more than the value of searchBuffer away from the closest geofencing border,then + * the value is -999. A value of 999 means that there is great confidence the coordinate is well + * outside the geofence. A value of -999 means that there is great confidence the coordinate is + * well within the geofence. + */ + distance?: number; + /** + * The unique ID for the geofence geometry. + */ + geometryId?: string; + /** + * Latitude of the nearest point of the geometry. + */ + nearestLat?: number; + /** + * Longitude of the nearest point of the geometry. + */ + nearestLon?: number; + /** + * The unique id returned from user upload service when uploading a geofence. Will not be + * included in geofencing post API. + */ + udId?: string; +} + +/** + * Schema of the Data property of an EventGridEvent for an + * Microsoft.AppConfiguration.KeyValueModified event. + */ +export interface AppConfigurationKeyValueModifiedEventData { + /** + * The key used to identify the key-value that was modified. + */ + key?: string; + /** + * The label, if any, used to identify the key-value that was modified. + */ + label?: string; + /** + * The etag representing the new state of the key-value. + */ + etag?: string; +} + +/** + * Schema of the Data property of an EventGridEvent for an + * Microsoft.AppConfiguration.KeyValueDeleted event. + */ +export interface AppConfigurationKeyValueDeletedEventData { + /** + * The key used to identify the key-value that was deleted. + */ + key?: string; + /** + * The label, if any, used to identify the key-value that was deleted. + */ + label?: string; + /** + * The etag representing the key-value that was deleted. + */ + etag?: string; +} diff --git a/lib/services/eventgrid/lib/models/index.js b/lib/services/eventgrid/lib/models/index.js index 0920724ca0..dd0c80c0e1 100644 --- a/lib/services/eventgrid/lib/models/index.js +++ b/lib/services/eventgrid/lib/models/index.js @@ -49,10 +49,14 @@ exports.DeviceConnectionStateEventInfo = require('./deviceConnectionStateEventIn exports.ContainerRegistryEventData = require('./containerRegistryEventData'); exports.ContainerRegistryImagePushedEventData = require('./containerRegistryImagePushedEventData'); exports.ContainerRegistryImageDeletedEventData = require('./containerRegistryImageDeletedEventData'); +exports.ContainerRegistryArtifactEventData = require('./containerRegistryArtifactEventData'); +exports.ContainerRegistryChartPushedEventData = require('./containerRegistryChartPushedEventData'); +exports.ContainerRegistryChartDeletedEventData = require('./containerRegistryChartDeletedEventData'); exports.ContainerRegistryEventTarget = require('./containerRegistryEventTarget'); exports.ContainerRegistryEventRequest = require('./containerRegistryEventRequest'); exports.ContainerRegistryEventActor = require('./containerRegistryEventActor'); exports.ContainerRegistryEventSource = require('./containerRegistryEventSource'); +exports.ContainerRegistryArtifactEventTarget = require('./containerRegistryArtifactEventTarget'); exports.ServiceBusActiveMessagesAvailableWithNoListenersEventData = require('./serviceBusActiveMessagesAvailableWithNoListenersEventData'); exports.ServiceBusDeadletterMessagesAvailableWithNoListenersEventData = require('./serviceBusDeadletterMessagesAvailableWithNoListenersEventData'); exports.MediaJobStateChangeEventData = require('./mediaJobStateChangeEventData'); @@ -60,6 +64,7 @@ exports.MediaJobErrorDetail = require('./mediaJobErrorDetail'); exports.MediaJobError = require('./mediaJobError'); exports.MediaJobOutput = require('./mediaJobOutput'); exports.MediaJobOutputAsset = require('./mediaJobOutputAsset'); +exports.MediaJobOutputProgressEventData = require('./mediaJobOutputProgressEventData'); exports.MediaJobOutputStateChangeEventData = require('./mediaJobOutputStateChangeEventData'); exports.MediaJobScheduledEventData = require('./mediaJobScheduledEventData'); exports.MediaJobProcessingEventData = require('./mediaJobProcessingEventData'); @@ -82,6 +87,13 @@ exports.MediaLiveEventIncomingVideoStreamsOutOfSyncEventData = require('./mediaL exports.MediaLiveEventIncomingDataChunkDroppedEventData = require('./mediaLiveEventIncomingDataChunkDroppedEventData'); exports.MediaLiveEventIngestHeartbeatEventData = require('./mediaLiveEventIngestHeartbeatEventData'); exports.MediaLiveEventTrackDiscontinuityDetectedEventData = require('./mediaLiveEventTrackDiscontinuityDetectedEventData'); +exports.MapsGeofenceEventProperties = require('./mapsGeofenceEventProperties'); +exports.MapsGeofenceEnteredEventData = require('./mapsGeofenceEnteredEventData'); +exports.MapsGeofenceExitedEventData = require('./mapsGeofenceExitedEventData'); +exports.MapsGeofenceResultEventData = require('./mapsGeofenceResultEventData'); +exports.MapsGeofenceGeometry = require('./mapsGeofenceGeometry'); +exports.AppConfigurationKeyValueModifiedEventData = require('./appConfigurationKeyValueModifiedEventData'); +exports.AppConfigurationKeyValueDeletedEventData = require('./appConfigurationKeyValueDeletedEventData'); exports.discriminators = { 'MediaJobOutput' : exports.MediaJobOutput, 'MediaJobOutput.#Microsoft.Media.JobOutputAsset' : exports.MediaJobOutputAsset diff --git a/lib/services/eventgrid/lib/models/mapsGeofenceEnteredEventData.js b/lib/services/eventgrid/lib/models/mapsGeofenceEnteredEventData.js new file mode 100644 index 0000000000..8830567e85 --- /dev/null +++ b/lib/services/eventgrid/lib/models/mapsGeofenceEnteredEventData.js @@ -0,0 +1,99 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Schema of the Data property of an EventGridEvent for a + * Microsoft.Maps.GeofenceEntered event. + * + * @extends models['MapsGeofenceEventProperties'] + */ +class MapsGeofenceEnteredEventData extends models['MapsGeofenceEventProperties'] { + /** + * Create a MapsGeofenceEnteredEventData. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of MapsGeofenceEnteredEventData + * + * @returns {object} metadata of MapsGeofenceEnteredEventData + * + */ + mapper() { + return { + required: false, + serializedName: 'MapsGeofenceEnteredEventData', + type: { + name: 'Composite', + className: 'MapsGeofenceEnteredEventData', + modelProperties: { + expiredGeofenceGeometryId: { + required: false, + serializedName: 'expiredGeofenceGeometryId', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + geometries: { + required: false, + serializedName: 'geometries', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'MapsGeofenceGeometryElementType', + type: { + name: 'Composite', + className: 'MapsGeofenceGeometry' + } + } + } + }, + invalidPeriodGeofenceGeometryId: { + required: false, + serializedName: 'invalidPeriodGeofenceGeometryId', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + isEventPublished: { + required: false, + serializedName: 'isEventPublished', + type: { + name: 'Boolean' + } + } + } + } + }; + } +} + +module.exports = MapsGeofenceEnteredEventData; diff --git a/lib/services/eventgrid/lib/models/mapsGeofenceEventProperties.js b/lib/services/eventgrid/lib/models/mapsGeofenceEventProperties.js new file mode 100644 index 0000000000..c3a0ccc555 --- /dev/null +++ b/lib/services/eventgrid/lib/models/mapsGeofenceEventProperties.js @@ -0,0 +1,106 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Schema of the Data property of an EventGridEvent for a Geofence event + * (GeofenceEntered, GeofenceExited, GeofenceResult). + * + */ +class MapsGeofenceEventProperties { + /** + * Create a MapsGeofenceEventProperties. + * @property {array} [expiredGeofenceGeometryId] Lists of the geometry ID of + * the geofence which is expired relative to the user time in the request. + * @property {array} [geometries] Lists the fence geometries that either + * fully contain the coordinate position or have an overlap with the + * searchBuffer around the fence. + * @property {array} [invalidPeriodGeofenceGeometryId] Lists of the geometry + * ID of the geofence which is in invalid period relative to the user time in + * the request. + * @property {boolean} [isEventPublished] True if at least one event is + * published to the Azure Maps event subscriber, false if no event is + * published to the Azure Maps event subscriber. + */ + constructor() { + } + + /** + * Defines the metadata of MapsGeofenceEventProperties + * + * @returns {object} metadata of MapsGeofenceEventProperties + * + */ + mapper() { + return { + required: false, + serializedName: 'MapsGeofenceEventProperties', + type: { + name: 'Composite', + className: 'MapsGeofenceEventProperties', + modelProperties: { + expiredGeofenceGeometryId: { + required: false, + serializedName: 'expiredGeofenceGeometryId', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + geometries: { + required: false, + serializedName: 'geometries', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'MapsGeofenceGeometryElementType', + type: { + name: 'Composite', + className: 'MapsGeofenceGeometry' + } + } + } + }, + invalidPeriodGeofenceGeometryId: { + required: false, + serializedName: 'invalidPeriodGeofenceGeometryId', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + isEventPublished: { + required: false, + serializedName: 'isEventPublished', + type: { + name: 'Boolean' + } + } + } + } + }; + } +} + +module.exports = MapsGeofenceEventProperties; diff --git a/lib/services/eventgrid/lib/models/mapsGeofenceExitedEventData.js b/lib/services/eventgrid/lib/models/mapsGeofenceExitedEventData.js new file mode 100644 index 0000000000..5c7ce7ba07 --- /dev/null +++ b/lib/services/eventgrid/lib/models/mapsGeofenceExitedEventData.js @@ -0,0 +1,99 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Schema of the Data property of an EventGridEvent for a + * Microsoft.Maps.GeofenceExited event. + * + * @extends models['MapsGeofenceEventProperties'] + */ +class MapsGeofenceExitedEventData extends models['MapsGeofenceEventProperties'] { + /** + * Create a MapsGeofenceExitedEventData. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of MapsGeofenceExitedEventData + * + * @returns {object} metadata of MapsGeofenceExitedEventData + * + */ + mapper() { + return { + required: false, + serializedName: 'MapsGeofenceExitedEventData', + type: { + name: 'Composite', + className: 'MapsGeofenceExitedEventData', + modelProperties: { + expiredGeofenceGeometryId: { + required: false, + serializedName: 'expiredGeofenceGeometryId', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + geometries: { + required: false, + serializedName: 'geometries', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'MapsGeofenceGeometryElementType', + type: { + name: 'Composite', + className: 'MapsGeofenceGeometry' + } + } + } + }, + invalidPeriodGeofenceGeometryId: { + required: false, + serializedName: 'invalidPeriodGeofenceGeometryId', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + isEventPublished: { + required: false, + serializedName: 'isEventPublished', + type: { + name: 'Boolean' + } + } + } + } + }; + } +} + +module.exports = MapsGeofenceExitedEventData; diff --git a/lib/services/eventgrid/lib/models/mapsGeofenceGeometry.js b/lib/services/eventgrid/lib/models/mapsGeofenceGeometry.js new file mode 100644 index 0000000000..93db99a594 --- /dev/null +++ b/lib/services/eventgrid/lib/models/mapsGeofenceGeometry.js @@ -0,0 +1,104 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The geofence geometry. + * + */ +class MapsGeofenceGeometry { + /** + * Create a MapsGeofenceGeometry. + * @property {string} [deviceId] ID of the device. + * @property {number} [distance] Distance from the coordinate to the closest + * border of the geofence. Positive means the coordinate is outside of the + * geofence. If the coordinate is outside of the geofence, but more than the + * value of searchBuffer away from the closest geofence border, then the + * value is 999. Negative means the coordinate is inside of the geofence. If + * the coordinate is inside the polygon, but more than the value of + * searchBuffer away from the closest geofencing border,then the value is + * -999. A value of 999 means that there is great confidence the coordinate + * is well outside the geofence. A value of -999 means that there is great + * confidence the coordinate is well within the geofence. + * @property {string} [geometryId] The unique ID for the geofence geometry. + * @property {number} [nearestLat] Latitude of the nearest point of the + * geometry. + * @property {number} [nearestLon] Longitude of the nearest point of the + * geometry. + * @property {string} [udId] The unique id returned from user upload service + * when uploading a geofence. Will not be included in geofencing post API. + */ + constructor() { + } + + /** + * Defines the metadata of MapsGeofenceGeometry + * + * @returns {object} metadata of MapsGeofenceGeometry + * + */ + mapper() { + return { + required: false, + serializedName: 'MapsGeofenceGeometry', + type: { + name: 'Composite', + className: 'MapsGeofenceGeometry', + modelProperties: { + deviceId: { + required: false, + serializedName: 'deviceId', + type: { + name: 'String' + } + }, + distance: { + required: false, + serializedName: 'distance', + type: { + name: 'Number' + } + }, + geometryId: { + required: false, + serializedName: 'geometryId', + type: { + name: 'String' + } + }, + nearestLat: { + required: false, + serializedName: 'nearestLat', + type: { + name: 'Number' + } + }, + nearestLon: { + required: false, + serializedName: 'nearestLon', + type: { + name: 'Number' + } + }, + udId: { + required: false, + serializedName: 'udId', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = MapsGeofenceGeometry; diff --git a/lib/services/eventgrid/lib/models/mapsGeofenceResultEventData.js b/lib/services/eventgrid/lib/models/mapsGeofenceResultEventData.js new file mode 100644 index 0000000000..6c0bd1bbdd --- /dev/null +++ b/lib/services/eventgrid/lib/models/mapsGeofenceResultEventData.js @@ -0,0 +1,99 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Schema of the Data property of an EventGridEvent for a + * Microsoft.Maps.GeofenceResult event. + * + * @extends models['MapsGeofenceEventProperties'] + */ +class MapsGeofenceResultEventData extends models['MapsGeofenceEventProperties'] { + /** + * Create a MapsGeofenceResultEventData. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of MapsGeofenceResultEventData + * + * @returns {object} metadata of MapsGeofenceResultEventData + * + */ + mapper() { + return { + required: false, + serializedName: 'MapsGeofenceResultEventData', + type: { + name: 'Composite', + className: 'MapsGeofenceResultEventData', + modelProperties: { + expiredGeofenceGeometryId: { + required: false, + serializedName: 'expiredGeofenceGeometryId', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + geometries: { + required: false, + serializedName: 'geometries', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'MapsGeofenceGeometryElementType', + type: { + name: 'Composite', + className: 'MapsGeofenceGeometry' + } + } + } + }, + invalidPeriodGeofenceGeometryId: { + required: false, + serializedName: 'invalidPeriodGeofenceGeometryId', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + isEventPublished: { + required: false, + serializedName: 'isEventPublished', + type: { + name: 'Boolean' + } + } + } + } + }; + } +} + +module.exports = MapsGeofenceResultEventData; diff --git a/lib/services/eventgrid/lib/models/mediaJobCanceledEventData.js b/lib/services/eventgrid/lib/models/mediaJobCanceledEventData.js index 6a2011a6dd..5e0b0dfcff 100644 --- a/lib/services/eventgrid/lib/models/mediaJobCanceledEventData.js +++ b/lib/services/eventgrid/lib/models/mediaJobCanceledEventData.js @@ -20,7 +20,7 @@ const models = require('./index'); class MediaJobCanceledEventData extends models['MediaJobStateChangeEventData'] { /** * Create a MediaJobCanceledEventData. - * @member {array} [outputs] Gets the Job outputs. + * @property {array} [outputs] Gets the Job outputs. */ constructor() { super(); diff --git a/lib/services/eventgrid/lib/models/mediaJobError.js b/lib/services/eventgrid/lib/models/mediaJobError.js index c9196f21af..63f0187bd4 100644 --- a/lib/services/eventgrid/lib/models/mediaJobError.js +++ b/lib/services/eventgrid/lib/models/mediaJobError.js @@ -17,19 +17,19 @@ class MediaJobError { /** * Create a MediaJobError. - * @member {string} [code] Error code describing the error. Possible values + * @property {string} [code] Error code describing the error. Possible values * include: 'ServiceError', 'ServiceTransientError', 'DownloadNotAccessible', * 'DownloadTransientError', 'UploadNotAccessible', 'UploadTransientError', * 'ConfigurationUnsupported', 'ContentMalformed', 'ContentUnsupported' - * @member {string} [message] A human-readable language-dependent + * @property {string} [message] A human-readable language-dependent * representation of the error. - * @member {string} [category] Helps with categorization of errors. Possible - * values include: 'Service', 'Download', 'Upload', 'Configuration', + * @property {string} [category] Helps with categorization of errors. + * Possible values include: 'Service', 'Download', 'Upload', 'Configuration', * 'Content' - * @member {string} [retry] Indicates that it may be possible to retry the + * @property {string} [retry] Indicates that it may be possible to retry the * Job. If retry is unsuccessful, please contact Azure support via Azure * Portal. Possible values include: 'DoNotRetry', 'MayRetry' - * @member {array} [details] An array of details about specific errors that + * @property {array} [details] An array of details about specific errors that * led to this reported error. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/mediaJobErrorDetail.js b/lib/services/eventgrid/lib/models/mediaJobErrorDetail.js index fbe57222f3..5721117549 100644 --- a/lib/services/eventgrid/lib/models/mediaJobErrorDetail.js +++ b/lib/services/eventgrid/lib/models/mediaJobErrorDetail.js @@ -17,8 +17,8 @@ class MediaJobErrorDetail { /** * Create a MediaJobErrorDetail. - * @member {string} [code] Code describing the error detail. - * @member {string} [message] A human-readable representation of the error. + * @property {string} [code] Code describing the error detail. + * @property {string} [message] A human-readable representation of the error. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/mediaJobErroredEventData.js b/lib/services/eventgrid/lib/models/mediaJobErroredEventData.js index a49382952c..00cf741b07 100644 --- a/lib/services/eventgrid/lib/models/mediaJobErroredEventData.js +++ b/lib/services/eventgrid/lib/models/mediaJobErroredEventData.js @@ -20,7 +20,7 @@ const models = require('./index'); class MediaJobErroredEventData extends models['MediaJobStateChangeEventData'] { /** * Create a MediaJobErroredEventData. - * @member {array} [outputs] Gets the Job outputs. + * @property {array} [outputs] Gets the Job outputs. */ constructor() { super(); diff --git a/lib/services/eventgrid/lib/models/mediaJobFinishedEventData.js b/lib/services/eventgrid/lib/models/mediaJobFinishedEventData.js index f947825b2a..c34ce5a370 100644 --- a/lib/services/eventgrid/lib/models/mediaJobFinishedEventData.js +++ b/lib/services/eventgrid/lib/models/mediaJobFinishedEventData.js @@ -20,7 +20,7 @@ const models = require('./index'); class MediaJobFinishedEventData extends models['MediaJobStateChangeEventData'] { /** * Create a MediaJobFinishedEventData. - * @member {array} [outputs] Gets the Job outputs. + * @property {array} [outputs] Gets the Job outputs. */ constructor() { super(); diff --git a/lib/services/eventgrid/lib/models/mediaJobOutput.js b/lib/services/eventgrid/lib/models/mediaJobOutput.js index 99dd1c7d5a..bee6e9407d 100644 --- a/lib/services/eventgrid/lib/models/mediaJobOutput.js +++ b/lib/services/eventgrid/lib/models/mediaJobOutput.js @@ -17,28 +17,28 @@ class MediaJobOutput { /** * Create a MediaJobOutput. - * @member {object} [error] Gets the Job output error. - * @member {string} [error.code] Error code describing the error. Possible + * @property {object} [error] Gets the Job output error. + * @property {string} [error.code] Error code describing the error. Possible * values include: 'ServiceError', 'ServiceTransientError', * 'DownloadNotAccessible', 'DownloadTransientError', 'UploadNotAccessible', * 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', * 'ContentUnsupported' - * @member {string} [error.message] A human-readable language-dependent + * @property {string} [error.message] A human-readable language-dependent * representation of the error. - * @member {string} [error.category] Helps with categorization of errors. + * @property {string} [error.category] Helps with categorization of errors. * Possible values include: 'Service', 'Download', 'Upload', 'Configuration', * 'Content' - * @member {string} [error.retry] Indicates that it may be possible to retry - * the Job. If retry is unsuccessful, please contact Azure support via Azure - * Portal. Possible values include: 'DoNotRetry', 'MayRetry' - * @member {array} [error.details] An array of details about specific errors - * that led to this reported error. - * @member {string} [label] Gets the Job output label. - * @member {number} progress Gets the Job output progress. - * @member {string} state Gets the Job output state. Possible values include: - * 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', - * 'Scheduled' - * @member {string} odatatype Polymorphic Discriminator + * @property {string} [error.retry] Indicates that it may be possible to + * retry the Job. If retry is unsuccessful, please contact Azure support via + * Azure Portal. Possible values include: 'DoNotRetry', 'MayRetry' + * @property {array} [error.details] An array of details about specific + * errors that led to this reported error. + * @property {string} [label] Gets the Job output label. + * @property {number} progress Gets the Job output progress. + * @property {string} state Gets the Job output state. Possible values + * include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', + * 'Queued', 'Scheduled' + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/mediaJobOutputAsset.js b/lib/services/eventgrid/lib/models/mediaJobOutputAsset.js index c98fc9f916..9c2072744a 100644 --- a/lib/services/eventgrid/lib/models/mediaJobOutputAsset.js +++ b/lib/services/eventgrid/lib/models/mediaJobOutputAsset.js @@ -20,7 +20,7 @@ const models = require('./index'); class MediaJobOutputAsset extends models['MediaJobOutput'] { /** * Create a MediaJobOutputAsset. - * @member {string} [assetName] Gets the Job output asset name. + * @property {string} [assetName] Gets the Job output asset name. */ constructor() { super(); diff --git a/lib/services/eventgrid/lib/models/mediaJobOutputProgressEventData.js b/lib/services/eventgrid/lib/models/mediaJobOutputProgressEventData.js new file mode 100644 index 0000000000..4ed67eb6c5 --- /dev/null +++ b/lib/services/eventgrid/lib/models/mediaJobOutputProgressEventData.js @@ -0,0 +1,75 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Job Output Progress Event Data. + * + */ +class MediaJobOutputProgressEventData { + /** + * Create a MediaJobOutputProgressEventData. + * @property {string} [label] Gets the Job output label. + * @property {number} [progress] Gets the Job output progress. + * @property {object} [jobCorrelationData] Gets the Job correlation data. + */ + constructor() { + } + + /** + * Defines the metadata of MediaJobOutputProgressEventData + * + * @returns {object} metadata of MediaJobOutputProgressEventData + * + */ + mapper() { + return { + required: false, + serializedName: '#Microsoft.Media.JobOutputProgress', + type: { + name: 'Composite', + className: 'MediaJobOutputProgressEventData', + modelProperties: { + label: { + required: false, + serializedName: 'label', + type: { + name: 'String' + } + }, + progress: { + required: false, + serializedName: 'progress', + type: { + name: 'Number' + } + }, + jobCorrelationData: { + required: false, + serializedName: 'jobCorrelationData', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = MediaJobOutputProgressEventData; diff --git a/lib/services/eventgrid/lib/models/mediaJobOutputStateChangeEventData.js b/lib/services/eventgrid/lib/models/mediaJobOutputStateChangeEventData.js index 1d6154ed4e..b1fb83ad5c 100644 --- a/lib/services/eventgrid/lib/models/mediaJobOutputStateChangeEventData.js +++ b/lib/services/eventgrid/lib/models/mediaJobOutputStateChangeEventData.js @@ -18,33 +18,33 @@ class MediaJobOutputStateChangeEventData { /** * Create a MediaJobOutputStateChangeEventData. - * @member {string} [previousState] The previous state of the Job. Possible + * @property {string} [previousState] The previous state of the Job. Possible * values include: 'Canceled', 'Canceling', 'Error', 'Finished', * 'Processing', 'Queued', 'Scheduled' - * @member {object} [output] Gets the output. - * @member {object} [output.error] Gets the Job output error. - * @member {string} [output.error.code] Error code describing the error. + * @property {object} [output] Gets the output. + * @property {object} [output.error] Gets the Job output error. + * @property {string} [output.error.code] Error code describing the error. * Possible values include: 'ServiceError', 'ServiceTransientError', * 'DownloadNotAccessible', 'DownloadTransientError', 'UploadNotAccessible', * 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', * 'ContentUnsupported' - * @member {string} [output.error.message] A human-readable + * @property {string} [output.error.message] A human-readable * language-dependent representation of the error. - * @member {string} [output.error.category] Helps with categorization of + * @property {string} [output.error.category] Helps with categorization of * errors. Possible values include: 'Service', 'Download', 'Upload', * 'Configuration', 'Content' - * @member {string} [output.error.retry] Indicates that it may be possible to - * retry the Job. If retry is unsuccessful, please contact Azure support via - * Azure Portal. Possible values include: 'DoNotRetry', 'MayRetry' - * @member {array} [output.error.details] An array of details about specific - * errors that led to this reported error. - * @member {string} [output.label] Gets the Job output label. - * @member {number} [output.progress] Gets the Job output progress. - * @member {string} [output.state] Gets the Job output state. Possible values - * include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', - * 'Queued', 'Scheduled' - * @member {string} [output.odatatype] Polymorphic Discriminator - * @member {object} [jobCorrelationData] Gets the Job correlation data. + * @property {string} [output.error.retry] Indicates that it may be possible + * to retry the Job. If retry is unsuccessful, please contact Azure support + * via Azure Portal. Possible values include: 'DoNotRetry', 'MayRetry' + * @property {array} [output.error.details] An array of details about + * specific errors that led to this reported error. + * @property {string} [output.label] Gets the Job output label. + * @property {number} [output.progress] Gets the Job output progress. + * @property {string} [output.state] Gets the Job output state. Possible + * values include: 'Canceled', 'Canceling', 'Error', 'Finished', + * 'Processing', 'Queued', 'Scheduled' + * @property {string} [output.odatatype] Polymorphic Discriminator + * @property {object} [jobCorrelationData] Gets the Job correlation data. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/mediaJobStateChangeEventData.js b/lib/services/eventgrid/lib/models/mediaJobStateChangeEventData.js index 91f3984815..a0bea596f3 100644 --- a/lib/services/eventgrid/lib/models/mediaJobStateChangeEventData.js +++ b/lib/services/eventgrid/lib/models/mediaJobStateChangeEventData.js @@ -18,13 +18,13 @@ class MediaJobStateChangeEventData { /** * Create a MediaJobStateChangeEventData. - * @member {string} [previousState] The previous state of the Job. Possible + * @property {string} [previousState] The previous state of the Job. Possible * values include: 'Canceled', 'Canceling', 'Error', 'Finished', * 'Processing', 'Queued', 'Scheduled' - * @member {string} [state] The new state of the Job. Possible values + * @property {string} [state] The new state of the Job. Possible values * include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', * 'Queued', 'Scheduled' - * @member {object} [correlationData] Gets the Job correlation data. + * @property {object} [correlationData] Gets the Job correlation data. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/mediaLiveEventConnectionRejectedEventData.js b/lib/services/eventgrid/lib/models/mediaLiveEventConnectionRejectedEventData.js index 11befa2666..86904c99b2 100644 --- a/lib/services/eventgrid/lib/models/mediaLiveEventConnectionRejectedEventData.js +++ b/lib/services/eventgrid/lib/models/mediaLiveEventConnectionRejectedEventData.js @@ -17,12 +17,12 @@ class MediaLiveEventConnectionRejectedEventData { /** * Create a MediaLiveEventConnectionRejectedEventData. - * @member {string} [ingestUrl] Gets the ingest URL provided by the live + * @property {string} [ingestUrl] Gets the ingest URL provided by the live * event. - * @member {string} [streamId] Gets the stream Id. - * @member {string} [encoderIp] Gets the remote IP. - * @member {string} [encoderPort] Gets the remote port. - * @member {string} [resultCode] Gets the result code. + * @property {string} [streamId] Gets the stream Id. + * @property {string} [encoderIp] Gets the remote IP. + * @property {string} [encoderPort] Gets the remote port. + * @property {string} [resultCode] Gets the result code. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/mediaLiveEventEncoderConnectedEventData.js b/lib/services/eventgrid/lib/models/mediaLiveEventEncoderConnectedEventData.js index 585b1073b6..a301aacb8a 100644 --- a/lib/services/eventgrid/lib/models/mediaLiveEventEncoderConnectedEventData.js +++ b/lib/services/eventgrid/lib/models/mediaLiveEventEncoderConnectedEventData.js @@ -17,11 +17,11 @@ class MediaLiveEventEncoderConnectedEventData { /** * Create a MediaLiveEventEncoderConnectedEventData. - * @member {string} [ingestUrl] Gets the ingest URL provided by the live + * @property {string} [ingestUrl] Gets the ingest URL provided by the live * event. - * @member {string} [streamId] Gets the stream Id. - * @member {string} [encoderIp] Gets the remote IP. - * @member {string} [encoderPort] Gets the remote port. + * @property {string} [streamId] Gets the stream Id. + * @property {string} [encoderIp] Gets the remote IP. + * @property {string} [encoderPort] Gets the remote port. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/mediaLiveEventEncoderDisconnectedEventData.js b/lib/services/eventgrid/lib/models/mediaLiveEventEncoderDisconnectedEventData.js index 2034b17067..255082cb21 100644 --- a/lib/services/eventgrid/lib/models/mediaLiveEventEncoderDisconnectedEventData.js +++ b/lib/services/eventgrid/lib/models/mediaLiveEventEncoderDisconnectedEventData.js @@ -17,12 +17,12 @@ class MediaLiveEventEncoderDisconnectedEventData { /** * Create a MediaLiveEventEncoderDisconnectedEventData. - * @member {string} [ingestUrl] Gets the ingest URL provided by the live + * @property {string} [ingestUrl] Gets the ingest URL provided by the live * event. - * @member {string} [streamId] Gets the stream Id. - * @member {string} [encoderIp] Gets the remote IP. - * @member {string} [encoderPort] Gets the remote port. - * @member {string} [resultCode] Gets the result code. + * @property {string} [streamId] Gets the stream Id. + * @property {string} [encoderIp] Gets the remote IP. + * @property {string} [encoderPort] Gets the remote port. + * @property {string} [resultCode] Gets the result code. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/mediaLiveEventIncomingDataChunkDroppedEventData.js b/lib/services/eventgrid/lib/models/mediaLiveEventIncomingDataChunkDroppedEventData.js index 84668146d4..91f4d1d309 100644 --- a/lib/services/eventgrid/lib/models/mediaLiveEventIncomingDataChunkDroppedEventData.js +++ b/lib/services/eventgrid/lib/models/mediaLiveEventIncomingDataChunkDroppedEventData.js @@ -11,20 +11,21 @@ 'use strict'; /** - * Ingest fragment dropped event event data. + * Ingest fragment dropped event data. * */ class MediaLiveEventIncomingDataChunkDroppedEventData { /** * Create a MediaLiveEventIncomingDataChunkDroppedEventData. - * @member {string} [timestamp] Gets the timestamp of the data chunk dropped. - * @member {string} [trackType] Gets the type of the track (Audio / Video). - * @member {number} [bitrate] Gets the bitrate of the track. - * @member {string} [timescale] Gets the timescale of the Timestamp. - * @member {string} [resultCode] Gets the result code for fragment drop + * @property {string} [timestamp] Gets the timestamp of the data chunk + * dropped. + * @property {string} [trackType] Gets the type of the track (Audio / Video). + * @property {number} [bitrate] Gets the bitrate of the track. + * @property {string} [timescale] Gets the timescale of the Timestamp. + * @property {string} [resultCode] Gets the result code for fragment drop * operation. - * @member {string} [trackName] Gets the name of the track for which fragment - * is dropped. + * @property {string} [trackName] Gets the name of the track for which + * fragment is dropped. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/mediaLiveEventIncomingStreamReceivedEventData.js b/lib/services/eventgrid/lib/models/mediaLiveEventIncomingStreamReceivedEventData.js index 4da10dc532..7512175782 100644 --- a/lib/services/eventgrid/lib/models/mediaLiveEventIncomingStreamReceivedEventData.js +++ b/lib/services/eventgrid/lib/models/mediaLiveEventIncomingStreamReceivedEventData.js @@ -17,17 +17,17 @@ class MediaLiveEventIncomingStreamReceivedEventData { /** * Create a MediaLiveEventIncomingStreamReceivedEventData. - * @member {string} [ingestUrl] Gets the ingest URL provided by the live + * @property {string} [ingestUrl] Gets the ingest URL provided by the live * event. - * @member {string} [trackType] Gets the type of the track (Audio / Video). - * @member {string} [trackName] Gets the track name. - * @member {number} [bitrate] Gets the bitrate of the track. - * @member {string} [encoderIp] Gets the remote IP. - * @member {string} [encoderPort] Gets the remote port. - * @member {string} [timestamp] Gets the first timestamp of the data chunk + * @property {string} [trackType] Gets the type of the track (Audio / Video). + * @property {string} [trackName] Gets the track name. + * @property {number} [bitrate] Gets the bitrate of the track. + * @property {string} [encoderIp] Gets the remote IP. + * @property {string} [encoderPort] Gets the remote port. + * @property {string} [timestamp] Gets the first timestamp of the data chunk * received. - * @member {string} [duration] Gets the duration of the first data chunk. - * @member {string} [timescale] Gets the timescale in which timestamp is + * @property {string} [duration] Gets the duration of the first data chunk. + * @property {string} [timescale] Gets the timescale in which timestamp is * represented. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/mediaLiveEventIncomingStreamsOutOfSyncEventData.js b/lib/services/eventgrid/lib/models/mediaLiveEventIncomingStreamsOutOfSyncEventData.js index 9a0af04272..ab12e304e5 100644 --- a/lib/services/eventgrid/lib/models/mediaLiveEventIncomingStreamsOutOfSyncEventData.js +++ b/lib/services/eventgrid/lib/models/mediaLiveEventIncomingStreamsOutOfSyncEventData.js @@ -17,18 +17,18 @@ class MediaLiveEventIncomingStreamsOutOfSyncEventData { /** * Create a MediaLiveEventIncomingStreamsOutOfSyncEventData. - * @member {string} [minLastTimestamp] Gets the minimum last timestamp + * @property {string} [minLastTimestamp] Gets the minimum last timestamp * received. - * @member {string} [typeOfStreamWithMinLastTimestamp] Gets the type of + * @property {string} [typeOfStreamWithMinLastTimestamp] Gets the type of * stream with minimum last timestamp. - * @member {string} [maxLastTimestamp] Gets the maximum timestamp among all + * @property {string} [maxLastTimestamp] Gets the maximum timestamp among all * the tracks (audio or video). - * @member {string} [typeOfStreamWithMaxLastTimestamp] Gets the type of + * @property {string} [typeOfStreamWithMaxLastTimestamp] Gets the type of * stream with maximum last timestamp. - * @member {string} [timescaleOfMinLastTimestamp] Gets the timescale in which - * "MinLastTimestamp" is represented. - * @member {string} [timescaleOfMaxLastTimestamp] Gets the timescale in which - * "MaxLastTimestamp" is represented. + * @property {string} [timescaleOfMinLastTimestamp] Gets the timescale in + * which "MinLastTimestamp" is represented. + * @property {string} [timescaleOfMaxLastTimestamp] Gets the timescale in + * which "MaxLastTimestamp" is represented. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/mediaLiveEventIncomingVideoStreamsOutOfSyncEventData.js b/lib/services/eventgrid/lib/models/mediaLiveEventIncomingVideoStreamsOutOfSyncEventData.js index f2dc523646..c00402cdaa 100644 --- a/lib/services/eventgrid/lib/models/mediaLiveEventIncomingVideoStreamsOutOfSyncEventData.js +++ b/lib/services/eventgrid/lib/models/mediaLiveEventIncomingVideoStreamsOutOfSyncEventData.js @@ -17,15 +17,15 @@ class MediaLiveEventIncomingVideoStreamsOutOfSyncEventData { /** * Create a MediaLiveEventIncomingVideoStreamsOutOfSyncEventData. - * @member {string} [firstTimestamp] Gets the first timestamp received for + * @property {string} [firstTimestamp] Gets the first timestamp received for * one of the quality levels. - * @member {string} [firstDuration] Gets the duration of the data chunk with - * first timestamp. - * @member {string} [secondTimestamp] Gets the timestamp received for some + * @property {string} [firstDuration] Gets the duration of the data chunk + * with first timestamp. + * @property {string} [secondTimestamp] Gets the timestamp received for some * other quality levels. - * @member {string} [secondDuration] Gets the duration of the data chunk with - * second timestamp. - * @member {string} [timescale] Gets the timescale in which both the + * @property {string} [secondDuration] Gets the duration of the data chunk + * with second timestamp. + * @property {string} [timescale] Gets the timescale in which both the * timestamps and durations are represented. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/mediaLiveEventIngestHeartbeatEventData.js b/lib/services/eventgrid/lib/models/mediaLiveEventIngestHeartbeatEventData.js index 0fe6c51951..c59b6dc7f2 100644 --- a/lib/services/eventgrid/lib/models/mediaLiveEventIngestHeartbeatEventData.js +++ b/lib/services/eventgrid/lib/models/mediaLiveEventIngestHeartbeatEventData.js @@ -11,26 +11,26 @@ 'use strict'; /** - * Ingest fragment dropped event event data. + * Ingest fragment dropped event data. * */ class MediaLiveEventIngestHeartbeatEventData { /** * Create a MediaLiveEventIngestHeartbeatEventData. - * @member {string} [trackType] Gets the type of the track (Audio / Video). - * @member {string} [trackName] Gets the track name. - * @member {number} [bitrate] Gets the bitrate of the track. - * @member {number} [incomingBitrate] Gets the incoming bitrate. - * @member {string} [lastTimestamp] Gets the last timestamp. - * @member {string} [timescale] Gets the timescale of the last timestamp. - * @member {number} [overlapCount] Gets the fragment Overlap count. - * @member {number} [discontinuityCount] Gets the fragment Discontinuity + * @property {string} [trackType] Gets the type of the track (Audio / Video). + * @property {string} [trackName] Gets the track name. + * @property {number} [bitrate] Gets the bitrate of the track. + * @property {number} [incomingBitrate] Gets the incoming bitrate. + * @property {string} [lastTimestamp] Gets the last timestamp. + * @property {string} [timescale] Gets the timescale of the last timestamp. + * @property {number} [overlapCount] Gets the fragment Overlap count. + * @property {number} [discontinuityCount] Gets the fragment Discontinuity * count. - * @member {number} [nonincreasingCount] Gets Non increasing count. - * @member {boolean} [unexpectedBitrate] Gets a value indicating whether + * @property {number} [nonincreasingCount] Gets Non increasing count. + * @property {boolean} [unexpectedBitrate] Gets a value indicating whether * unexpected bitrate is present or not. - * @member {string} [state] Gets the state of the live event. - * @member {boolean} [healthy] Gets a value indicating whether preview is + * @property {string} [state] Gets the state of the live event. + * @property {boolean} [healthy] Gets a value indicating whether preview is * healthy or not. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/mediaLiveEventTrackDiscontinuityDetectedEventData.js b/lib/services/eventgrid/lib/models/mediaLiveEventTrackDiscontinuityDetectedEventData.js index ea58baa0ea..2759ceead1 100644 --- a/lib/services/eventgrid/lib/models/mediaLiveEventTrackDiscontinuityDetectedEventData.js +++ b/lib/services/eventgrid/lib/models/mediaLiveEventTrackDiscontinuityDetectedEventData.js @@ -17,16 +17,16 @@ class MediaLiveEventTrackDiscontinuityDetectedEventData { /** * Create a MediaLiveEventTrackDiscontinuityDetectedEventData. - * @member {string} [trackType] Gets the type of the track (Audio / Video). - * @member {string} [trackName] Gets the track name. - * @member {number} [bitrate] Gets the bitrate. - * @member {string} [previousTimestamp] Gets the timestamp of the previous + * @property {string} [trackType] Gets the type of the track (Audio / Video). + * @property {string} [trackName] Gets the track name. + * @property {number} [bitrate] Gets the bitrate. + * @property {string} [previousTimestamp] Gets the timestamp of the previous * fragment. - * @member {string} [newTimestamp] Gets the timestamp of the current + * @property {string} [newTimestamp] Gets the timestamp of the current * fragment. - * @member {string} [timescale] Gets the timescale in which both timestamps + * @property {string} [timescale] Gets the timescale in which both timestamps * and discontinuity gap are represented. - * @member {string} [discontinuityGap] Gets the discontinuity gap between + * @property {string} [discontinuityGap] Gets the discontinuity gap between * PreviousTimestamp and NewTimestamp. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/resourceActionCancelData.js b/lib/services/eventgrid/lib/models/resourceActionCancelData.js index 00522dbb2b..008042b55a 100644 --- a/lib/services/eventgrid/lib/models/resourceActionCancelData.js +++ b/lib/services/eventgrid/lib/models/resourceActionCancelData.js @@ -19,19 +19,20 @@ class ResourceActionCancelData { /** * Create a ResourceActionCancelData. - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the + * @property {string} [tenantId] The tenant ID of the resource. + * @property {string} [subscriptionId] The subscription ID of the resource. + * @property {string} [resourceGroup] The resource group of the resource. + * @property {string} [resourceProvider] The resource provider performing the * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the + * @property {string} [resourceUri] The URI of the resource in the operation. + * @property {string} [operationName] The operation that was performed. + * @property {string} [status] The status of the operation. + * @property {string} [authorization] The requested authorization for the * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * @property {string} [claims] The properties of the claims. + * @property {string} [correlationId] An operation ID used for + * troubleshooting. + * @property {string} [httpRequest] The details of the operation. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/resourceActionFailureData.js b/lib/services/eventgrid/lib/models/resourceActionFailureData.js index d180ac3cbb..0cdde6855b 100644 --- a/lib/services/eventgrid/lib/models/resourceActionFailureData.js +++ b/lib/services/eventgrid/lib/models/resourceActionFailureData.js @@ -19,19 +19,20 @@ class ResourceActionFailureData { /** * Create a ResourceActionFailureData. - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the + * @property {string} [tenantId] The tenant ID of the resource. + * @property {string} [subscriptionId] The subscription ID of the resource. + * @property {string} [resourceGroup] The resource group of the resource. + * @property {string} [resourceProvider] The resource provider performing the * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the + * @property {string} [resourceUri] The URI of the resource in the operation. + * @property {string} [operationName] The operation that was performed. + * @property {string} [status] The status of the operation. + * @property {string} [authorization] The requested authorization for the * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * @property {string} [claims] The properties of the claims. + * @property {string} [correlationId] An operation ID used for + * troubleshooting. + * @property {string} [httpRequest] The details of the operation. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/resourceActionSuccessData.js b/lib/services/eventgrid/lib/models/resourceActionSuccessData.js index 849fc2ee28..9f3633c378 100644 --- a/lib/services/eventgrid/lib/models/resourceActionSuccessData.js +++ b/lib/services/eventgrid/lib/models/resourceActionSuccessData.js @@ -19,19 +19,20 @@ class ResourceActionSuccessData { /** * Create a ResourceActionSuccessData. - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the + * @property {string} [tenantId] The tenant ID of the resource. + * @property {string} [subscriptionId] The subscription ID of the resource. + * @property {string} [resourceGroup] The resource group of the resource. + * @property {string} [resourceProvider] The resource provider performing the * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the + * @property {string} [resourceUri] The URI of the resource in the operation. + * @property {string} [operationName] The operation that was performed. + * @property {string} [status] The status of the operation. + * @property {string} [authorization] The requested authorization for the * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * @property {string} [claims] The properties of the claims. + * @property {string} [correlationId] An operation ID used for + * troubleshooting. + * @property {string} [httpRequest] The details of the operation. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/resourceDeleteCancelData.js b/lib/services/eventgrid/lib/models/resourceDeleteCancelData.js index c978e7a40a..d65f78011e 100644 --- a/lib/services/eventgrid/lib/models/resourceDeleteCancelData.js +++ b/lib/services/eventgrid/lib/models/resourceDeleteCancelData.js @@ -19,19 +19,20 @@ class ResourceDeleteCancelData { /** * Create a ResourceDeleteCancelData. - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the + * @property {string} [tenantId] The tenant ID of the resource. + * @property {string} [subscriptionId] The subscription ID of the resource. + * @property {string} [resourceGroup] The resource group of the resource. + * @property {string} [resourceProvider] The resource provider performing the * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the + * @property {string} [resourceUri] The URI of the resource in the operation. + * @property {string} [operationName] The operation that was performed. + * @property {string} [status] The status of the operation. + * @property {string} [authorization] The requested authorization for the * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * @property {string} [claims] The properties of the claims. + * @property {string} [correlationId] An operation ID used for + * troubleshooting. + * @property {string} [httpRequest] The details of the operation. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/resourceDeleteFailureData.js b/lib/services/eventgrid/lib/models/resourceDeleteFailureData.js index 025dbd3d4e..a2ea445beb 100644 --- a/lib/services/eventgrid/lib/models/resourceDeleteFailureData.js +++ b/lib/services/eventgrid/lib/models/resourceDeleteFailureData.js @@ -19,19 +19,20 @@ class ResourceDeleteFailureData { /** * Create a ResourceDeleteFailureData. - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the + * @property {string} [tenantId] The tenant ID of the resource. + * @property {string} [subscriptionId] The subscription ID of the resource. + * @property {string} [resourceGroup] The resource group of the resource. + * @property {string} [resourceProvider] The resource provider performing the * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the + * @property {string} [resourceUri] The URI of the resource in the operation. + * @property {string} [operationName] The operation that was performed. + * @property {string} [status] The status of the operation. + * @property {string} [authorization] The requested authorization for the * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * @property {string} [claims] The properties of the claims. + * @property {string} [correlationId] An operation ID used for + * troubleshooting. + * @property {string} [httpRequest] The details of the operation. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/resourceDeleteSuccessData.js b/lib/services/eventgrid/lib/models/resourceDeleteSuccessData.js index 3bb930be74..272207ca80 100644 --- a/lib/services/eventgrid/lib/models/resourceDeleteSuccessData.js +++ b/lib/services/eventgrid/lib/models/resourceDeleteSuccessData.js @@ -19,19 +19,20 @@ class ResourceDeleteSuccessData { /** * Create a ResourceDeleteSuccessData. - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the + * @property {string} [tenantId] The tenant ID of the resource. + * @property {string} [subscriptionId] The subscription ID of the resource. + * @property {string} [resourceGroup] The resource group of the resource. + * @property {string} [resourceProvider] The resource provider performing the * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the + * @property {string} [resourceUri] The URI of the resource in the operation. + * @property {string} [operationName] The operation that was performed. + * @property {string} [status] The status of the operation. + * @property {string} [authorization] The requested authorization for the * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * @property {string} [claims] The properties of the claims. + * @property {string} [correlationId] An operation ID used for + * troubleshooting. + * @property {string} [httpRequest] The details of the operation. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/resourceWriteCancelData.js b/lib/services/eventgrid/lib/models/resourceWriteCancelData.js index e012649a79..beedb84655 100644 --- a/lib/services/eventgrid/lib/models/resourceWriteCancelData.js +++ b/lib/services/eventgrid/lib/models/resourceWriteCancelData.js @@ -19,19 +19,20 @@ class ResourceWriteCancelData { /** * Create a ResourceWriteCancelData. - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the + * @property {string} [tenantId] The tenant ID of the resource. + * @property {string} [subscriptionId] The subscription ID of the resource. + * @property {string} [resourceGroup] The resource group of the resource. + * @property {string} [resourceProvider] The resource provider performing the * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the + * @property {string} [resourceUri] The URI of the resource in the operation. + * @property {string} [operationName] The operation that was performed. + * @property {string} [status] The status of the operation. + * @property {string} [authorization] The requested authorization for the * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * @property {string} [claims] The properties of the claims. + * @property {string} [correlationId] An operation ID used for + * troubleshooting. + * @property {string} [httpRequest] The details of the operation. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/resourceWriteFailureData.js b/lib/services/eventgrid/lib/models/resourceWriteFailureData.js index 3dede8caa7..c7bf63cc14 100644 --- a/lib/services/eventgrid/lib/models/resourceWriteFailureData.js +++ b/lib/services/eventgrid/lib/models/resourceWriteFailureData.js @@ -19,19 +19,20 @@ class ResourceWriteFailureData { /** * Create a ResourceWriteFailureData. - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the + * @property {string} [tenantId] The tenant ID of the resource. + * @property {string} [subscriptionId] The subscription ID of the resource. + * @property {string} [resourceGroup] The resource group of the resource. + * @property {string} [resourceProvider] The resource provider performing the * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the + * @property {string} [resourceUri] The URI of the resource in the operation. + * @property {string} [operationName] The operation that was performed. + * @property {string} [status] The status of the operation. + * @property {string} [authorization] The requested authorization for the * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * @property {string} [claims] The properties of the claims. + * @property {string} [correlationId] An operation ID used for + * troubleshooting. + * @property {string} [httpRequest] The details of the operation. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/resourceWriteSuccessData.js b/lib/services/eventgrid/lib/models/resourceWriteSuccessData.js index aca1ab5aac..18a9101644 100644 --- a/lib/services/eventgrid/lib/models/resourceWriteSuccessData.js +++ b/lib/services/eventgrid/lib/models/resourceWriteSuccessData.js @@ -19,19 +19,20 @@ class ResourceWriteSuccessData { /** * Create a ResourceWriteSuccessData. - * @member {string} [tenantId] The tenant ID of the resource. - * @member {string} [subscriptionId] The subscription ID of the resource. - * @member {string} [resourceGroup] The resource group of the resource. - * @member {string} [resourceProvider] The resource provider performing the + * @property {string} [tenantId] The tenant ID of the resource. + * @property {string} [subscriptionId] The subscription ID of the resource. + * @property {string} [resourceGroup] The resource group of the resource. + * @property {string} [resourceProvider] The resource provider performing the * operation. - * @member {string} [resourceUri] The URI of the resource in the operation. - * @member {string} [operationName] The operation that was performed. - * @member {string} [status] The status of the operation. - * @member {string} [authorization] The requested authorization for the + * @property {string} [resourceUri] The URI of the resource in the operation. + * @property {string} [operationName] The operation that was performed. + * @property {string} [status] The status of the operation. + * @property {string} [authorization] The requested authorization for the * operation. - * @member {string} [claims] The properties of the claims. - * @member {string} [correlationId] An operation ID used for troubleshooting. - * @member {string} [httpRequest] The details of the operation. + * @property {string} [claims] The properties of the claims. + * @property {string} [correlationId] An operation ID used for + * troubleshooting. + * @property {string} [httpRequest] The details of the operation. */ constructor() { } diff --git a/lib/services/eventgrid/lib/models/serviceBusActiveMessagesAvailableWithNoListenersEventData.js b/lib/services/eventgrid/lib/models/serviceBusActiveMessagesAvailableWithNoListenersEventData.js index bc2be17d6d..c9a712b878 100644 --- a/lib/services/eventgrid/lib/models/serviceBusActiveMessagesAvailableWithNoListenersEventData.js +++ b/lib/services/eventgrid/lib/models/serviceBusActiveMessagesAvailableWithNoListenersEventData.js @@ -18,17 +18,17 @@ class ServiceBusActiveMessagesAvailableWithNoListenersEventData { /** * Create a ServiceBusActiveMessagesAvailableWithNoListenersEventData. - * @member {string} [namespaceName] The namespace name of the + * @property {string} [namespaceName] The namespace name of the * Microsoft.ServiceBus resource. - * @member {string} [requestUri] The endpoint of the Microsoft.ServiceBus + * @property {string} [requestUri] The endpoint of the Microsoft.ServiceBus * resource. - * @member {string} [entityType] The entity type of the Microsoft.ServiceBus - * resource. Could be one of 'queue' or 'subscriber'. - * @member {string} [queueName] The name of the Microsoft.ServiceBus queue. + * @property {string} [entityType] The entity type of the + * Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'. + * @property {string} [queueName] The name of the Microsoft.ServiceBus queue. * If the entity type is of type 'subscriber', then this value will be null. - * @member {string} [topicName] The name of the Microsoft.ServiceBus topic. + * @property {string} [topicName] The name of the Microsoft.ServiceBus topic. * If the entity type is of type 'queue', then this value will be null. - * @member {string} [subscriptionName] The name of the Microsoft.ServiceBus + * @property {string} [subscriptionName] The name of the Microsoft.ServiceBus * topic's subscription. If the entity type is of type 'queue', then this * value will be null. */ diff --git a/lib/services/eventgrid/lib/models/serviceBusDeadletterMessagesAvailableWithNoListenersEventData.js b/lib/services/eventgrid/lib/models/serviceBusDeadletterMessagesAvailableWithNoListenersEventData.js index 3231725544..2c6463555d 100644 --- a/lib/services/eventgrid/lib/models/serviceBusDeadletterMessagesAvailableWithNoListenersEventData.js +++ b/lib/services/eventgrid/lib/models/serviceBusDeadletterMessagesAvailableWithNoListenersEventData.js @@ -18,17 +18,17 @@ class ServiceBusDeadletterMessagesAvailableWithNoListenersEventData { /** * Create a ServiceBusDeadletterMessagesAvailableWithNoListenersEventData. - * @member {string} [namespaceName] The namespace name of the + * @property {string} [namespaceName] The namespace name of the * Microsoft.ServiceBus resource. - * @member {string} [requestUri] The endpoint of the Microsoft.ServiceBus + * @property {string} [requestUri] The endpoint of the Microsoft.ServiceBus * resource. - * @member {string} [entityType] The entity type of the Microsoft.ServiceBus - * resource. Could be one of 'queue' or 'subscriber'. - * @member {string} [queueName] The name of the Microsoft.ServiceBus queue. + * @property {string} [entityType] The entity type of the + * Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'. + * @property {string} [queueName] The name of the Microsoft.ServiceBus queue. * If the entity type is of type 'subscriber', then this value will be null. - * @member {string} [topicName] The name of the Microsoft.ServiceBus topic. + * @property {string} [topicName] The name of the Microsoft.ServiceBus topic. * If the entity type is of type 'queue', then this value will be null. - * @member {string} [subscriptionName] The name of the Microsoft.ServiceBus + * @property {string} [subscriptionName] The name of the Microsoft.ServiceBus * topic's subscription. If the entity type is of type 'queue', then this * value will be null. */ diff --git a/lib/services/eventgrid/lib/models/storageBlobCreatedEventData.js b/lib/services/eventgrid/lib/models/storageBlobCreatedEventData.js index 02080b7cca..55bda3775c 100644 --- a/lib/services/eventgrid/lib/models/storageBlobCreatedEventData.js +++ b/lib/services/eventgrid/lib/models/storageBlobCreatedEventData.js @@ -18,26 +18,26 @@ class StorageBlobCreatedEventData { /** * Create a StorageBlobCreatedEventData. - * @member {string} [api] The name of the API/operation that triggered this + * @property {string} [api] The name of the API/operation that triggered this * event. - * @member {string} [clientRequestId] A request id provided by the client of - * the storage API operation that triggered this event. - * @member {string} [requestId] The request id generated by the Storage + * @property {string} [clientRequestId] A request id provided by the client + * of the storage API operation that triggered this event. + * @property {string} [requestId] The request id generated by the Storage * service for the storage API operation that triggered this event. - * @member {string} [eTag] The etag of the object at the time this event was - * triggered. - * @member {string} [contentType] The content type of the blob. This is the + * @property {string} [eTag] The etag of the object at the time this event + * was triggered. + * @property {string} [contentType] The content type of the blob. This is the * same as what would be returned in the Content-Type header from the blob. - * @member {number} [contentLength] The size of the blob in bytes. This is + * @property {number} [contentLength] The size of the blob in bytes. This is * the same as what would be returned in the Content-Length header from the * blob. - * @member {string} [blobType] The type of blob. - * @member {string} [url] The path to the blob. - * @member {string} [sequencer] An opaque string value representing the + * @property {string} [blobType] The type of blob. + * @property {string} [url] The path to the blob. + * @property {string} [sequencer] An opaque string value representing the * logical sequence of events for any particular blob name. Users can use * standard string comparison to understand the relative sequence of two * events on the same blob name. - * @member {object} [storageDiagnostics] For service use only. Diagnostic + * @property {object} [storageDiagnostics] For service use only. Diagnostic * data occasionally included by the Azure Storage service. This property * should be ignored by event consumers. */ diff --git a/lib/services/eventgrid/lib/models/storageBlobDeletedEventData.js b/lib/services/eventgrid/lib/models/storageBlobDeletedEventData.js index 28655b305e..6430665ce9 100644 --- a/lib/services/eventgrid/lib/models/storageBlobDeletedEventData.js +++ b/lib/services/eventgrid/lib/models/storageBlobDeletedEventData.js @@ -18,21 +18,21 @@ class StorageBlobDeletedEventData { /** * Create a StorageBlobDeletedEventData. - * @member {string} [api] The name of the API/operation that triggered this + * @property {string} [api] The name of the API/operation that triggered this * event. - * @member {string} [clientRequestId] A request id provided by the client of - * the storage API operation that triggered this event. - * @member {string} [requestId] The request id generated by the Storage + * @property {string} [clientRequestId] A request id provided by the client + * of the storage API operation that triggered this event. + * @property {string} [requestId] The request id generated by the Storage * service for the storage API operation that triggered this event. - * @member {string} [contentType] The content type of the blob. This is the + * @property {string} [contentType] The content type of the blob. This is the * same as what would be returned in the Content-Type header from the blob. - * @member {string} [blobType] The type of blob. - * @member {string} [url] The path to the blob. - * @member {string} [sequencer] An opaque string value representing the + * @property {string} [blobType] The type of blob. + * @property {string} [url] The path to the blob. + * @property {string} [sequencer] An opaque string value representing the * logical sequence of events for any particular blob name. Users can use * standard string comparison to understand the relative sequence of two * events on the same blob name. - * @member {object} [storageDiagnostics] For service use only. Diagnostic + * @property {object} [storageDiagnostics] For service use only. Diagnostic * data occasionally included by the Azure Storage service. This property * should be ignored by event consumers. */ diff --git a/lib/services/eventgrid/lib/models/subscriptionDeletedEventData.js b/lib/services/eventgrid/lib/models/subscriptionDeletedEventData.js index 4c68cd7422..a42e0df5e3 100644 --- a/lib/services/eventgrid/lib/models/subscriptionDeletedEventData.js +++ b/lib/services/eventgrid/lib/models/subscriptionDeletedEventData.js @@ -18,7 +18,7 @@ class SubscriptionDeletedEventData { /** * Create a SubscriptionDeletedEventData. - * @member {string} [eventSubscriptionId] The Azure resource ID of the + * @property {string} [eventSubscriptionId] The Azure resource ID of the * deleted event subscription. */ constructor() { diff --git a/lib/services/eventgrid/lib/models/subscriptionValidationEventData.js b/lib/services/eventgrid/lib/models/subscriptionValidationEventData.js index f5a15131d5..c5a46c5472 100644 --- a/lib/services/eventgrid/lib/models/subscriptionValidationEventData.js +++ b/lib/services/eventgrid/lib/models/subscriptionValidationEventData.js @@ -18,12 +18,12 @@ class SubscriptionValidationEventData { /** * Create a SubscriptionValidationEventData. - * @member {string} [validationCode] The validation code sent by Azure Event - * Grid to validate an event subscription. To complete the validation + * @property {string} [validationCode] The validation code sent by Azure + * Event Grid to validate an event subscription. To complete the validation * handshake, the subscriber must either respond with this validation code as * part of the validation response, or perform a GET request on the * validationUrl (available starting version 2018-05-01-preview). - * @member {string} [validationUrl] The validation URL sent by Azure Event + * @property {string} [validationUrl] The validation URL sent by Azure Event * Grid (available starting version 2018-05-01-preview). To complete the * validation handshake, the subscriber must either respond with the * validationCode as part of the validation response, or perform a GET diff --git a/lib/services/eventgrid/lib/models/subscriptionValidationResponse.js b/lib/services/eventgrid/lib/models/subscriptionValidationResponse.js index 61235d648d..695aed1338 100644 --- a/lib/services/eventgrid/lib/models/subscriptionValidationResponse.js +++ b/lib/services/eventgrid/lib/models/subscriptionValidationResponse.js @@ -20,8 +20,8 @@ class SubscriptionValidationResponse { /** * Create a SubscriptionValidationResponse. - * @member {string} [validationResponse] The validation response sent by the - * subscriber to Azure Event Grid to complete the validation of an event + * @property {string} [validationResponse] The validation response sent by + * the subscriber to Azure Event Grid to complete the validation of an event * subscription. */ constructor() { diff --git a/lib/services/eventgrid/package.json b/lib/services/eventgrid/package.json index 34fcf173e5..918c5db773 100644 --- a/lib/services/eventgrid/package.json +++ b/lib/services/eventgrid/package.json @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}