From b65b5371e981992ec45a248921db24ca846cb7da Mon Sep 17 00:00:00 2001 From: Azure SDK for Python bot Date: Thu, 22 Nov 2018 00:06:53 +0000 Subject: [PATCH] Generated from 247c6a22105cd7c58a189359cf973edcb0ff05bd typo: datafactory/resource-manager/Microsoft.DataFactory/entityTypes/LinkedService - retrive -> retrieve - seperate -> separate - Serivce- > Service --- lib/services/datafactoryManagement/README.md | 13 +- .../lib/models/accessPolicyResponse.js | 82 + .../lib/models/activity.js | 10 +- .../lib/models/activityDependency.js | 4 +- .../lib/models/activityPolicy.js | 17 +- .../lib/models/activityRun.js | 26 +- .../lib/models/activityRunsQueryResponse.js | 4 +- .../lib/models/amazonMWSLinkedService.js | 30 +- .../lib/models/amazonMWSObjectDataset.js | 2 +- .../lib/models/amazonMWSSource.js | 2 +- .../lib/models/amazonRedshiftLinkedService.js | 16 +- .../lib/models/amazonRedshiftSource.js | 18 +- .../lib/models/amazonS3Dataset.js | 24 +- .../lib/models/amazonS3LinkedService.js | 12 +- .../lib/models/appendVariableActivity.js | 8 +- .../lib/models/azureBatchLinkedService.js | 22 +- .../lib/models/azureBlobDataset.js | 18 +- .../models/azureBlobStorageLinkedService.js | 53 +- .../azureDataLakeAnalyticsLinkedService.js | 29 +- .../lib/models/azureDataLakeStoreDataset.js | 16 +- .../models/azureDataLakeStoreLinkedService.js | 26 +- .../lib/models/azureDataLakeStoreSink.js | 2 +- .../lib/models/azureDataLakeStoreSource.js | 4 +- .../models/azureDatabricksLinkedService.js | 26 +- .../lib/models/azureKeyVaultLinkedService.js | 2 +- .../models/azureKeyVaultSecretReference.js | 10 +- .../models/azureMLBatchExecutionActivity.js | 15 +- .../lib/models/azureMLLinkedService.js | 24 +- .../models/azureMLUpdateResourceActivity.js | 14 +- .../lib/models/azureMLWebServiceFile.js | 10 +- .../lib/models/azureMySqlLinkedService.js | 19 +- .../lib/models/azureMySqlSource.js | 4 +- .../lib/models/azureMySqlTableDataset.js | 2 +- .../models/azurePostgreSqlLinkedService.js | 19 +- .../lib/models/azurePostgreSqlSource.js | 2 +- .../lib/models/azurePostgreSqlTableDataset.js | 2 +- .../lib/models/azureSearchIndexDataset.js | 2 +- .../lib/models/azureSearchIndexSink.js | 6 +- .../lib/models/azureSearchLinkedService.js | 8 +- .../lib/models/azureSqlDWLinkedService.js | 29 +- .../lib/models/azureSqlDWTableDataset.js | 4 +- .../models/azureSqlDatabaseLinkedService.js | 31 +- .../lib/models/azureSqlTableDataset.js | 4 +- .../lib/models/azureStorageLinkedService.js | 37 +- .../lib/models/azureTableDataset.js | 2 +- .../lib/models/azureTableSink.js | 11 +- .../lib/models/azureTableSource.js | 8 +- .../models/azureTableStorageLinkedService.js | 37 +- .../lib/models/blobEventsTrigger.js | 9 +- .../lib/models/blobSink.js | 10 +- .../lib/models/blobSource.js | 12 +- .../lib/models/blobTrigger.js | 13 +- .../lib/models/cassandraLinkedService.js | 16 +- .../lib/models/cassandraSource.js | 4 +- .../lib/models/cassandraTableDataset.js | 6 +- .../lib/models/concurLinkedService.js | 20 +- .../lib/models/concurObjectDataset.js | 2 +- .../lib/models/concurSource.js | 2 +- .../lib/models/copyActivity.js | 82 +- .../lib/models/copySink.js | 12 +- .../lib/models/copySource.js | 8 +- .../lib/models/copyTranslator.js | 2 +- .../lib/models/cosmosDbLinkedService.js | 18 +- .../lib/models/couchbaseLinkedService.js | 18 +- .../lib/models/couchbaseSource.js | 2 +- .../lib/models/couchbaseTableDataset.js | 2 +- .../createLinkedIntegrationRuntimeRequest.js | 8 +- .../lib/models/createRunResponse.js | 2 +- .../lib/models/customActivity.js | 26 +- .../models/customActivityReferenceObject.js | 4 +- .../models/customDataSourceLinkedService.js | 2 +- .../lib/models/customDataset.js | 2 +- .../models/dataLakeAnalyticsUSQLActivity.js | 20 +- .../lib/models/databricksNotebookActivity.js | 12 +- .../lib/models/databricksSparkJarActivity.js | 6 +- .../models/databricksSparkPythonActivity.js | 6 +- .../lib/models/dataset.js | 26 +- .../lib/models/datasetCompression.js | 2 +- .../lib/models/datasetDeflateCompression.js | 2 +- .../lib/models/datasetFolder.js | 2 +- .../lib/models/datasetGZipCompression.js | 2 +- .../lib/models/datasetListResponse.js | 2 +- .../lib/models/datasetReference.js | 4 +- .../lib/models/datasetResource.js | 31 +- .../lib/models/datasetStorageFormat.js | 8 +- .../models/datasetZipDeflateCompression.js | 4 +- .../lib/models/db2LinkedService.js | 16 +- .../lib/models/deleteActivity.js | 10 +- .../lib/models/dependencyReference.js | 2 +- .../lib/models/distcpSettings.js | 6 +- .../lib/models/documentDbCollectionDataset.js | 2 +- .../lib/models/documentDbCollectionSink.js | 2 +- .../lib/models/documentDbCollectionSource.js | 6 +- .../lib/models/drillLinkedService.js | 19 +- .../lib/models/drillSource.js | 2 +- .../lib/models/drillTableDataset.js | 2 +- .../lib/models/dynamicsEntityDataset.js | 4 +- .../lib/models/dynamicsLinkedService.js | 30 +- .../lib/models/dynamicsSink.js | 2 +- .../lib/models/dynamicsSource.js | 4 +- .../lib/models/eloquaLinkedService.js | 18 +- .../lib/models/eloquaObjectDataset.js | 2 +- .../lib/models/eloquaSource.js | 2 +- .../lib/models/executePipelineActivity.js | 11 +- .../lib/models/executeSSISPackageActivity.js | 36 +- .../lib/models/executionActivity.js | 20 +- .../lib/models/expression.js | 2 +- .../lib/models/factory.js | 27 +- .../lib/models/factoryGitHubConfiguration.js | 2 +- .../lib/models/factoryIdentity.js | 4 +- .../lib/models/factoryListResponse.js | 2 +- .../lib/models/factoryRepoConfiguration.js | 12 +- .../lib/models/factoryRepoUpdate.js | 17 +- .../lib/models/factoryUpdateParameters.js | 8 +- .../lib/models/factoryVSTSConfiguration.js | 4 +- .../lib/models/fileServerLinkedService.js | 12 +- .../lib/models/fileShareDataset.js | 20 +- .../lib/models/fileSystemSink.js | 2 +- .../lib/models/fileSystemSource.js | 4 +- .../lib/models/filterActivity.js | 8 +- .../lib/models/forEachActivity.js | 10 +- .../lib/models/ftpServerLinkedService.js | 22 +- .../lib/models/getMetadataActivity.js | 8 +- .../lib/models/gitHubAccessTokenRequest.js | 6 +- .../lib/models/gitHubAccessTokenResponse.js | 2 +- .../lib/models/googleBigQueryLinkedService.js | 38 +- .../lib/models/googleBigQueryObjectDataset.js | 2 +- .../lib/models/googleBigQuerySource.js | 2 +- .../lib/models/greenplumLinkedService.js | 19 +- .../lib/models/greenplumSource.js | 2 +- .../lib/models/greenplumTableDataset.js | 2 +- .../lib/models/hBaseLinkedService.js | 29 +- .../lib/models/hBaseObjectDataset.js | 2 +- .../lib/models/hBaseSource.js | 2 +- .../lib/models/hDInsightHiveActivity.js | 17 +- .../lib/models/hDInsightLinkedService.js | 28 +- .../lib/models/hDInsightMapReduceActivity.js | 23 +- .../models/hDInsightOnDemandLinkedService.js | 97 +- .../lib/models/hDInsightPigActivity.js | 17 +- .../lib/models/hDInsightSparkActivity.js | 28 +- .../lib/models/hDInsightStreamingActivity.js | 33 +- .../lib/models/hdfsLinkedService.js | 12 +- .../lib/models/hdfsSource.js | 12 +- .../lib/models/hiveLinkedService.js | 40 +- .../lib/models/hiveObjectDataset.js | 2 +- .../lib/models/hiveSource.js | 2 +- .../lib/models/httpDataset.js | 23 +- .../lib/models/httpLinkedService.js | 20 +- .../lib/models/httpSource.js | 2 +- .../lib/models/hubspotLinkedService.js | 28 +- .../lib/models/hubspotObjectDataset.js | 2 +- .../lib/models/hubspotSource.js | 2 +- .../lib/models/ifConditionActivity.js | 12 +- .../lib/models/impalaLinkedService.js | 28 +- .../lib/models/impalaObjectDataset.js | 2 +- .../lib/models/impalaSource.js | 2 +- .../lib/models/index.d.ts | 9091 ++++++++--------- .../datafactoryManagement/lib/models/index.js | 2 + .../lib/models/integrationRuntime.js | 4 +- .../lib/models/integrationRuntimeAuthKeys.js | 6 +- .../integrationRuntimeComputeProperties.js | 20 +- .../integrationRuntimeConnectionInfo.js | 14 +- ...ationRuntimeCustomSetupScriptProperties.js | 6 +- .../models/integrationRuntimeListResponse.js | 2 +- .../integrationRuntimeMonitoringData.js | 4 +- .../models/integrationRuntimeNodeIpAddress.js | 2 +- .../integrationRuntimeNodeMonitoringData.js | 18 +- .../lib/models/integrationRuntimeReference.js | 4 +- ...tegrationRuntimeRegenerateKeyParameters.js | 2 +- .../lib/models/integrationRuntimeResource.js | 7 +- .../integrationRuntimeSsisCatalogInfo.js | 13 +- .../integrationRuntimeSsisProperties.js | 36 +- .../lib/models/integrationRuntimeStatus.js | 8 +- .../integrationRuntimeStatusListResponse.js | 4 +- .../integrationRuntimeStatusResponse.js | 12 +- .../integrationRuntimeVNetProperties.js | 8 +- .../lib/models/jiraLinkedService.js | 22 +- .../lib/models/jiraObjectDataset.js | 2 +- .../lib/models/jiraSource.js | 2 +- .../lib/models/jsonFormat.js | 18 +- .../lib/models/linkedIntegrationRuntime.js | 14 +- ...inkedIntegrationRuntimeKeyAuthorization.js | 4 +- ...nkedIntegrationRuntimeRbacAuthorization.js | 2 +- .../models/linkedIntegrationRuntimeRequest.js | 2 +- .../models/linkedIntegrationRuntimeType.js | 2 +- .../lib/models/linkedService.js | 18 +- .../lib/models/linkedServiceListResponse.js | 2 +- .../lib/models/linkedServiceReference.js | 4 +- .../lib/models/linkedServiceResource.js | 18 +- .../lib/models/lookupActivity.js | 18 +- .../lib/models/magentoLinkedService.js | 16 +- .../lib/models/magentoObjectDataset.js | 2 +- .../lib/models/magentoSource.js | 2 +- .../lib/models/managedIntegrationRuntime.js | 61 +- .../models/managedIntegrationRuntimeError.js | 9 +- .../models/managedIntegrationRuntimeNode.js | 6 +- ...anagedIntegrationRuntimeOperationResult.js | 13 +- .../models/managedIntegrationRuntimeStatus.js | 24 +- .../lib/models/mariaDBLinkedService.js | 19 +- .../lib/models/mariaDBSource.js | 2 +- .../lib/models/mariaDBTableDataset.js | 2 +- .../lib/models/marketoLinkedService.js | 19 +- .../lib/models/marketoObjectDataset.js | 2 +- .../lib/models/marketoSource.js | 2 +- .../lib/models/mongoDbCollectionDataset.js | 2 +- .../lib/models/mongoDbLinkedService.js | 24 +- .../lib/models/mongoDbSource.js | 2 +- .../lib/models/multiplePipelineTrigger.js | 2 +- .../lib/models/mySqlLinkedService.js | 21 +- .../lib/models/netezzaLinkedService.js | 19 +- .../lib/models/netezzaSource.js | 2 +- .../lib/models/netezzaTableDataset.js | 2 +- .../lib/models/oDataLinkedService.js | 12 +- .../lib/models/oDataResourceDataset.js | 2 +- .../lib/models/odbcLinkedService.js | 18 +- .../lib/models/odbcSink.js | 2 +- .../lib/models/operation.js | 26 +- .../lib/models/operationDisplay.js | 8 +- .../lib/models/operationListResponse.js | 2 +- .../lib/models/operationLogSpecification.js | 6 +- .../lib/models/operationMetricAvailability.js | 4 +- .../lib/models/operationMetricDimension.js | 8 +- .../models/operationMetricSpecification.js | 22 +- .../models/operationServiceSpecification.js | 6 +- .../lib/models/oracleLinkedService.js | 19 +- .../lib/models/oracleSink.js | 2 +- .../lib/models/oracleSource.js | 8 +- .../lib/models/oracleTableDataset.js | 2 +- .../lib/models/parameterSpecification.js | 4 +- .../lib/models/paypalLinkedService.js | 20 +- .../lib/models/paypalObjectDataset.js | 2 +- .../lib/models/paypalSource.js | 2 +- .../lib/models/phoenixLinkedService.js | 28 +- .../lib/models/phoenixObjectDataset.js | 2 +- .../lib/models/phoenixSource.js | 2 +- .../lib/models/pipelineFolder.js | 2 +- .../lib/models/pipelineListResponse.js | 2 +- .../lib/models/pipelineReference.js | 4 +- .../lib/models/pipelineResource.js | 18 +- .../lib/models/pipelineRun.js | 30 +- .../lib/models/pipelineRunInvokedBy.js | 7 +- .../lib/models/pipelineRunsQueryResponse.js | 4 +- .../lib/models/polybaseSettings.js | 8 +- .../lib/models/postgreSqlLinkedService.js | 21 +- .../lib/models/prestoLinkedService.js | 38 +- .../lib/models/prestoObjectDataset.js | 2 +- .../lib/models/prestoSource.js | 2 +- .../lib/models/quickBooksLinkedService.js | 24 +- .../lib/models/quickBooksObjectDataset.js | 2 +- .../lib/models/quickBooksSource.js | 2 +- .../lib/models/recurrenceSchedule.js | 10 +- .../models/recurrenceScheduleOccurrence.js | 4 +- .../models/redirectIncompatibleRowSettings.js | 12 +- .../lib/models/redshiftUnloadSettings.js | 14 +- .../lib/models/relationalSource.js | 4 +- .../lib/models/relationalTableDataset.js | 2 +- .../lib/models/rerunTriggerListResponse.js | 2 +- .../lib/models/rerunTriggerResource.js | 13 +- .../lib/models/rerunTumblingWindowTrigger.js | 10 +- ...unTumblingWindowTriggerActionParameters.js | 6 +- .../lib/models/resource.js | 12 +- .../lib/models/responsysLinkedService.js | 20 +- .../lib/models/responsysObjectDataset.js | 2 +- .../lib/models/responsysSource.js | 2 +- .../lib/models/retryPolicy.js | 6 +- .../lib/models/runFilterParameters.js | 12 +- .../lib/models/runQueryFilter.js | 12 +- .../lib/models/runQueryOrderBy.js | 4 +- .../lib/models/sSISExecutionParameter.js | 2 +- .../lib/models/sSISPackageLocation.js | 2 +- .../lib/models/sSISPropertyOverride.js | 6 +- .../lib/models/salesforceLinkedService.js | 22 +- .../salesforceMarketingCloudLinkedService.js | 18 +- .../salesforceMarketingCloudObjectDataset.js | 2 +- .../models/salesforceMarketingCloudSource.js | 2 +- .../lib/models/salesforceObjectDataset.js | 2 +- .../lib/models/salesforceSink.js | 8 +- .../lib/models/salesforceSource.js | 6 +- .../lib/models/sapBWLinkedService.js | 16 +- .../sapCloudForCustomerLinkedService.js | 10 +- .../sapCloudForCustomerResourceDataset.js | 4 +- .../lib/models/sapCloudForCustomerSink.js | 2 +- .../lib/models/sapCloudForCustomerSource.js | 4 +- .../lib/models/sapEccLinkedService.js | 10 +- .../lib/models/sapEccResourceDataset.js | 2 +- .../lib/models/sapEccSource.js | 4 +- .../lib/models/sapHanaLinkedService.js | 16 +- .../lib/models/scheduleTrigger.js | 24 +- .../lib/models/scheduleTriggerRecurrence.js | 22 +- .../lib/models/scriptAction.js | 10 +- .../lib/models/secretBase.js | 2 +- .../lib/models/secureString.js | 2 +- ...ependencyTumblingWindowTriggerReference.js | 4 +- .../models/selfHostedIntegrationRuntime.js | 5 +- .../selfHostedIntegrationRuntimeNode.js | 45 +- .../selfHostedIntegrationRuntimeStatus.js | 38 +- .../lib/models/serviceNowLinkedService.js | 26 +- .../lib/models/serviceNowObjectDataset.js | 2 +- .../lib/models/serviceNowSource.js | 2 +- .../lib/models/setVariableActivity.js | 6 +- .../lib/models/sftpServerLinkedService.js | 30 +- .../lib/models/shopifyLinkedService.js | 18 +- .../lib/models/shopifyObjectDataset.js | 2 +- .../lib/models/shopifySource.js | 2 +- .../lib/models/sparkLinkedService.js | 32 +- .../lib/models/sparkObjectDataset.js | 2 +- .../lib/models/sparkSource.js | 2 +- .../lib/models/sqlDWSink.js | 20 +- .../lib/models/sqlDWSource.js | 6 +- .../lib/models/sqlServerLinkedService.js | 10 +- .../sqlServerStoredProcedureActivity.js | 4 +- .../lib/models/sqlServerTableDataset.js | 4 +- .../lib/models/sqlSink.js | 10 +- .../lib/models/sqlSource.js | 6 +- .../lib/models/squareLinkedService.js | 22 +- .../lib/models/squareObjectDataset.js | 2 +- .../lib/models/squareSource.js | 2 +- .../lib/models/stagingSettings.js | 18 +- .../lib/models/storedProcedureParameter.js | 4 +- .../lib/models/subResource.js | 8 +- .../lib/models/sybaseLinkedService.js | 18 +- .../lib/models/tabularTranslator.js | 10 +- .../lib/models/teradataLinkedService.js | 14 +- .../lib/models/textFormat.js | 24 +- .../lib/models/trigger.js | 6 +- .../lib/models/triggerDependencyReference.js | 5 +- .../lib/models/triggerListResponse.js | 2 +- .../lib/models/triggerPipelineReference.js | 8 +- .../lib/models/triggerReference.js | 2 +- .../lib/models/triggerResource.js | 12 +- .../lib/models/triggerRun.js | 16 +- .../lib/models/triggerRunsQueryResponse.js | 4 +- .../lib/models/tumblingWindowTrigger.js | 40 +- ...umblingWindowTriggerDependencyReference.js | 6 +- .../lib/models/untilActivity.js | 19 +- .../updateIntegrationRuntimeNodeRequest.js | 2 +- .../models/updateIntegrationRuntimeRequest.js | 6 +- .../lib/models/userAccessPolicy.js | 92 + .../lib/models/userProperty.js | 4 +- .../lib/models/variableSpecification.js | 4 +- .../lib/models/verticaLinkedService.js | 19 +- .../lib/models/verticaSource.js | 2 +- .../lib/models/verticaTableDataset.js | 2 +- .../lib/models/waitActivity.js | 2 +- .../lib/models/webActivity.js | 34 +- .../lib/models/webActivityAuthentication.js | 14 +- .../lib/models/webBasicAuthentication.js | 8 +- .../webClientCertificateAuthentication.js | 8 +- .../lib/models/webLinkedService.js | 8 +- .../models/webLinkedServiceTypeProperties.js | 4 +- .../lib/models/webTableDataset.js | 6 +- .../lib/models/xeroLinkedService.js | 27 +- .../lib/models/xeroObjectDataset.js | 2 +- .../lib/models/xeroSource.js | 2 +- .../lib/models/zohoLinkedService.js | 16 +- .../lib/models/zohoObjectDataset.js | 2 +- .../lib/models/zohoSource.js | 2 +- .../lib/operations/factories.js | 334 + .../lib/operations/index.d.ts | 97 + 359 files changed, 6914 insertions(+), 6736 deletions(-) create mode 100644 lib/services/datafactoryManagement/lib/models/accessPolicyResponse.js create mode 100644 lib/services/datafactoryManagement/lib/models/userAccessPolicy.js diff --git a/lib/services/datafactoryManagement/README.md b/lib/services/datafactoryManagement/README.md index efde5c083a..a289dfe11e 100644 --- a/lib/services/datafactoryManagement/README.md +++ b/lib/services/datafactoryManagement/README.md @@ -3,22 +3,23 @@ uid: azure-arm-datafactory summary: *content --- -# Microsoft Azure SDK for Node.js - DataFactoryManagementClient +**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.** +## Microsoft Azure SDK for Node.js - DataFactoryManagementClient This project provides a Node.js package for accessing Azure. Right now it supports: - **Node.js version 6.x.x or higher** -## Features +### Features -## How to Install +### How to Install ```bash npm install azure-arm-datafactory ``` -## How to use +### How to use -### Authentication, client creation and list operations as an example. +#### Authentication, client creation and list operations as an example. ```javascript const msRestAzure = require("ms-rest-azure"); @@ -35,6 +36,6 @@ msRestAzure.interactiveLogin().then((creds) => { console.dir(err, {depth: null, colors: true}); }); -## Related projects +### Related projects - [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) diff --git a/lib/services/datafactoryManagement/lib/models/accessPolicyResponse.js b/lib/services/datafactoryManagement/lib/models/accessPolicyResponse.js new file mode 100644 index 0000000000..e18228f470 --- /dev/null +++ b/lib/services/datafactoryManagement/lib/models/accessPolicyResponse.js @@ -0,0 +1,82 @@ +/* + * 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'; + +/** + * Get Data Plane read only token response definition. + * + */ +class AccessPolicyResponse { + /** + * Create a AccessPolicyResponse. + * @property {object} [policy] The user access policy. + * @property {string} [policy.permissions] The string with permissions for + * Data Plane access. Currently only 'r' is supported which grants read only + * access. + * @property {string} [policy.accessResourcePath] The resource path to get + * access relative to factory. Currently only empty string is supported which + * corresponds to the factory resource. + * @property {string} [policy.profileName] The name of the profile. Currently + * only the default is supported. The default value is DefaultProfile. + * @property {string} [policy.startTime] Start time for the token. If not + * specified the current time will be used. + * @property {string} [policy.expireTime] Expiration time for the token. + * Maximum duration for the token is eight hours and by default the token + * will expire in eight hours. + * @property {string} [accessToken] Data Plane read only access token. + * @property {string} [dataPlaneUrl] Data Plane service base URL. + */ + constructor() { + } + + /** + * Defines the metadata of AccessPolicyResponse + * + * @returns {object} metadata of AccessPolicyResponse + * + */ + mapper() { + return { + required: false, + serializedName: 'AccessPolicyResponse', + type: { + name: 'Composite', + className: 'AccessPolicyResponse', + modelProperties: { + policy: { + required: false, + serializedName: 'policy', + type: { + name: 'Composite', + className: 'UserAccessPolicy' + } + }, + accessToken: { + required: false, + serializedName: 'accessToken', + type: { + name: 'String' + } + }, + dataPlaneUrl: { + required: false, + serializedName: 'dataPlaneUrl', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = AccessPolicyResponse; diff --git a/lib/services/datafactoryManagement/lib/models/activity.js b/lib/services/datafactoryManagement/lib/models/activity.js index 4c29060000..71fdd06a20 100644 --- a/lib/services/datafactoryManagement/lib/models/activity.js +++ b/lib/services/datafactoryManagement/lib/models/activity.js @@ -17,11 +17,11 @@ class Activity { /** * Create a Activity. - * @member {string} name Activity name. - * @member {string} [description] Activity description. - * @member {array} [dependsOn] Activity depends on condition. - * @member {array} [userProperties] Activity user properties. - * @member {string} type Polymorphic Discriminator + * @property {string} name Activity name. + * @property {string} [description] Activity description. + * @property {array} [dependsOn] Activity depends on condition. + * @property {array} [userProperties] Activity user properties. + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/activityDependency.js b/lib/services/datafactoryManagement/lib/models/activityDependency.js index c8f54f0aba..59db6cc2ff 100644 --- a/lib/services/datafactoryManagement/lib/models/activityDependency.js +++ b/lib/services/datafactoryManagement/lib/models/activityDependency.js @@ -17,8 +17,8 @@ class ActivityDependency { /** * Create a ActivityDependency. - * @member {string} activity Activity name. - * @member {array} dependencyConditions Match-Condition for the dependency. + * @property {string} activity Activity name. + * @property {array} dependencyConditions Match-Condition for the dependency. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/activityPolicy.js b/lib/services/datafactoryManagement/lib/models/activityPolicy.js index 856bccee7a..24cebc5742 100644 --- a/lib/services/datafactoryManagement/lib/models/activityPolicy.js +++ b/lib/services/datafactoryManagement/lib/models/activityPolicy.js @@ -17,17 +17,18 @@ class ActivityPolicy { /** * Create a ActivityPolicy. - * @member {object} [timeout] Specifies the timeout for the activity to run. - * The default timeout is 7 days. Type: string (or Expression with resultType - * string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {object} [retry] Maximum ordinary retry attempts. Default is 0. + * @property {object} [timeout] Specifies the timeout for the activity to + * run. The default timeout is 7 days. Type: string (or Expression with + * resultType string), pattern: + * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). + * @property {object} [retry] Maximum ordinary retry attempts. Default is 0. * Type: integer (or Expression with resultType integer), minimum: 0. - * @member {number} [retryIntervalInSeconds] Interval between each retry + * @property {number} [retryIntervalInSeconds] Interval between each retry * attempt (in seconds). The default is 30 sec. - * @member {boolean} [secureInput] When set to true, Input from activity is - * considered as secure and will not be logged to monitoring. - * @member {boolean} [secureOutput] When set to true, Output from activity is + * @property {boolean} [secureInput] When set to true, Input from activity is * considered as secure and will not be logged to monitoring. + * @property {boolean} [secureOutput] When set to true, Output from activity + * is considered as secure and will not be logged to monitoring. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/activityRun.js b/lib/services/datafactoryManagement/lib/models/activityRun.js index eec19281b9..a3a186d6da 100644 --- a/lib/services/datafactoryManagement/lib/models/activityRun.js +++ b/lib/services/datafactoryManagement/lib/models/activityRun.js @@ -17,22 +17,22 @@ class ActivityRun { /** * Create a ActivityRun. - * @member {string} [pipelineName] The name of the pipeline. - * @member {string} [pipelineRunId] The id of the pipeline run. - * @member {string} [activityName] The name of the activity. - * @member {string} [activityType] The type of the activity. - * @member {string} [activityRunId] The id of the activity run. - * @member {string} [linkedServiceName] The name of the compute linked + * @property {string} [pipelineName] The name of the pipeline. + * @property {string} [pipelineRunId] The id of the pipeline run. + * @property {string} [activityName] The name of the activity. + * @property {string} [activityType] The type of the activity. + * @property {string} [activityRunId] The id of the activity run. + * @property {string} [linkedServiceName] The name of the compute linked * service. - * @member {string} [status] The status of the activity run. - * @member {date} [activityRunStart] The start time of the activity run in + * @property {string} [status] The status of the activity run. + * @property {date} [activityRunStart] The start time of the activity run in * 'ISO 8601' format. - * @member {date} [activityRunEnd] The end time of the activity run in 'ISO + * @property {date} [activityRunEnd] The end time of the activity run in 'ISO * 8601' format. - * @member {number} [durationInMs] The duration of the activity run. - * @member {object} [input] The input for the activity. - * @member {object} [output] The output for the activity. - * @member {object} [error] The error if any from the activity run. + * @property {number} [durationInMs] The duration of the activity run. + * @property {object} [input] The input for the activity. + * @property {object} [output] The output for the activity. + * @property {object} [error] The error if any from the activity run. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/activityRunsQueryResponse.js b/lib/services/datafactoryManagement/lib/models/activityRunsQueryResponse.js index 5880f16e60..070d003691 100644 --- a/lib/services/datafactoryManagement/lib/models/activityRunsQueryResponse.js +++ b/lib/services/datafactoryManagement/lib/models/activityRunsQueryResponse.js @@ -17,8 +17,8 @@ class ActivityRunsQueryResponse { /** * Create a ActivityRunsQueryResponse. - * @member {array} value List of activity runs. - * @member {string} [continuationToken] The continuation token for getting + * @property {array} value List of activity runs. + * @property {string} [continuationToken] The continuation token for getting * the next page of results, if any remaining results exist, null otherwise. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/amazonMWSLinkedService.js b/lib/services/datafactoryManagement/lib/models/amazonMWSLinkedService.js index be565f69eb..d5d9f95415 100644 --- a/lib/services/datafactoryManagement/lib/models/amazonMWSLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/amazonMWSLinkedService.js @@ -20,26 +20,26 @@ const models = require('./index'); class AmazonMWSLinkedService extends models['LinkedService'] { /** * Create a AmazonMWSLinkedService. - * @member {object} endpoint The endpoint of the Amazon MWS server, (i.e. + * @property {object} endpoint The endpoint of the Amazon MWS server, (i.e. * mws.amazonservices.com) - * @member {object} marketplaceID The Amazon Marketplace ID you want to - * retrieve data from. To retrive data from multiple Marketplace IDs, - * seperate them with a comma (,). (i.e. A2EUQ1WTGCTBG2) - * @member {object} sellerID The Amazon seller ID. - * @member {object} [mwsAuthToken] The Amazon MWS authentication token. - * @member {string} [mwsAuthToken.type] Polymorphic Discriminator - * @member {object} accessKeyId The access key id used to access data. - * @member {object} [secretKey] The secret key used to access data. - * @member {string} [secretKey.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {object} marketplaceID The Amazon Marketplace ID you want to + * retrieve data from. To retrieve data from multiple Marketplace IDs, + * separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2) + * @property {object} sellerID The Amazon seller ID. + * @property {object} [mwsAuthToken] The Amazon MWS authentication token. + * @property {string} [mwsAuthToken.type] Polymorphic Discriminator + * @property {object} accessKeyId The access key id used to access data. + * @property {object} [secretKey] The secret key used to access data. + * @property {string} [secretKey.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/amazonMWSObjectDataset.js b/lib/services/datafactoryManagement/lib/models/amazonMWSObjectDataset.js index b513c17d84..c0189cf2e0 100644 --- a/lib/services/datafactoryManagement/lib/models/amazonMWSObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/amazonMWSObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class AmazonMWSObjectDataset extends models['Dataset'] { /** * Create a AmazonMWSObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/amazonMWSSource.js b/lib/services/datafactoryManagement/lib/models/amazonMWSSource.js index 2a13e3b767..0736350d8b 100644 --- a/lib/services/datafactoryManagement/lib/models/amazonMWSSource.js +++ b/lib/services/datafactoryManagement/lib/models/amazonMWSSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class AmazonMWSSource extends models['CopySource'] { /** * Create a AmazonMWSSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/amazonRedshiftLinkedService.js b/lib/services/datafactoryManagement/lib/models/amazonRedshiftLinkedService.js index e571510985..3a5558dd76 100644 --- a/lib/services/datafactoryManagement/lib/models/amazonRedshiftLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/amazonRedshiftLinkedService.js @@ -20,18 +20,18 @@ const models = require('./index'); class AmazonRedshiftLinkedService extends models['LinkedService'] { /** * Create a AmazonRedshiftLinkedService. - * @member {object} server The name of the Amazon Redshift server. Type: + * @property {object} server The name of the Amazon Redshift server. Type: * string (or Expression with resultType string). - * @member {object} [username] The username of the Amazon Redshift source. + * @property {object} [username] The username of the Amazon Redshift source. * Type: string (or Expression with resultType string). - * @member {object} [password] The password of the Amazon Redshift source. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} database The database name of the Amazon Redshift source. - * Type: string (or Expression with resultType string). - * @member {object} [port] The TCP port number that the Amazon Redshift + * @property {object} [password] The password of the Amazon Redshift source. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} database The database name of the Amazon Redshift + * source. Type: string (or Expression with resultType string). + * @property {object} [port] The TCP port number that the Amazon Redshift * server uses to listen for client connections. The default value is 5439. * Type: integer (or Expression with resultType integer). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/amazonRedshiftSource.js b/lib/services/datafactoryManagement/lib/models/amazonRedshiftSource.js index 4c20bdbf13..440fad5d14 100644 --- a/lib/services/datafactoryManagement/lib/models/amazonRedshiftSource.js +++ b/lib/services/datafactoryManagement/lib/models/amazonRedshiftSource.js @@ -20,21 +20,21 @@ const models = require('./index'); class AmazonRedshiftSource extends models['CopySource'] { /** * Create a AmazonRedshiftSource. - * @member {object} [query] Database query. Type: string (or Expression with - * resultType string). - * @member {object} [redshiftUnloadSettings] The Amazon S3 settings needed + * @property {object} [query] Database query. Type: string (or Expression + * with resultType string). + * @property {object} [redshiftUnloadSettings] The Amazon S3 settings needed * for the interim Amazon S3 when copying from Amazon Redshift with unload. * With this, data from Amazon Redshift source will be unloaded into S3 first * and then copied into the targeted sink from the interim S3. - * @member {object} [redshiftUnloadSettings.s3LinkedServiceName] The name of - * the Amazon S3 linked service which will be used for the unload operation - * when copying from the Amazon Redshift source. - * @member {string} + * @property {object} [redshiftUnloadSettings.s3LinkedServiceName] The name + * of the Amazon S3 linked service which will be used for the unload + * operation when copying from the Amazon Redshift source. + * @property {string} * [redshiftUnloadSettings.s3LinkedServiceName.referenceName] Reference * LinkedService name. - * @member {object} [redshiftUnloadSettings.s3LinkedServiceName.parameters] + * @property {object} [redshiftUnloadSettings.s3LinkedServiceName.parameters] * Arguments for LinkedService. - * @member {object} [redshiftUnloadSettings.bucketName] The bucket of the + * @property {object} [redshiftUnloadSettings.bucketName] The bucket of the * interim Amazon S3 which will be used to store the unloaded data from * Amazon Redshift source. The bucket must be in the same region as the * Amazon Redshift source. Type: string (or Expression with resultType diff --git a/lib/services/datafactoryManagement/lib/models/amazonS3Dataset.js b/lib/services/datafactoryManagement/lib/models/amazonS3Dataset.js index c24e955602..41fdc0e476 100644 --- a/lib/services/datafactoryManagement/lib/models/amazonS3Dataset.js +++ b/lib/services/datafactoryManagement/lib/models/amazonS3Dataset.js @@ -20,23 +20,23 @@ const models = require('./index'); class AmazonS3Dataset extends models['Dataset'] { /** * Create a AmazonS3Dataset. - * @member {object} bucketName The name of the Amazon S3 bucket. Type: string - * (or Expression with resultType string). - * @member {object} [key] The key of the Amazon S3 object. Type: string (or - * Expression with resultType string). - * @member {object} [prefix] The prefix filter for the S3 object name. Type: + * @property {object} bucketName The name of the Amazon S3 bucket. Type: * string (or Expression with resultType string). - * @member {object} [version] The version for the S3 object. Type: string (or + * @property {object} [key] The key of the Amazon S3 object. Type: string (or * Expression with resultType string). - * @member {object} [format] The format of files. - * @member {object} [format.serializer] Serializer. Type: string (or + * @property {object} [prefix] The prefix filter for the S3 object name. + * Type: string (or Expression with resultType string). + * @property {object} [version] The version for the S3 object. Type: string + * (or Expression with resultType string). + * @property {object} [format] The format of files. + * @property {object} [format.serializer] Serializer. Type: string (or * Expression with resultType string). - * @member {object} [format.deserializer] Deserializer. Type: string (or + * @property {object} [format.deserializer] Deserializer. Type: string (or * Expression with resultType string). - * @member {string} [format.type] Polymorphic Discriminator - * @member {object} [compression] The data compression method used for the + * @property {string} [format.type] Polymorphic Discriminator + * @property {object} [compression] The data compression method used for the * Amazon S3 object. - * @member {string} [compression.type] Polymorphic Discriminator + * @property {string} [compression.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/amazonS3LinkedService.js b/lib/services/datafactoryManagement/lib/models/amazonS3LinkedService.js index 0c2304b112..5db05a96f1 100644 --- a/lib/services/datafactoryManagement/lib/models/amazonS3LinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/amazonS3LinkedService.js @@ -20,13 +20,13 @@ const models = require('./index'); class AmazonS3LinkedService extends models['LinkedService'] { /** * Create a AmazonS3LinkedService. - * @member {object} [accessKeyId] The access key identifier of the Amazon S3 - * Identity and Access Management (IAM) user. Type: string (or Expression + * @property {object} [accessKeyId] The access key identifier of the Amazon + * S3 Identity and Access Management (IAM) user. Type: string (or Expression * with resultType string). - * @member {object} [secretAccessKey] The secret access key of the Amazon S3 - * Identity and Access Management (IAM) user. - * @member {string} [secretAccessKey.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [secretAccessKey] The secret access key of the Amazon + * S3 Identity and Access Management (IAM) user. + * @property {string} [secretAccessKey.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/appendVariableActivity.js b/lib/services/datafactoryManagement/lib/models/appendVariableActivity.js index 44284ba3a0..0814f8e7bf 100644 --- a/lib/services/datafactoryManagement/lib/models/appendVariableActivity.js +++ b/lib/services/datafactoryManagement/lib/models/appendVariableActivity.js @@ -20,10 +20,10 @@ const models = require('./index'); class AppendVariableActivity extends models['ControlActivity'] { /** * Create a AppendVariableActivity. - * @member {string} [variableName] Name of the variable whose value needs to - * be appended to. - * @member {object} [value] Value to be appended. Could be a static value or - * Expression + * @property {string} [variableName] Name of the variable whose value needs + * to be appended to. + * @property {object} [value] Value to be appended. Could be a static value + * or Expression */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/azureBatchLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureBatchLinkedService.js index 3c4f00cfd8..e8b98332bb 100644 --- a/lib/services/datafactoryManagement/lib/models/azureBatchLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureBatchLinkedService.js @@ -20,21 +20,21 @@ const models = require('./index'); class AzureBatchLinkedService extends models['LinkedService'] { /** * Create a AzureBatchLinkedService. - * @member {object} accountName The Azure Batch account name. Type: string + * @property {object} accountName The Azure Batch account name. Type: string * (or Expression with resultType string). - * @member {object} [accessKey] The Azure Batch account access key. - * @member {string} [accessKey.type] Polymorphic Discriminator - * @member {object} batchUri The Azure Batch URI. Type: string (or Expression - * with resultType string). - * @member {object} poolName The Azure Batch pool name. Type: string (or + * @property {object} [accessKey] The Azure Batch account access key. + * @property {string} [accessKey.type] Polymorphic Discriminator + * @property {object} batchUri The Azure Batch URI. Type: string (or * Expression with resultType string). - * @member {object} linkedServiceName The Azure Storage linked service + * @property {object} poolName The Azure Batch pool name. Type: string (or + * Expression with resultType string). + * @property {object} linkedServiceName The Azure Storage linked service * reference. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for + * @property {string} [linkedServiceName.referenceName] Reference + * LinkedService name. + * @property {object} [linkedServiceName.parameters] Arguments for * LinkedService. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureBlobDataset.js b/lib/services/datafactoryManagement/lib/models/azureBlobDataset.js index 577cc421b2..a65543fc36 100644 --- a/lib/services/datafactoryManagement/lib/models/azureBlobDataset.js +++ b/lib/services/datafactoryManagement/lib/models/azureBlobDataset.js @@ -20,21 +20,21 @@ const models = require('./index'); class AzureBlobDataset extends models['Dataset'] { /** * Create a AzureBlobDataset. - * @member {object} [folderPath] The path of the Azure Blob storage. Type: + * @property {object} [folderPath] The path of the Azure Blob storage. Type: * string (or Expression with resultType string). - * @member {object} [tableRootLocation] The root of blob path. Type: string + * @property {object} [tableRootLocation] The root of blob path. Type: string * (or Expression with resultType string). - * @member {object} [fileName] The name of the Azure Blob. Type: string (or + * @property {object} [fileName] The name of the Azure Blob. Type: string (or * Expression with resultType string). - * @member {object} [format] The format of the Azure Blob storage. - * @member {object} [format.serializer] Serializer. Type: string (or + * @property {object} [format] The format of the Azure Blob storage. + * @property {object} [format.serializer] Serializer. Type: string (or * Expression with resultType string). - * @member {object} [format.deserializer] Deserializer. Type: string (or + * @property {object} [format.deserializer] Deserializer. Type: string (or * Expression with resultType string). - * @member {string} [format.type] Polymorphic Discriminator - * @member {object} [compression] The data compression method used for the + * @property {string} [format.type] Polymorphic Discriminator + * @property {object} [compression] The data compression method used for the * blob storage. - * @member {string} [compression.type] Polymorphic Discriminator + * @property {string} [compression.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/azureBlobStorageLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureBlobStorageLinkedService.js index 186a6e7361..9c0c06f6e6 100644 --- a/lib/services/datafactoryManagement/lib/models/azureBlobStorageLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureBlobStorageLinkedService.js @@ -20,50 +20,51 @@ const models = require('./index'); class AzureBlobStorageLinkedService extends models['LinkedService'] { /** * Create a AzureBlobStorageLinkedService. - * @member {object} [connectionString] The connection string. It is mutually - * exclusive with sasUri, serviceEndpoint property. Type: string, + * @property {object} [connectionString] The connection string. It is + * mutually exclusive with sasUri, serviceEndpoint property. Type: string, * SecureString or AzureKeyVaultSecretReference. - * @member {object} [accountKey] The Azure key vault secret reference of + * @property {object} [accountKey] The Azure key vault secret reference of * accountKey in connection string. - * @member {object} [accountKey.store] The Azure Key Vault linked service + * @property {object} [accountKey.store] The Azure Key Vault linked service * reference. - * @member {string} [accountKey.store.referenceName] Reference LinkedService - * name. - * @member {object} [accountKey.store.parameters] Arguments for + * @property {string} [accountKey.store.referenceName] Reference + * LinkedService name. + * @property {object} [accountKey.store.parameters] Arguments for * LinkedService. - * @member {object} [accountKey.secretName] The name of the secret in Azure + * @property {object} [accountKey.secretName] The name of the secret in Azure * Key Vault. Type: string (or Expression with resultType string). - * @member {object} [accountKey.secretVersion] The version of the secret in + * @property {object} [accountKey.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [sasUri] SAS URI of the Azure Blob Storage resource. It + * @property {object} [sasUri] SAS URI of the Azure Blob Storage resource. It * is mutually exclusive with connectionString, serviceEndpoint property. * Type: string, SecureString or AzureKeyVaultSecretReference. - * @member {object} [sasToken] The Azure key vault secret reference of + * @property {object} [sasToken] The Azure key vault secret reference of * sasToken in sas uri. - * @member {object} [sasToken.store] The Azure Key Vault linked service + * @property {object} [sasToken.store] The Azure Key Vault linked service * reference. - * @member {string} [sasToken.store.referenceName] Reference LinkedService + * @property {string} [sasToken.store.referenceName] Reference LinkedService * name. - * @member {object} [sasToken.store.parameters] Arguments for LinkedService. - * @member {object} [sasToken.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [sasToken.secretVersion] The version of the secret in + * @property {object} [sasToken.store.parameters] Arguments for + * LinkedService. + * @property {object} [sasToken.secretName] The name of the secret in Azure + * Key Vault. Type: string (or Expression with resultType string). + * @property {object} [sasToken.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {string} [serviceEndpoint] Blob service endpoint of the Azure Blob - * Storage resource. It is mutually exclusive with connectionString, sasUri - * property. - * @member {object} [servicePrincipalId] The ID of the service principal used - * to authenticate against Azure SQL Data Warehouse. Type: string (or + * @property {string} [serviceEndpoint] Blob service endpoint of the Azure + * Blob Storage resource. It is mutually exclusive with connectionString, + * sasUri property. + * @property {object} [servicePrincipalId] The ID of the service principal + * used to authenticate against Azure SQL Data Warehouse. Type: string (or * Expression with resultType string). - * @member {object} [servicePrincipalKey] The key of the service principal + * @property {object} [servicePrincipalKey] The key of the service principal * used to authenticate against Azure SQL Data Warehouse. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} [tenant] The name or ID of the tenant to which the + * @property {string} [servicePrincipalKey.type] Polymorphic Discriminator + * @property {object} [tenant] The name or ID of the tenant to which the * service principal belongs. Type: string (or Expression with resultType * string). - * @member {string} [encryptedCredential] The encrypted credential used for + * @property {string} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureDataLakeAnalyticsLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureDataLakeAnalyticsLinkedService.js index 4475d5a9fc..aa1838c7f6 100644 --- a/lib/services/datafactoryManagement/lib/models/azureDataLakeAnalyticsLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureDataLakeAnalyticsLinkedService.js @@ -20,25 +20,26 @@ const models = require('./index'); class AzureDataLakeAnalyticsLinkedService extends models['LinkedService'] { /** * Create a AzureDataLakeAnalyticsLinkedService. - * @member {object} accountName The Azure Data Lake Analytics account name. + * @property {object} accountName The Azure Data Lake Analytics account name. * Type: string (or Expression with resultType string). - * @member {object} [servicePrincipalId] The ID of the application used to + * @property {object} [servicePrincipalId] The ID of the application used to * authenticate against the Azure Data Lake Analytics account. Type: string * (or Expression with resultType string). - * @member {object} [servicePrincipalKey] The Key of the application used to - * authenticate against the Azure Data Lake Analytics account. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} tenant The name or ID of the tenant to which the service - * principal belongs. Type: string (or Expression with resultType string). - * @member {object} [subscriptionId] Data Lake Analytics account subscription - * ID (if different from Data Factory account). Type: string (or Expression - * with resultType string). - * @member {object} [resourceGroupName] Data Lake Analytics account resource - * group name (if different from Data Factory account). Type: string (or + * @property {object} [servicePrincipalKey] The Key of the application used + * to authenticate against the Azure Data Lake Analytics account. + * @property {string} [servicePrincipalKey.type] Polymorphic Discriminator + * @property {object} tenant The name or ID of the tenant to which the + * service principal belongs. Type: string (or Expression with resultType + * string). + * @property {object} [subscriptionId] Data Lake Analytics account + * subscription ID (if different from Data Factory account). Type: string (or * Expression with resultType string). - * @member {object} [dataLakeAnalyticsUri] Azure Data Lake Analytics URI + * @property {object} [resourceGroupName] Data Lake Analytics account + * resource group name (if different from Data Factory account). Type: string + * (or Expression with resultType string). + * @property {object} [dataLakeAnalyticsUri] Azure Data Lake Analytics URI * Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreDataset.js b/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreDataset.js index f09801de16..0af387c20e 100644 --- a/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreDataset.js +++ b/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreDataset.js @@ -20,19 +20,19 @@ const models = require('./index'); class AzureDataLakeStoreDataset extends models['Dataset'] { /** * Create a AzureDataLakeStoreDataset. - * @member {object} folderPath Path to the folder in the Azure Data Lake + * @property {object} folderPath Path to the folder in the Azure Data Lake * Store. Type: string (or Expression with resultType string). - * @member {object} [fileName] The name of the file in the Azure Data Lake + * @property {object} [fileName] The name of the file in the Azure Data Lake * Store. Type: string (or Expression with resultType string). - * @member {object} [format] The format of the Data Lake Store. - * @member {object} [format.serializer] Serializer. Type: string (or + * @property {object} [format] The format of the Data Lake Store. + * @property {object} [format.serializer] Serializer. Type: string (or * Expression with resultType string). - * @member {object} [format.deserializer] Deserializer. Type: string (or + * @property {object} [format.deserializer] Deserializer. Type: string (or * Expression with resultType string). - * @member {string} [format.type] Polymorphic Discriminator - * @member {object} [compression] The data compression method used for the + * @property {string} [format.type] Polymorphic Discriminator + * @property {object} [compression] The data compression method used for the * item(s) in the Azure Data Lake Store. - * @member {string} [compression.type] Polymorphic Discriminator + * @property {string} [compression.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreLinkedService.js index e5129d8c8f..69aebde444 100644 --- a/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreLinkedService.js @@ -20,26 +20,26 @@ const models = require('./index'); class AzureDataLakeStoreLinkedService extends models['LinkedService'] { /** * Create a AzureDataLakeStoreLinkedService. - * @member {object} dataLakeStoreUri Data Lake Store service URI. Type: + * @property {object} dataLakeStoreUri Data Lake Store service URI. Type: * string (or Expression with resultType string). - * @member {object} [servicePrincipalId] The ID of the application used to + * @property {object} [servicePrincipalId] The ID of the application used to * authenticate against the Azure Data Lake Store account. Type: string (or * Expression with resultType string). - * @member {object} [servicePrincipalKey] The Key of the application used to - * authenticate against the Azure Data Lake Store account. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} [tenant] The name or ID of the tenant to which the + * @property {object} [servicePrincipalKey] The Key of the application used + * to authenticate against the Azure Data Lake Store account. + * @property {string} [servicePrincipalKey.type] Polymorphic Discriminator + * @property {object} [tenant] The name or ID of the tenant to which the * service principal belongs. Type: string (or Expression with resultType * string). - * @member {object} [accountName] Data Lake Store account name. Type: string - * (or Expression with resultType string). - * @member {object} [subscriptionId] Data Lake Store account subscription ID - * (if different from Data Factory account). Type: string (or Expression with - * resultType string). - * @member {object} [resourceGroupName] Data Lake Store account resource + * @property {object} [accountName] Data Lake Store account name. Type: + * string (or Expression with resultType string). + * @property {object} [subscriptionId] Data Lake Store account subscription + * ID (if different from Data Factory account). Type: string (or Expression + * with resultType string). + * @property {object} [resourceGroupName] Data Lake Store account resource * group name (if different from Data Factory account). Type: string (or * Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreSink.js b/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreSink.js index 8579b2c97b..8208e2271c 100644 --- a/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreSink.js +++ b/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreSink.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureDataLakeStoreSink extends models['CopySink'] { /** * Create a AzureDataLakeStoreSink. - * @member {string} [copyBehavior] The type of copy behavior for copy sink. + * @property {string} [copyBehavior] The type of copy behavior for copy sink. * Possible values include: 'PreserveHierarchy', 'FlattenHierarchy', * 'MergeFiles' */ diff --git a/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreSource.js b/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreSource.js index d1bd29f33a..4af6b8a7e5 100644 --- a/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreSource.js +++ b/lib/services/datafactoryManagement/lib/models/azureDataLakeStoreSource.js @@ -20,8 +20,8 @@ const models = require('./index'); class AzureDataLakeStoreSource extends models['CopySource'] { /** * Create a AzureDataLakeStoreSource. - * @member {object} [recursive] If true, files under the folder path will be - * read recursively. Default is true. Type: boolean (or Expression with + * @property {object} [recursive] If true, files under the folder path will + * be read recursively. Default is true. Type: boolean (or Expression with * resultType boolean). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/azureDatabricksLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureDatabricksLinkedService.js index d573546698..39515bdce3 100644 --- a/lib/services/datafactoryManagement/lib/models/azureDatabricksLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureDatabricksLinkedService.js @@ -20,31 +20,31 @@ const models = require('./index'); class AzureDatabricksLinkedService extends models['LinkedService'] { /** * Create a AzureDatabricksLinkedService. - * @member {object} domain .azuredatabricks.net, domain name of your - * Databricks deployment. Type: string (or Expression with resultType + * @property {object} domain .azuredatabricks.net, domain name of + * your Databricks deployment. Type: string (or Expression with resultType * string). - * @member {object} accessToken Access token for databricks REST API. Refer + * @property {object} accessToken Access token for databricks REST API. Refer * to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: * string (or Expression with resultType string). - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} [existingClusterId] The id of an existing cluster that + * @property {string} [accessToken.type] Polymorphic Discriminator + * @property {object} [existingClusterId] The id of an existing cluster that * will be used for all runs of this job. Type: string (or Expression with * resultType string). - * @member {object} [newClusterVersion] The Spark version of new cluster. + * @property {object} [newClusterVersion] The Spark version of new cluster. * Type: string (or Expression with resultType string). - * @member {object} [newClusterNumOfWorker] Number of worker nodes that new + * @property {object} [newClusterNumOfWorker] Number of worker nodes that new * cluster should have. A string formatted Int32, like '1' means numOfWorker * is 1 or '1:10' means auto-scale from 1 as min and 10 as max. Type: string * (or Expression with resultType string). - * @member {object} [newClusterNodeType] The node types of new cluster. Type: - * string (or Expression with resultType string). - * @member {object} [newClusterSparkConf] A set of optional, user-specified + * @property {object} [newClusterNodeType] The node types of new cluster. + * Type: string (or Expression with resultType string). + * @property {object} [newClusterSparkConf] A set of optional, user-specified * Spark configuration key-value pairs. - * @member {object} [newClusterSparkEnvVars] A set of optional, + * @property {object} [newClusterSparkEnvVars] A set of optional, * user-specified Spark environment variables key-value pairs. - * @member {object} [newClusterCustomTags] Additional tags for cluster + * @property {object} [newClusterCustomTags] Additional tags for cluster * resources. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureKeyVaultLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureKeyVaultLinkedService.js index 6cfb00ca9d..269eff8502 100644 --- a/lib/services/datafactoryManagement/lib/models/azureKeyVaultLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureKeyVaultLinkedService.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureKeyVaultLinkedService extends models['LinkedService'] { /** * Create a AzureKeyVaultLinkedService. - * @member {object} baseUrl The base URL of the Azure Key Vault. e.g. + * @property {object} baseUrl The base URL of the Azure Key Vault. e.g. * https://myakv.vault.azure.net Type: string (or Expression with resultType * string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureKeyVaultSecretReference.js b/lib/services/datafactoryManagement/lib/models/azureKeyVaultSecretReference.js index 6493a950cf..b4607b4a78 100644 --- a/lib/services/datafactoryManagement/lib/models/azureKeyVaultSecretReference.js +++ b/lib/services/datafactoryManagement/lib/models/azureKeyVaultSecretReference.js @@ -20,12 +20,12 @@ const models = require('./index'); class AzureKeyVaultSecretReference extends models['SecretBase'] { /** * Create a AzureKeyVaultSecretReference. - * @member {object} store The Azure Key Vault linked service reference. - * @member {string} [store.referenceName] Reference LinkedService name. - * @member {object} [store.parameters] Arguments for LinkedService. - * @member {object} secretName The name of the secret in Azure Key Vault. + * @property {object} store The Azure Key Vault linked service reference. + * @property {string} [store.referenceName] Reference LinkedService name. + * @property {object} [store.parameters] Arguments for LinkedService. + * @property {object} secretName The name of the secret in Azure Key Vault. * Type: string (or Expression with resultType string). - * @member {object} [secretVersion] The version of the secret in Azure Key + * @property {object} [secretVersion] The version of the secret in Azure Key * Vault. The default value is the latest version of the secret. Type: string * (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureMLBatchExecutionActivity.js b/lib/services/datafactoryManagement/lib/models/azureMLBatchExecutionActivity.js index a7a0e211b3..3f49157c9d 100644 --- a/lib/services/datafactoryManagement/lib/models/azureMLBatchExecutionActivity.js +++ b/lib/services/datafactoryManagement/lib/models/azureMLBatchExecutionActivity.js @@ -20,17 +20,18 @@ const models = require('./index'); class AzureMLBatchExecutionActivity extends models['ExecutionActivity'] { /** * Create a AzureMLBatchExecutionActivity. - * @member {object} [globalParameters] Key,Value pairs to be passed to the + * @property {object} [globalParameters] Key,Value pairs to be passed to the * Azure ML Batch Execution Service endpoint. Keys must match the names of * web service parameters defined in the published Azure ML web service. * Values will be passed in the GlobalParameters property of the Azure ML * batch execution request. - * @member {object} [webServiceOutputs] Key,Value pairs, mapping the names of - * Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects - * specifying the output Blob locations. This information will be passed in - * the WebServiceOutputs property of the Azure ML batch execution request. - * @member {object} [webServiceInputs] Key,Value pairs, mapping the names of - * Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects + * @property {object} [webServiceOutputs] Key,Value pairs, mapping the names + * of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile + * objects specifying the output Blob locations. This information will be + * passed in the WebServiceOutputs property of the Azure ML batch execution + * request. + * @property {object} [webServiceInputs] Key,Value pairs, mapping the names + * of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects * specifying the input Blob locations.. This information will be passed in * the WebServiceInputs property of the Azure ML batch execution request. */ diff --git a/lib/services/datafactoryManagement/lib/models/azureMLLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureMLLinkedService.js index 1e33facd4b..8cdfe55b69 100644 --- a/lib/services/datafactoryManagement/lib/models/azureMLLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureMLLinkedService.js @@ -20,25 +20,25 @@ const models = require('./index'); class AzureMLLinkedService extends models['LinkedService'] { /** * Create a AzureMLLinkedService. - * @member {object} mlEndpoint The Batch Execution REST URL for an Azure ML + * @property {object} mlEndpoint The Batch Execution REST URL for an Azure ML * Web Service endpoint. Type: string (or Expression with resultType string). - * @member {object} apiKey The API key for accessing the Azure ML model + * @property {object} apiKey The API key for accessing the Azure ML model * endpoint. - * @member {string} [apiKey.type] Polymorphic Discriminator - * @member {object} [updateResourceEndpoint] The Update Resource REST URL for - * an Azure ML Web Service endpoint. Type: string (or Expression with + * @property {string} [apiKey.type] Polymorphic Discriminator + * @property {object} [updateResourceEndpoint] The Update Resource REST URL + * for an Azure ML Web Service endpoint. Type: string (or Expression with * resultType string). - * @member {object} [servicePrincipalId] The ID of the service principal used - * to authenticate against the ARM-based updateResourceEndpoint of an Azure - * ML web service. Type: string (or Expression with resultType string). - * @member {object} [servicePrincipalKey] The key of the service principal + * @property {object} [servicePrincipalId] The ID of the service principal + * used to authenticate against the ARM-based updateResourceEndpoint of an + * Azure ML web service. Type: string (or Expression with resultType string). + * @property {object} [servicePrincipalKey] The key of the service principal * used to authenticate against the ARM-based updateResourceEndpoint of an * Azure ML web service. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} [tenant] The name or ID of the tenant to which the + * @property {string} [servicePrincipalKey.type] Polymorphic Discriminator + * @property {object} [tenant] The name or ID of the tenant to which the * service principal belongs. Type: string (or Expression with resultType * string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureMLUpdateResourceActivity.js b/lib/services/datafactoryManagement/lib/models/azureMLUpdateResourceActivity.js index 22b7afffaa..ab1a4f8778 100644 --- a/lib/services/datafactoryManagement/lib/models/azureMLUpdateResourceActivity.js +++ b/lib/services/datafactoryManagement/lib/models/azureMLUpdateResourceActivity.js @@ -20,17 +20,17 @@ const models = require('./index'); class AzureMLUpdateResourceActivity extends models['ExecutionActivity'] { /** * Create a AzureMLUpdateResourceActivity. - * @member {object} trainedModelName Name of the Trained Model module in the - * Web Service experiment to be updated. Type: string (or Expression with + * @property {object} trainedModelName Name of the Trained Model module in + * the Web Service experiment to be updated. Type: string (or Expression with * resultType string). - * @member {object} trainedModelLinkedServiceName Name of Azure Storage + * @property {object} trainedModelLinkedServiceName Name of Azure Storage * linked service holding the .ilearner file that will be uploaded by the * update operation. - * @member {string} [trainedModelLinkedServiceName.referenceName] Reference + * @property {string} [trainedModelLinkedServiceName.referenceName] Reference * LinkedService name. - * @member {object} [trainedModelLinkedServiceName.parameters] Arguments for - * LinkedService. - * @member {object} trainedModelFilePath The relative file path in + * @property {object} [trainedModelLinkedServiceName.parameters] Arguments + * for LinkedService. + * @property {object} trainedModelFilePath The relative file path in * trainedModelLinkedService to represent the .ilearner file that will be * uploaded by the update operation. Type: string (or Expression with * resultType string). diff --git a/lib/services/datafactoryManagement/lib/models/azureMLWebServiceFile.js b/lib/services/datafactoryManagement/lib/models/azureMLWebServiceFile.js index 6dead8f0e1..befa13113f 100644 --- a/lib/services/datafactoryManagement/lib/models/azureMLWebServiceFile.js +++ b/lib/services/datafactoryManagement/lib/models/azureMLWebServiceFile.js @@ -17,14 +17,14 @@ class AzureMLWebServiceFile { /** * Create a AzureMLWebServiceFile. - * @member {object} filePath The relative file path, including container + * @property {object} filePath The relative file path, including container * name, in the Azure Blob Storage specified by the LinkedService. Type: * string (or Expression with resultType string). - * @member {object} linkedServiceName Reference to an Azure Storage + * @property {object} linkedServiceName Reference to an Azure Storage * LinkedService, where Azure ML WebService Input/Output file located. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for + * @property {string} [linkedServiceName.referenceName] Reference + * LinkedService name. + * @property {object} [linkedServiceName.parameters] Arguments for * LinkedService. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/azureMySqlLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureMySqlLinkedService.js index 95e51d7c9e..7cfd3f2c4a 100644 --- a/lib/services/datafactoryManagement/lib/models/azureMySqlLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureMySqlLinkedService.js @@ -20,21 +20,22 @@ const models = require('./index'); class AzureMySqlLinkedService extends models['LinkedService'] { /** * Create a AzureMySqlLinkedService. - * @member {object} connectionString The connection string. Type: string, + * @property {object} connectionString The connection string. Type: string, * SecureString or AzureKeyVaultSecretReference. - * @member {object} [password] The Azure key vault secret reference of + * @property {object} [password] The Azure key vault secret reference of * password in connection string. - * @member {object} [password.store] The Azure Key Vault linked service + * @property {object} [password.store] The Azure Key Vault linked service * reference. - * @member {string} [password.store.referenceName] Reference LinkedService + * @property {string} [password.store.referenceName] Reference LinkedService * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in + * @property {object} [password.store.parameters] Arguments for + * LinkedService. + * @property {object} [password.secretName] The name of the secret in Azure + * Key Vault. Type: string (or Expression with resultType string). + * @property {object} [password.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureMySqlSource.js b/lib/services/datafactoryManagement/lib/models/azureMySqlSource.js index 75eae8ab98..f533eeeda9 100644 --- a/lib/services/datafactoryManagement/lib/models/azureMySqlSource.js +++ b/lib/services/datafactoryManagement/lib/models/azureMySqlSource.js @@ -20,8 +20,8 @@ const models = require('./index'); class AzureMySqlSource extends models['CopySource'] { /** * Create a AzureMySqlSource. - * @member {object} [query] Database query. Type: string (or Expression with - * resultType string). + * @property {object} [query] Database query. Type: string (or Expression + * with resultType string). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/azureMySqlTableDataset.js b/lib/services/datafactoryManagement/lib/models/azureMySqlTableDataset.js index 61fc527ba2..3ee67a76c8 100644 --- a/lib/services/datafactoryManagement/lib/models/azureMySqlTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/azureMySqlTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureMySqlTableDataset extends models['Dataset'] { /** * Create a AzureMySqlTableDataset. - * @member {object} [tableName] The Azure MySQL database table name. Type: + * @property {object} [tableName] The Azure MySQL database table name. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/azurePostgreSqlLinkedService.js b/lib/services/datafactoryManagement/lib/models/azurePostgreSqlLinkedService.js index 36631484c8..0298a67758 100644 --- a/lib/services/datafactoryManagement/lib/models/azurePostgreSqlLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azurePostgreSqlLinkedService.js @@ -20,21 +20,22 @@ const models = require('./index'); class AzurePostgreSqlLinkedService extends models['LinkedService'] { /** * Create a AzurePostgreSqlLinkedService. - * @member {object} [connectionString] An ODBC connection string. Type: + * @property {object} [connectionString] An ODBC connection string. Type: * string, SecureString or AzureKeyVaultSecretReference. - * @member {object} [password] The Azure key vault secret reference of + * @property {object} [password] The Azure key vault secret reference of * password in connection string. - * @member {object} [password.store] The Azure Key Vault linked service + * @property {object} [password.store] The Azure Key Vault linked service * reference. - * @member {string} [password.store.referenceName] Reference LinkedService + * @property {string} [password.store.referenceName] Reference LinkedService * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in + * @property {object} [password.store.parameters] Arguments for + * LinkedService. + * @property {object} [password.secretName] The name of the secret in Azure + * Key Vault. Type: string (or Expression with resultType string). + * @property {object} [password.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azurePostgreSqlSource.js b/lib/services/datafactoryManagement/lib/models/azurePostgreSqlSource.js index b1fd487dbc..8c38ea95ed 100644 --- a/lib/services/datafactoryManagement/lib/models/azurePostgreSqlSource.js +++ b/lib/services/datafactoryManagement/lib/models/azurePostgreSqlSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzurePostgreSqlSource extends models['CopySource'] { /** * Create a AzurePostgreSqlSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/azurePostgreSqlTableDataset.js b/lib/services/datafactoryManagement/lib/models/azurePostgreSqlTableDataset.js index 199ee9c525..ddf5a97b7d 100644 --- a/lib/services/datafactoryManagement/lib/models/azurePostgreSqlTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/azurePostgreSqlTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzurePostgreSqlTableDataset extends models['Dataset'] { /** * Create a AzurePostgreSqlTableDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/azureSearchIndexDataset.js b/lib/services/datafactoryManagement/lib/models/azureSearchIndexDataset.js index 744d513582..d80e46a97f 100644 --- a/lib/services/datafactoryManagement/lib/models/azureSearchIndexDataset.js +++ b/lib/services/datafactoryManagement/lib/models/azureSearchIndexDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureSearchIndexDataset extends models['Dataset'] { /** * Create a AzureSearchIndexDataset. - * @member {object} indexName The name of the Azure Search Index. Type: + * @property {object} indexName The name of the Azure Search Index. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/azureSearchIndexSink.js b/lib/services/datafactoryManagement/lib/models/azureSearchIndexSink.js index 7cc5972c20..9e6566ea22 100644 --- a/lib/services/datafactoryManagement/lib/models/azureSearchIndexSink.js +++ b/lib/services/datafactoryManagement/lib/models/azureSearchIndexSink.js @@ -20,9 +20,9 @@ const models = require('./index'); class AzureSearchIndexSink extends models['CopySink'] { /** * Create a AzureSearchIndexSink. - * @member {string} [writeBehavior] Specify the write behavior when upserting - * documents into Azure Search Index. Possible values include: 'Merge', - * 'Upload' + * @property {string} [writeBehavior] Specify the write behavior when + * upserting documents into Azure Search Index. Possible values include: + * 'Merge', 'Upload' */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/azureSearchLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureSearchLinkedService.js index d59c0671d9..cd9dab6a6e 100644 --- a/lib/services/datafactoryManagement/lib/models/azureSearchLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureSearchLinkedService.js @@ -20,11 +20,11 @@ const models = require('./index'); class AzureSearchLinkedService extends models['LinkedService'] { /** * Create a AzureSearchLinkedService. - * @member {object} url URL for Azure Search service. Type: string (or + * @property {object} url URL for Azure Search service. Type: string (or * Expression with resultType string). - * @member {object} [key] Admin Key for Azure Search service - * @member {string} [key.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [key] Admin Key for Azure Search service + * @property {string} [key.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureSqlDWLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureSqlDWLinkedService.js index 9520621886..c5e0bada49 100644 --- a/lib/services/datafactoryManagement/lib/models/azureSqlDWLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureSqlDWLinkedService.js @@ -20,31 +20,32 @@ const models = require('./index'); class AzureSqlDWLinkedService extends models['LinkedService'] { /** * Create a AzureSqlDWLinkedService. - * @member {object} connectionString The connection string. Type: string, + * @property {object} connectionString The connection string. Type: string, * SecureString or AzureKeyVaultSecretReference. Type: string, SecureString * or AzureKeyVaultSecretReference. - * @member {object} [password] The Azure key vault secret reference of + * @property {object} [password] The Azure key vault secret reference of * password in connection string. - * @member {object} [password.store] The Azure Key Vault linked service + * @property {object} [password.store] The Azure Key Vault linked service * reference. - * @member {string} [password.store.referenceName] Reference LinkedService + * @property {string} [password.store.referenceName] Reference LinkedService * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in + * @property {object} [password.store.parameters] Arguments for + * LinkedService. + * @property {object} [password.secretName] The name of the secret in Azure + * Key Vault. Type: string (or Expression with resultType string). + * @property {object} [password.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [servicePrincipalId] The ID of the service principal used - * to authenticate against Azure SQL Data Warehouse. Type: string (or + * @property {object} [servicePrincipalId] The ID of the service principal + * used to authenticate against Azure SQL Data Warehouse. Type: string (or * Expression with resultType string). - * @member {object} [servicePrincipalKey] The key of the service principal + * @property {object} [servicePrincipalKey] The key of the service principal * used to authenticate against Azure SQL Data Warehouse. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} [tenant] The name or ID of the tenant to which the + * @property {string} [servicePrincipalKey.type] Polymorphic Discriminator + * @property {object} [tenant] The name or ID of the tenant to which the * service principal belongs. Type: string (or Expression with resultType * string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureSqlDWTableDataset.js b/lib/services/datafactoryManagement/lib/models/azureSqlDWTableDataset.js index 112b63a20c..4e8c03a32c 100644 --- a/lib/services/datafactoryManagement/lib/models/azureSqlDWTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/azureSqlDWTableDataset.js @@ -20,8 +20,8 @@ const models = require('./index'); class AzureSqlDWTableDataset extends models['Dataset'] { /** * Create a AzureSqlDWTableDataset. - * @member {object} tableName The table name of the Azure SQL Data Warehouse. - * Type: string (or Expression with resultType string). + * @property {object} tableName The table name of the Azure SQL Data + * Warehouse. Type: string (or Expression with resultType string). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/azureSqlDatabaseLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureSqlDatabaseLinkedService.js index 1983649e0e..ef12c9107e 100644 --- a/lib/services/datafactoryManagement/lib/models/azureSqlDatabaseLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureSqlDatabaseLinkedService.js @@ -20,30 +20,31 @@ const models = require('./index'); class AzureSqlDatabaseLinkedService extends models['LinkedService'] { /** * Create a AzureSqlDatabaseLinkedService. - * @member {object} connectionString The connection string. Type: string, + * @property {object} connectionString The connection string. Type: string, * SecureString or AzureKeyVaultSecretReference. - * @member {object} [password] The Azure key vault secret reference of + * @property {object} [password] The Azure key vault secret reference of * password in connection string. - * @member {object} [password.store] The Azure Key Vault linked service + * @property {object} [password.store] The Azure Key Vault linked service * reference. - * @member {string} [password.store.referenceName] Reference LinkedService + * @property {string} [password.store.referenceName] Reference LinkedService * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in + * @property {object} [password.store.parameters] Arguments for + * LinkedService. + * @property {object} [password.secretName] The name of the secret in Azure + * Key Vault. Type: string (or Expression with resultType string). + * @property {object} [password.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [servicePrincipalId] The ID of the service principal used - * to authenticate against Azure SQL Database. Type: string (or Expression - * with resultType string). - * @member {object} [servicePrincipalKey] The key of the service principal + * @property {object} [servicePrincipalId] The ID of the service principal + * used to authenticate against Azure SQL Database. Type: string (or + * Expression with resultType string). + * @property {object} [servicePrincipalKey] The key of the service principal * used to authenticate against Azure SQL Database. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} [tenant] The name or ID of the tenant to which the + * @property {string} [servicePrincipalKey.type] Polymorphic Discriminator + * @property {object} [tenant] The name or ID of the tenant to which the * service principal belongs. Type: string (or Expression with resultType * string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureSqlTableDataset.js b/lib/services/datafactoryManagement/lib/models/azureSqlTableDataset.js index 7dac032c0f..de3f05edc1 100644 --- a/lib/services/datafactoryManagement/lib/models/azureSqlTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/azureSqlTableDataset.js @@ -20,8 +20,8 @@ const models = require('./index'); class AzureSqlTableDataset extends models['Dataset'] { /** * Create a AzureSqlTableDataset. - * @member {object} tableName The table name of the Azure SQL database. Type: - * string (or Expression with resultType string). + * @property {object} tableName The table name of the Azure SQL database. + * Type: string (or Expression with resultType string). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/azureStorageLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureStorageLinkedService.js index 2f79e16624..8079d00225 100644 --- a/lib/services/datafactoryManagement/lib/models/azureStorageLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureStorageLinkedService.js @@ -20,38 +20,39 @@ const models = require('./index'); class AzureStorageLinkedService extends models['LinkedService'] { /** * Create a AzureStorageLinkedService. - * @member {object} [connectionString] The connection string. It is mutually - * exclusive with sasUri property. Type: string, SecureString or + * @property {object} [connectionString] The connection string. It is + * mutually exclusive with sasUri property. Type: string, SecureString or * AzureKeyVaultSecretReference. - * @member {object} [accountKey] The Azure key vault secret reference of + * @property {object} [accountKey] The Azure key vault secret reference of * accountKey in connection string. - * @member {object} [accountKey.store] The Azure Key Vault linked service + * @property {object} [accountKey.store] The Azure Key Vault linked service * reference. - * @member {string} [accountKey.store.referenceName] Reference LinkedService - * name. - * @member {object} [accountKey.store.parameters] Arguments for + * @property {string} [accountKey.store.referenceName] Reference + * LinkedService name. + * @property {object} [accountKey.store.parameters] Arguments for * LinkedService. - * @member {object} [accountKey.secretName] The name of the secret in Azure + * @property {object} [accountKey.secretName] The name of the secret in Azure * Key Vault. Type: string (or Expression with resultType string). - * @member {object} [accountKey.secretVersion] The version of the secret in + * @property {object} [accountKey.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [sasUri] SAS URI of the Azure Storage resource. It is + * @property {object} [sasUri] SAS URI of the Azure Storage resource. It is * mutually exclusive with connectionString property. Type: string, * SecureString or AzureKeyVaultSecretReference. - * @member {object} [sasToken] The Azure key vault secret reference of + * @property {object} [sasToken] The Azure key vault secret reference of * sasToken in sas uri. - * @member {object} [sasToken.store] The Azure Key Vault linked service + * @property {object} [sasToken.store] The Azure Key Vault linked service * reference. - * @member {string} [sasToken.store.referenceName] Reference LinkedService + * @property {string} [sasToken.store.referenceName] Reference LinkedService * name. - * @member {object} [sasToken.store.parameters] Arguments for LinkedService. - * @member {object} [sasToken.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [sasToken.secretVersion] The version of the secret in + * @property {object} [sasToken.store.parameters] Arguments for + * LinkedService. + * @property {object} [sasToken.secretName] The name of the secret in Azure + * Key Vault. Type: string (or Expression with resultType string). + * @property {object} [sasToken.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {string} [encryptedCredential] The encrypted credential used for + * @property {string} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/azureTableDataset.js b/lib/services/datafactoryManagement/lib/models/azureTableDataset.js index c8f8d59118..b305c1eac3 100644 --- a/lib/services/datafactoryManagement/lib/models/azureTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/azureTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureTableDataset extends models['Dataset'] { /** * Create a AzureTableDataset. - * @member {object} tableName The table name of the Azure Table storage. + * @property {object} tableName The table name of the Azure Table storage. * Type: string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/azureTableSink.js b/lib/services/datafactoryManagement/lib/models/azureTableSink.js index 9284deb142..302331a578 100644 --- a/lib/services/datafactoryManagement/lib/models/azureTableSink.js +++ b/lib/services/datafactoryManagement/lib/models/azureTableSink.js @@ -20,13 +20,14 @@ const models = require('./index'); class AzureTableSink extends models['CopySink'] { /** * Create a AzureTableSink. - * @member {object} [azureTableDefaultPartitionKeyValue] Azure Table default - * partition key value. Type: string (or Expression with resultType string). - * @member {object} [azureTablePartitionKeyName] Azure Table partition key + * @property {object} [azureTableDefaultPartitionKeyValue] Azure Table + * default partition key value. Type: string (or Expression with resultType + * string). + * @property {object} [azureTablePartitionKeyName] Azure Table partition key * name. Type: string (or Expression with resultType string). - * @member {object} [azureTableRowKeyName] Azure Table row key name. Type: + * @property {object} [azureTableRowKeyName] Azure Table row key name. Type: * string (or Expression with resultType string). - * @member {object} [azureTableInsertType] Azure Table insert type. Type: + * @property {object} [azureTableInsertType] Azure Table insert type. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/azureTableSource.js b/lib/services/datafactoryManagement/lib/models/azureTableSource.js index 8b159f5f59..f5d036f01d 100644 --- a/lib/services/datafactoryManagement/lib/models/azureTableSource.js +++ b/lib/services/datafactoryManagement/lib/models/azureTableSource.js @@ -20,11 +20,11 @@ const models = require('./index'); class AzureTableSource extends models['CopySource'] { /** * Create a AzureTableSource. - * @member {object} [azureTableSourceQuery] Azure Table source query. Type: + * @property {object} [azureTableSourceQuery] Azure Table source query. Type: * string (or Expression with resultType string). - * @member {object} [azureTableSourceIgnoreTableNotFound] Azure Table source - * ignore table not found. Type: boolean (or Expression with resultType - * boolean). + * @property {object} [azureTableSourceIgnoreTableNotFound] Azure Table + * source ignore table not found. Type: boolean (or Expression with + * resultType boolean). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/azureTableStorageLinkedService.js b/lib/services/datafactoryManagement/lib/models/azureTableStorageLinkedService.js index e404abee78..7ea0745563 100644 --- a/lib/services/datafactoryManagement/lib/models/azureTableStorageLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/azureTableStorageLinkedService.js @@ -20,38 +20,39 @@ const models = require('./index'); class AzureTableStorageLinkedService extends models['LinkedService'] { /** * Create a AzureTableStorageLinkedService. - * @member {object} [connectionString] The connection string. It is mutually - * exclusive with sasUri property. Type: string, SecureString or + * @property {object} [connectionString] The connection string. It is + * mutually exclusive with sasUri property. Type: string, SecureString or * AzureKeyVaultSecretReference. - * @member {object} [accountKey] The Azure key vault secret reference of + * @property {object} [accountKey] The Azure key vault secret reference of * accountKey in connection string. - * @member {object} [accountKey.store] The Azure Key Vault linked service + * @property {object} [accountKey.store] The Azure Key Vault linked service * reference. - * @member {string} [accountKey.store.referenceName] Reference LinkedService - * name. - * @member {object} [accountKey.store.parameters] Arguments for + * @property {string} [accountKey.store.referenceName] Reference + * LinkedService name. + * @property {object} [accountKey.store.parameters] Arguments for * LinkedService. - * @member {object} [accountKey.secretName] The name of the secret in Azure + * @property {object} [accountKey.secretName] The name of the secret in Azure * Key Vault. Type: string (or Expression with resultType string). - * @member {object} [accountKey.secretVersion] The version of the secret in + * @property {object} [accountKey.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [sasUri] SAS URI of the Azure Storage resource. It is + * @property {object} [sasUri] SAS URI of the Azure Storage resource. It is * mutually exclusive with connectionString property. Type: string, * SecureString or AzureKeyVaultSecretReference. - * @member {object} [sasToken] The Azure key vault secret reference of + * @property {object} [sasToken] The Azure key vault secret reference of * sasToken in sas uri. - * @member {object} [sasToken.store] The Azure Key Vault linked service + * @property {object} [sasToken.store] The Azure Key Vault linked service * reference. - * @member {string} [sasToken.store.referenceName] Reference LinkedService + * @property {string} [sasToken.store.referenceName] Reference LinkedService * name. - * @member {object} [sasToken.store.parameters] Arguments for LinkedService. - * @member {object} [sasToken.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [sasToken.secretVersion] The version of the secret in + * @property {object} [sasToken.store.parameters] Arguments for + * LinkedService. + * @property {object} [sasToken.secretName] The name of the secret in Azure + * Key Vault. Type: string (or Expression with resultType string). + * @property {object} [sasToken.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {string} [encryptedCredential] The encrypted credential used for + * @property {string} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/blobEventsTrigger.js b/lib/services/datafactoryManagement/lib/models/blobEventsTrigger.js index ae4fb1319b..8ee411694e 100644 --- a/lib/services/datafactoryManagement/lib/models/blobEventsTrigger.js +++ b/lib/services/datafactoryManagement/lib/models/blobEventsTrigger.js @@ -20,17 +20,18 @@ const models = require('./index'); class BlobEventsTrigger extends models['MultiplePipelineTrigger'] { /** * Create a BlobEventsTrigger. - * @member {string} [blobPathBeginsWith] The blob path must begin with the + * @property {string} [blobPathBeginsWith] The blob path must begin with the * pattern provided for trigger to fire. For example, * '/records/blobs/december/' will only fire the trigger for blobs in the * december folder under the records container. At least one of these must be * provided: blobPathBeginsWith, blobPathEndsWith. - * @member {string} [blobPathEndsWith] The blob path must end with the + * @property {string} [blobPathEndsWith] The blob path must end with the * pattern provided for trigger to fire. For example, 'december/boxes.csv' * will only fire the trigger for blobs named boxes in a december folder. At * least one of these must be provided: blobPathBeginsWith, blobPathEndsWith. - * @member {array} events The type of events that cause this trigger to fire. - * @member {string} scope The ARM resource ID of the Storage Account. + * @property {array} events The type of events that cause this trigger to + * fire. + * @property {string} scope The ARM resource ID of the Storage Account. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/blobSink.js b/lib/services/datafactoryManagement/lib/models/blobSink.js index 0c549d1d5f..a102c652e8 100644 --- a/lib/services/datafactoryManagement/lib/models/blobSink.js +++ b/lib/services/datafactoryManagement/lib/models/blobSink.js @@ -20,13 +20,13 @@ const models = require('./index'); class BlobSink extends models['CopySink'] { /** * Create a BlobSink. - * @member {object} [blobWriterOverwriteFiles] Blob writer overwrite files. + * @property {object} [blobWriterOverwriteFiles] Blob writer overwrite files. * Type: boolean (or Expression with resultType boolean). - * @member {object} [blobWriterDateTimeFormat] Blob writer date time format. - * Type: string (or Expression with resultType string). - * @member {object} [blobWriterAddHeader] Blob writer add header. Type: + * @property {object} [blobWriterDateTimeFormat] Blob writer date time + * format. Type: string (or Expression with resultType string). + * @property {object} [blobWriterAddHeader] Blob writer add header. Type: * boolean (or Expression with resultType boolean). - * @member {string} [copyBehavior] The type of copy behavior for copy sink. + * @property {string} [copyBehavior] The type of copy behavior for copy sink. * Possible values include: 'PreserveHierarchy', 'FlattenHierarchy', * 'MergeFiles' */ diff --git a/lib/services/datafactoryManagement/lib/models/blobSource.js b/lib/services/datafactoryManagement/lib/models/blobSource.js index 8072f09c5c..31aec6da60 100644 --- a/lib/services/datafactoryManagement/lib/models/blobSource.js +++ b/lib/services/datafactoryManagement/lib/models/blobSource.js @@ -20,12 +20,12 @@ const models = require('./index'); class BlobSource extends models['CopySource'] { /** * Create a BlobSource. - * @member {object} [treatEmptyAsNull] Treat empty as null. Type: boolean (or - * Expression with resultType boolean). - * @member {object} [skipHeaderLineCount] Number of header lines to skip from - * each blob. Type: integer (or Expression with resultType integer). - * @member {object} [recursive] If true, files under the folder path will be - * read recursively. Default is true. Type: boolean (or Expression with + * @property {object} [treatEmptyAsNull] Treat empty as null. Type: boolean + * (or Expression with resultType boolean). + * @property {object} [skipHeaderLineCount] Number of header lines to skip + * from each blob. Type: integer (or Expression with resultType integer). + * @property {object} [recursive] If true, files under the folder path will + * be read recursively. Default is true. Type: boolean (or Expression with * resultType boolean). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/blobTrigger.js b/lib/services/datafactoryManagement/lib/models/blobTrigger.js index 924220a262..ff26b8821b 100644 --- a/lib/services/datafactoryManagement/lib/models/blobTrigger.js +++ b/lib/services/datafactoryManagement/lib/models/blobTrigger.js @@ -20,14 +20,15 @@ const models = require('./index'); class BlobTrigger extends models['MultiplePipelineTrigger'] { /** * Create a BlobTrigger. - * @member {string} folderPath The path of the container/folder that will + * @property {string} folderPath The path of the container/folder that will * trigger the pipeline. - * @member {number} maxConcurrency The max number of parallel files to handle - * when it is triggered. - * @member {object} linkedService The Azure Storage linked service reference. - * @member {string} [linkedService.referenceName] Reference LinkedService + * @property {number} maxConcurrency The max number of parallel files to + * handle when it is triggered. + * @property {object} linkedService The Azure Storage linked service + * reference. + * @property {string} [linkedService.referenceName] Reference LinkedService * name. - * @member {object} [linkedService.parameters] Arguments for LinkedService. + * @property {object} [linkedService.parameters] Arguments for LinkedService. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/cassandraLinkedService.js b/lib/services/datafactoryManagement/lib/models/cassandraLinkedService.js index 50d0e63445..aa52c1a2b6 100644 --- a/lib/services/datafactoryManagement/lib/models/cassandraLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/cassandraLinkedService.js @@ -20,17 +20,17 @@ const models = require('./index'); class CassandraLinkedService extends models['LinkedService'] { /** * Create a CassandraLinkedService. - * @member {object} host Host name for connection. Type: string (or + * @property {object} host Host name for connection. Type: string (or * Expression with resultType string). - * @member {object} [authenticationType] AuthenticationType to be used for + * @property {object} [authenticationType] AuthenticationType to be used for * connection. Type: string (or Expression with resultType string). - * @member {object} [port] The port for the connection. Type: integer (or + * @property {object} [port] The port for the connection. Type: integer (or * Expression with resultType integer). - * @member {object} [username] Username for authentication. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password for authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [username] Username for authentication. Type: string + * (or Expression with resultType string). + * @property {object} [password] Password for authentication. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/cassandraSource.js b/lib/services/datafactoryManagement/lib/models/cassandraSource.js index 5f1b750203..13108991f6 100644 --- a/lib/services/datafactoryManagement/lib/models/cassandraSource.js +++ b/lib/services/datafactoryManagement/lib/models/cassandraSource.js @@ -20,10 +20,10 @@ const models = require('./index'); class CassandraSource extends models['CopySource'] { /** * Create a CassandraSource. - * @member {object} [query] Database query. Should be a SQL-92 query + * @property {object} [query] Database query. Should be a SQL-92 query * expression or Cassandra Query Language (CQL) command. Type: string (or * Expression with resultType string). - * @member {string} [consistencyLevel] The consistency level specifies how + * @property {string} [consistencyLevel] The consistency level specifies how * many Cassandra servers must respond to a read request before returning * data to the client application. Cassandra checks the specified number of * Cassandra servers for data to satisfy the read request. Must be one of diff --git a/lib/services/datafactoryManagement/lib/models/cassandraTableDataset.js b/lib/services/datafactoryManagement/lib/models/cassandraTableDataset.js index 50ab3093ea..443688630c 100644 --- a/lib/services/datafactoryManagement/lib/models/cassandraTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/cassandraTableDataset.js @@ -20,10 +20,10 @@ const models = require('./index'); class CassandraTableDataset extends models['Dataset'] { /** * Create a CassandraTableDataset. - * @member {object} [tableName] The table name of the Cassandra database. + * @property {object} [tableName] The table name of the Cassandra database. + * Type: string (or Expression with resultType string). + * @property {object} [keyspace] The keyspace of the Cassandra database. * Type: string (or Expression with resultType string). - * @member {object} [keyspace] The keyspace of the Cassandra database. Type: - * string (or Expression with resultType string). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/concurLinkedService.js b/lib/services/datafactoryManagement/lib/models/concurLinkedService.js index 204f58e022..d172183b11 100644 --- a/lib/services/datafactoryManagement/lib/models/concurLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/concurLinkedService.js @@ -13,29 +13,29 @@ const models = require('./index'); /** - * Concur Serivce linked service. + * Concur Service linked service. * * @extends models['LinkedService'] */ class ConcurLinkedService extends models['LinkedService'] { /** * Create a ConcurLinkedService. - * @member {object} clientId Application client_id supplied by Concur App + * @property {object} clientId Application client_id supplied by Concur App * Management. - * @member {object} username The user name that you use to access Concur + * @property {object} username The user name that you use to access Concur * Service. - * @member {object} [password] The password corresponding to the user name + * @property {object} [password] The password corresponding to the user name * that you provided in the username field. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/concurObjectDataset.js b/lib/services/datafactoryManagement/lib/models/concurObjectDataset.js index 9ee74546df..5383f9d228 100644 --- a/lib/services/datafactoryManagement/lib/models/concurObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/concurObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class ConcurObjectDataset extends models['Dataset'] { /** * Create a ConcurObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/concurSource.js b/lib/services/datafactoryManagement/lib/models/concurSource.js index d9003bafd8..eae6808d06 100644 --- a/lib/services/datafactoryManagement/lib/models/concurSource.js +++ b/lib/services/datafactoryManagement/lib/models/concurSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class ConcurSource extends models['CopySource'] { /** * Create a ConcurSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/copyActivity.js b/lib/services/datafactoryManagement/lib/models/copyActivity.js index a6faf7bf67..71ccd64331 100644 --- a/lib/services/datafactoryManagement/lib/models/copyActivity.js +++ b/lib/services/datafactoryManagement/lib/models/copyActivity.js @@ -20,65 +20,65 @@ const models = require('./index'); class CopyActivity extends models['ExecutionActivity'] { /** * Create a CopyActivity. - * @member {object} source Copy activity source. - * @member {object} [source.sourceRetryCount] Source retry count. Type: + * @property {object} source Copy activity source. + * @property {object} [source.sourceRetryCount] Source retry count. Type: * integer (or Expression with resultType integer). - * @member {object} [source.sourceRetryWait] Source retry wait. Type: string - * (or Expression with resultType string), pattern: + * @property {object} [source.sourceRetryWait] Source retry wait. Type: + * string (or Expression with resultType string), pattern: * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {string} [source.type] Polymorphic Discriminator - * @member {object} sink Copy activity sink. - * @member {object} [sink.writeBatchSize] Write batch size. Type: integer (or - * Expression with resultType integer), minimum: 0. - * @member {object} [sink.writeBatchTimeout] Write batch timeout. Type: + * @property {string} [source.type] Polymorphic Discriminator + * @property {object} sink Copy activity sink. + * @property {object} [sink.writeBatchSize] Write batch size. Type: integer + * (or Expression with resultType integer), minimum: 0. + * @property {object} [sink.writeBatchTimeout] Write batch timeout. Type: * string (or Expression with resultType string), pattern: * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {object} [sink.sinkRetryCount] Sink retry count. Type: integer (or - * Expression with resultType integer). - * @member {object} [sink.sinkRetryWait] Sink retry wait. Type: string (or + * @property {object} [sink.sinkRetryCount] Sink retry count. Type: integer + * (or Expression with resultType integer). + * @property {object} [sink.sinkRetryWait] Sink retry wait. Type: string (or * Expression with resultType string), pattern: * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {string} [sink.type] Polymorphic Discriminator - * @member {object} [translator] Copy activity translator. If not specificed, - * tabular translator is used. - * @member {string} [translator.type] Polymorphic Discriminator - * @member {object} [enableStaging] Specifies whether to copy data via an + * @property {string} [sink.type] Polymorphic Discriminator + * @property {object} [translator] Copy activity translator. If not + * specificed, tabular translator is used. + * @property {string} [translator.type] Polymorphic Discriminator + * @property {object} [enableStaging] Specifies whether to copy data via an * interim staging. Default value is false. Type: boolean (or Expression with * resultType boolean). - * @member {object} [stagingSettings] Specifies interim staging settings when - * EnableStaging is true. - * @member {object} [stagingSettings.linkedServiceName] Staging linked + * @property {object} [stagingSettings] Specifies interim staging settings + * when EnableStaging is true. + * @property {object} [stagingSettings.linkedServiceName] Staging linked * service reference. - * @member {string} [stagingSettings.linkedServiceName.referenceName] + * @property {string} [stagingSettings.linkedServiceName.referenceName] * Reference LinkedService name. - * @member {object} [stagingSettings.linkedServiceName.parameters] Arguments - * for LinkedService. - * @member {object} [stagingSettings.path] The path to storage for storing + * @property {object} [stagingSettings.linkedServiceName.parameters] + * Arguments for LinkedService. + * @property {object} [stagingSettings.path] The path to storage for storing * the interim data. Type: string (or Expression with resultType string). - * @member {object} [stagingSettings.enableCompression] Specifies whether to - * use compression when copying data via an interim staging. Default value is - * false. Type: boolean (or Expression with resultType boolean). - * @member {object} [parallelCopies] Maximum number of concurrent sessions + * @property {object} [stagingSettings.enableCompression] Specifies whether + * to use compression when copying data via an interim staging. Default value + * is false. Type: boolean (or Expression with resultType boolean). + * @property {object} [parallelCopies] Maximum number of concurrent sessions * opened on the source or sink to avoid overloading the data store. Type: * integer (or Expression with resultType integer), minimum: 0. - * @member {object} [dataIntegrationUnits] Maximum number of data integration - * units that can be used to perform this data movement. Type: integer (or - * Expression with resultType integer), minimum: 0. - * @member {object} [enableSkipIncompatibleRow] Whether to skip incompatible - * row. Default value is false. Type: boolean (or Expression with resultType - * boolean). - * @member {object} [redirectIncompatibleRowSettings] Redirect incompatible + * @property {object} [dataIntegrationUnits] Maximum number of data + * integration units that can be used to perform this data movement. Type: + * integer (or Expression with resultType integer), minimum: 0. + * @property {object} [enableSkipIncompatibleRow] Whether to skip + * incompatible row. Default value is false. Type: boolean (or Expression + * with resultType boolean). + * @property {object} [redirectIncompatibleRowSettings] Redirect incompatible * row settings when EnableSkipIncompatibleRow is true. - * @member {object} [redirectIncompatibleRowSettings.linkedServiceName] Name - * of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service - * used for redirecting incompatible row. Must be specified if + * @property {object} [redirectIncompatibleRowSettings.linkedServiceName] + * Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked + * service used for redirecting incompatible row. Must be specified if * redirectIncompatibleRowSettings is specified. Type: string (or Expression * with resultType string). - * @member {object} [redirectIncompatibleRowSettings.path] The path for + * @property {object} [redirectIncompatibleRowSettings.path] The path for * storing the redirect incompatible row data. Type: string (or Expression * with resultType string). - * @member {array} [inputs] List of inputs for the activity. - * @member {array} [outputs] List of outputs for the activity. + * @property {array} [inputs] List of inputs for the activity. + * @property {array} [outputs] List of outputs for the activity. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/copySink.js b/lib/services/datafactoryManagement/lib/models/copySink.js index 1e9e0a1aa9..20619ba255 100644 --- a/lib/services/datafactoryManagement/lib/models/copySink.js +++ b/lib/services/datafactoryManagement/lib/models/copySink.js @@ -17,17 +17,17 @@ class CopySink { /** * Create a CopySink. - * @member {object} [writeBatchSize] Write batch size. Type: integer (or + * @property {object} [writeBatchSize] Write batch size. Type: integer (or * Expression with resultType integer), minimum: 0. - * @member {object} [writeBatchTimeout] Write batch timeout. Type: string (or - * Expression with resultType string), pattern: + * @property {object} [writeBatchTimeout] Write batch timeout. Type: string + * (or Expression with resultType string), pattern: * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {object} [sinkRetryCount] Sink retry count. Type: integer (or + * @property {object} [sinkRetryCount] Sink retry count. Type: integer (or * Expression with resultType integer). - * @member {object} [sinkRetryWait] Sink retry wait. Type: string (or + * @property {object} [sinkRetryWait] Sink retry wait. Type: string (or * Expression with resultType string), pattern: * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/copySource.js b/lib/services/datafactoryManagement/lib/models/copySource.js index 6b6d4814ea..f9eb011521 100644 --- a/lib/services/datafactoryManagement/lib/models/copySource.js +++ b/lib/services/datafactoryManagement/lib/models/copySource.js @@ -17,12 +17,12 @@ class CopySource { /** * Create a CopySource. - * @member {object} [sourceRetryCount] Source retry count. Type: integer (or - * Expression with resultType integer). - * @member {object} [sourceRetryWait] Source retry wait. Type: string (or + * @property {object} [sourceRetryCount] Source retry count. Type: integer + * (or Expression with resultType integer). + * @property {object} [sourceRetryWait] Source retry wait. Type: string (or * Expression with resultType string), pattern: * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/copyTranslator.js b/lib/services/datafactoryManagement/lib/models/copyTranslator.js index 1a354627dc..7889b1c564 100644 --- a/lib/services/datafactoryManagement/lib/models/copyTranslator.js +++ b/lib/services/datafactoryManagement/lib/models/copyTranslator.js @@ -17,7 +17,7 @@ class CopyTranslator { /** * Create a CopyTranslator. - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/cosmosDbLinkedService.js b/lib/services/datafactoryManagement/lib/models/cosmosDbLinkedService.js index de4afa7f1d..0a3a0b38e6 100644 --- a/lib/services/datafactoryManagement/lib/models/cosmosDbLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/cosmosDbLinkedService.js @@ -20,22 +20,22 @@ const models = require('./index'); class CosmosDbLinkedService extends models['LinkedService'] { /** * Create a CosmosDbLinkedService. - * @member {object} connectionString The connection string. Type: string, + * @property {object} connectionString The connection string. Type: string, * SecureString or AzureKeyVaultSecretReference. - * @member {object} [accountKey] The Azure key vault secret reference of + * @property {object} [accountKey] The Azure key vault secret reference of * accountKey in connection string. - * @member {object} [accountKey.store] The Azure Key Vault linked service + * @property {object} [accountKey.store] The Azure Key Vault linked service * reference. - * @member {string} [accountKey.store.referenceName] Reference LinkedService - * name. - * @member {object} [accountKey.store.parameters] Arguments for + * @property {string} [accountKey.store.referenceName] Reference + * LinkedService name. + * @property {object} [accountKey.store.parameters] Arguments for * LinkedService. - * @member {object} [accountKey.secretName] The name of the secret in Azure + * @property {object} [accountKey.secretName] The name of the secret in Azure * Key Vault. Type: string (or Expression with resultType string). - * @member {object} [accountKey.secretVersion] The version of the secret in + * @property {object} [accountKey.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/couchbaseLinkedService.js b/lib/services/datafactoryManagement/lib/models/couchbaseLinkedService.js index ac711f41e5..e419dbda7b 100644 --- a/lib/services/datafactoryManagement/lib/models/couchbaseLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/couchbaseLinkedService.js @@ -20,22 +20,22 @@ const models = require('./index'); class CouchbaseLinkedService extends models['LinkedService'] { /** * Create a CouchbaseLinkedService. - * @member {object} [connectionString] An ODBC connection string. Type: + * @property {object} [connectionString] An ODBC connection string. Type: * string, SecureString or AzureKeyVaultSecretReference. - * @member {object} [credString] The Azure key vault secret reference of + * @property {object} [credString] The Azure key vault secret reference of * credString in connection string. - * @member {object} [credString.store] The Azure Key Vault linked service + * @property {object} [credString.store] The Azure Key Vault linked service * reference. - * @member {string} [credString.store.referenceName] Reference LinkedService - * name. - * @member {object} [credString.store.parameters] Arguments for + * @property {string} [credString.store.referenceName] Reference + * LinkedService name. + * @property {object} [credString.store.parameters] Arguments for * LinkedService. - * @member {object} [credString.secretName] The name of the secret in Azure + * @property {object} [credString.secretName] The name of the secret in Azure * Key Vault. Type: string (or Expression with resultType string). - * @member {object} [credString.secretVersion] The version of the secret in + * @property {object} [credString.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/couchbaseSource.js b/lib/services/datafactoryManagement/lib/models/couchbaseSource.js index 57b814e3bc..ea062cb639 100644 --- a/lib/services/datafactoryManagement/lib/models/couchbaseSource.js +++ b/lib/services/datafactoryManagement/lib/models/couchbaseSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class CouchbaseSource extends models['CopySource'] { /** * Create a CouchbaseSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/couchbaseTableDataset.js b/lib/services/datafactoryManagement/lib/models/couchbaseTableDataset.js index 9e7e01c748..9eb10bee0d 100644 --- a/lib/services/datafactoryManagement/lib/models/couchbaseTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/couchbaseTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class CouchbaseTableDataset extends models['Dataset'] { /** * Create a CouchbaseTableDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/createLinkedIntegrationRuntimeRequest.js b/lib/services/datafactoryManagement/lib/models/createLinkedIntegrationRuntimeRequest.js index b9f5655fa3..b9b09710cb 100644 --- a/lib/services/datafactoryManagement/lib/models/createLinkedIntegrationRuntimeRequest.js +++ b/lib/services/datafactoryManagement/lib/models/createLinkedIntegrationRuntimeRequest.js @@ -17,12 +17,12 @@ class CreateLinkedIntegrationRuntimeRequest { /** * Create a CreateLinkedIntegrationRuntimeRequest. - * @member {string} [name] The name of the linked integration runtime. - * @member {string} [subscriptionId] The ID of the subscription that the + * @property {string} [name] The name of the linked integration runtime. + * @property {string} [subscriptionId] The ID of the subscription that the * linked integration runtime belongs to. - * @member {string} [dataFactoryName] The name of the data factory that the + * @property {string} [dataFactoryName] The name of the data factory that the * linked integration runtime belongs to. - * @member {string} [dataFactoryLocation] The location of the data factory + * @property {string} [dataFactoryLocation] The location of the data factory * that the linked integration runtime belongs to. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/createRunResponse.js b/lib/services/datafactoryManagement/lib/models/createRunResponse.js index 998fecdacb..4a2803abcc 100644 --- a/lib/services/datafactoryManagement/lib/models/createRunResponse.js +++ b/lib/services/datafactoryManagement/lib/models/createRunResponse.js @@ -17,7 +17,7 @@ class CreateRunResponse { /** * Create a CreateRunResponse. - * @member {string} runId Identifier of a run. + * @property {string} runId Identifier of a run. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/customActivity.js b/lib/services/datafactoryManagement/lib/models/customActivity.js index a209ff81be..337fb1cba3 100644 --- a/lib/services/datafactoryManagement/lib/models/customActivity.js +++ b/lib/services/datafactoryManagement/lib/models/customActivity.js @@ -20,24 +20,24 @@ const models = require('./index'); class CustomActivity extends models['ExecutionActivity'] { /** * Create a CustomActivity. - * @member {object} command Command for custom activity Type: string (or + * @property {object} command Command for custom activity Type: string (or * Expression with resultType string). - * @member {object} [resourceLinkedService] Resource linked service + * @property {object} [resourceLinkedService] Resource linked service * reference. - * @member {string} [resourceLinkedService.referenceName] Reference + * @property {string} [resourceLinkedService.referenceName] Reference * LinkedService name. - * @member {object} [resourceLinkedService.parameters] Arguments for + * @property {object} [resourceLinkedService.parameters] Arguments for * LinkedService. - * @member {object} [folderPath] Folder path for resource files Type: string - * (or Expression with resultType string). - * @member {object} [referenceObjects] Reference objects - * @member {array} [referenceObjects.linkedServices] Linked service + * @property {object} [folderPath] Folder path for resource files Type: + * string (or Expression with resultType string). + * @property {object} [referenceObjects] Reference objects + * @property {array} [referenceObjects.linkedServices] Linked service * references. - * @member {array} [referenceObjects.datasets] Dataset references. - * @member {object} [extendedProperties] User defined property bag. There is - * no restriction on the keys or values that can be used. The user specified - * custom activity has the full responsibility to consume and interpret the - * content defined. + * @property {array} [referenceObjects.datasets] Dataset references. + * @property {object} [extendedProperties] User defined property bag. There + * is no restriction on the keys or values that can be used. The user + * specified custom activity has the full responsibility to consume and + * interpret the content defined. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/customActivityReferenceObject.js b/lib/services/datafactoryManagement/lib/models/customActivityReferenceObject.js index 40d1bca23d..ba4d932697 100644 --- a/lib/services/datafactoryManagement/lib/models/customActivityReferenceObject.js +++ b/lib/services/datafactoryManagement/lib/models/customActivityReferenceObject.js @@ -17,8 +17,8 @@ class CustomActivityReferenceObject { /** * Create a CustomActivityReferenceObject. - * @member {array} [linkedServices] Linked service references. - * @member {array} [datasets] Dataset references. + * @property {array} [linkedServices] Linked service references. + * @property {array} [datasets] Dataset references. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/customDataSourceLinkedService.js b/lib/services/datafactoryManagement/lib/models/customDataSourceLinkedService.js index b61e4c7268..6c73881a67 100644 --- a/lib/services/datafactoryManagement/lib/models/customDataSourceLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/customDataSourceLinkedService.js @@ -20,7 +20,7 @@ const models = require('./index'); class CustomDataSourceLinkedService extends models['LinkedService'] { /** * Create a CustomDataSourceLinkedService. - * @member {object} typeProperties Custom linked service properties. + * @property {object} typeProperties Custom linked service properties. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/customDataset.js b/lib/services/datafactoryManagement/lib/models/customDataset.js index 9d66138f83..1eed3198e8 100644 --- a/lib/services/datafactoryManagement/lib/models/customDataset.js +++ b/lib/services/datafactoryManagement/lib/models/customDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class CustomDataset extends models['Dataset'] { /** * Create a CustomDataset. - * @member {object} typeProperties Custom dataset properties. + * @property {object} typeProperties Custom dataset properties. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/dataLakeAnalyticsUSQLActivity.js b/lib/services/datafactoryManagement/lib/models/dataLakeAnalyticsUSQLActivity.js index 676f9c1f0e..882052020f 100644 --- a/lib/services/datafactoryManagement/lib/models/dataLakeAnalyticsUSQLActivity.js +++ b/lib/services/datafactoryManagement/lib/models/dataLakeAnalyticsUSQLActivity.js @@ -20,25 +20,25 @@ const models = require('./index'); class DataLakeAnalyticsUSQLActivity extends models['ExecutionActivity'] { /** * Create a DataLakeAnalyticsUSQLActivity. - * @member {object} scriptPath Case-sensitive path to folder that contains + * @property {object} scriptPath Case-sensitive path to folder that contains * the U-SQL script. Type: string (or Expression with resultType string). - * @member {object} scriptLinkedService Script linked service reference. - * @member {string} [scriptLinkedService.referenceName] Reference + * @property {object} scriptLinkedService Script linked service reference. + * @property {string} [scriptLinkedService.referenceName] Reference * LinkedService name. - * @member {object} [scriptLinkedService.parameters] Arguments for + * @property {object} [scriptLinkedService.parameters] Arguments for * LinkedService. - * @member {object} [degreeOfParallelism] The maximum number of nodes + * @property {object} [degreeOfParallelism] The maximum number of nodes * simultaneously used to run the job. Default value is 1. Type: integer (or * Expression with resultType integer), minimum: 1. - * @member {object} [priority] Determines which jobs out of all that are + * @property {object} [priority] Determines which jobs out of all that are * queued should be selected to run first. The lower the number, the higher * the priority. Default value is 1000. Type: integer (or Expression with * resultType integer), minimum: 1. - * @member {object} [parameters] Parameters for U-SQL job request. - * @member {object} [runtimeVersion] Runtime version of the U-SQL engine to + * @property {object} [parameters] Parameters for U-SQL job request. + * @property {object} [runtimeVersion] Runtime version of the U-SQL engine to * use. Type: string (or Expression with resultType string). - * @member {object} [compilationMode] Compilation mode of U-SQL. Must be one - * of these values : Semantic, Full and SingleBox. Type: string (or + * @property {object} [compilationMode] Compilation mode of U-SQL. Must be + * one of these values : Semantic, Full and SingleBox. Type: string (or * Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/databricksNotebookActivity.js b/lib/services/datafactoryManagement/lib/models/databricksNotebookActivity.js index e174a0a581..eaee5a8bed 100644 --- a/lib/services/datafactoryManagement/lib/models/databricksNotebookActivity.js +++ b/lib/services/datafactoryManagement/lib/models/databricksNotebookActivity.js @@ -20,13 +20,13 @@ const models = require('./index'); class DatabricksNotebookActivity extends models['ExecutionActivity'] { /** * Create a DatabricksNotebookActivity. - * @member {object} notebookPath The absolute path of the notebook to be run - * in the Databricks Workspace. This path must begin with a slash. Type: + * @property {object} notebookPath The absolute path of the notebook to be + * run in the Databricks Workspace. This path must begin with a slash. Type: * string (or Expression with resultType string). - * @member {object} [baseParameters] Base parameters to be used for each run - * of this job.If the notebook takes a parameter that is not specified, the - * default value from the notebook will be used. - * @member {array} [libraries] A list of libraries to be installed on the + * @property {object} [baseParameters] Base parameters to be used for each + * run of this job.If the notebook takes a parameter that is not specified, + * the default value from the notebook will be used. + * @property {array} [libraries] A list of libraries to be installed on the * cluster that will execute the job. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/databricksSparkJarActivity.js b/lib/services/datafactoryManagement/lib/models/databricksSparkJarActivity.js index 8063762e8c..04ee8f3595 100644 --- a/lib/services/datafactoryManagement/lib/models/databricksSparkJarActivity.js +++ b/lib/services/datafactoryManagement/lib/models/databricksSparkJarActivity.js @@ -20,12 +20,12 @@ const models = require('./index'); class DatabricksSparkJarActivity extends models['ExecutionActivity'] { /** * Create a DatabricksSparkJarActivity. - * @member {object} mainClassName The full name of the class containing the + * @property {object} mainClassName The full name of the class containing the * main method to be executed. This class must be contained in a JAR provided * as a library. Type: string (or Expression with resultType string). - * @member {array} [parameters] Parameters that will be passed to the main + * @property {array} [parameters] Parameters that will be passed to the main * method. - * @member {array} [libraries] A list of libraries to be installed on the + * @property {array} [libraries] A list of libraries to be installed on the * cluster that will execute the job. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/databricksSparkPythonActivity.js b/lib/services/datafactoryManagement/lib/models/databricksSparkPythonActivity.js index ce5c6fd83f..1b614ff0b3 100644 --- a/lib/services/datafactoryManagement/lib/models/databricksSparkPythonActivity.js +++ b/lib/services/datafactoryManagement/lib/models/databricksSparkPythonActivity.js @@ -20,12 +20,12 @@ const models = require('./index'); class DatabricksSparkPythonActivity extends models['ExecutionActivity'] { /** * Create a DatabricksSparkPythonActivity. - * @member {object} pythonFile The URI of the Python file to be executed. + * @property {object} pythonFile The URI of the Python file to be executed. * DBFS paths are supported. Type: string (or Expression with resultType * string). - * @member {array} [parameters] Command line parameters that will be passed + * @property {array} [parameters] Command line parameters that will be passed * to the Python file. - * @member {array} [libraries] A list of libraries to be installed on the + * @property {array} [libraries] A list of libraries to be installed on the * cluster that will execute the job. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/dataset.js b/lib/services/datafactoryManagement/lib/models/dataset.js index dac4427d16..6aaa564dec 100644 --- a/lib/services/datafactoryManagement/lib/models/dataset.js +++ b/lib/services/datafactoryManagement/lib/models/dataset.js @@ -18,23 +18,23 @@ class Dataset { /** * Create a Dataset. - * @member {string} [description] Dataset description. - * @member {object} [structure] Columns that define the structure of the + * @property {string} [description] Dataset description. + * @property {object} [structure] Columns that define the structure of the * dataset. Type: array (or Expression with resultType array), itemType: * DatasetDataElement. - * @member {object} linkedServiceName Linked service reference. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for + * @property {object} linkedServiceName Linked service reference. + * @property {string} [linkedServiceName.referenceName] Reference + * LinkedService name. + * @property {object} [linkedServiceName.parameters] Arguments for * LinkedService. - * @member {object} [parameters] Parameters for dataset. - * @member {array} [annotations] List of tags that can be used for describing - * the Dataset. - * @member {object} [folder] The folder that this Dataset is in. If not + * @property {object} [parameters] Parameters for dataset. + * @property {array} [annotations] List of tags that can be used for + * describing the Dataset. + * @property {object} [folder] The folder that this Dataset is in. If not * specified, Dataset will appear at the root level. - * @member {string} [folder.name] The name of the folder that this Dataset is - * in. - * @member {string} type Polymorphic Discriminator + * @property {string} [folder.name] The name of the folder that this Dataset + * is in. + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/datasetCompression.js b/lib/services/datafactoryManagement/lib/models/datasetCompression.js index bfa7abdd35..e216489146 100644 --- a/lib/services/datafactoryManagement/lib/models/datasetCompression.js +++ b/lib/services/datafactoryManagement/lib/models/datasetCompression.js @@ -17,7 +17,7 @@ class DatasetCompression { /** * Create a DatasetCompression. - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/datasetDeflateCompression.js b/lib/services/datafactoryManagement/lib/models/datasetDeflateCompression.js index 2bd76c154b..630e11510c 100644 --- a/lib/services/datafactoryManagement/lib/models/datasetDeflateCompression.js +++ b/lib/services/datafactoryManagement/lib/models/datasetDeflateCompression.js @@ -20,7 +20,7 @@ const models = require('./index'); class DatasetDeflateCompression extends models['DatasetCompression'] { /** * Create a DatasetDeflateCompression. - * @member {string} [level] The Deflate compression level. Possible values + * @property {string} [level] The Deflate compression level. Possible values * include: 'Optimal', 'Fastest' */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/datasetFolder.js b/lib/services/datafactoryManagement/lib/models/datasetFolder.js index 0b4e43bc0c..c1ff1ef13c 100644 --- a/lib/services/datafactoryManagement/lib/models/datasetFolder.js +++ b/lib/services/datafactoryManagement/lib/models/datasetFolder.js @@ -18,7 +18,7 @@ class DatasetFolder { /** * Create a DatasetFolder. - * @member {string} [name] The name of the folder that this Dataset is in. + * @property {string} [name] The name of the folder that this Dataset is in. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/datasetGZipCompression.js b/lib/services/datafactoryManagement/lib/models/datasetGZipCompression.js index 84eeeccef5..c8c9349975 100644 --- a/lib/services/datafactoryManagement/lib/models/datasetGZipCompression.js +++ b/lib/services/datafactoryManagement/lib/models/datasetGZipCompression.js @@ -20,7 +20,7 @@ const models = require('./index'); class DatasetGZipCompression extends models['DatasetCompression'] { /** * Create a DatasetGZipCompression. - * @member {string} [level] The GZip compression level. Possible values + * @property {string} [level] The GZip compression level. Possible values * include: 'Optimal', 'Fastest' */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/datasetListResponse.js b/lib/services/datafactoryManagement/lib/models/datasetListResponse.js index 4db487404b..cc473590db 100644 --- a/lib/services/datafactoryManagement/lib/models/datasetListResponse.js +++ b/lib/services/datafactoryManagement/lib/models/datasetListResponse.js @@ -16,7 +16,7 @@ class DatasetListResponse extends Array { /** * Create a DatasetListResponse. - * @member {string} [nextLink] The link to the next page of results, if any + * @property {string} [nextLink] The link to the next page of results, if any * remaining results exist. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/datasetReference.js b/lib/services/datafactoryManagement/lib/models/datasetReference.js index efeb402517..b8ffe1a1ee 100644 --- a/lib/services/datafactoryManagement/lib/models/datasetReference.js +++ b/lib/services/datafactoryManagement/lib/models/datasetReference.js @@ -17,8 +17,8 @@ class DatasetReference { /** * Create a DatasetReference. - * @member {string} referenceName Reference dataset name. - * @member {object} [parameters] Arguments for dataset. + * @property {string} referenceName Reference dataset name. + * @property {object} [parameters] Arguments for dataset. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/datasetResource.js b/lib/services/datafactoryManagement/lib/models/datasetResource.js index 9a5e9bc6dd..f0e4684369 100644 --- a/lib/services/datafactoryManagement/lib/models/datasetResource.js +++ b/lib/services/datafactoryManagement/lib/models/datasetResource.js @@ -20,24 +20,25 @@ const models = require('./index'); class DatasetResource extends models['SubResource'] { /** * Create a DatasetResource. - * @member {object} properties Dataset properties. - * @member {string} [properties.description] Dataset description. - * @member {object} [properties.structure] Columns that define the structure - * of the dataset. Type: array (or Expression with resultType array), - * itemType: DatasetDataElement. - * @member {object} [properties.linkedServiceName] Linked service reference. - * @member {string} [properties.linkedServiceName.referenceName] Reference + * @property {object} properties Dataset properties. + * @property {string} [properties.description] Dataset description. + * @property {object} [properties.structure] Columns that define the + * structure of the dataset. Type: array (or Expression with resultType + * array), itemType: DatasetDataElement. + * @property {object} [properties.linkedServiceName] Linked service + * reference. + * @property {string} [properties.linkedServiceName.referenceName] Reference * LinkedService name. - * @member {object} [properties.linkedServiceName.parameters] Arguments for + * @property {object} [properties.linkedServiceName.parameters] Arguments for * LinkedService. - * @member {object} [properties.parameters] Parameters for dataset. - * @member {array} [properties.annotations] List of tags that can be used for - * describing the Dataset. - * @member {object} [properties.folder] The folder that this Dataset is in. + * @property {object} [properties.parameters] Parameters for dataset. + * @property {array} [properties.annotations] List of tags that can be used + * for describing the Dataset. + * @property {object} [properties.folder] The folder that this Dataset is in. * If not specified, Dataset will appear at the root level. - * @member {string} [properties.folder.name] The name of the folder that this - * Dataset is in. - * @member {string} [properties.type] Polymorphic Discriminator + * @property {string} [properties.folder.name] The name of the folder that + * this Dataset is in. + * @property {string} [properties.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/datasetStorageFormat.js b/lib/services/datafactoryManagement/lib/models/datasetStorageFormat.js index 8f784c5bf7..1516d0abd9 100644 --- a/lib/services/datafactoryManagement/lib/models/datasetStorageFormat.js +++ b/lib/services/datafactoryManagement/lib/models/datasetStorageFormat.js @@ -17,11 +17,11 @@ class DatasetStorageFormat { /** * Create a DatasetStorageFormat. - * @member {object} [serializer] Serializer. Type: string (or Expression with - * resultType string). - * @member {object} [deserializer] Deserializer. Type: string (or Expression + * @property {object} [serializer] Serializer. Type: string (or Expression * with resultType string). - * @member {string} type Polymorphic Discriminator + * @property {object} [deserializer] Deserializer. Type: string (or + * Expression with resultType string). + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/datasetZipDeflateCompression.js b/lib/services/datafactoryManagement/lib/models/datasetZipDeflateCompression.js index e2a4353c55..c61b855ad4 100644 --- a/lib/services/datafactoryManagement/lib/models/datasetZipDeflateCompression.js +++ b/lib/services/datafactoryManagement/lib/models/datasetZipDeflateCompression.js @@ -20,8 +20,8 @@ const models = require('./index'); class DatasetZipDeflateCompression extends models['DatasetCompression'] { /** * Create a DatasetZipDeflateCompression. - * @member {string} [level] The ZipDeflate compression level. Possible values - * include: 'Optimal', 'Fastest' + * @property {string} [level] The ZipDeflate compression level. Possible + * values include: 'Optimal', 'Fastest' */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/db2LinkedService.js b/lib/services/datafactoryManagement/lib/models/db2LinkedService.js index 49f54f616b..2e75f47b77 100644 --- a/lib/services/datafactoryManagement/lib/models/db2LinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/db2LinkedService.js @@ -20,17 +20,17 @@ const models = require('./index'); class Db2LinkedService extends models['LinkedService'] { /** * Create a Db2LinkedService. - * @member {object} server Server name for connection. Type: string (or + * @property {object} server Server name for connection. Type: string (or * Expression with resultType string). - * @member {object} database Database name for connection. Type: string (or + * @property {object} database Database name for connection. Type: string (or * Expression with resultType string). - * @member {string} [authenticationType] AuthenticationType to be used for + * @property {string} [authenticationType] AuthenticationType to be used for * connection. Possible values include: 'Basic' - * @member {object} [username] Username for authentication. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password for authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [username] Username for authentication. Type: string + * (or Expression with resultType string). + * @property {object} [password] Password for authentication. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/deleteActivity.js b/lib/services/datafactoryManagement/lib/models/deleteActivity.js index a93f67b371..0d05c22a64 100644 --- a/lib/services/datafactoryManagement/lib/models/deleteActivity.js +++ b/lib/services/datafactoryManagement/lib/models/deleteActivity.js @@ -20,12 +20,12 @@ const models = require('./index'); class DeleteActivity extends models['ExecutionActivity'] { /** * Create a DeleteActivity. - * @member {object} [recursive] If true, files under the folder path will be - * deleted recursively. Default is true. Type: boolean (or Expression with + * @property {object} [recursive] If true, files under the folder path will + * be deleted recursively. Default is true. Type: boolean (or Expression with * resultType boolean). - * @member {object} dataset Delete activity dataset reference. - * @member {string} [dataset.referenceName] Reference dataset name. - * @member {object} [dataset.parameters] Arguments for dataset. + * @property {object} dataset Delete activity dataset reference. + * @property {string} [dataset.referenceName] Reference dataset name. + * @property {object} [dataset.parameters] Arguments for dataset. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/dependencyReference.js b/lib/services/datafactoryManagement/lib/models/dependencyReference.js index 9675bbdb77..4797833323 100644 --- a/lib/services/datafactoryManagement/lib/models/dependencyReference.js +++ b/lib/services/datafactoryManagement/lib/models/dependencyReference.js @@ -17,7 +17,7 @@ class DependencyReference { /** * Create a DependencyReference. - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/distcpSettings.js b/lib/services/datafactoryManagement/lib/models/distcpSettings.js index 97b2c93fa4..7df7fe105b 100644 --- a/lib/services/datafactoryManagement/lib/models/distcpSettings.js +++ b/lib/services/datafactoryManagement/lib/models/distcpSettings.js @@ -17,14 +17,14 @@ class DistcpSettings { /** * Create a DistcpSettings. - * @member {object} resourceManagerEndpoint Specifies the Yarn + * @property {object} resourceManagerEndpoint Specifies the Yarn * ResourceManager endpoint. Type: string (or Expression with resultType * string). - * @member {object} tempScriptPath Specifies an existing folder path which + * @property {object} tempScriptPath Specifies an existing folder path which * will be used to store temp Distcp command script. The script file is * generated by ADF and will be removed after Copy job finished. Type: string * (or Expression with resultType string). - * @member {object} [distcpOptions] Specifies the Distcp options. Type: + * @property {object} [distcpOptions] Specifies the Distcp options. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/documentDbCollectionDataset.js b/lib/services/datafactoryManagement/lib/models/documentDbCollectionDataset.js index ac2cfa7c46..338471e355 100644 --- a/lib/services/datafactoryManagement/lib/models/documentDbCollectionDataset.js +++ b/lib/services/datafactoryManagement/lib/models/documentDbCollectionDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class DocumentDbCollectionDataset extends models['Dataset'] { /** * Create a DocumentDbCollectionDataset. - * @member {object} collectionName Document Database collection name. Type: + * @property {object} collectionName Document Database collection name. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/documentDbCollectionSink.js b/lib/services/datafactoryManagement/lib/models/documentDbCollectionSink.js index 8c899dd241..ca7cc9e542 100644 --- a/lib/services/datafactoryManagement/lib/models/documentDbCollectionSink.js +++ b/lib/services/datafactoryManagement/lib/models/documentDbCollectionSink.js @@ -20,7 +20,7 @@ const models = require('./index'); class DocumentDbCollectionSink extends models['CopySink'] { /** * Create a DocumentDbCollectionSink. - * @member {object} [nestingSeparator] Nested properties separator. Default + * @property {object} [nestingSeparator] Nested properties separator. Default * is . (dot). Type: string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/documentDbCollectionSource.js b/lib/services/datafactoryManagement/lib/models/documentDbCollectionSource.js index bfbd58bdce..d7f42616ee 100644 --- a/lib/services/datafactoryManagement/lib/models/documentDbCollectionSource.js +++ b/lib/services/datafactoryManagement/lib/models/documentDbCollectionSource.js @@ -20,9 +20,9 @@ const models = require('./index'); class DocumentDbCollectionSource extends models['CopySource'] { /** * Create a DocumentDbCollectionSource. - * @member {object} [query] Documents query. Type: string (or Expression with - * resultType string). - * @member {object} [nestingSeparator] Nested properties separator. Type: + * @property {object} [query] Documents query. Type: string (or Expression + * with resultType string). + * @property {object} [nestingSeparator] Nested properties separator. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/drillLinkedService.js b/lib/services/datafactoryManagement/lib/models/drillLinkedService.js index c428292293..27c32a29ac 100644 --- a/lib/services/datafactoryManagement/lib/models/drillLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/drillLinkedService.js @@ -20,19 +20,20 @@ const models = require('./index'); class DrillLinkedService extends models['LinkedService'] { /** * Create a DrillLinkedService. - * @member {object} [connectionString] An ODBC connection string. Type: + * @property {object} [connectionString] An ODBC connection string. Type: * string, SecureString or AzureKeyVaultSecretReference. - * @member {object} [pwd] The Azure key vault secret reference of password in - * connection string. - * @member {object} [pwd.store] The Azure Key Vault linked service reference. - * @member {string} [pwd.store.referenceName] Reference LinkedService name. - * @member {object} [pwd.store.parameters] Arguments for LinkedService. - * @member {object} [pwd.secretName] The name of the secret in Azure Key + * @property {object} [pwd] The Azure key vault secret reference of password + * in connection string. + * @property {object} [pwd.store] The Azure Key Vault linked service + * reference. + * @property {string} [pwd.store.referenceName] Reference LinkedService name. + * @property {object} [pwd.store.parameters] Arguments for LinkedService. + * @property {object} [pwd.secretName] The name of the secret in Azure Key * Vault. Type: string (or Expression with resultType string). - * @member {object} [pwd.secretVersion] The version of the secret in Azure + * @property {object} [pwd.secretVersion] The version of the secret in Azure * Key Vault. The default value is the latest version of the secret. Type: * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/drillSource.js b/lib/services/datafactoryManagement/lib/models/drillSource.js index 3728a93bd4..defeb073cd 100644 --- a/lib/services/datafactoryManagement/lib/models/drillSource.js +++ b/lib/services/datafactoryManagement/lib/models/drillSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class DrillSource extends models['CopySource'] { /** * Create a DrillSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/drillTableDataset.js b/lib/services/datafactoryManagement/lib/models/drillTableDataset.js index 0f7e5716f6..eee329fd41 100644 --- a/lib/services/datafactoryManagement/lib/models/drillTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/drillTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class DrillTableDataset extends models['Dataset'] { /** * Create a DrillTableDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/dynamicsEntityDataset.js b/lib/services/datafactoryManagement/lib/models/dynamicsEntityDataset.js index 97f46aae18..d25ec57b78 100644 --- a/lib/services/datafactoryManagement/lib/models/dynamicsEntityDataset.js +++ b/lib/services/datafactoryManagement/lib/models/dynamicsEntityDataset.js @@ -20,8 +20,8 @@ const models = require('./index'); class DynamicsEntityDataset extends models['Dataset'] { /** * Create a DynamicsEntityDataset. - * @member {object} [entityName] The logical name of the entity. Type: string - * (or Expression with resultType string). + * @property {object} [entityName] The logical name of the entity. Type: + * string (or Expression with resultType string). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/dynamicsLinkedService.js b/lib/services/datafactoryManagement/lib/models/dynamicsLinkedService.js index 0b161aea87..4664883800 100644 --- a/lib/services/datafactoryManagement/lib/models/dynamicsLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/dynamicsLinkedService.js @@ -20,31 +20,31 @@ const models = require('./index'); class DynamicsLinkedService extends models['LinkedService'] { /** * Create a DynamicsLinkedService. - * @member {object} deploymentType The deployment type of the Dynamics + * @property {object} deploymentType The deployment type of the Dynamics * instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for * Dynamics on-premises with Ifd. Type: string (or Expression with resultType * string). - * @member {object} [hostName] The host name of the on-premises Dynamics + * @property {object} [hostName] The host name of the on-premises Dynamics * server. The property is required for on-prem and not allowed for online. * Type: string (or Expression with resultType string). - * @member {object} [port] The port of on-premises Dynamics server. The + * @property {object} [port] The port of on-premises Dynamics server. The * property is required for on-prem and not allowed for online. Default is * 443. Type: integer (or Expression with resultType integer), minimum: 0. - * @member {object} [serviceUri] The URL to the Microsoft Dynamics server. + * @property {object} [serviceUri] The URL to the Microsoft Dynamics server. * The property is required for on-line and not allowed for on-prem. Type: * string (or Expression with resultType string). - * @member {object} [organizationName] The organization name of the Dynamics - * instance. The property is required for on-prem and required for online - * when there are more than one Dynamics instances associated with the user. - * Type: string (or Expression with resultType string). - * @member {object} authenticationType The authentication type to connect to - * Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises + * @property {object} [organizationName] The organization name of the + * Dynamics instance. The property is required for on-prem and required for + * online when there are more than one Dynamics instances associated with the + * user. Type: string (or Expression with resultType string). + * @property {object} authenticationType The authentication type to connect + * to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises * with Ifd scenario. Type: string (or Expression with resultType string). - * @member {object} username User name to access the Dynamics instance. Type: - * string (or Expression with resultType string). - * @member {object} [password] Password to access the Dynamics instance. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} username User name to access the Dynamics instance. + * Type: string (or Expression with resultType string). + * @property {object} [password] Password to access the Dynamics instance. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/dynamicsSink.js b/lib/services/datafactoryManagement/lib/models/dynamicsSink.js index 53ed02d91d..5d0fee91a8 100644 --- a/lib/services/datafactoryManagement/lib/models/dynamicsSink.js +++ b/lib/services/datafactoryManagement/lib/models/dynamicsSink.js @@ -20,7 +20,7 @@ const models = require('./index'); class DynamicsSink extends models['CopySink'] { /** * Create a DynamicsSink. - * @member {object} [ignoreNullValues] The flag indicating whether ignore + * @property {object} [ignoreNullValues] The flag indicating whether ignore * null values from input dataset (except key fields) during write operation. * Default is false. Type: boolean (or Expression with resultType boolean). */ diff --git a/lib/services/datafactoryManagement/lib/models/dynamicsSource.js b/lib/services/datafactoryManagement/lib/models/dynamicsSource.js index 2985aaac82..735695d90a 100644 --- a/lib/services/datafactoryManagement/lib/models/dynamicsSource.js +++ b/lib/services/datafactoryManagement/lib/models/dynamicsSource.js @@ -20,8 +20,8 @@ const models = require('./index'); class DynamicsSource extends models['CopySource'] { /** * Create a DynamicsSource. - * @member {object} [query] FetchXML is a proprietary query language that is - * used in Microsoft Dynamics (online & on-premises). Type: string (or + * @property {object} [query] FetchXML is a proprietary query language that + * is used in Microsoft Dynamics (online & on-premises). Type: string (or * Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/eloquaLinkedService.js b/lib/services/datafactoryManagement/lib/models/eloquaLinkedService.js index 98f2b55b8d..af7d4e5ace 100644 --- a/lib/services/datafactoryManagement/lib/models/eloquaLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/eloquaLinkedService.js @@ -20,21 +20,21 @@ const models = require('./index'); class EloquaLinkedService extends models['LinkedService'] { /** * Create a EloquaLinkedService. - * @member {object} endpoint The endpoint of the Eloqua server. (i.e. + * @property {object} endpoint The endpoint of the Eloqua server. (i.e. * eloqua.example.com) - * @member {object} username The site name and user name of your Eloqua + * @property {object} username The site name and user name of your Eloqua * account in the form: sitename/username. (i.e. Eloqua/Alice) - * @member {object} [password] The password corresponding to the user name. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {object} [password] The password corresponding to the user name. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/eloquaObjectDataset.js b/lib/services/datafactoryManagement/lib/models/eloquaObjectDataset.js index ee28233501..01f7f5dbc6 100644 --- a/lib/services/datafactoryManagement/lib/models/eloquaObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/eloquaObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class EloquaObjectDataset extends models['Dataset'] { /** * Create a EloquaObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/eloquaSource.js b/lib/services/datafactoryManagement/lib/models/eloquaSource.js index ad5ffb10e4..2af89f799d 100644 --- a/lib/services/datafactoryManagement/lib/models/eloquaSource.js +++ b/lib/services/datafactoryManagement/lib/models/eloquaSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class EloquaSource extends models['CopySource'] { /** * Create a EloquaSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/executePipelineActivity.js b/lib/services/datafactoryManagement/lib/models/executePipelineActivity.js index a7f683daa2..298f7c74a3 100644 --- a/lib/services/datafactoryManagement/lib/models/executePipelineActivity.js +++ b/lib/services/datafactoryManagement/lib/models/executePipelineActivity.js @@ -20,11 +20,12 @@ const models = require('./index'); class ExecutePipelineActivity extends models['ControlActivity'] { /** * Create a ExecutePipelineActivity. - * @member {object} pipelineProperty Pipeline reference. - * @member {string} [pipelineProperty.referenceName] Reference pipeline name. - * @member {string} [pipelineProperty.name] Reference name. - * @member {object} [parameters] Pipeline parameters. - * @member {boolean} [waitOnCompletion] Defines whether activity execution + * @property {object} pipelineProperty Pipeline reference. + * @property {string} [pipelineProperty.referenceName] Reference pipeline + * name. + * @property {string} [pipelineProperty.name] Reference name. + * @property {object} [parameters] Pipeline parameters. + * @property {boolean} [waitOnCompletion] Defines whether activity execution * will wait for the dependent pipeline execution to finish. Default is * false. */ diff --git a/lib/services/datafactoryManagement/lib/models/executeSSISPackageActivity.js b/lib/services/datafactoryManagement/lib/models/executeSSISPackageActivity.js index bc961a82c9..c1ae10472f 100644 --- a/lib/services/datafactoryManagement/lib/models/executeSSISPackageActivity.js +++ b/lib/services/datafactoryManagement/lib/models/executeSSISPackageActivity.js @@ -20,29 +20,29 @@ const models = require('./index'); class ExecuteSSISPackageActivity extends models['ExecutionActivity'] { /** * Create a ExecuteSSISPackageActivity. - * @member {object} packageLocation SSIS package location. - * @member {string} [packageLocation.packagePath] The SSIS package path. - * @member {string} [runtime] Specifies the runtime to execute SSIS package. - * Possible values include: 'x64', 'x86' - * @member {string} [loggingLevel] The logging level of SSIS package + * @property {object} packageLocation SSIS package location. + * @property {string} [packageLocation.packagePath] The SSIS package path. + * @property {string} [runtime] Specifies the runtime to execute SSIS + * package. Possible values include: 'x64', 'x86' + * @property {string} [loggingLevel] The logging level of SSIS package * execution. - * @member {string} [environmentPath] The environment path to execute the + * @property {string} [environmentPath] The environment path to execute the * SSIS package. - * @member {object} connectVia The integration runtime reference. - * @member {string} [connectVia.referenceName] Reference integration runtime - * name. - * @member {object} [connectVia.parameters] Arguments for integration + * @property {object} connectVia The integration runtime reference. + * @property {string} [connectVia.referenceName] Reference integration + * runtime name. + * @property {object} [connectVia.parameters] Arguments for integration * runtime. - * @member {object} [projectParameters] The project level parameters to + * @property {object} [projectParameters] The project level parameters to * execute the SSIS package. - * @member {object} [packageParameters] The package level parameters to + * @property {object} [packageParameters] The package level parameters to * execute the SSIS package. - * @member {object} [projectConnectionManagers] The project level connection - * managers to execute the SSIS package. - * @member {object} [packageConnectionManagers] The package level connection - * managers to execute the SSIS package. - * @member {object} [propertyOverrides] The property overrides to execute the - * SSIS package. + * @property {object} [projectConnectionManagers] The project level + * connection managers to execute the SSIS package. + * @property {object} [packageConnectionManagers] The package level + * connection managers to execute the SSIS package. + * @property {object} [propertyOverrides] The property overrides to execute + * the SSIS package. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/executionActivity.js b/lib/services/datafactoryManagement/lib/models/executionActivity.js index 2dadb92822..53218e1899 100644 --- a/lib/services/datafactoryManagement/lib/models/executionActivity.js +++ b/lib/services/datafactoryManagement/lib/models/executionActivity.js @@ -20,23 +20,23 @@ const models = require('./index'); class ExecutionActivity extends models['Activity'] { /** * Create a ExecutionActivity. - * @member {object} [linkedServiceName] Linked service reference. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for + * @property {object} [linkedServiceName] Linked service reference. + * @property {string} [linkedServiceName.referenceName] Reference + * LinkedService name. + * @property {object} [linkedServiceName.parameters] Arguments for * LinkedService. - * @member {object} [policy] Activity policy. - * @member {object} [policy.timeout] Specifies the timeout for the activity + * @property {object} [policy] Activity policy. + * @property {object} [policy.timeout] Specifies the timeout for the activity * to run. The default timeout is 7 days. Type: string (or Expression with * resultType string), pattern: * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {object} [policy.retry] Maximum ordinary retry attempts. Default + * @property {object} [policy.retry] Maximum ordinary retry attempts. Default * is 0. Type: integer (or Expression with resultType integer), minimum: 0. - * @member {number} [policy.retryIntervalInSeconds] Interval between each + * @property {number} [policy.retryIntervalInSeconds] Interval between each * retry attempt (in seconds). The default is 30 sec. - * @member {boolean} [policy.secureInput] When set to true, Input from + * @property {boolean} [policy.secureInput] When set to true, Input from * activity is considered as secure and will not be logged to monitoring. - * @member {boolean} [policy.secureOutput] When set to true, Output from + * @property {boolean} [policy.secureOutput] When set to true, Output from * activity is considered as secure and will not be logged to monitoring. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/expression.js b/lib/services/datafactoryManagement/lib/models/expression.js index 5a2347f5c0..946a50f1f8 100644 --- a/lib/services/datafactoryManagement/lib/models/expression.js +++ b/lib/services/datafactoryManagement/lib/models/expression.js @@ -17,7 +17,7 @@ class Expression { /** * Create a Expression. - * @member {string} value Expression value. + * @property {string} value Expression value. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/factory.js b/lib/services/datafactoryManagement/lib/models/factory.js index 42151c6f38..1baa4a7507 100644 --- a/lib/services/datafactoryManagement/lib/models/factory.js +++ b/lib/services/datafactoryManagement/lib/models/factory.js @@ -20,22 +20,23 @@ const models = require('./index'); class Factory extends models['Resource'] { /** * Create a Factory. - * @member {object} [identity] Managed service identity of the factory. - * @member {uuid} [identity.principalId] The principal id of the identity. - * @member {uuid} [identity.tenantId] The client tenant id of the identity. - * @member {string} [provisioningState] Factory provisioning state, example + * @property {object} [identity] Managed service identity of the factory. + * @property {uuid} [identity.principalId] The principal id of the identity. + * @property {uuid} [identity.tenantId] The client tenant id of the identity. + * @property {string} [provisioningState] Factory provisioning state, example * Succeeded. - * @member {date} [createTime] Time the factory was created in ISO8601 + * @property {date} [createTime] Time the factory was created in ISO8601 * format. - * @member {string} [version] Version of the factory. - * @member {object} [repoConfiguration] Git repo information of the factory. - * @member {string} [repoConfiguration.accountName] Account name. - * @member {string} [repoConfiguration.repositoryName] Rrepository name. - * @member {string} [repoConfiguration.collaborationBranch] Collaboration + * @property {string} [version] Version of the factory. + * @property {object} [repoConfiguration] Git repo information of the + * factory. + * @property {string} [repoConfiguration.accountName] Account name. + * @property {string} [repoConfiguration.repositoryName] Rrepository name. + * @property {string} [repoConfiguration.collaborationBranch] Collaboration * branch. - * @member {string} [repoConfiguration.rootFolder] Root folder. - * @member {string} [repoConfiguration.lastCommitId] Last commit id. - * @member {string} [repoConfiguration.type] Polymorphic Discriminator + * @property {string} [repoConfiguration.rootFolder] Root folder. + * @property {string} [repoConfiguration.lastCommitId] Last commit id. + * @property {string} [repoConfiguration.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/factoryGitHubConfiguration.js b/lib/services/datafactoryManagement/lib/models/factoryGitHubConfiguration.js index a485851c3b..988c6b8ee3 100644 --- a/lib/services/datafactoryManagement/lib/models/factoryGitHubConfiguration.js +++ b/lib/services/datafactoryManagement/lib/models/factoryGitHubConfiguration.js @@ -20,7 +20,7 @@ const models = require('./index'); class FactoryGitHubConfiguration extends models['FactoryRepoConfiguration'] { /** * Create a FactoryGitHubConfiguration. - * @member {string} [hostName] GitHub Enterprise host name. For example: + * @property {string} [hostName] GitHub Enterprise host name. For example: * https://github.mydomain.com */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/factoryIdentity.js b/lib/services/datafactoryManagement/lib/models/factoryIdentity.js index bc41f7dfce..b15e325141 100644 --- a/lib/services/datafactoryManagement/lib/models/factoryIdentity.js +++ b/lib/services/datafactoryManagement/lib/models/factoryIdentity.js @@ -17,8 +17,8 @@ class FactoryIdentity { /** * Create a FactoryIdentity. - * @member {uuid} [principalId] The principal id of the identity. - * @member {uuid} [tenantId] The client tenant id of the identity. + * @property {uuid} [principalId] The principal id of the identity. + * @property {uuid} [tenantId] The client tenant id of the identity. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/factoryListResponse.js b/lib/services/datafactoryManagement/lib/models/factoryListResponse.js index ba340d314f..cacd521574 100644 --- a/lib/services/datafactoryManagement/lib/models/factoryListResponse.js +++ b/lib/services/datafactoryManagement/lib/models/factoryListResponse.js @@ -16,7 +16,7 @@ class FactoryListResponse extends Array { /** * Create a FactoryListResponse. - * @member {string} [nextLink] The link to the next page of results, if any + * @property {string} [nextLink] The link to the next page of results, if any * remaining results exist. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/factoryRepoConfiguration.js b/lib/services/datafactoryManagement/lib/models/factoryRepoConfiguration.js index fed15a1a80..2e50adb8a1 100644 --- a/lib/services/datafactoryManagement/lib/models/factoryRepoConfiguration.js +++ b/lib/services/datafactoryManagement/lib/models/factoryRepoConfiguration.js @@ -17,12 +17,12 @@ class FactoryRepoConfiguration { /** * Create a FactoryRepoConfiguration. - * @member {string} accountName Account name. - * @member {string} repositoryName Rrepository name. - * @member {string} collaborationBranch Collaboration branch. - * @member {string} rootFolder Root folder. - * @member {string} [lastCommitId] Last commit id. - * @member {string} type Polymorphic Discriminator + * @property {string} accountName Account name. + * @property {string} repositoryName Rrepository name. + * @property {string} collaborationBranch Collaboration branch. + * @property {string} rootFolder Root folder. + * @property {string} [lastCommitId] Last commit id. + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/factoryRepoUpdate.js b/lib/services/datafactoryManagement/lib/models/factoryRepoUpdate.js index 5d5753ac57..56333c1efe 100644 --- a/lib/services/datafactoryManagement/lib/models/factoryRepoUpdate.js +++ b/lib/services/datafactoryManagement/lib/models/factoryRepoUpdate.js @@ -17,15 +17,16 @@ class FactoryRepoUpdate { /** * Create a FactoryRepoUpdate. - * @member {string} [factoryResourceId] The factory resource id. - * @member {object} [repoConfiguration] Git repo information of the factory. - * @member {string} [repoConfiguration.accountName] Account name. - * @member {string} [repoConfiguration.repositoryName] Rrepository name. - * @member {string} [repoConfiguration.collaborationBranch] Collaboration + * @property {string} [factoryResourceId] The factory resource id. + * @property {object} [repoConfiguration] Git repo information of the + * factory. + * @property {string} [repoConfiguration.accountName] Account name. + * @property {string} [repoConfiguration.repositoryName] Rrepository name. + * @property {string} [repoConfiguration.collaborationBranch] Collaboration * branch. - * @member {string} [repoConfiguration.rootFolder] Root folder. - * @member {string} [repoConfiguration.lastCommitId] Last commit id. - * @member {string} [repoConfiguration.type] Polymorphic Discriminator + * @property {string} [repoConfiguration.rootFolder] Root folder. + * @property {string} [repoConfiguration.lastCommitId] Last commit id. + * @property {string} [repoConfiguration.type] Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/factoryUpdateParameters.js b/lib/services/datafactoryManagement/lib/models/factoryUpdateParameters.js index 2e579e7b49..95433db561 100644 --- a/lib/services/datafactoryManagement/lib/models/factoryUpdateParameters.js +++ b/lib/services/datafactoryManagement/lib/models/factoryUpdateParameters.js @@ -17,10 +17,10 @@ class FactoryUpdateParameters { /** * Create a FactoryUpdateParameters. - * @member {object} [tags] The resource tags. - * @member {object} [identity] Managed service identity of the factory. - * @member {uuid} [identity.principalId] The principal id of the identity. - * @member {uuid} [identity.tenantId] The client tenant id of the identity. + * @property {object} [tags] The resource tags. + * @property {object} [identity] Managed service identity of the factory. + * @property {uuid} [identity.principalId] The principal id of the identity. + * @property {uuid} [identity.tenantId] The client tenant id of the identity. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/factoryVSTSConfiguration.js b/lib/services/datafactoryManagement/lib/models/factoryVSTSConfiguration.js index df68d3d378..abd624a719 100644 --- a/lib/services/datafactoryManagement/lib/models/factoryVSTSConfiguration.js +++ b/lib/services/datafactoryManagement/lib/models/factoryVSTSConfiguration.js @@ -20,8 +20,8 @@ const models = require('./index'); class FactoryVSTSConfiguration extends models['FactoryRepoConfiguration'] { /** * Create a FactoryVSTSConfiguration. - * @member {string} projectName VSTS project name. - * @member {string} [tenantId] VSTS tenant id. + * @property {string} projectName VSTS project name. + * @property {string} [tenantId] VSTS tenant id. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/fileServerLinkedService.js b/lib/services/datafactoryManagement/lib/models/fileServerLinkedService.js index 611b0f08a5..cd7a979cc8 100644 --- a/lib/services/datafactoryManagement/lib/models/fileServerLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/fileServerLinkedService.js @@ -20,13 +20,13 @@ const models = require('./index'); class FileServerLinkedService extends models['LinkedService'] { /** * Create a FileServerLinkedService. - * @member {object} host Host name of the server. Type: string (or Expression - * with resultType string). - * @member {object} [userId] User ID to logon the server. Type: string (or + * @property {object} host Host name of the server. Type: string (or * Expression with resultType string). - * @member {object} [password] Password to logon the server. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [userId] User ID to logon the server. Type: string (or + * Expression with resultType string). + * @property {object} [password] Password to logon the server. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/fileShareDataset.js b/lib/services/datafactoryManagement/lib/models/fileShareDataset.js index 032ebb6bf4..060c68d204 100644 --- a/lib/services/datafactoryManagement/lib/models/fileShareDataset.js +++ b/lib/services/datafactoryManagement/lib/models/fileShareDataset.js @@ -20,22 +20,22 @@ const models = require('./index'); class FileShareDataset extends models['Dataset'] { /** * Create a FileShareDataset. - * @member {object} [folderPath] The path of the on-premises file system. + * @property {object} [folderPath] The path of the on-premises file system. * Type: string (or Expression with resultType string). - * @member {object} [fileName] The name of the on-premises file system. Type: - * string (or Expression with resultType string). - * @member {object} [format] The format of the files. - * @member {object} [format.serializer] Serializer. Type: string (or + * @property {object} [fileName] The name of the on-premises file system. + * Type: string (or Expression with resultType string). + * @property {object} [format] The format of the files. + * @property {object} [format.serializer] Serializer. Type: string (or * Expression with resultType string). - * @member {object} [format.deserializer] Deserializer. Type: string (or + * @property {object} [format.deserializer] Deserializer. Type: string (or * Expression with resultType string). - * @member {string} [format.type] Polymorphic Discriminator - * @member {object} [fileFilter] Specify a filter to be used to select a + * @property {string} [format.type] Polymorphic Discriminator + * @property {object} [fileFilter] Specify a filter to be used to select a * subset of files in the folderPath rather than all files. Type: string (or * Expression with resultType string). - * @member {object} [compression] The data compression method used for the + * @property {object} [compression] The data compression method used for the * file system. - * @member {string} [compression.type] Polymorphic Discriminator + * @property {string} [compression.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/fileSystemSink.js b/lib/services/datafactoryManagement/lib/models/fileSystemSink.js index cc5f6e5d72..700bbe8260 100644 --- a/lib/services/datafactoryManagement/lib/models/fileSystemSink.js +++ b/lib/services/datafactoryManagement/lib/models/fileSystemSink.js @@ -20,7 +20,7 @@ const models = require('./index'); class FileSystemSink extends models['CopySink'] { /** * Create a FileSystemSink. - * @member {string} [copyBehavior] The type of copy behavior for copy sink. + * @property {string} [copyBehavior] The type of copy behavior for copy sink. * Possible values include: 'PreserveHierarchy', 'FlattenHierarchy', * 'MergeFiles' */ diff --git a/lib/services/datafactoryManagement/lib/models/fileSystemSource.js b/lib/services/datafactoryManagement/lib/models/fileSystemSource.js index aa7f667c83..ca5d732f0a 100644 --- a/lib/services/datafactoryManagement/lib/models/fileSystemSource.js +++ b/lib/services/datafactoryManagement/lib/models/fileSystemSource.js @@ -20,8 +20,8 @@ const models = require('./index'); class FileSystemSource extends models['CopySource'] { /** * Create a FileSystemSource. - * @member {object} [recursive] If true, files under the folder path will be - * read recursively. Default is true. Type: boolean (or Expression with + * @property {object} [recursive] If true, files under the folder path will + * be read recursively. Default is true. Type: boolean (or Expression with * resultType boolean). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/filterActivity.js b/lib/services/datafactoryManagement/lib/models/filterActivity.js index fecec0d9d0..d29f294524 100644 --- a/lib/services/datafactoryManagement/lib/models/filterActivity.js +++ b/lib/services/datafactoryManagement/lib/models/filterActivity.js @@ -20,10 +20,10 @@ const models = require('./index'); class FilterActivity extends models['ControlActivity'] { /** * Create a FilterActivity. - * @member {object} items Input array on which filter should be applied. - * @member {string} [items.value] Expression value. - * @member {object} condition Condition to be used for filtering the input. - * @member {string} [condition.value] Expression value. + * @property {object} items Input array on which filter should be applied. + * @property {string} [items.value] Expression value. + * @property {object} condition Condition to be used for filtering the input. + * @property {string} [condition.value] Expression value. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/forEachActivity.js b/lib/services/datafactoryManagement/lib/models/forEachActivity.js index c876215d15..5aaab99619 100644 --- a/lib/services/datafactoryManagement/lib/models/forEachActivity.js +++ b/lib/services/datafactoryManagement/lib/models/forEachActivity.js @@ -21,13 +21,13 @@ const models = require('./index'); class ForEachActivity extends models['ControlActivity'] { /** * Create a ForEachActivity. - * @member {boolean} [isSequential] Should the loop be executed in sequence + * @property {boolean} [isSequential] Should the loop be executed in sequence * or in parallel (max 50) - * @member {number} [batchCount] Batch count to be used for controlling the + * @property {number} [batchCount] Batch count to be used for controlling the * number of parallel execution (when isSequential is set to false). - * @member {object} items Collection to iterate. - * @member {string} [items.value] Expression value. - * @member {array} activities List of activities to execute . + * @property {object} items Collection to iterate. + * @property {string} [items.value] Expression value. + * @property {array} activities List of activities to execute . */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/ftpServerLinkedService.js b/lib/services/datafactoryManagement/lib/models/ftpServerLinkedService.js index 32cebadc3a..6a15860426 100644 --- a/lib/services/datafactoryManagement/lib/models/ftpServerLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/ftpServerLinkedService.js @@ -20,26 +20,26 @@ const models = require('./index'); class FtpServerLinkedService extends models['LinkedService'] { /** * Create a FtpServerLinkedService. - * @member {object} host Host name of the FTP server. Type: string (or + * @property {object} host Host name of the FTP server. Type: string (or * Expression with resultType string). - * @member {object} [port] The TCP port number that the FTP server uses to + * @property {object} [port] The TCP port number that the FTP server uses to * listen for client connections. Default value is 21. Type: integer (or * Expression with resultType integer), minimum: 0. - * @member {string} [authenticationType] The authentication type to be used + * @property {string} [authenticationType] The authentication type to be used * to connect to the FTP server. Possible values include: 'Basic', * 'Anonymous' - * @member {object} [userName] Username to logon the FTP server. Type: string - * (or Expression with resultType string). - * @member {object} [password] Password to logon the FTP server. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [userName] Username to logon the FTP server. Type: + * string (or Expression with resultType string). + * @property {object} [password] Password to logon the FTP server. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). - * @member {object} [enableSsl] If true, connect to the FTP server over + * @property {object} [enableSsl] If true, connect to the FTP server over * SSL/TLS channel. Default value is true. Type: boolean (or Expression with * resultType boolean). - * @member {object} [enableServerCertificateValidation] If true, validate the - * FTP server SSL certificate when connect over SSL/TLS channel. Default + * @property {object} [enableServerCertificateValidation] If true, validate + * the FTP server SSL certificate when connect over SSL/TLS channel. Default * value is true. Type: boolean (or Expression with resultType boolean). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/getMetadataActivity.js b/lib/services/datafactoryManagement/lib/models/getMetadataActivity.js index bae4fcffd2..4b33934898 100644 --- a/lib/services/datafactoryManagement/lib/models/getMetadataActivity.js +++ b/lib/services/datafactoryManagement/lib/models/getMetadataActivity.js @@ -20,10 +20,10 @@ const models = require('./index'); class GetMetadataActivity extends models['ExecutionActivity'] { /** * Create a GetMetadataActivity. - * @member {object} dataset GetMetadata activity dataset reference. - * @member {string} [dataset.referenceName] Reference dataset name. - * @member {object} [dataset.parameters] Arguments for dataset. - * @member {array} [fieldList] Fields of metadata to get from dataset. + * @property {object} dataset GetMetadata activity dataset reference. + * @property {string} [dataset.referenceName] Reference dataset name. + * @property {object} [dataset.parameters] Arguments for dataset. + * @property {array} [fieldList] Fields of metadata to get from dataset. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/gitHubAccessTokenRequest.js b/lib/services/datafactoryManagement/lib/models/gitHubAccessTokenRequest.js index 888fe8443f..0924720d5f 100644 --- a/lib/services/datafactoryManagement/lib/models/gitHubAccessTokenRequest.js +++ b/lib/services/datafactoryManagement/lib/models/gitHubAccessTokenRequest.js @@ -17,9 +17,9 @@ class GitHubAccessTokenRequest { /** * Create a GitHubAccessTokenRequest. - * @member {string} gitHubAccessCode GitHub access code. - * @member {string} [gitHubClientId] GitHub application client ID. - * @member {string} gitHubAccessTokenBaseUrl GitHub access token base URL. + * @property {string} gitHubAccessCode GitHub access code. + * @property {string} [gitHubClientId] GitHub application client ID. + * @property {string} gitHubAccessTokenBaseUrl GitHub access token base URL. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/gitHubAccessTokenResponse.js b/lib/services/datafactoryManagement/lib/models/gitHubAccessTokenResponse.js index 3623fa9a8d..1e2705ba61 100644 --- a/lib/services/datafactoryManagement/lib/models/gitHubAccessTokenResponse.js +++ b/lib/services/datafactoryManagement/lib/models/gitHubAccessTokenResponse.js @@ -17,7 +17,7 @@ class GitHubAccessTokenResponse { /** * Create a GitHubAccessTokenResponse. - * @member {string} [gitHubAccessToken] GitHub access token. + * @property {string} [gitHubAccessToken] GitHub access token. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/googleBigQueryLinkedService.js b/lib/services/datafactoryManagement/lib/models/googleBigQueryLinkedService.js index 82c6ef9884..1540a21ec2 100644 --- a/lib/services/datafactoryManagement/lib/models/googleBigQueryLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/googleBigQueryLinkedService.js @@ -20,40 +20,40 @@ const models = require('./index'); class GoogleBigQueryLinkedService extends models['LinkedService'] { /** * Create a GoogleBigQueryLinkedService. - * @member {object} project The default BigQuery project to query against. - * @member {object} [additionalProjects] A comma-separated list of public + * @property {object} project The default BigQuery project to query against. + * @property {object} [additionalProjects] A comma-separated list of public * BigQuery projects to access. - * @member {object} [requestGoogleDriveScope] Whether to request access to + * @property {object} [requestGoogleDriveScope] Whether to request access to * Google Drive. Allowing Google Drive access enables support for federated * tables that combine BigQuery data with data from Google Drive. The default * value is false. - * @member {string} authenticationType The OAuth 2.0 authentication mechanism - * used for authentication. ServiceAuthentication can only be used on - * self-hosted IR. Possible values include: 'ServiceAuthentication', + * @property {string} authenticationType The OAuth 2.0 authentication + * mechanism used for authentication. ServiceAuthentication can only be used + * on self-hosted IR. Possible values include: 'ServiceAuthentication', * 'UserAuthentication' - * @member {object} [refreshToken] The refresh token obtained from Google for - * authorizing access to BigQuery for UserAuthentication. - * @member {string} [refreshToken.type] Polymorphic Discriminator - * @member {object} [clientId] The client id of the google application used + * @property {object} [refreshToken] The refresh token obtained from Google + * for authorizing access to BigQuery for UserAuthentication. + * @property {string} [refreshToken.type] Polymorphic Discriminator + * @property {object} [clientId] The client id of the google application used * to acquire the refresh token. - * @member {string} [clientId.type] Polymorphic Discriminator - * @member {object} [clientSecret] The client secret of the google + * @property {string} [clientId.type] Polymorphic Discriminator + * @property {object} [clientSecret] The client secret of the google * application used to acquire the refresh token. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [email] The service account email ID that is used for + * @property {string} [clientSecret.type] Polymorphic Discriminator + * @property {object} [email] The service account email ID that is used for * ServiceAuthentication and can only be used on self-hosted IR. - * @member {object} [keyFilePath] The full path to the .p12 key file that is - * used to authenticate the service account email address and can only be + * @property {object} [keyFilePath] The full path to the .p12 key file that + * is used to authenticate the service account email address and can only be * used on self-hosted IR. - * @member {object} [trustedCertPath] The full path of the .pem file + * @property {object} [trustedCertPath] The full path of the .pem file * containing trusted CA certificates for verifying the server when * connecting over SSL. This property can only be set when using SSL on * self-hosted IR. The default value is the cacerts.pem file installed with * the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA + * @property {object} [useSystemTrustStore] Specifies whether to use a CA * certificate from the system trust store or from a specified PEM file. The * default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/googleBigQueryObjectDataset.js b/lib/services/datafactoryManagement/lib/models/googleBigQueryObjectDataset.js index 2028c1fb42..345f675d5b 100644 --- a/lib/services/datafactoryManagement/lib/models/googleBigQueryObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/googleBigQueryObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class GoogleBigQueryObjectDataset extends models['Dataset'] { /** * Create a GoogleBigQueryObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/googleBigQuerySource.js b/lib/services/datafactoryManagement/lib/models/googleBigQuerySource.js index e4015ac8df..b73bc055ad 100644 --- a/lib/services/datafactoryManagement/lib/models/googleBigQuerySource.js +++ b/lib/services/datafactoryManagement/lib/models/googleBigQuerySource.js @@ -20,7 +20,7 @@ const models = require('./index'); class GoogleBigQuerySource extends models['CopySource'] { /** * Create a GoogleBigQuerySource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/greenplumLinkedService.js b/lib/services/datafactoryManagement/lib/models/greenplumLinkedService.js index a898e83d25..b04eec76c4 100644 --- a/lib/services/datafactoryManagement/lib/models/greenplumLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/greenplumLinkedService.js @@ -20,19 +20,20 @@ const models = require('./index'); class GreenplumLinkedService extends models['LinkedService'] { /** * Create a GreenplumLinkedService. - * @member {object} [connectionString] An ODBC connection string. Type: + * @property {object} [connectionString] An ODBC connection string. Type: * string, SecureString or AzureKeyVaultSecretReference. - * @member {object} [pwd] The Azure key vault secret reference of password in - * connection string. - * @member {object} [pwd.store] The Azure Key Vault linked service reference. - * @member {string} [pwd.store.referenceName] Reference LinkedService name. - * @member {object} [pwd.store.parameters] Arguments for LinkedService. - * @member {object} [pwd.secretName] The name of the secret in Azure Key + * @property {object} [pwd] The Azure key vault secret reference of password + * in connection string. + * @property {object} [pwd.store] The Azure Key Vault linked service + * reference. + * @property {string} [pwd.store.referenceName] Reference LinkedService name. + * @property {object} [pwd.store.parameters] Arguments for LinkedService. + * @property {object} [pwd.secretName] The name of the secret in Azure Key * Vault. Type: string (or Expression with resultType string). - * @member {object} [pwd.secretVersion] The version of the secret in Azure + * @property {object} [pwd.secretVersion] The version of the secret in Azure * Key Vault. The default value is the latest version of the secret. Type: * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/greenplumSource.js b/lib/services/datafactoryManagement/lib/models/greenplumSource.js index c91f576a42..b24f231d72 100644 --- a/lib/services/datafactoryManagement/lib/models/greenplumSource.js +++ b/lib/services/datafactoryManagement/lib/models/greenplumSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class GreenplumSource extends models['CopySource'] { /** * Create a GreenplumSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/greenplumTableDataset.js b/lib/services/datafactoryManagement/lib/models/greenplumTableDataset.js index c6603e234a..de2eacaab4 100644 --- a/lib/services/datafactoryManagement/lib/models/greenplumTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/greenplumTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class GreenplumTableDataset extends models['Dataset'] { /** * Create a GreenplumTableDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/hBaseLinkedService.js b/lib/services/datafactoryManagement/lib/models/hBaseLinkedService.js index 6f4bbab94c..26ce75e5dc 100644 --- a/lib/services/datafactoryManagement/lib/models/hBaseLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/hBaseLinkedService.js @@ -20,31 +20,32 @@ const models = require('./index'); class HBaseLinkedService extends models['LinkedService'] { /** * Create a HBaseLinkedService. - * @member {object} host The IP address or host name of the HBase server. + * @property {object} host The IP address or host name of the HBase server. * (i.e. 192.168.222.160) - * @member {object} [port] The TCP port that the HBase instance uses to + * @property {object} [port] The TCP port that the HBase instance uses to * listen for client connections. The default value is 9090. - * @member {object} [httpPath] The partial URL corresponding to the HBase + * @property {object} [httpPath] The partial URL corresponding to the HBase * server. (i.e. /gateway/sandbox/hbase/version) - * @member {string} authenticationType The authentication mechanism to use to - * connect to the HBase server. Possible values include: 'Anonymous', 'Basic' - * @member {object} [username] The user name used to connect to the HBase + * @property {string} authenticationType The authentication mechanism to use + * to connect to the HBase server. Possible values include: 'Anonymous', + * 'Basic' + * @property {object} [username] The user name used to connect to the HBase * instance. - * @member {object} [password] The password corresponding to the user name. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [enableSsl] Specifies whether the connections to the + * @property {object} [password] The password corresponding to the user name. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [enableSsl] Specifies whether the connections to the * server are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file + * @property {object} [trustedCertPath] The full path of the .pem file * containing trusted CA certificates for verifying the server when * connecting over SSL. This property can only be set when using SSL on * self-hosted IR. The default value is the cacerts.pem file installed with * the IR. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when + * @property {object} [allowHostNameCNMismatch] Specifies whether to require + * a CA-issued SSL certificate name to match the host name of the server when * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow + * @property {object} [allowSelfSignedServerCert] Specifies whether to allow * self-signed certificates from the server. The default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/hBaseObjectDataset.js b/lib/services/datafactoryManagement/lib/models/hBaseObjectDataset.js index af3f68907d..ed9635e7a7 100644 --- a/lib/services/datafactoryManagement/lib/models/hBaseObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/hBaseObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class HBaseObjectDataset extends models['Dataset'] { /** * Create a HBaseObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/hBaseSource.js b/lib/services/datafactoryManagement/lib/models/hBaseSource.js index 96d8333833..ecfd1e3759 100644 --- a/lib/services/datafactoryManagement/lib/models/hBaseSource.js +++ b/lib/services/datafactoryManagement/lib/models/hBaseSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class HBaseSource extends models['CopySource'] { /** * Create a HBaseSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/hDInsightHiveActivity.js b/lib/services/datafactoryManagement/lib/models/hDInsightHiveActivity.js index 53e88784c6..ea1f8c5f70 100644 --- a/lib/services/datafactoryManagement/lib/models/hDInsightHiveActivity.js +++ b/lib/services/datafactoryManagement/lib/models/hDInsightHiveActivity.js @@ -20,19 +20,20 @@ const models = require('./index'); class HDInsightHiveActivity extends models['ExecutionActivity'] { /** * Create a HDInsightHiveActivity. - * @member {array} [storageLinkedServices] Storage linked service references. - * @member {array} [argumentsProperty] User specified arguments to + * @property {array} [storageLinkedServices] Storage linked service + * references. + * @property {array} [argumentsProperty] User specified arguments to * HDInsightActivity. - * @member {string} [getDebugInfo] Debug info option. Possible values + * @property {string} [getDebugInfo] Debug info option. Possible values * include: 'None', 'Always', 'Failure' - * @member {object} [scriptPath] Script path. Type: string (or Expression + * @property {object} [scriptPath] Script path. Type: string (or Expression * with resultType string). - * @member {object} [scriptLinkedService] Script linked service reference. - * @member {string} [scriptLinkedService.referenceName] Reference + * @property {object} [scriptLinkedService] Script linked service reference. + * @property {string} [scriptLinkedService.referenceName] Reference * LinkedService name. - * @member {object} [scriptLinkedService.parameters] Arguments for + * @property {object} [scriptLinkedService.parameters] Arguments for * LinkedService. - * @member {object} [defines] Allows user to specify defines for Hive job + * @property {object} [defines] Allows user to specify defines for Hive job * request. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/hDInsightLinkedService.js b/lib/services/datafactoryManagement/lib/models/hDInsightLinkedService.js index 73f24a977b..c8be0e5e11 100644 --- a/lib/services/datafactoryManagement/lib/models/hDInsightLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/hDInsightLinkedService.js @@ -20,25 +20,25 @@ const models = require('./index'); class HDInsightLinkedService extends models['LinkedService'] { /** * Create a HDInsightLinkedService. - * @member {object} clusterUri HDInsight cluster URI. Type: string (or + * @property {object} clusterUri HDInsight cluster URI. Type: string (or * Expression with resultType string). - * @member {object} [userName] HDInsight cluster user name. Type: string (or - * Expression with resultType string). - * @member {object} [password] HDInsight cluster password. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [linkedServiceName] The Azure Storage linked service + * @property {object} [userName] HDInsight cluster user name. Type: string + * (or Expression with resultType string). + * @property {object} [password] HDInsight cluster password. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [linkedServiceName] The Azure Storage linked service * reference. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for + * @property {string} [linkedServiceName.referenceName] Reference + * LinkedService name. + * @property {object} [linkedServiceName.parameters] Arguments for * LinkedService. - * @member {object} [hcatalogLinkedServiceName] A reference to the Azure SQL - * linked service that points to the HCatalog database. - * @member {string} [hcatalogLinkedServiceName.referenceName] Reference + * @property {object} [hcatalogLinkedServiceName] A reference to the Azure + * SQL linked service that points to the HCatalog database. + * @property {string} [hcatalogLinkedServiceName.referenceName] Reference * LinkedService name. - * @member {object} [hcatalogLinkedServiceName.parameters] Arguments for + * @property {object} [hcatalogLinkedServiceName.parameters] Arguments for * LinkedService. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/hDInsightMapReduceActivity.js b/lib/services/datafactoryManagement/lib/models/hDInsightMapReduceActivity.js index 54fb8013a2..af2cf24e07 100644 --- a/lib/services/datafactoryManagement/lib/models/hDInsightMapReduceActivity.js +++ b/lib/services/datafactoryManagement/lib/models/hDInsightMapReduceActivity.js @@ -20,22 +20,23 @@ const models = require('./index'); class HDInsightMapReduceActivity extends models['ExecutionActivity'] { /** * Create a HDInsightMapReduceActivity. - * @member {array} [storageLinkedServices] Storage linked service references. - * @member {array} [argumentsProperty] User specified arguments to + * @property {array} [storageLinkedServices] Storage linked service + * references. + * @property {array} [argumentsProperty] User specified arguments to * HDInsightActivity. - * @member {string} [getDebugInfo] Debug info option. Possible values + * @property {string} [getDebugInfo] Debug info option. Possible values * include: 'None', 'Always', 'Failure' - * @member {object} className Class name. Type: string (or Expression with + * @property {object} className Class name. Type: string (or Expression with * resultType string). - * @member {object} jarFilePath Jar path. Type: string (or Expression with + * @property {object} jarFilePath Jar path. Type: string (or Expression with * resultType string). - * @member {object} [jarLinkedService] Jar linked service reference. - * @member {string} [jarLinkedService.referenceName] Reference LinkedService - * name. - * @member {object} [jarLinkedService.parameters] Arguments for + * @property {object} [jarLinkedService] Jar linked service reference. + * @property {string} [jarLinkedService.referenceName] Reference + * LinkedService name. + * @property {object} [jarLinkedService.parameters] Arguments for * LinkedService. - * @member {array} [jarLibs] Jar libs. - * @member {object} [defines] Allows user to specify defines for the + * @property {array} [jarLibs] Jar libs. + * @property {object} [defines] Allows user to specify defines for the * MapReduce job request. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/hDInsightOnDemandLinkedService.js b/lib/services/datafactoryManagement/lib/models/hDInsightOnDemandLinkedService.js index 39751a2ed6..0da58522ba 100644 --- a/lib/services/datafactoryManagement/lib/models/hDInsightOnDemandLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/hDInsightOnDemandLinkedService.js @@ -20,85 +20,86 @@ const models = require('./index'); class HDInsightOnDemandLinkedService extends models['LinkedService'] { /** * Create a HDInsightOnDemandLinkedService. - * @member {object} clusterSize Number of worker/data nodes in the cluster. + * @property {object} clusterSize Number of worker/data nodes in the cluster. * Suggestion value: 4. Type: string (or Expression with resultType string). - * @member {object} timeToLive The allowed idle time for the on-demand + * @property {object} timeToLive The allowed idle time for the on-demand * HDInsight cluster. Specifies how long the on-demand HDInsight cluster * stays alive after completion of an activity run if there are no other * active jobs in the cluster. The minimum value is 5 mins. Type: string (or * Expression with resultType string). - * @member {object} version Version of the HDInsight cluster.  Type: string + * @property {object} version Version of the HDInsight cluster.  Type: string * (or Expression with resultType string). - * @member {object} linkedServiceName Azure Storage linked service to be used - * by the on-demand cluster for storing and processing data. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for + * @property {object} linkedServiceName Azure Storage linked service to be + * used by the on-demand cluster for storing and processing data. + * @property {string} [linkedServiceName.referenceName] Reference + * LinkedService name. + * @property {object} [linkedServiceName.parameters] Arguments for * LinkedService. - * @member {object} hostSubscriptionId The customer’s subscription to host + * @property {object} hostSubscriptionId The customer’s subscription to host * the cluster. Type: string (or Expression with resultType string). - * @member {object} [servicePrincipalId] The service principal id for the + * @property {object} [servicePrincipalId] The service principal id for the * hostSubscriptionId. Type: string (or Expression with resultType string). - * @member {object} [servicePrincipalKey] The key for the service principal + * @property {object} [servicePrincipalKey] The key for the service principal * id. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} tenant The Tenant id/name to which the service principal - * belongs. Type: string (or Expression with resultType string). - * @member {object} clusterResourceGroup The resource group where the cluster - * belongs. Type: string (or Expression with resultType string). - * @member {object} [clusterNamePrefix] The prefix of cluster name, postfix + * @property {string} [servicePrincipalKey.type] Polymorphic Discriminator + * @property {object} tenant The Tenant id/name to which the service + * principal belongs. Type: string (or Expression with resultType string). + * @property {object} clusterResourceGroup The resource group where the + * cluster belongs. Type: string (or Expression with resultType string). + * @property {object} [clusterNamePrefix] The prefix of cluster name, postfix * will be distinct with timestamp. Type: string (or Expression with * resultType string). - * @member {object} [clusterUserName] The username to access the cluster. + * @property {object} [clusterUserName] The username to access the cluster. * Type: string (or Expression with resultType string). - * @member {object} [clusterPassword] The password to access the cluster. - * @member {string} [clusterPassword.type] Polymorphic Discriminator - * @member {object} [clusterSshUserName] The username to SSH remotely connect - * to cluster’s node (for Linux). Type: string (or Expression with resultType - * string). - * @member {object} [clusterSshPassword] The password to SSH remotely connect - * cluster’s node (for Linux). - * @member {string} [clusterSshPassword.type] Polymorphic Discriminator - * @member {array} [additionalLinkedServiceNames] Specifies additional + * @property {object} [clusterPassword] The password to access the cluster. + * @property {string} [clusterPassword.type] Polymorphic Discriminator + * @property {object} [clusterSshUserName] The username to SSH remotely + * connect to cluster’s node (for Linux). Type: string (or Expression with + * resultType string). + * @property {object} [clusterSshPassword] The password to SSH remotely + * connect cluster’s node (for Linux). + * @property {string} [clusterSshPassword.type] Polymorphic Discriminator + * @property {array} [additionalLinkedServiceNames] Specifies additional * storage accounts for the HDInsight linked service so that the Data Factory * service can register them on your behalf. - * @member {object} [hcatalogLinkedServiceName] The name of Azure SQL linked - * service that point to the HCatalog database. The on-demand HDInsight - * cluster is created by using the Azure SQL database as the metastore. - * @member {string} [hcatalogLinkedServiceName.referenceName] Reference + * @property {object} [hcatalogLinkedServiceName] The name of Azure SQL + * linked service that point to the HCatalog database. The on-demand + * HDInsight cluster is created by using the Azure SQL database as the + * metastore. + * @property {string} [hcatalogLinkedServiceName.referenceName] Reference * LinkedService name. - * @member {object} [hcatalogLinkedServiceName.parameters] Arguments for + * @property {object} [hcatalogLinkedServiceName.parameters] Arguments for * LinkedService. - * @member {object} [clusterType] The cluster type. Type: string (or + * @property {object} [clusterType] The cluster type. Type: string (or * Expression with resultType string). - * @member {object} [sparkVersion] The version of spark if the cluster type + * @property {object} [sparkVersion] The version of spark if the cluster type * is 'spark'. Type: string (or Expression with resultType string). - * @member {object} [coreConfiguration] Specifies the core configuration + * @property {object} [coreConfiguration] Specifies the core configuration * parameters (as in core-site.xml) for the HDInsight cluster to be created. - * @member {object} [hBaseConfiguration] Specifies the HBase configuration + * @property {object} [hBaseConfiguration] Specifies the HBase configuration * parameters (hbase-site.xml) for the HDInsight cluster. - * @member {object} [hdfsConfiguration] Specifies the HDFS configuration + * @property {object} [hdfsConfiguration] Specifies the HDFS configuration * parameters (hdfs-site.xml) for the HDInsight cluster. - * @member {object} [hiveConfiguration] Specifies the hive configuration + * @property {object} [hiveConfiguration] Specifies the hive configuration * parameters (hive-site.xml) for the HDInsight cluster. - * @member {object} [mapReduceConfiguration] Specifies the MapReduce + * @property {object} [mapReduceConfiguration] Specifies the MapReduce * configuration parameters (mapred-site.xml) for the HDInsight cluster. - * @member {object} [oozieConfiguration] Specifies the Oozie configuration + * @property {object} [oozieConfiguration] Specifies the Oozie configuration * parameters (oozie-site.xml) for the HDInsight cluster. - * @member {object} [stormConfiguration] Specifies the Storm configuration + * @property {object} [stormConfiguration] Specifies the Storm configuration * parameters (storm-site.xml) for the HDInsight cluster. - * @member {object} [yarnConfiguration] Specifies the Yarn configuration + * @property {object} [yarnConfiguration] Specifies the Yarn configuration * parameters (yarn-site.xml) for the HDInsight cluster. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). - * @member {object} [headNodeSize] Specifies the size of the head node for + * @property {object} [headNodeSize] Specifies the size of the head node for * the HDInsight cluster. - * @member {object} [dataNodeSize] Specifies the size of the data node for + * @property {object} [dataNodeSize] Specifies the size of the data node for * the HDInsight cluster. - * @member {object} [zookeeperNodeSize] Specifies the size of the Zoo Keeper - * node for the HDInsight cluster. - * @member {array} [scriptActions] Custom script actions to run on HDI + * @property {object} [zookeeperNodeSize] Specifies the size of the Zoo + * Keeper node for the HDInsight cluster. + * @property {array} [scriptActions] Custom script actions to run on HDI * ondemand cluster once it's up. Please refer to * https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions. */ diff --git a/lib/services/datafactoryManagement/lib/models/hDInsightPigActivity.js b/lib/services/datafactoryManagement/lib/models/hDInsightPigActivity.js index 68be557a45..eadd1b65dc 100644 --- a/lib/services/datafactoryManagement/lib/models/hDInsightPigActivity.js +++ b/lib/services/datafactoryManagement/lib/models/hDInsightPigActivity.js @@ -20,19 +20,20 @@ const models = require('./index'); class HDInsightPigActivity extends models['ExecutionActivity'] { /** * Create a HDInsightPigActivity. - * @member {array} [storageLinkedServices] Storage linked service references. - * @member {array} [argumentsProperty] User specified arguments to + * @property {array} [storageLinkedServices] Storage linked service + * references. + * @property {array} [argumentsProperty] User specified arguments to * HDInsightActivity. - * @member {string} [getDebugInfo] Debug info option. Possible values + * @property {string} [getDebugInfo] Debug info option. Possible values * include: 'None', 'Always', 'Failure' - * @member {object} [scriptPath] Script path. Type: string (or Expression + * @property {object} [scriptPath] Script path. Type: string (or Expression * with resultType string). - * @member {object} [scriptLinkedService] Script linked service reference. - * @member {string} [scriptLinkedService.referenceName] Reference + * @property {object} [scriptLinkedService] Script linked service reference. + * @property {string} [scriptLinkedService.referenceName] Reference * LinkedService name. - * @member {object} [scriptLinkedService.parameters] Arguments for + * @property {object} [scriptLinkedService.parameters] Arguments for * LinkedService. - * @member {object} [defines] Allows user to specify defines for Pig job + * @property {object} [defines] Allows user to specify defines for Pig job * request. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/hDInsightSparkActivity.js b/lib/services/datafactoryManagement/lib/models/hDInsightSparkActivity.js index 446417f354..869e79cb36 100644 --- a/lib/services/datafactoryManagement/lib/models/hDInsightSparkActivity.js +++ b/lib/services/datafactoryManagement/lib/models/hDInsightSparkActivity.js @@ -20,25 +20,25 @@ const models = require('./index'); class HDInsightSparkActivity extends models['ExecutionActivity'] { /** * Create a HDInsightSparkActivity. - * @member {object} rootPath The root path in 'sparkJobLinkedService' for all - * the job’s files. Type: string (or Expression with resultType string). - * @member {object} entryFilePath The relative path to the root folder of the - * code/package to be executed. Type: string (or Expression with resultType - * string). - * @member {array} [argumentsProperty] The user-specified arguments to + * @property {object} rootPath The root path in 'sparkJobLinkedService' for + * all the job’s files. Type: string (or Expression with resultType string). + * @property {object} entryFilePath The relative path to the root folder of + * the code/package to be executed. Type: string (or Expression with + * resultType string). + * @property {array} [argumentsProperty] The user-specified arguments to * HDInsightSparkActivity. - * @member {string} [getDebugInfo] Debug info option. Possible values + * @property {string} [getDebugInfo] Debug info option. Possible values * include: 'None', 'Always', 'Failure' - * @member {object} [sparkJobLinkedService] The storage linked service for + * @property {object} [sparkJobLinkedService] The storage linked service for * uploading the entry file and dependencies, and for receiving logs. - * @member {string} [sparkJobLinkedService.referenceName] Reference + * @property {string} [sparkJobLinkedService.referenceName] Reference * LinkedService name. - * @member {object} [sparkJobLinkedService.parameters] Arguments for + * @property {object} [sparkJobLinkedService.parameters] Arguments for * LinkedService. - * @member {string} [className] The application's Java/Spark main class. - * @member {object} [proxyUser] The user to impersonate that will execute the - * job. Type: string (or Expression with resultType string). - * @member {object} [sparkConfig] Spark configuration property. + * @property {string} [className] The application's Java/Spark main class. + * @property {object} [proxyUser] The user to impersonate that will execute + * the job. Type: string (or Expression with resultType string). + * @property {object} [sparkConfig] Spark configuration property. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/hDInsightStreamingActivity.js b/lib/services/datafactoryManagement/lib/models/hDInsightStreamingActivity.js index 7fe59e5af8..1c2de121c4 100644 --- a/lib/services/datafactoryManagement/lib/models/hDInsightStreamingActivity.js +++ b/lib/services/datafactoryManagement/lib/models/hDInsightStreamingActivity.js @@ -20,31 +20,32 @@ const models = require('./index'); class HDInsightStreamingActivity extends models['ExecutionActivity'] { /** * Create a HDInsightStreamingActivity. - * @member {array} [storageLinkedServices] Storage linked service references. - * @member {array} [argumentsProperty] User specified arguments to + * @property {array} [storageLinkedServices] Storage linked service + * references. + * @property {array} [argumentsProperty] User specified arguments to * HDInsightActivity. - * @member {string} [getDebugInfo] Debug info option. Possible values + * @property {string} [getDebugInfo] Debug info option. Possible values * include: 'None', 'Always', 'Failure' - * @member {object} mapper Mapper executable name. Type: string (or + * @property {object} mapper Mapper executable name. Type: string (or * Expression with resultType string). - * @member {object} reducer Reducer executable name. Type: string (or + * @property {object} reducer Reducer executable name. Type: string (or * Expression with resultType string). - * @member {object} input Input blob path. Type: string (or Expression with + * @property {object} input Input blob path. Type: string (or Expression with * resultType string). - * @member {object} output Output blob path. Type: string (or Expression with - * resultType string). - * @member {array} filePaths Paths to streaming job files. Can be + * @property {object} output Output blob path. Type: string (or Expression + * with resultType string). + * @property {array} filePaths Paths to streaming job files. Can be * directories. - * @member {object} [fileLinkedService] Linked service reference where the + * @property {object} [fileLinkedService] Linked service reference where the * files are located. - * @member {string} [fileLinkedService.referenceName] Reference LinkedService - * name. - * @member {object} [fileLinkedService.parameters] Arguments for + * @property {string} [fileLinkedService.referenceName] Reference + * LinkedService name. + * @property {object} [fileLinkedService.parameters] Arguments for * LinkedService. - * @member {object} [combiner] Combiner executable name. Type: string (or + * @property {object} [combiner] Combiner executable name. Type: string (or * Expression with resultType string). - * @member {array} [commandEnvironment] Command line environment values. - * @member {object} [defines] Allows user to specify defines for streaming + * @property {array} [commandEnvironment] Command line environment values. + * @property {object} [defines] Allows user to specify defines for streaming * job request. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/hdfsLinkedService.js b/lib/services/datafactoryManagement/lib/models/hdfsLinkedService.js index d2687d48f0..5fa2edc23a 100644 --- a/lib/services/datafactoryManagement/lib/models/hdfsLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/hdfsLinkedService.js @@ -20,19 +20,19 @@ const models = require('./index'); class HdfsLinkedService extends models['LinkedService'] { /** * Create a HdfsLinkedService. - * @member {object} url The URL of the HDFS service endpoint, e.g. + * @property {object} url The URL of the HDFS service endpoint, e.g. * http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with * resultType string). - * @member {object} [authenticationType] Type of authentication used to + * @property {object} [authenticationType] Type of authentication used to * connect to the HDFS. Possible values are: Anonymous and Windows. Type: * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). - * @member {object} [userName] User name for Windows authentication. Type: + * @property {object} [userName] User name for Windows authentication. Type: * string (or Expression with resultType string). - * @member {object} [password] Password for Windows authentication. - * @member {string} [password.type] Polymorphic Discriminator + * @property {object} [password] Password for Windows authentication. + * @property {string} [password.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/hdfsSource.js b/lib/services/datafactoryManagement/lib/models/hdfsSource.js index 1674d24984..83f05d98c8 100644 --- a/lib/services/datafactoryManagement/lib/models/hdfsSource.js +++ b/lib/services/datafactoryManagement/lib/models/hdfsSource.js @@ -20,18 +20,18 @@ const models = require('./index'); class HdfsSource extends models['CopySource'] { /** * Create a HdfsSource. - * @member {object} [recursive] If true, files under the folder path will be - * read recursively. Default is true. Type: boolean (or Expression with + * @property {object} [recursive] If true, files under the folder path will + * be read recursively. Default is true. Type: boolean (or Expression with * resultType boolean). - * @member {object} [distcpSettings] Specifies Distcp-related settings. - * @member {object} [distcpSettings.resourceManagerEndpoint] Specifies the + * @property {object} [distcpSettings] Specifies Distcp-related settings. + * @property {object} [distcpSettings.resourceManagerEndpoint] Specifies the * Yarn ResourceManager endpoint. Type: string (or Expression with resultType * string). - * @member {object} [distcpSettings.tempScriptPath] Specifies an existing + * @property {object} [distcpSettings.tempScriptPath] Specifies an existing * folder path which will be used to store temp Distcp command script. The * script file is generated by ADF and will be removed after Copy job * finished. Type: string (or Expression with resultType string). - * @member {object} [distcpSettings.distcpOptions] Specifies the Distcp + * @property {object} [distcpSettings.distcpOptions] Specifies the Distcp * options. Type: string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/hiveLinkedService.js b/lib/services/datafactoryManagement/lib/models/hiveLinkedService.js index fb532fb8e7..c7f851d29f 100644 --- a/lib/services/datafactoryManagement/lib/models/hiveLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/hiveLinkedService.js @@ -20,47 +20,47 @@ const models = require('./index'); class HiveLinkedService extends models['LinkedService'] { /** * Create a HiveLinkedService. - * @member {object} host IP address or host name of the Hive server, + * @property {object} host IP address or host name of the Hive server, * separated by ';' for multiple hosts (only when serviceDiscoveryMode is * enable). - * @member {object} [port] The TCP port that the Hive server uses to listen + * @property {object} [port] The TCP port that the Hive server uses to listen * for client connections. - * @member {string} [serverType] The type of Hive server. Possible values + * @property {string} [serverType] The type of Hive server. Possible values * include: 'HiveServer1', 'HiveServer2', 'HiveThriftServer' - * @member {string} [thriftTransportProtocol] The transport protocol to use + * @property {string} [thriftTransportProtocol] The transport protocol to use * in the Thrift layer. Possible values include: 'Binary', 'SASL', 'HTTP ' - * @member {string} authenticationType The authentication method used to + * @property {string} authenticationType The authentication method used to * access the Hive server. Possible values include: 'Anonymous', 'Username', * 'UsernameAndPassword', 'WindowsAzureHDInsightService' - * @member {object} [serviceDiscoveryMode] true to indicate using the + * @property {object} [serviceDiscoveryMode] true to indicate using the * ZooKeeper service, false not. - * @member {object} [zooKeeperNameSpace] The namespace on ZooKeeper under + * @property {object} [zooKeeperNameSpace] The namespace on ZooKeeper under * which Hive Server 2 nodes are added. - * @member {object} [useNativeQuery] Specifies whether the driver uses native - * HiveQL queries,or converts them into an equivalent form in HiveQL. - * @member {object} [username] The user name that you use to access Hive + * @property {object} [useNativeQuery] Specifies whether the driver uses + * native HiveQL queries,or converts them into an equivalent form in HiveQL. + * @property {object} [username] The user name that you use to access Hive * Server. - * @member {object} [password] The password corresponding to the user name + * @property {object} [password] The password corresponding to the user name * that you provided in the Username field - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [httpPath] The partial URL corresponding to the Hive + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [httpPath] The partial URL corresponding to the Hive * server. - * @member {object} [enableSsl] Specifies whether the connections to the + * @property {object} [enableSsl] Specifies whether the connections to the * server are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file + * @property {object} [trustedCertPath] The full path of the .pem file * containing trusted CA certificates for verifying the server when * connecting over SSL. This property can only be set when using SSL on * self-hosted IR. The default value is the cacerts.pem file installed with * the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA + * @property {object} [useSystemTrustStore] Specifies whether to use a CA * certificate from the system trust store or from a specified PEM file. The * default value is false. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when + * @property {object} [allowHostNameCNMismatch] Specifies whether to require + * a CA-issued SSL certificate name to match the host name of the server when * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow + * @property {object} [allowSelfSignedServerCert] Specifies whether to allow * self-signed certificates from the server. The default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/hiveObjectDataset.js b/lib/services/datafactoryManagement/lib/models/hiveObjectDataset.js index 4b9ccc0d63..3c853fc33b 100644 --- a/lib/services/datafactoryManagement/lib/models/hiveObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/hiveObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class HiveObjectDataset extends models['Dataset'] { /** * Create a HiveObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/hiveSource.js b/lib/services/datafactoryManagement/lib/models/hiveSource.js index 1230851273..91186bdea1 100644 --- a/lib/services/datafactoryManagement/lib/models/hiveSource.js +++ b/lib/services/datafactoryManagement/lib/models/hiveSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class HiveSource extends models['CopySource'] { /** * Create a HiveSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/httpDataset.js b/lib/services/datafactoryManagement/lib/models/httpDataset.js index ffc50b15cb..8a7d2483fb 100644 --- a/lib/services/datafactoryManagement/lib/models/httpDataset.js +++ b/lib/services/datafactoryManagement/lib/models/httpDataset.js @@ -20,26 +20,27 @@ const models = require('./index'); class HttpDataset extends models['Dataset'] { /** * Create a HttpDataset. - * @member {object} [relativeUrl] The relative URL based on the URL in the + * @property {object} [relativeUrl] The relative URL based on the URL in the * HttpLinkedService refers to an HTTP file Type: string (or Expression with * resultType string). - * @member {object} [requestMethod] The HTTP method for the HTTP request. + * @property {object} [requestMethod] The HTTP method for the HTTP request. * Type: string (or Expression with resultType string). - * @member {object} [requestBody] The body for the HTTP request. Type: string - * (or Expression with resultType string). - * @member {object} [additionalHeaders] The headers for the HTTP Request. + * @property {object} [requestBody] The body for the HTTP request. Type: + * string (or Expression with resultType string). + * @property {object} [additionalHeaders] The headers for the HTTP Request. * e.g. request-header-name-1:request-header-value-1 * ... * request-header-name-n:request-header-value-n Type: string (or Expression * with resultType string). - * @member {object} [format] The format of files. - * @member {object} [format.serializer] Serializer. Type: string (or + * @property {object} [format] The format of files. + * @property {object} [format.serializer] Serializer. Type: string (or * Expression with resultType string). - * @member {object} [format.deserializer] Deserializer. Type: string (or + * @property {object} [format.deserializer] Deserializer. Type: string (or * Expression with resultType string). - * @member {string} [format.type] Polymorphic Discriminator - * @member {object} [compression] The data compression method used on files. - * @member {string} [compression.type] Polymorphic Discriminator + * @property {string} [format.type] Polymorphic Discriminator + * @property {object} [compression] The data compression method used on + * files. + * @property {string} [compression.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/httpLinkedService.js b/lib/services/datafactoryManagement/lib/models/httpLinkedService.js index 365356d504..da26ed20a9 100644 --- a/lib/services/datafactoryManagement/lib/models/httpLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/httpLinkedService.js @@ -20,32 +20,32 @@ const models = require('./index'); class HttpLinkedService extends models['LinkedService'] { /** * Create a HttpLinkedService. - * @member {object} url The base URL of the HTTP endpoint, e.g. + * @property {object} url The base URL of the HTTP endpoint, e.g. * http://www.microsoft.com. Type: string (or Expression with resultType * string). - * @member {string} [authenticationType] The authentication type to be used + * @property {string} [authenticationType] The authentication type to be used * to connect to the HTTP server. Possible values include: 'Basic', * 'Anonymous', 'Digest', 'Windows', 'ClientCertificate' - * @member {object} [userName] User name for Basic, Digest, or Windows + * @property {object} [userName] User name for Basic, Digest, or Windows * authentication. Type: string (or Expression with resultType string). - * @member {object} [password] Password for Basic, Digest, Windows, or + * @property {object} [password] Password for Basic, Digest, Windows, or * ClientCertificate with EmbeddedCertData authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [embeddedCertData] Base64 encoded certificate data for + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [embeddedCertData] Base64 encoded certificate data for * ClientCertificate authentication. For on-premises copy with * ClientCertificate authentication, either CertThumbprint or * EmbeddedCertData/Password should be specified. Type: string (or Expression * with resultType string). - * @member {object} [certThumbprint] Thumbprint of certificate for + * @property {object} [certThumbprint] Thumbprint of certificate for * ClientCertificate authentication. Only valid for on-premises copy. For * on-premises copy with ClientCertificate authentication, either * CertThumbprint or EmbeddedCertData/Password should be specified. Type: * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). - * @member {object} [enableServerCertificateValidation] If true, validate the - * HTTPS server SSL certificate. Default value is true. Type: boolean (or + * @property {object} [enableServerCertificateValidation] If true, validate + * the HTTPS server SSL certificate. Default value is true. Type: boolean (or * Expression with resultType boolean). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/httpSource.js b/lib/services/datafactoryManagement/lib/models/httpSource.js index f4115a04a0..b31f20cc63 100644 --- a/lib/services/datafactoryManagement/lib/models/httpSource.js +++ b/lib/services/datafactoryManagement/lib/models/httpSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class HttpSource extends models['CopySource'] { /** * Create a HttpSource. - * @member {object} [httpRequestTimeout] Specifies the timeout for a HTTP + * @property {object} [httpRequestTimeout] Specifies the timeout for a HTTP * client to get HTTP response from HTTP server. The default value is * equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or * Expression with resultType string), pattern: diff --git a/lib/services/datafactoryManagement/lib/models/hubspotLinkedService.js b/lib/services/datafactoryManagement/lib/models/hubspotLinkedService.js index 6235140c1a..745e92a588 100644 --- a/lib/services/datafactoryManagement/lib/models/hubspotLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/hubspotLinkedService.js @@ -13,33 +13,33 @@ const models = require('./index'); /** - * Hubspot Serivce linked service. + * Hubspot Service linked service. * * @extends models['LinkedService'] */ class HubspotLinkedService extends models['LinkedService'] { /** * Create a HubspotLinkedService. - * @member {object} clientId The client ID associated with your Hubspot + * @property {object} clientId The client ID associated with your Hubspot * application. - * @member {object} [clientSecret] The client secret associated with your + * @property {object} [clientSecret] The client secret associated with your * Hubspot application. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [accessToken] The access token obtained when initially + * @property {string} [clientSecret.type] Polymorphic Discriminator + * @property {object} [accessToken] The access token obtained when initially * authenticating your OAuth integration. - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} [refreshToken] The refresh token obtained when initially - * authenticating your OAuth integration. - * @member {string} [refreshToken.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {string} [accessToken.type] Polymorphic Discriminator + * @property {object} [refreshToken] The refresh token obtained when + * initially authenticating your OAuth integration. + * @property {string} [refreshToken.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/hubspotObjectDataset.js b/lib/services/datafactoryManagement/lib/models/hubspotObjectDataset.js index f18a8a351b..8aa78e3601 100644 --- a/lib/services/datafactoryManagement/lib/models/hubspotObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/hubspotObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class HubspotObjectDataset extends models['Dataset'] { /** * Create a HubspotObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/hubspotSource.js b/lib/services/datafactoryManagement/lib/models/hubspotSource.js index 0a407bc7a5..a5962e27b2 100644 --- a/lib/services/datafactoryManagement/lib/models/hubspotSource.js +++ b/lib/services/datafactoryManagement/lib/models/hubspotSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class HubspotSource extends models['CopySource'] { /** * Create a HubspotSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/ifConditionActivity.js b/lib/services/datafactoryManagement/lib/models/ifConditionActivity.js index 0343ebc097..0bbf29660d 100644 --- a/lib/services/datafactoryManagement/lib/models/ifConditionActivity.js +++ b/lib/services/datafactoryManagement/lib/models/ifConditionActivity.js @@ -22,14 +22,14 @@ const models = require('./index'); class IfConditionActivity extends models['ControlActivity'] { /** * Create a IfConditionActivity. - * @member {object} expression An expression that would evaluate to Boolean. - * This is used to determine the block of activities (ifTrueActivities or - * ifFalseActivities) that will be executed. - * @member {string} [expression.value] Expression value. - * @member {array} [ifTrueActivities] List of activities to execute if + * @property {object} expression An expression that would evaluate to + * Boolean. This is used to determine the block of activities + * (ifTrueActivities or ifFalseActivities) that will be executed. + * @property {string} [expression.value] Expression value. + * @property {array} [ifTrueActivities] List of activities to execute if * expression is evaluated to true. This is an optional property and if not * provided, the activity will exit without any action. - * @member {array} [ifFalseActivities] List of activities to execute if + * @property {array} [ifFalseActivities] List of activities to execute if * expression is evaluated to false. This is an optional property and if not * provided, the activity will exit without any action. */ diff --git a/lib/services/datafactoryManagement/lib/models/impalaLinkedService.js b/lib/services/datafactoryManagement/lib/models/impalaLinkedService.js index 19b8518673..7257a048ee 100644 --- a/lib/services/datafactoryManagement/lib/models/impalaLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/impalaLinkedService.js @@ -20,34 +20,34 @@ const models = require('./index'); class ImpalaLinkedService extends models['LinkedService'] { /** * Create a ImpalaLinkedService. - * @member {object} host The IP address or host name of the Impala server. + * @property {object} host The IP address or host name of the Impala server. * (i.e. 192.168.222.160) - * @member {object} [port] The TCP port that the Impala server uses to listen - * for client connections. The default value is 21050. - * @member {string} authenticationType The authentication type to use. + * @property {object} [port] The TCP port that the Impala server uses to + * listen for client connections. The default value is 21050. + * @property {string} authenticationType The authentication type to use. * Possible values include: 'Anonymous', 'SASLUsername', * 'UsernameAndPassword' - * @member {object} [username] The user name used to access the Impala + * @property {object} [username] The user name used to access the Impala * server. The default value is anonymous when using SASLUsername. - * @member {object} [password] The password corresponding to the user name + * @property {object} [password] The password corresponding to the user name * when using UsernameAndPassword. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [enableSsl] Specifies whether the connections to the + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [enableSsl] Specifies whether the connections to the * server are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file + * @property {object} [trustedCertPath] The full path of the .pem file * containing trusted CA certificates for verifying the server when * connecting over SSL. This property can only be set when using SSL on * self-hosted IR. The default value is the cacerts.pem file installed with * the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA + * @property {object} [useSystemTrustStore] Specifies whether to use a CA * certificate from the system trust store or from a specified PEM file. The * default value is false. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when + * @property {object} [allowHostNameCNMismatch] Specifies whether to require + * a CA-issued SSL certificate name to match the host name of the server when * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow + * @property {object} [allowSelfSignedServerCert] Specifies whether to allow * self-signed certificates from the server. The default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/impalaObjectDataset.js b/lib/services/datafactoryManagement/lib/models/impalaObjectDataset.js index 3b6a0f791c..041f0210a6 100644 --- a/lib/services/datafactoryManagement/lib/models/impalaObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/impalaObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class ImpalaObjectDataset extends models['Dataset'] { /** * Create a ImpalaObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/impalaSource.js b/lib/services/datafactoryManagement/lib/models/impalaSource.js index 727e4f8480..a00f15ddf7 100644 --- a/lib/services/datafactoryManagement/lib/models/impalaSource.js +++ b/lib/services/datafactoryManagement/lib/models/impalaSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class ImpalaSource extends models['CopySource'] { /** * Create a ImpalaSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/index.d.ts b/lib/services/datafactoryManagement/lib/models/index.d.ts index b6fd7d1f84..77877fd3f0 100644 --- a/lib/services/datafactoryManagement/lib/models/index.d.ts +++ b/lib/services/datafactoryManagement/lib/models/index.d.ts @@ -1,8151 +1,7668 @@ /* * 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 Resource class. - * @constructor * Azure Data Factory top-level resource. - * - * @member {string} [id] The resource identifier. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. - * @member {string} [location] The resource location. - * @member {object} [tags] The resource tags. - * @member {string} [eTag] Etag identifies change in the resource. */ export interface Resource extends BaseResource { + /** + * The resource identifier. + */ readonly id?: string; + /** + * The resource name. + */ readonly name?: string; + /** + * The resource type. + */ readonly type?: string; + /** + * The resource location. + */ location?: string; + /** + * The resource tags. + */ tags?: { [propertyName: string]: string }; + /** + * Etag identifies change in the resource. + */ readonly eTag?: string; } /** - * @class - * Initializes a new instance of the SubResource class. - * @constructor * Azure Data Factory nested resource, which belongs to a factory. - * - * @member {string} [id] The resource identifier. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. - * @member {string} [etag] Etag identifies change in the resource. */ export interface SubResource extends BaseResource { + /** + * The resource identifier. + */ readonly id?: string; + /** + * The resource name. + */ readonly name?: string; + /** + * The resource type. + */ readonly type?: string; + /** + * Etag identifies change in the resource. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the Expression class. - * @constructor * Azure Data Factory expression definition. - * - * @member {string} value Expression value. */ export interface Expression { + /** + * Expression value. + */ value: string; } /** - * @class - * Initializes a new instance of the SecretBase class. - * @constructor * The base definition of a secret type. - * - * @member {string} type Polymorphic Discriminator */ export interface SecretBase { + /** + * Polymorphic Discriminator + */ type: string; } /** - * @class - * Initializes a new instance of the SecureString class. - * @constructor - * Azure Data Factory secure string definition. The string value will be masked - * with asterisks '*' during Get or List API calls. - * - * @member {string} value Value of secure string. + * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' + * during Get or List API calls. */ export interface SecureString extends SecretBase { + /** + * Value of secure string. + */ value: string; } /** - * @class - * Initializes a new instance of the LinkedServiceReference class. - * @constructor * Linked service reference type. - * - * @member {string} referenceName Reference LinkedService name. - * @member {object} [parameters] Arguments for LinkedService. */ export interface LinkedServiceReference { + /** + * Reference LinkedService name. + */ referenceName: string; + /** + * Arguments for LinkedService. + */ parameters?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the AzureKeyVaultSecretReference class. - * @constructor * Azure Key Vault secret reference. - * - * @member {object} store The Azure Key Vault linked service reference. - * @member {string} [store.referenceName] Reference LinkedService name. - * @member {object} [store.parameters] Arguments for LinkedService. - * @member {object} secretName The name of the secret in Azure Key Vault. Type: - * string (or Expression with resultType string). - * @member {object} [secretVersion] The version of the secret in Azure Key - * Vault. The default value is the latest version of the secret. Type: string - * (or Expression with resultType string). */ export interface AzureKeyVaultSecretReference extends SecretBase { + /** + * The Azure Key Vault linked service reference. + */ store: LinkedServiceReference; + /** + * The name of the secret in Azure Key Vault. Type: string (or Expression with resultType + * string). + */ secretName: any; + /** + * The version of the secret in Azure Key Vault. The default value is the latest version of the + * secret. Type: string (or Expression with resultType string). + */ secretVersion?: any; } /** - * @class - * Initializes a new instance of the FactoryIdentity class. - * @constructor * Identity properties of the factory resource. - * - * @member {uuid} [principalId] The principal id of the identity. - * @member {uuid} [tenantId] The client tenant id of the identity. */ export interface FactoryIdentity { + /** + * The principal id of the identity. + */ readonly principalId?: string; + /** + * The client tenant id of the identity. + */ readonly tenantId?: string; } /** - * @class - * Initializes a new instance of the FactoryRepoConfiguration class. - * @constructor * Factory's git repo information. - * - * @member {string} accountName Account name. - * @member {string} repositoryName Rrepository name. - * @member {string} collaborationBranch Collaboration branch. - * @member {string} rootFolder Root folder. - * @member {string} [lastCommitId] Last commit id. - * @member {string} type Polymorphic Discriminator */ export interface FactoryRepoConfiguration { + /** + * Account name. + */ accountName: string; + /** + * Rrepository name. + */ repositoryName: string; + /** + * Collaboration branch. + */ collaborationBranch: string; + /** + * Root folder. + */ rootFolder: string; + /** + * Last commit id. + */ lastCommitId?: string; + /** + * Polymorphic Discriminator + */ type: string; } /** - * @class - * Initializes a new instance of the Factory class. - * @constructor * Factory resource type. - * - * @member {object} [identity] Managed service identity of the factory. - * @member {uuid} [identity.principalId] The principal id of the identity. - * @member {uuid} [identity.tenantId] The client tenant id of the identity. - * @member {string} [provisioningState] Factory provisioning state, example - * Succeeded. - * @member {date} [createTime] Time the factory was created in ISO8601 format. - * @member {string} [version] Version of the factory. - * @member {object} [repoConfiguration] Git repo information of the factory. - * @member {string} [repoConfiguration.accountName] Account name. - * @member {string} [repoConfiguration.repositoryName] Rrepository name. - * @member {string} [repoConfiguration.collaborationBranch] Collaboration - * branch. - * @member {string} [repoConfiguration.rootFolder] Root folder. - * @member {string} [repoConfiguration.lastCommitId] Last commit id. - * @member {string} [repoConfiguration.type] Polymorphic Discriminator */ export interface Factory extends Resource { + /** + * Managed service identity of the factory. + */ identity?: FactoryIdentity; + /** + * Factory provisioning state, example Succeeded. + */ readonly provisioningState?: string; + /** + * Time the factory was created in ISO8601 format. + */ readonly createTime?: Date; + /** + * Version of the factory. + */ readonly version?: string; + /** + * Git repo information of the factory. + */ repoConfiguration?: FactoryRepoConfiguration; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the IntegrationRuntime class. - * @constructor - * Azure Data Factory nested object which serves as a compute resource for - * activities. - * - * @member {string} [description] Integration runtime description. - * @member {string} type Polymorphic Discriminator + * Azure Data Factory nested object which serves as a compute resource for activities. */ export interface IntegrationRuntime { + /** + * Integration runtime description. + */ description?: string; + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeResource class. - * @constructor * Integration runtime resource type. - * - * @member {object} properties Integration runtime properties. - * @member {string} [properties.description] Integration runtime description. - * @member {string} [properties.type] Polymorphic Discriminator */ export interface IntegrationRuntimeResource extends SubResource { + /** + * Integration runtime properties. + */ properties: IntegrationRuntime; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeReference class. - * @constructor * Integration runtime reference type. - * - * @member {string} referenceName Reference integration runtime name. - * @member {object} [parameters] Arguments for integration runtime. */ export interface IntegrationRuntimeReference { + /** + * Reference integration runtime name. + */ referenceName: string; + /** + * Arguments for integration runtime. + */ parameters?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeStatus class. - * @constructor * Integration runtime status. - * - * @member {string} [dataFactoryName] The data factory name which the - * integration runtime belong to. - * @member {string} [state] The state of integration runtime. Possible values - * include: 'Initial', 'Stopped', 'Started', 'Starting', 'Stopping', - * 'NeedRegistration', 'Online', 'Limited', 'Offline', 'AccessDenied' - * @member {string} type Polymorphic Discriminator */ export interface IntegrationRuntimeStatus { + /** + * The data factory name which the integration runtime belong to. + */ readonly dataFactoryName?: string; + /** + * The state of integration runtime. Possible values include: 'Initial', 'Stopped', 'Started', + * 'Starting', 'Stopping', 'NeedRegistration', 'Online', 'Limited', 'Offline', 'AccessDenied' + */ readonly state?: string; + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeStatusResponse class. - * @constructor * Integration runtime status response. - * - * @member {string} [name] The integration runtime name. - * @member {object} properties Integration runtime properties. - * @member {string} [properties.dataFactoryName] The data factory name which - * the integration runtime belong to. - * @member {string} [properties.state] The state of integration runtime. - * Possible values include: 'Initial', 'Stopped', 'Started', 'Starting', - * 'Stopping', 'NeedRegistration', 'Online', 'Limited', 'Offline', - * 'AccessDenied' - * @member {string} [properties.type] Polymorphic Discriminator */ export interface IntegrationRuntimeStatusResponse { + /** + * The integration runtime name. + */ readonly name?: string; + /** + * Integration runtime properties. + */ properties: IntegrationRuntimeStatus; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeStatusListResponse class. - * @constructor * A list of integration runtime status. - * - * @member {array} value List of integration runtime status. - * @member {string} [nextLink] The link to the next page of results, if any - * remaining results exist. */ export interface IntegrationRuntimeStatusListResponse { + /** + * List of integration runtime status. + */ value: IntegrationRuntimeStatusResponse[]; + /** + * The link to the next page of results, if any remaining results exist. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the UpdateIntegrationRuntimeRequest class. - * @constructor * Update integration runtime request. - * - * @member {string} [autoUpdate] Enables or disables the auto-update feature of - * the self-hosted integration runtime. See - * https://go.microsoft.com/fwlink/?linkid=854189. Possible values include: - * 'On', 'Off' - * @member {string} [updateDelayOffset] The time offset (in hours) in the day, - * e.g., PT03H is 3 hours. The integration runtime auto update will happen on - * that time. */ export interface UpdateIntegrationRuntimeRequest { + /** + * Enables or disables the auto-update feature of the self-hosted integration runtime. See + * https://go.microsoft.com/fwlink/?linkid=854189. Possible values include: 'On', 'Off' + */ autoUpdate?: string; + /** + * The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto + * update will happen on that time. + */ updateDelayOffset?: string; } /** - * @class - * Initializes a new instance of the UpdateIntegrationRuntimeNodeRequest class. - * @constructor * Update integration runtime node request. - * - * @member {number} [concurrentJobsLimit] The number of concurrent jobs - * permitted to run on the integration runtime node. Values between 1 and - * maxConcurrentJobs(inclusive) are allowed. */ export interface UpdateIntegrationRuntimeNodeRequest { + /** + * The number of concurrent jobs permitted to run on the integration runtime node. Values between + * 1 and maxConcurrentJobs(inclusive) are allowed. + */ concurrentJobsLimit?: number; } /** - * @class - * Initializes a new instance of the LinkedIntegrationRuntimeRequest class. - * @constructor * Data factory name for linked integration runtime request. - * - * @member {string} linkedFactoryName The data factory name for linked - * integration runtime. */ export interface LinkedIntegrationRuntimeRequest { + /** + * The data factory name for linked integration runtime. + */ linkedFactoryName: string; } /** - * @class - * Initializes a new instance of the CreateLinkedIntegrationRuntimeRequest class. - * @constructor * The linked integration runtime information. - * - * @member {string} [name] The name of the linked integration runtime. - * @member {string} [subscriptionId] The ID of the subscription that the linked - * integration runtime belongs to. - * @member {string} [dataFactoryName] The name of the data factory that the - * linked integration runtime belongs to. - * @member {string} [dataFactoryLocation] The location of the data factory that - * the linked integration runtime belongs to. */ export interface CreateLinkedIntegrationRuntimeRequest { + /** + * The name of the linked integration runtime. + */ name?: string; + /** + * The ID of the subscription that the linked integration runtime belongs to. + */ subscriptionId?: string; + /** + * The name of the data factory that the linked integration runtime belongs to. + */ dataFactoryName?: string; + /** + * The location of the data factory that the linked integration runtime belongs to. + */ dataFactoryLocation?: string; } /** - * @class - * Initializes a new instance of the ParameterSpecification class. - * @constructor * Definition of a single parameter for an entity. - * - * @member {string} type Parameter type. Possible values include: 'Object', - * 'String', 'Int', 'Float', 'Bool', 'Array', 'SecureString' - * @member {object} [defaultValue] Default value of parameter. */ export interface ParameterSpecification { + /** + * Parameter type. Possible values include: 'Object', 'String', 'Int', 'Float', 'Bool', 'Array', + * 'SecureString' + */ type: string; + /** + * Default value of parameter. + */ defaultValue?: any; } /** - * @class - * Initializes a new instance of the LinkedService class. - * @constructor - * The Azure Data Factory nested object which contains the information and - * credential which can be used to connect with related store or compute - * resource. - * - * @member {object} [connectVia] The integration runtime reference. - * @member {string} [connectVia.referenceName] Reference integration runtime - * name. - * @member {object} [connectVia.parameters] Arguments for integration runtime. - * @member {string} [description] Linked service description. - * @member {object} [parameters] Parameters for linked service. - * @member {array} [annotations] List of tags that can be used for describing - * the Dataset. - * @member {string} type Polymorphic Discriminator + * The Azure Data Factory nested object which contains the information and credential which can be + * used to connect with related store or compute resource. */ export interface LinkedService { + /** + * The integration runtime reference. + */ connectVia?: IntegrationRuntimeReference; + /** + * Linked service description. + */ description?: string; + /** + * Parameters for linked service. + */ parameters?: { [propertyName: string]: ParameterSpecification }; + /** + * List of tags that can be used for describing the Dataset. + */ annotations?: any[]; + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the LinkedServiceResource class. - * @constructor * Linked service resource type. - * - * @member {object} properties Properties of linked service. - * @member {object} [properties.connectVia] The integration runtime reference. - * @member {string} [properties.connectVia.referenceName] Reference integration - * runtime name. - * @member {object} [properties.connectVia.parameters] Arguments for - * integration runtime. - * @member {string} [properties.description] Linked service description. - * @member {object} [properties.parameters] Parameters for linked service. - * @member {array} [properties.annotations] List of tags that can be used for - * describing the Dataset. - * @member {string} [properties.type] Polymorphic Discriminator */ export interface LinkedServiceResource extends SubResource { + /** + * Properties of linked service. + */ properties: LinkedService; } /** - * @class - * Initializes a new instance of the DatasetFolder class. - * @constructor - * The folder that this Dataset is in. If not specified, Dataset will appear at - * the root level. - * - * @member {string} [name] The name of the folder that this Dataset is in. + * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ export interface DatasetFolder { + /** + * The name of the folder that this Dataset is in. + */ name?: string; } /** - * @class - * Initializes a new instance of the Dataset class. - * @constructor - * The Azure Data Factory nested object which identifies data within different - * data stores, such as tables, files, folders, and documents. - * - * @member {string} [description] Dataset description. - * @member {object} [structure] Columns that define the structure of the - * dataset. Type: array (or Expression with resultType array), itemType: - * DatasetDataElement. - * @member {object} linkedServiceName Linked service reference. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for LinkedService. - * @member {object} [parameters] Parameters for dataset. - * @member {array} [annotations] List of tags that can be used for describing - * the Dataset. - * @member {object} [folder] The folder that this Dataset is in. If not - * specified, Dataset will appear at the root level. - * @member {string} [folder.name] The name of the folder that this Dataset is - * in. - * @member {string} type Polymorphic Discriminator + * The Azure Data Factory nested object which identifies data within different data stores, such as + * tables, files, folders, and documents. */ export interface Dataset { + /** + * Dataset description. + */ description?: string; + /** + * Columns that define the structure of the dataset. Type: array (or Expression with resultType + * array), itemType: DatasetDataElement. + */ structure?: any; + /** + * Linked service reference. + */ linkedServiceName: LinkedServiceReference; + /** + * Parameters for dataset. + */ parameters?: { [propertyName: string]: ParameterSpecification }; + /** + * List of tags that can be used for describing the Dataset. + */ annotations?: any[]; + /** + * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. + */ folder?: DatasetFolder; + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the DatasetResource class. - * @constructor * Dataset resource type. - * - * @member {object} properties Dataset properties. - * @member {string} [properties.description] Dataset description. - * @member {object} [properties.structure] Columns that define the structure of - * the dataset. Type: array (or Expression with resultType array), itemType: - * DatasetDataElement. - * @member {object} [properties.linkedServiceName] Linked service reference. - * @member {string} [properties.linkedServiceName.referenceName] Reference - * LinkedService name. - * @member {object} [properties.linkedServiceName.parameters] Arguments for - * LinkedService. - * @member {object} [properties.parameters] Parameters for dataset. - * @member {array} [properties.annotations] List of tags that can be used for - * describing the Dataset. - * @member {object} [properties.folder] The folder that this Dataset is in. If - * not specified, Dataset will appear at the root level. - * @member {string} [properties.folder.name] The name of the folder that this - * Dataset is in. - * @member {string} [properties.type] Polymorphic Discriminator */ export interface DatasetResource extends SubResource { + /** + * Dataset properties. + */ properties: Dataset; } /** - * @class - * Initializes a new instance of the ActivityDependency class. - * @constructor * Activity dependency information. - * - * @member {string} activity Activity name. - * @member {array} dependencyConditions Match-Condition for the dependency. */ export interface ActivityDependency { + /** + * Activity name. + */ activity: string; + /** + * Match-Condition for the dependency. + */ dependencyConditions: string[]; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the UserProperty class. - * @constructor * User property. - * - * @member {string} name User proprety name. - * @member {object} value User proprety value. Type: string (or Expression with - * resultType string). */ export interface UserProperty { + /** + * User proprety name. + */ name: string; + /** + * User proprety value. Type: string (or Expression with resultType string). + */ value: any; } /** - * @class - * Initializes a new instance of the Activity class. - * @constructor * A pipeline activity. - * - * @member {string} name Activity name. - * @member {string} [description] Activity description. - * @member {array} [dependsOn] Activity depends on condition. - * @member {array} [userProperties] Activity user properties. - * @member {string} type Polymorphic Discriminator */ export interface Activity { + /** + * Activity name. + */ name: string; + /** + * Activity description. + */ description?: string; + /** + * Activity depends on condition. + */ dependsOn?: ActivityDependency[]; + /** + * Activity user properties. + */ userProperties?: UserProperty[]; + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the VariableSpecification class. - * @constructor * Definition of a single variable for a Pipeline. - * - * @member {string} type Variable type. Possible values include: 'String', - * 'Bool', 'Array' - * @member {object} [defaultValue] Default value of variable. */ export interface VariableSpecification { + /** + * Variable type. Possible values include: 'String', 'Bool', 'Array' + */ type: string; + /** + * Default value of variable. + */ defaultValue?: any; } /** - * @class - * Initializes a new instance of the PipelineFolder class. - * @constructor - * The folder that this Pipeline is in. If not specified, Pipeline will appear - * at the root level. - * - * @member {string} [name] The name of the folder that this Pipeline is in. + * The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. */ export interface PipelineFolder { + /** + * The name of the folder that this Pipeline is in. + */ name?: string; } /** - * @class - * Initializes a new instance of the PipelineResource class. - * @constructor * Pipeline resource type. - * - * @member {string} [description] The description of the pipeline. - * @member {array} [activities] List of activities in pipeline. - * @member {object} [parameters] List of parameters for pipeline. - * @member {object} [variables] List of variables for pipeline. - * @member {number} [concurrency] The max number of concurrent runs for the - * pipeline. - * @member {array} [annotations] List of tags that can be used for describing - * the Pipeline. - * @member {object} [folder] The folder that this Pipeline is in. If not - * specified, Pipeline will appear at the root level. - * @member {string} [folder.name] The name of the folder that this Pipeline is - * in. */ export interface PipelineResource extends SubResource { + /** + * The description of the pipeline. + */ description?: string; + /** + * List of activities in pipeline. + */ activities?: Activity[]; + /** + * List of parameters for pipeline. + */ parameters?: { [propertyName: string]: ParameterSpecification }; + /** + * List of variables for pipeline. + */ variables?: { [propertyName: string]: VariableSpecification }; + /** + * The max number of concurrent runs for the pipeline. + */ concurrency?: number; + /** + * List of tags that can be used for describing the Pipeline. + */ annotations?: any[]; + /** + * The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. + */ folder?: PipelineFolder; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the Trigger class. - * @constructor - * Azure data factory nested object which contains information about creating - * pipeline run - * - * @member {string} [description] Trigger description. - * @member {string} [runtimeState] Indicates if trigger is running or not. - * Updated when Start/Stop APIs are called on the Trigger. Possible values - * include: 'Started', 'Stopped', 'Disabled' - * @member {string} type Polymorphic Discriminator + * Azure data factory nested object which contains information about creating pipeline run */ export interface Trigger { + /** + * Trigger description. + */ description?: string; + /** + * Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the + * Trigger. Possible values include: 'Started', 'Stopped', 'Disabled' + */ readonly runtimeState?: string; + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the TriggerResource class. - * @constructor * Trigger resource type. - * - * @member {object} properties Properties of the trigger. - * @member {string} [properties.description] Trigger description. - * @member {string} [properties.runtimeState] Indicates if trigger is running - * or not. Updated when Start/Stop APIs are called on the Trigger. Possible - * values include: 'Started', 'Stopped', 'Disabled' - * @member {string} [properties.type] Polymorphic Discriminator */ export interface TriggerResource extends SubResource { + /** + * Properties of the trigger. + */ properties: Trigger; } /** - * @class - * Initializes a new instance of the CreateRunResponse class. - * @constructor * Response body with a run identifier. - * - * @member {string} runId Identifier of a run. */ export interface CreateRunResponse { + /** + * Identifier of a run. + */ runId: string; } /** - * @class - * Initializes a new instance of the FactoryVSTSConfiguration class. - * @constructor * Factory's VSTS repo information. - * - * @member {string} projectName VSTS project name. - * @member {string} [tenantId] VSTS tenant id. */ export interface FactoryVSTSConfiguration extends FactoryRepoConfiguration { + /** + * VSTS project name. + */ projectName: string; + /** + * VSTS tenant id. + */ tenantId?: string; } /** - * @class - * Initializes a new instance of the FactoryGitHubConfiguration class. - * @constructor * Factory's GitHub repo information. - * - * @member {string} [hostName] GitHub Enterprise host name. For example: - * https://github.mydomain.com */ export interface FactoryGitHubConfiguration extends FactoryRepoConfiguration { + /** + * GitHub Enterprise host name. For example: https://github.mydomain.com + */ hostName?: string; } /** - * @class - * Initializes a new instance of the FactoryRepoUpdate class. - * @constructor * Factory's git repo information. - * - * @member {string} [factoryResourceId] The factory resource id. - * @member {object} [repoConfiguration] Git repo information of the factory. - * @member {string} [repoConfiguration.accountName] Account name. - * @member {string} [repoConfiguration.repositoryName] Rrepository name. - * @member {string} [repoConfiguration.collaborationBranch] Collaboration - * branch. - * @member {string} [repoConfiguration.rootFolder] Root folder. - * @member {string} [repoConfiguration.lastCommitId] Last commit id. - * @member {string} [repoConfiguration.type] Polymorphic Discriminator */ export interface FactoryRepoUpdate { + /** + * The factory resource id. + */ factoryResourceId?: string; + /** + * Git repo information of the factory. + */ repoConfiguration?: FactoryRepoConfiguration; } /** - * @class - * Initializes a new instance of the GitHubAccessTokenRequest class. - * @constructor * Get GitHub access token request definition. - * - * @member {string} gitHubAccessCode GitHub access code. - * @member {string} [gitHubClientId] GitHub application client ID. - * @member {string} gitHubAccessTokenBaseUrl GitHub access token base URL. */ export interface GitHubAccessTokenRequest { + /** + * GitHub access code. + */ gitHubAccessCode: string; + /** + * GitHub application client ID. + */ gitHubClientId?: string; + /** + * GitHub access token base URL. + */ gitHubAccessTokenBaseUrl: string; } /** - * @class - * Initializes a new instance of the GitHubAccessTokenResponse class. - * @constructor * Get GitHub access token response definition. - * - * @member {string} [gitHubAccessToken] GitHub access token. */ export interface GitHubAccessTokenResponse { + /** + * GitHub access token. + */ gitHubAccessToken?: string; } /** - * @class - * Initializes a new instance of the PipelineReference class. - * @constructor - * Pipeline reference type. - * - * @member {string} referenceName Reference pipeline name. - * @member {string} [name] Reference name. - */ -export interface PipelineReference { - referenceName: string; - name?: string; -} - -/** - * @class - * Initializes a new instance of the TriggerPipelineReference class. - * @constructor - * Pipeline that needs to be triggered with the given parameters. - * - * @member {object} [pipelineReference] Pipeline reference. - * @member {string} [pipelineReference.referenceName] Reference pipeline name. - * @member {string} [pipelineReference.name] Reference name. - * @member {object} [parameters] Pipeline parameters. + * Get Data Plane read only token request definition. */ -export interface TriggerPipelineReference { - pipelineReference?: PipelineReference; - parameters?: { [propertyName: string]: any }; +export interface UserAccessPolicy { + /** + * The string with permissions for Data Plane access. Currently only 'r' is supported which + * grants read only access. + */ + permissions?: string; + /** + * The resource path to get access relative to factory. Currently only empty string is supported + * which corresponds to the factory resource. + */ + accessResourcePath?: string; + /** + * The name of the profile. Currently only the default is supported. The default value is + * DefaultProfile. + */ + profileName?: string; + /** + * Start time for the token. If not specified the current time will be used. + */ + startTime?: string; + /** + * Expiration time for the token. Maximum duration for the token is eight hours and by default + * the token will expire in eight hours. + */ + expireTime?: string; +} + +/** + * Get Data Plane read only token response definition. + */ +export interface AccessPolicyResponse { + /** + * The user access policy. + */ + policy?: UserAccessPolicy; + /** + * Data Plane read only access token. + */ + accessToken?: string; + /** + * Data Plane service base URL. + */ + dataPlaneUrl?: string; +} + +/** + * Pipeline reference type. + */ +export interface PipelineReference { + /** + * Reference pipeline name. + */ + referenceName: string; + /** + * Reference name. + */ + name?: string; +} + +/** + * Pipeline that needs to be triggered with the given parameters. + */ +export interface TriggerPipelineReference { + /** + * Pipeline reference. + */ + pipelineReference?: PipelineReference; + /** + * Pipeline parameters. + */ + parameters?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the FactoryUpdateParameters class. - * @constructor * Parameters for updating a factory resource. - * - * @member {object} [tags] The resource tags. - * @member {object} [identity] Managed service identity of the factory. - * @member {uuid} [identity.principalId] The principal id of the identity. - * @member {uuid} [identity.tenantId] The client tenant id of the identity. */ export interface FactoryUpdateParameters { + /** + * The resource tags. + */ tags?: { [propertyName: string]: string }; + /** + * Managed service identity of the factory. + */ identity?: FactoryIdentity; } /** - * @class - * Initializes a new instance of the DatasetReference class. - * @constructor * Dataset reference type. - * - * @member {string} referenceName Reference dataset name. - * @member {object} [parameters] Arguments for dataset. */ export interface DatasetReference { + /** + * Reference dataset name. + */ referenceName: string; + /** + * Arguments for dataset. + */ parameters?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the RunQueryFilter class. - * @constructor * Query filter option for listing runs. - * - * @member {string} operand Parameter name to be used for filter. The allowed - * operands to query pipeline runs are PipelineName, RunStart, RunEnd and - * Status; to query activity runs are ActivityName, ActivityRunStart, - * ActivityRunEnd, ActivityType and Status, and to query trigger runs are - * TriggerName, TriggerRunTimestamp and Status. Possible values include: - * 'PipelineName', 'Status', 'RunStart', 'RunEnd', 'ActivityName', - * 'ActivityRunStart', 'ActivityRunEnd', 'ActivityType', 'TriggerName', - * 'TriggerRunTimestamp' - * @member {string} operator Operator to be used for filter. Possible values - * include: 'Equals', 'NotEquals', 'In', 'NotIn' - * @member {array} values List of filter values. */ export interface RunQueryFilter { + /** + * Parameter name to be used for filter. The allowed operands to query pipeline runs are + * PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, + * ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are + * TriggerName, TriggerRunTimestamp and Status. Possible values include: 'PipelineName', + * 'Status', 'RunStart', 'RunEnd', 'ActivityName', 'ActivityRunStart', 'ActivityRunEnd', + * 'ActivityType', 'TriggerName', 'TriggerRunTimestamp' + */ operand: string; + /** + * Operator to be used for filter. Possible values include: 'Equals', 'NotEquals', 'In', 'NotIn' + */ operator: string; + /** + * List of filter values. + */ values: string[]; } /** - * @class - * Initializes a new instance of the RunQueryOrderBy class. - * @constructor * An object to provide order by options for listing runs. - * - * @member {string} orderBy Parameter name to be used for order by. The allowed - * parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd - * and Status; for activity runs are ActivityName, ActivityRunStart, - * ActivityRunEnd and Status; for trigger runs are TriggerName, - * TriggerRunTimestamp and Status. Possible values include: 'RunStart', - * 'RunEnd', 'PipelineName', 'Status', 'ActivityName', 'ActivityRunStart', - * 'ActivityRunEnd', 'TriggerName', 'TriggerRunTimestamp' - * @member {string} order Sorting order of the parameter. Possible values - * include: 'ASC', 'DESC' */ export interface RunQueryOrderBy { + /** + * Parameter name to be used for order by. The allowed parameters to order by for pipeline runs + * are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, + * ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, + * TriggerRunTimestamp and Status. Possible values include: 'RunStart', 'RunEnd', 'PipelineName', + * 'Status', 'ActivityName', 'ActivityRunStart', 'ActivityRunEnd', 'TriggerName', + * 'TriggerRunTimestamp' + */ orderBy: string; + /** + * Sorting order of the parameter. Possible values include: 'ASC', 'DESC' + */ order: string; } /** - * @class - * Initializes a new instance of the RunFilterParameters class. - * @constructor * Query parameters for listing runs. - * - * @member {string} [continuationToken] The continuation token for getting the - * next page of results. Null for first page. - * @member {date} lastUpdatedAfter The time at or after which the run event was - * updated in 'ISO 8601' format. - * @member {date} lastUpdatedBefore The time at or before which the run event - * was updated in 'ISO 8601' format. - * @member {array} [filters] List of filters. - * @member {array} [orderBy] List of OrderBy option. */ export interface RunFilterParameters { + /** + * The continuation token for getting the next page of results. Null for first page. + */ continuationToken?: string; + /** + * The time at or after which the run event was updated in 'ISO 8601' format. + */ lastUpdatedAfter: Date; + /** + * The time at or before which the run event was updated in 'ISO 8601' format. + */ lastUpdatedBefore: Date; + /** + * List of filters. + */ filters?: RunQueryFilter[]; + /** + * List of OrderBy option. + */ orderBy?: RunQueryOrderBy[]; } /** - * @class - * Initializes a new instance of the PipelineRunInvokedBy class. - * @constructor * Provides entity name and id that started the pipeline run. - * - * @member {string} [name] Name of the entity that started the pipeline run. - * @member {string} [id] The ID of the entity that started the run. - * @member {string} [invokedByType] The type of the entity that started the - * run. */ export interface PipelineRunInvokedBy { + /** + * Name of the entity that started the pipeline run. + */ readonly name?: string; + /** + * The ID of the entity that started the run. + */ readonly id?: string; + /** + * The type of the entity that started the run. + */ readonly invokedByType?: string; } /** - * @class - * Initializes a new instance of the PipelineRun class. - * @constructor * Information about a pipeline run. - * - * @member {string} [runId] Identifier of a run. - * @member {string} [pipelineName] The pipeline name. - * @member {object} [parameters] The full or partial list of parameter name, - * value pair used in the pipeline run. - * @member {object} [invokedBy] Entity that started the pipeline run. - * @member {string} [invokedBy.name] Name of the entity that started the - * pipeline run. - * @member {string} [invokedBy.id] The ID of the entity that started the run. - * @member {string} [invokedBy.invokedByType] The type of the entity that - * started the run. - * @member {date} [lastUpdated] The last updated timestamp for the pipeline run - * event in ISO8601 format. - * @member {date} [runStart] The start time of a pipeline run in ISO8601 - * format. - * @member {date} [runEnd] The end time of a pipeline run in ISO8601 format. - * @member {number} [durationInMs] The duration of a pipeline run. - * @member {string} [status] The status of a pipeline run. - * @member {string} [message] The message from a pipeline run. */ export interface PipelineRun { + /** + * Identifier of a run. + */ readonly runId?: string; + /** + * The pipeline name. + */ readonly pipelineName?: string; + /** + * The full or partial list of parameter name, value pair used in the pipeline run. + */ readonly parameters?: { [propertyName: string]: string }; + /** + * Entity that started the pipeline run. + */ readonly invokedBy?: PipelineRunInvokedBy; + /** + * The last updated timestamp for the pipeline run event in ISO8601 format. + */ readonly lastUpdated?: Date; + /** + * The start time of a pipeline run in ISO8601 format. + */ readonly runStart?: Date; + /** + * The end time of a pipeline run in ISO8601 format. + */ readonly runEnd?: Date; + /** + * The duration of a pipeline run. + */ readonly durationInMs?: number; + /** + * The status of a pipeline run. + */ readonly status?: string; + /** + * The message from a pipeline run. + */ readonly message?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the PipelineRunsQueryResponse class. - * @constructor * A list pipeline runs. - * - * @member {array} value List of pipeline runs. - * @member {string} [continuationToken] The continuation token for getting the - * next page of results, if any remaining results exist, null otherwise. */ export interface PipelineRunsQueryResponse { + /** + * List of pipeline runs. + */ value: PipelineRun[]; + /** + * The continuation token for getting the next page of results, if any remaining results exist, + * null otherwise. + */ continuationToken?: string; } /** - * @class - * Initializes a new instance of the ActivityRun class. - * @constructor * Information about an activity run in a pipeline. - * - * @member {string} [pipelineName] The name of the pipeline. - * @member {string} [pipelineRunId] The id of the pipeline run. - * @member {string} [activityName] The name of the activity. - * @member {string} [activityType] The type of the activity. - * @member {string} [activityRunId] The id of the activity run. - * @member {string} [linkedServiceName] The name of the compute linked service. - * @member {string} [status] The status of the activity run. - * @member {date} [activityRunStart] The start time of the activity run in 'ISO - * 8601' format. - * @member {date} [activityRunEnd] The end time of the activity run in 'ISO - * 8601' format. - * @member {number} [durationInMs] The duration of the activity run. - * @member {object} [input] The input for the activity. - * @member {object} [output] The output for the activity. - * @member {object} [error] The error if any from the activity run. */ export interface ActivityRun { + /** + * The name of the pipeline. + */ readonly pipelineName?: string; + /** + * The id of the pipeline run. + */ readonly pipelineRunId?: string; + /** + * The name of the activity. + */ readonly activityName?: string; + /** + * The type of the activity. + */ readonly activityType?: string; + /** + * The id of the activity run. + */ readonly activityRunId?: string; + /** + * The name of the compute linked service. + */ readonly linkedServiceName?: string; + /** + * The status of the activity run. + */ readonly status?: string; + /** + * The start time of the activity run in 'ISO 8601' format. + */ readonly activityRunStart?: Date; + /** + * The end time of the activity run in 'ISO 8601' format. + */ readonly activityRunEnd?: Date; + /** + * The duration of the activity run. + */ readonly durationInMs?: number; + /** + * The input for the activity. + */ readonly input?: any; + /** + * The output for the activity. + */ readonly output?: any; + /** + * The error if any from the activity run. + */ readonly error?: any; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ActivityRunsQueryResponse class. - * @constructor * A list activity runs. - * - * @member {array} value List of activity runs. - * @member {string} [continuationToken] The continuation token for getting the - * next page of results, if any remaining results exist, null otherwise. */ export interface ActivityRunsQueryResponse { + /** + * List of activity runs. + */ value: ActivityRun[]; + /** + * The continuation token for getting the next page of results, if any remaining results exist, + * null otherwise. + */ continuationToken?: string; } /** - * @class - * Initializes a new instance of the TriggerRun class. - * @constructor * Trigger runs. - * - * @member {string} [triggerRunId] Trigger run id. - * @member {string} [triggerName] Trigger name. - * @member {string} [triggerType] Trigger type. - * @member {date} [triggerRunTimestamp] Trigger run start time. - * @member {string} [status] Trigger run status. Possible values include: - * 'Succeeded', 'Failed', 'Inprogress' - * @member {string} [message] Trigger error message. - * @member {object} [properties] List of property name and value related to - * trigger run. Name, value pair depends on type of trigger. - * @member {object} [triggeredPipelines] List of pipeline name and run Id - * triggered by the trigger run. */ export interface TriggerRun { + /** + * Trigger run id. + */ readonly triggerRunId?: string; + /** + * Trigger name. + */ readonly triggerName?: string; + /** + * Trigger type. + */ readonly triggerType?: string; + /** + * Trigger run start time. + */ readonly triggerRunTimestamp?: Date; + /** + * Trigger run status. Possible values include: 'Succeeded', 'Failed', 'Inprogress' + */ readonly status?: string; + /** + * Trigger error message. + */ readonly message?: string; + /** + * List of property name and value related to trigger run. Name, value pair depends on type of + * trigger. + */ readonly properties?: { [propertyName: string]: string }; + /** + * List of pipeline name and run Id triggered by the trigger run. + */ readonly triggeredPipelines?: { [propertyName: string]: string }; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the TriggerRunsQueryResponse class. - * @constructor * A list of trigger runs. - * - * @member {array} value List of trigger runs. - * @member {string} [continuationToken] The continuation token for getting the - * next page of results, if any remaining results exist, null otherwise. */ export interface TriggerRunsQueryResponse { + /** + * List of trigger runs. + */ value: TriggerRun[]; + /** + * The continuation token for getting the next page of results, if any remaining results exist, + * null otherwise. + */ continuationToken?: string; } /** - * @class - * Initializes a new instance of the RerunTumblingWindowTriggerActionParameters class. - * @constructor * Rerun tumbling window trigger Parameters. - * - * @member {date} startTime The start time for the time period for which - * restatement is initiated. Only UTC time is currently supported. - * @member {date} endTime The end time for the time period for which - * restatement is initiated. Only UTC time is currently supported. - * @member {number} maxConcurrency The max number of parallel time windows - * (ready for execution) for which a rerun is triggered. */ export interface RerunTumblingWindowTriggerActionParameters { + /** + * The start time for the time period for which restatement is initiated. Only UTC time is + * currently supported. + */ startTime: Date; + /** + * The end time for the time period for which restatement is initiated. Only UTC time is + * currently supported. + */ endTime: Date; + /** + * The max number of parallel time windows (ready for execution) for which a rerun is triggered. + */ maxConcurrency: number; } /** - * @class - * Initializes a new instance of the RerunTumblingWindowTrigger class. - * @constructor - * Trigger that schedules pipeline reruns for all fixed time interval windows - * from a requested start time to requested end time. - * - * @member {object} [parentTrigger] The parent trigger reference. - * @member {date} requestedStartTime The start time for the time period for - * which restatement is initiated. Only UTC time is currently supported. - * @member {date} requestedEndTime The end time for the time period for which - * restatement is initiated. Only UTC time is currently supported. - * @member {number} maxConcurrency The max number of parallel time windows - * (ready for execution) for which a rerun is triggered. + * Trigger that schedules pipeline reruns for all fixed time interval windows from a requested + * start time to requested end time. */ export interface RerunTumblingWindowTrigger extends Trigger { + /** + * The parent trigger reference. + */ parentTrigger?: any; + /** + * The start time for the time period for which restatement is initiated. Only UTC time is + * currently supported. + */ requestedStartTime: Date; + /** + * The end time for the time period for which restatement is initiated. Only UTC time is + * currently supported. + */ requestedEndTime: Date; + /** + * The max number of parallel time windows (ready for execution) for which a rerun is triggered. + */ maxConcurrency: number; } /** - * @class - * Initializes a new instance of the RerunTriggerResource class. - * @constructor * RerunTrigger resource type. - * - * @member {object} properties Properties of the rerun trigger. - * @member {object} [properties.parentTrigger] The parent trigger reference. - * @member {date} [properties.requestedStartTime] The start time for the time - * period for which restatement is initiated. Only UTC time is currently - * supported. - * @member {date} [properties.requestedEndTime] The end time for the time - * period for which restatement is initiated. Only UTC time is currently - * supported. - * @member {number} [properties.maxConcurrency] The max number of parallel time - * windows (ready for execution) for which a rerun is triggered. */ export interface RerunTriggerResource extends SubResource { + /** + * Properties of the rerun trigger. + */ properties: RerunTumblingWindowTrigger; } /** - * @class - * Initializes a new instance of the OperationDisplay class. - * @constructor * Metadata associated with the operation. - * - * @member {string} [description] The description of the operation. - * @member {string} [provider] The name of the provider. - * @member {string} [resource] The name of the resource type on which the - * operation is performed. - * @member {string} [operation] The type of operation: get, read, delete, etc. */ export interface OperationDisplay { + /** + * The description of the operation. + */ description?: string; + /** + * The name of the provider. + */ provider?: string; + /** + * The name of the resource type on which the operation is performed. + */ resource?: string; + /** + * The type of operation: get, read, delete, etc. + */ operation?: string; } /** - * @class - * Initializes a new instance of the OperationLogSpecification class. - * @constructor * Details about an operation related to logs. - * - * @member {string} [name] The name of the log category. - * @member {string} [displayName] Localized display name. - * @member {string} [blobDuration] Blobs created in the customer storage - * account, per hour. */ export interface OperationLogSpecification { + /** + * The name of the log category. + */ name?: string; + /** + * Localized display name. + */ displayName?: string; + /** + * Blobs created in the customer storage account, per hour. + */ blobDuration?: string; } /** - * @class - * Initializes a new instance of the OperationMetricAvailability class. - * @constructor * Defines how often data for a metric becomes available. - * - * @member {string} [timeGrain] The granularity for the metric. - * @member {string} [blobDuration] Blob created in the customer storage - * account, per hour. */ export interface OperationMetricAvailability { + /** + * The granularity for the metric. + */ timeGrain?: string; + /** + * Blob created in the customer storage account, per hour. + */ blobDuration?: string; } /** - * @class - * Initializes a new instance of the OperationMetricDimension class. - * @constructor * Defines the metric dimension. - * - * @member {string} [name] The name of the dimension for the metric. - * @member {string} [displayName] The display name of the metric dimension. - * @member {boolean} [toBeExportedForShoebox] Whether the dimension should be - * exported to Azure Monitor. */ export interface OperationMetricDimension { + /** + * The name of the dimension for the metric. + */ name?: string; + /** + * The display name of the metric dimension. + */ displayName?: string; + /** + * Whether the dimension should be exported to Azure Monitor. + */ toBeExportedForShoebox?: boolean; } /** - * @class - * Initializes a new instance of the OperationMetricSpecification class. - * @constructor * Details about an operation related to metrics. - * - * @member {string} [name] The name of the metric. - * @member {string} [displayName] Localized display name of the metric. - * @member {string} [displayDescription] The description of the metric. - * @member {string} [unit] The unit that the metric is measured in. - * @member {string} [aggregationType] The type of metric aggregation. - * @member {string} [enableRegionalMdmAccount] Whether or not the service is - * using regional MDM accounts. - * @member {string} [sourceMdmAccount] The name of the MDM account. - * @member {string} [sourceMdmNamespace] The name of the MDM namespace. - * @member {array} [availabilities] Defines how often data for metrics becomes - * available. - * @member {array} [dimensions] Defines the metric dimension. */ export interface OperationMetricSpecification { + /** + * The name of the metric. + */ name?: string; + /** + * Localized display name of the metric. + */ displayName?: string; + /** + * The description of the metric. + */ displayDescription?: string; + /** + * The unit that the metric is measured in. + */ unit?: string; + /** + * The type of metric aggregation. + */ aggregationType?: string; + /** + * Whether or not the service is using regional MDM accounts. + */ enableRegionalMdmAccount?: string; + /** + * The name of the MDM account. + */ sourceMdmAccount?: string; + /** + * The name of the MDM namespace. + */ sourceMdmNamespace?: string; + /** + * Defines how often data for metrics becomes available. + */ availabilities?: OperationMetricAvailability[]; + /** + * Defines the metric dimension. + */ dimensions?: OperationMetricDimension[]; } /** - * @class - * Initializes a new instance of the OperationServiceSpecification class. - * @constructor * Details about a service operation. - * - * @member {array} [logSpecifications] Details about operations related to - * logs. - * @member {array} [metricSpecifications] Details about operations related to - * metrics. */ export interface OperationServiceSpecification { + /** + * Details about operations related to logs. + */ logSpecifications?: OperationLogSpecification[]; + /** + * Details about operations related to metrics. + */ metricSpecifications?: OperationMetricSpecification[]; } /** - * @class - * Initializes a new instance of the Operation class. - * @constructor * Azure Data Factory API operation definition. - * - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {string} [origin] The intended executor of the operation. - * @member {object} [display] Metadata associated with the operation. - * @member {string} [display.description] The description of the operation. - * @member {string} [display.provider] The name of the provider. - * @member {string} [display.resource] The name of the resource type on which - * the operation is performed. - * @member {string} [display.operation] The type of operation: get, read, - * delete, etc. - * @member {object} [serviceSpecification] Details about a service operation. - * @member {array} [serviceSpecification.logSpecifications] Details about - * operations related to logs. - * @member {array} [serviceSpecification.metricSpecifications] Details about - * operations related to metrics. */ export interface Operation { + /** + * Operation name: {provider}/{resource}/{operation} + */ name?: string; + /** + * The intended executor of the operation. + */ origin?: string; + /** + * Metadata associated with the operation. + */ display?: OperationDisplay; + /** + * Details about a service operation. + */ serviceSpecification?: OperationServiceSpecification; } /** - * @class - * Initializes a new instance of the DependencyReference class. - * @constructor * Referenced dependency. - * - * @member {string} type Polymorphic Discriminator */ export interface DependencyReference { + /** + * Polymorphic Discriminator + */ type: string; } /** - * @class - * Initializes a new instance of the SelfDependencyTumblingWindowTriggerReference class. - * @constructor * Self referenced tumbling window trigger dependency. - * - * @member {string} offset Timespan applied to the start time of a tumbling - * window when evaluating dependency. - * @member {string} [size] The size of the window when evaluating the - * dependency. If undefined the frequency of the tumbling window will be used. */ export interface SelfDependencyTumblingWindowTriggerReference extends DependencyReference { + /** + * Timespan applied to the start time of a tumbling window when evaluating dependency. + */ offset: string; + /** + * The size of the window when evaluating the dependency. If undefined the frequency of the + * tumbling window will be used. + */ size?: string; } /** - * @class - * Initializes a new instance of the TriggerReference class. - * @constructor * Trigger reference type. - * - * @member {string} referenceName Reference trigger name. */ export interface TriggerReference { - referenceName: string; + /** + * Reference trigger name. + */ + referenceName: string; } /** - * @class - * Initializes a new instance of the TriggerDependencyReference class. - * @constructor * Trigger referenced dependency. - * - * @member {object} referenceTrigger Referenced trigger. - * @member {string} [referenceTrigger.referenceName] Reference trigger name. */ export interface TriggerDependencyReference extends DependencyReference { + /** + * Referenced trigger. + */ referenceTrigger: TriggerReference; } /** - * @class - * Initializes a new instance of the TumblingWindowTriggerDependencyReference class. - * @constructor * Referenced tumbling window trigger dependency. - * - * @member {string} [offset] Timespan applied to the start time of a tumbling - * window when evaluating dependency. - * @member {string} [size] The size of the window when evaluating the - * dependency. If undefined the frequency of the tumbling window will be used. */ export interface TumblingWindowTriggerDependencyReference extends TriggerDependencyReference { + /** + * Timespan applied to the start time of a tumbling window when evaluating dependency. + */ offset?: string; + /** + * The size of the window when evaluating the dependency. If undefined the frequency of the + * tumbling window will be used. + */ size?: string; } /** - * @class - * Initializes a new instance of the RetryPolicy class. - * @constructor * Execution policy for an activity. - * - * @member {object} [count] Maximum ordinary retry attempts. Default is 0. - * Type: integer (or Expression with resultType integer), minimum: 0. - * @member {number} [intervalInSeconds] Interval between retries in seconds. - * Default is 30. */ export interface RetryPolicy { + /** + * Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType + * integer), minimum: 0. + */ count?: any; + /** + * Interval between retries in seconds. Default is 30. + */ intervalInSeconds?: number; } /** - * @class - * Initializes a new instance of the TumblingWindowTrigger class. - * @constructor - * Trigger that schedules pipeline runs for all fixed time interval windows - * from a start time without gaps and also supports backfill scenarios (when - * start time is in the past). - * - * @member {object} pipelineProperty Pipeline for which runs are created when - * an event is fired for trigger window that is ready. - * @member {object} [pipelineProperty.pipelineReference] Pipeline reference. - * @member {string} [pipelineProperty.pipelineReference.referenceName] - * Reference pipeline name. - * @member {string} [pipelineProperty.pipelineReference.name] Reference name. - * @member {object} [pipelineProperty.parameters] Pipeline parameters. - * @member {string} frequency The frequency of the time windows. Possible - * values include: 'Minute', 'Hour' - * @member {number} interval The interval of the time windows. The minimum - * interval allowed is 15 Minutes. - * @member {date} startTime The start time for the time period for the trigger - * during which events are fired for windows that are ready. Only UTC time is - * currently supported. - * @member {date} [endTime] The end time for the time period for the trigger - * during which events are fired for windows that are ready. Only UTC time is - * currently supported. - * @member {object} [delay] Specifies how long the trigger waits past due time - * before triggering new run. It doesn't alter window start and end time. The - * default is 0. Type: string (or Expression with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {number} maxConcurrency The max number of parallel time windows - * (ready for execution) for which a new run is triggered. - * @member {object} [retryPolicy] Retry policy that will be applied for failed - * pipeline runs. - * @member {object} [retryPolicy.count] Maximum ordinary retry attempts. - * Default is 0. Type: integer (or Expression with resultType integer), - * minimum: 0. - * @member {number} [retryPolicy.intervalInSeconds] Interval between retries in - * seconds. Default is 30. - * @member {array} [dependsOn] Triggers that this trigger depends on. Only - * tumbling window triggers are supported. + * Trigger that schedules pipeline runs for all fixed time interval windows from a start time + * without gaps and also supports backfill scenarios (when start time is in the past). */ export interface TumblingWindowTrigger extends Trigger { + /** + * Pipeline for which runs are created when an event is fired for trigger window that is ready. + */ pipelineProperty: TriggerPipelineReference; + /** + * The frequency of the time windows. Possible values include: 'Minute', 'Hour' + */ frequency: string; + /** + * The interval of the time windows. The minimum interval allowed is 15 Minutes. + */ interval: number; + /** + * The start time for the time period for the trigger during which events are fired for windows + * that are ready. Only UTC time is currently supported. + */ startTime: Date; + /** + * The end time for the time period for the trigger during which events are fired for windows + * that are ready. Only UTC time is currently supported. + */ endTime?: Date; + /** + * Specifies how long the trigger waits past due time before triggering new run. It doesn't alter + * window start and end time. The default is 0. Type: string (or Expression with resultType + * string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). + */ delay?: any; + /** + * The max number of parallel time windows (ready for execution) for which a new run is + * triggered. + */ maxConcurrency: number; + /** + * Retry policy that will be applied for failed pipeline runs. + */ retryPolicy?: RetryPolicy; + /** + * Triggers that this trigger depends on. Only tumbling window triggers are supported. + */ dependsOn?: DependencyReference[]; } /** - * @class - * Initializes a new instance of the MultiplePipelineTrigger class. - * @constructor - * Base class for all triggers that support one to many model for trigger to - * pipeline. - * - * @member {array} [pipelines] Pipelines that need to be started. + * Base class for all triggers that support one to many model for trigger to pipeline. */ export interface MultiplePipelineTrigger extends Trigger { + /** + * Pipelines that need to be started. + */ pipelines?: TriggerPipelineReference[]; } /** - * @class - * Initializes a new instance of the BlobEventsTrigger class. - * @constructor * Trigger that runs everytime a Blob event occurs. - * - * @member {string} [blobPathBeginsWith] The blob path must begin with the - * pattern provided for trigger to fire. For example, - * '/records/blobs/december/' will only fire the trigger for blobs in the - * december folder under the records container. At least one of these must be - * provided: blobPathBeginsWith, blobPathEndsWith. - * @member {string} [blobPathEndsWith] The blob path must end with the pattern - * provided for trigger to fire. For example, 'december/boxes.csv' will only - * fire the trigger for blobs named boxes in a december folder. At least one of - * these must be provided: blobPathBeginsWith, blobPathEndsWith. - * @member {array} events The type of events that cause this trigger to fire. - * @member {string} scope The ARM resource ID of the Storage Account. */ export interface BlobEventsTrigger extends MultiplePipelineTrigger { + /** + * The blob path must begin with the pattern provided for trigger to fire. For example, + * '/records/blobs/december/' will only fire the trigger for blobs in the december folder under + * the records container. At least one of these must be provided: blobPathBeginsWith, + * blobPathEndsWith. + */ blobPathBeginsWith?: string; + /** + * The blob path must end with the pattern provided for trigger to fire. For example, + * 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At + * least one of these must be provided: blobPathBeginsWith, blobPathEndsWith. + */ blobPathEndsWith?: string; + /** + * The type of events that cause this trigger to fire. + */ events: string[]; + /** + * The ARM resource ID of the Storage Account. + */ scope: string; } /** - * @class - * Initializes a new instance of the BlobTrigger class. - * @constructor * Trigger that runs everytime the selected Blob container changes. - * - * @member {string} folderPath The path of the container/folder that will - * trigger the pipeline. - * @member {number} maxConcurrency The max number of parallel files to handle - * when it is triggered. - * @member {object} linkedService The Azure Storage linked service reference. - * @member {string} [linkedService.referenceName] Reference LinkedService name. - * @member {object} [linkedService.parameters] Arguments for LinkedService. */ export interface BlobTrigger extends MultiplePipelineTrigger { + /** + * The path of the container/folder that will trigger the pipeline. + */ folderPath: string; + /** + * The max number of parallel files to handle when it is triggered. + */ maxConcurrency: number; + /** + * The Azure Storage linked service reference. + */ linkedService: LinkedServiceReference; } /** - * @class - * Initializes a new instance of the RecurrenceScheduleOccurrence class. - * @constructor * The recurrence schedule occurence. - * - * @member {string} [day] The day of the week. Possible values include: - * 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday' - * @member {number} [occurrence] The occurrence. */ export interface RecurrenceScheduleOccurrence { + /** + * The day of the week. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', + * 'Thursday', 'Friday', 'Saturday' + */ day?: string; + /** + * The occurrence. + */ occurrence?: number; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the RecurrenceSchedule class. - * @constructor * The recurrence schedule. - * - * @member {array} [minutes] The minutes. - * @member {array} [hours] The hours. - * @member {array} [weekDays] The days of the week. - * @member {array} [monthDays] The month days. - * @member {array} [monthlyOccurrences] The monthly occurrences. */ export interface RecurrenceSchedule { + /** + * The minutes. + */ minutes?: number[]; + /** + * The hours. + */ hours?: number[]; + /** + * The days of the week. + */ weekDays?: string[]; + /** + * The month days. + */ monthDays?: number[]; + /** + * The monthly occurrences. + */ monthlyOccurrences?: RecurrenceScheduleOccurrence[]; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ScheduleTriggerRecurrence class. - * @constructor * The workflow trigger recurrence. - * - * @member {string} [frequency] The frequency. Possible values include: - * 'NotSpecified', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year' - * @member {number} [interval] The interval. - * @member {date} [startTime] The start time. - * @member {date} [endTime] The end time. - * @member {string} [timeZone] The time zone. - * @member {object} [schedule] The recurrence schedule. - * @member {array} [schedule.minutes] The minutes. - * @member {array} [schedule.hours] The hours. - * @member {array} [schedule.weekDays] The days of the week. - * @member {array} [schedule.monthDays] The month days. - * @member {array} [schedule.monthlyOccurrences] The monthly occurrences. */ export interface ScheduleTriggerRecurrence { + /** + * The frequency. Possible values include: 'NotSpecified', 'Minute', 'Hour', 'Day', 'Week', + * 'Month', 'Year' + */ frequency?: string; + /** + * The interval. + */ interval?: number; + /** + * The start time. + */ startTime?: Date; + /** + * The end time. + */ endTime?: Date; + /** + * The time zone. + */ timeZone?: string; + /** + * The recurrence schedule. + */ schedule?: RecurrenceSchedule; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ScheduleTrigger class. - * @constructor * Trigger that creates pipeline runs periodically, on schedule. - * - * @member {object} recurrence Recurrence schedule configuration. - * @member {string} [recurrence.frequency] The frequency. Possible values - * include: 'NotSpecified', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year' - * @member {number} [recurrence.interval] The interval. - * @member {date} [recurrence.startTime] The start time. - * @member {date} [recurrence.endTime] The end time. - * @member {string} [recurrence.timeZone] The time zone. - * @member {object} [recurrence.schedule] The recurrence schedule. - * @member {array} [recurrence.schedule.minutes] The minutes. - * @member {array} [recurrence.schedule.hours] The hours. - * @member {array} [recurrence.schedule.weekDays] The days of the week. - * @member {array} [recurrence.schedule.monthDays] The month days. - * @member {array} [recurrence.schedule.monthlyOccurrences] The monthly - * occurrences. */ export interface ScheduleTrigger extends MultiplePipelineTrigger { + /** + * Recurrence schedule configuration. + */ recurrence: ScheduleTriggerRecurrence; } /** - * @class - * Initializes a new instance of the ResponsysLinkedService class. - * @constructor * Responsys linked service. - * - * @member {object} endpoint The endpoint of the Responsys server. - * @member {object} clientId The client ID associated with the Responsys - * application. Type: string (or Expression with resultType string). - * @member {object} [clientSecret] The client secret associated with the - * Responsys application. Type: string (or Expression with resultType string). - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. Type: - * boolean (or Expression with resultType boolean). - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. Type: boolean (or Expression - * with resultType boolean). - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * Type: boolean (or Expression with resultType boolean). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface ResponsysLinkedService extends LinkedService { + /** + * The endpoint of the Responsys server. + */ endpoint: any; + /** + * The client ID associated with the Responsys application. Type: string (or Expression with + * resultType string). + */ clientId: any; + /** + * The client secret associated with the Responsys application. Type: string (or Expression with + * resultType string). + */ clientSecret?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. Type: boolean (or Expression with resultType boolean). + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. Type: boolean (or + * Expression with resultType boolean). + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. Type: boolean (or Expression with resultType boolean). + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AzureDatabricksLinkedService class. - * @constructor * Azure Databricks linked service. - * - * @member {object} domain .azuredatabricks.net, domain name of your - * Databricks deployment. Type: string (or Expression with resultType string). - * @member {object} accessToken Access token for databricks REST API. Refer to - * https://docs.azuredatabricks.net/api/latest/authentication.html. Type: - * string (or Expression with resultType string). - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} [existingClusterId] The id of an existing cluster that will - * be used for all runs of this job. Type: string (or Expression with - * resultType string). - * @member {object} [newClusterVersion] The Spark version of new cluster. Type: - * string (or Expression with resultType string). - * @member {object} [newClusterNumOfWorker] Number of worker nodes that new - * cluster should have. A string formatted Int32, like '1' means numOfWorker is - * 1 or '1:10' means auto-scale from 1 as min and 10 as max. Type: string (or - * Expression with resultType string). - * @member {object} [newClusterNodeType] The node types of new cluster. Type: - * string (or Expression with resultType string). - * @member {object} [newClusterSparkConf] A set of optional, user-specified - * Spark configuration key-value pairs. - * @member {object} [newClusterSparkEnvVars] A set of optional, user-specified - * Spark environment variables key-value pairs. - * @member {object} [newClusterCustomTags] Additional tags for cluster - * resources. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureDatabricksLinkedService extends LinkedService { + /** + * .azuredatabricks.net, domain name of your Databricks deployment. Type: string (or + * Expression with resultType string). + */ domain: any; + /** + * Access token for databricks REST API. Refer to + * https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression + * with resultType string). + */ accessToken: SecretBase; + /** + * The id of an existing cluster that will be used for all runs of this job. Type: string (or + * Expression with resultType string). + */ existingClusterId?: any; + /** + * The Spark version of new cluster. Type: string (or Expression with resultType string). + */ newClusterVersion?: any; + /** + * Number of worker nodes that new cluster should have. A string formatted Int32, like '1' means + * numOfWorker is 1 or '1:10' means auto-scale from 1 as min and 10 as max. Type: string (or + * Expression with resultType string). + */ newClusterNumOfWorker?: any; + /** + * The node types of new cluster. Type: string (or Expression with resultType string). + */ newClusterNodeType?: any; + /** + * A set of optional, user-specified Spark configuration key-value pairs. + */ newClusterSparkConf?: { [propertyName: string]: any }; + /** + * A set of optional, user-specified Spark environment variables key-value pairs. + */ newClusterSparkEnvVars?: { [propertyName: string]: any }; + /** + * Additional tags for cluster resources. + */ newClusterCustomTags?: { [propertyName: string]: any }; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AzureDataLakeAnalyticsLinkedService class. - * @constructor * Azure Data Lake Analytics linked service. - * - * @member {object} accountName The Azure Data Lake Analytics account name. - * Type: string (or Expression with resultType string). - * @member {object} [servicePrincipalId] The ID of the application used to - * authenticate against the Azure Data Lake Analytics account. Type: string (or - * Expression with resultType string). - * @member {object} [servicePrincipalKey] The Key of the application used to - * authenticate against the Azure Data Lake Analytics account. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} tenant The name or ID of the tenant to which the service - * principal belongs. Type: string (or Expression with resultType string). - * @member {object} [subscriptionId] Data Lake Analytics account subscription - * ID (if different from Data Factory account). Type: string (or Expression - * with resultType string). - * @member {object} [resourceGroupName] Data Lake Analytics account resource - * group name (if different from Data Factory account). Type: string (or - * Expression with resultType string). - * @member {object} [dataLakeAnalyticsUri] Azure Data Lake Analytics URI Type: - * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureDataLakeAnalyticsLinkedService extends LinkedService { + /** + * The Azure Data Lake Analytics account name. Type: string (or Expression with resultType + * string). + */ accountName: any; + /** + * The ID of the application used to authenticate against the Azure Data Lake Analytics account. + * Type: string (or Expression with resultType string). + */ servicePrincipalId?: any; + /** + * The Key of the application used to authenticate against the Azure Data Lake Analytics account. + */ servicePrincipalKey?: SecretBase; + /** + * The name or ID of the tenant to which the service principal belongs. Type: string (or + * Expression with resultType string). + */ tenant: any; + /** + * Data Lake Analytics account subscription ID (if different from Data Factory account). Type: + * string (or Expression with resultType string). + */ subscriptionId?: any; + /** + * Data Lake Analytics account resource group name (if different from Data Factory account). + * Type: string (or Expression with resultType string). + */ resourceGroupName?: any; + /** + * Azure Data Lake Analytics URI Type: string (or Expression with resultType string). + */ dataLakeAnalyticsUri?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the ScriptAction class. - * @constructor * Custom script action to run on HDI ondemand cluster once it's up. - * - * @member {string} name The user provided name of the script action. - * @member {string} uri The URI for the script action. - * @member {object} roles The node types on which the script action should be - * executed. - * @member {string} [parameters] The parameters for the script action. */ export interface ScriptAction { + /** + * The user provided name of the script action. + */ name: string; + /** + * The URI for the script action. + */ uri: string; + /** + * The node types on which the script action should be executed. + */ roles: any; + /** + * The parameters for the script action. + */ parameters?: string; } /** - * @class - * Initializes a new instance of the HDInsightOnDemandLinkedService class. - * @constructor * HDInsight ondemand linked service. - * - * @member {object} clusterSize Number of worker/data nodes in the cluster. - * Suggestion value: 4. Type: string (or Expression with resultType string). - * @member {object} timeToLive The allowed idle time for the on-demand - * HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays - * alive after completion of an activity run if there are no other active jobs - * in the cluster. The minimum value is 5 mins. Type: string (or Expression - * with resultType string). - * @member {object} version Version of the HDInsight cluster.  Type: string (or - * Expression with resultType string). - * @member {object} linkedServiceName Azure Storage linked service to be used - * by the on-demand cluster for storing and processing data. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for LinkedService. - * @member {object} hostSubscriptionId The customer’s subscription to host the - * cluster. Type: string (or Expression with resultType string). - * @member {object} [servicePrincipalId] The service principal id for the - * hostSubscriptionId. Type: string (or Expression with resultType string). - * @member {object} [servicePrincipalKey] The key for the service principal id. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} tenant The Tenant id/name to which the service principal - * belongs. Type: string (or Expression with resultType string). - * @member {object} clusterResourceGroup The resource group where the cluster - * belongs. Type: string (or Expression with resultType string). - * @member {object} [clusterNamePrefix] The prefix of cluster name, postfix - * will be distinct with timestamp. Type: string (or Expression with resultType - * string). - * @member {object} [clusterUserName] The username to access the cluster. Type: - * string (or Expression with resultType string). - * @member {object} [clusterPassword] The password to access the cluster. - * @member {string} [clusterPassword.type] Polymorphic Discriminator - * @member {object} [clusterSshUserName] The username to SSH remotely connect - * to cluster’s node (for Linux). Type: string (or Expression with resultType - * string). - * @member {object} [clusterSshPassword] The password to SSH remotely connect - * cluster’s node (for Linux). - * @member {string} [clusterSshPassword.type] Polymorphic Discriminator - * @member {array} [additionalLinkedServiceNames] Specifies additional storage - * accounts for the HDInsight linked service so that the Data Factory service - * can register them on your behalf. - * @member {object} [hcatalogLinkedServiceName] The name of Azure SQL linked - * service that point to the HCatalog database. The on-demand HDInsight cluster - * is created by using the Azure SQL database as the metastore. - * @member {string} [hcatalogLinkedServiceName.referenceName] Reference - * LinkedService name. - * @member {object} [hcatalogLinkedServiceName.parameters] Arguments for - * LinkedService. - * @member {object} [clusterType] The cluster type. Type: string (or Expression - * with resultType string). - * @member {object} [sparkVersion] The version of spark if the cluster type is - * 'spark'. Type: string (or Expression with resultType string). - * @member {object} [coreConfiguration] Specifies the core configuration - * parameters (as in core-site.xml) for the HDInsight cluster to be created. - * @member {object} [hBaseConfiguration] Specifies the HBase configuration - * parameters (hbase-site.xml) for the HDInsight cluster. - * @member {object} [hdfsConfiguration] Specifies the HDFS configuration - * parameters (hdfs-site.xml) for the HDInsight cluster. - * @member {object} [hiveConfiguration] Specifies the hive configuration - * parameters (hive-site.xml) for the HDInsight cluster. - * @member {object} [mapReduceConfiguration] Specifies the MapReduce - * configuration parameters (mapred-site.xml) for the HDInsight cluster. - * @member {object} [oozieConfiguration] Specifies the Oozie configuration - * parameters (oozie-site.xml) for the HDInsight cluster. - * @member {object} [stormConfiguration] Specifies the Storm configuration - * parameters (storm-site.xml) for the HDInsight cluster. - * @member {object} [yarnConfiguration] Specifies the Yarn configuration - * parameters (yarn-site.xml) for the HDInsight cluster. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). - * @member {object} [headNodeSize] Specifies the size of the head node for the - * HDInsight cluster. - * @member {object} [dataNodeSize] Specifies the size of the data node for the - * HDInsight cluster. - * @member {object} [zookeeperNodeSize] Specifies the size of the Zoo Keeper - * node for the HDInsight cluster. - * @member {array} [scriptActions] Custom script actions to run on HDI ondemand - * cluster once it's up. Please refer to - * https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions. */ export interface HDInsightOnDemandLinkedService extends LinkedService { + /** + * Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression + * with resultType string). + */ clusterSize: any; + /** + * The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand + * HDInsight cluster stays alive after completion of an activity run if there are no other active + * jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType + * string). + */ timeToLive: any; + /** + * Version of the HDInsight cluster.  Type: string (or Expression with resultType string). + */ version: any; + /** + * Azure Storage linked service to be used by the on-demand cluster for storing and processing + * data. + */ linkedServiceName: LinkedServiceReference; + /** + * The customer’s subscription to host the cluster. Type: string (or Expression with resultType + * string). + */ hostSubscriptionId: any; + /** + * The service principal id for the hostSubscriptionId. Type: string (or Expression with + * resultType string). + */ servicePrincipalId?: any; + /** + * The key for the service principal id. + */ servicePrincipalKey?: SecretBase; + /** + * The Tenant id/name to which the service principal belongs. Type: string (or Expression with + * resultType string). + */ tenant: any; + /** + * The resource group where the cluster belongs. Type: string (or Expression with resultType + * string). + */ clusterResourceGroup: any; + /** + * The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or + * Expression with resultType string). + */ clusterNamePrefix?: any; + /** + * The username to access the cluster. Type: string (or Expression with resultType string). + */ clusterUserName?: any; + /** + * The password to access the cluster. + */ clusterPassword?: SecretBase; + /** + * The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or + * Expression with resultType string). + */ clusterSshUserName?: any; + /** + * The password to SSH remotely connect cluster’s node (for Linux). + */ clusterSshPassword?: SecretBase; + /** + * Specifies additional storage accounts for the HDInsight linked service so that the Data + * Factory service can register them on your behalf. + */ additionalLinkedServiceNames?: LinkedServiceReference[]; + /** + * The name of Azure SQL linked service that point to the HCatalog database. The on-demand + * HDInsight cluster is created by using the Azure SQL database as the metastore. + */ hcatalogLinkedServiceName?: LinkedServiceReference; + /** + * The cluster type. Type: string (or Expression with resultType string). + */ clusterType?: any; + /** + * The version of spark if the cluster type is 'spark'. Type: string (or Expression with + * resultType string). + */ sparkVersion?: any; + /** + * Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to + * be created. + */ coreConfiguration?: any; + /** + * Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster. + */ hBaseConfiguration?: any; + /** + * Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster. + */ hdfsConfiguration?: any; + /** + * Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster. + */ hiveConfiguration?: any; + /** + * Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster. + */ mapReduceConfiguration?: any; + /** + * Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster. + */ oozieConfiguration?: any; + /** + * Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster. + */ stormConfiguration?: any; + /** + * Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster. + */ yarnConfiguration?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; + /** + * Specifies the size of the head node for the HDInsight cluster. + */ headNodeSize?: any; + /** + * Specifies the size of the data node for the HDInsight cluster. + */ dataNodeSize?: any; + /** + * Specifies the size of the Zoo Keeper node for the HDInsight cluster. + */ zookeeperNodeSize?: any; + /** + * Custom script actions to run on HDI ondemand cluster once it's up. Please refer to + * https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions. + */ scriptActions?: ScriptAction[]; } /** - * @class - * Initializes a new instance of the SalesforceMarketingCloudLinkedService class. - * @constructor * Salesforce Marketing Cloud linked service. - * - * @member {object} clientId The client ID associated with the Salesforce - * Marketing Cloud application. Type: string (or Expression with resultType - * string). - * @member {object} [clientSecret] The client secret associated with the - * Salesforce Marketing Cloud application. Type: string (or Expression with - * resultType string). - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. Type: - * boolean (or Expression with resultType boolean). - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. Type: boolean (or Expression - * with resultType boolean). - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * Type: boolean (or Expression with resultType boolean). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface SalesforceMarketingCloudLinkedService extends LinkedService { + /** + * The client ID associated with the Salesforce Marketing Cloud application. Type: string (or + * Expression with resultType string). + */ clientId: any; + /** + * The client secret associated with the Salesforce Marketing Cloud application. Type: string (or + * Expression with resultType string). + */ clientSecret?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. Type: boolean (or Expression with resultType boolean). + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. Type: boolean (or + * Expression with resultType boolean). + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. Type: boolean (or Expression with resultType boolean). + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the NetezzaLinkedService class. - * @constructor * Netezza linked service. - * - * @member {object} [connectionString] An ODBC connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [pwd] The Azure key vault secret reference of password in - * connection string. - * @member {object} [pwd.store] The Azure Key Vault linked service reference. - * @member {string} [pwd.store.referenceName] Reference LinkedService name. - * @member {object} [pwd.store.parameters] Arguments for LinkedService. - * @member {object} [pwd.secretName] The name of the secret in Azure Key Vault. - * Type: string (or Expression with resultType string). - * @member {object} [pwd.secretVersion] The version of the secret in Azure Key - * Vault. The default value is the latest version of the secret. Type: string - * (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface NetezzaLinkedService extends LinkedService { + /** + * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString?: any; + /** + * The Azure key vault secret reference of password in connection string. + */ pwd?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the VerticaLinkedService class. - * @constructor * Vertica linked service. - * - * @member {object} [connectionString] An ODBC connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [pwd] The Azure key vault secret reference of password in - * connection string. - * @member {object} [pwd.store] The Azure Key Vault linked service reference. - * @member {string} [pwd.store.referenceName] Reference LinkedService name. - * @member {object} [pwd.store.parameters] Arguments for LinkedService. - * @member {object} [pwd.secretName] The name of the secret in Azure Key Vault. - * Type: string (or Expression with resultType string). - * @member {object} [pwd.secretVersion] The version of the secret in Azure Key - * Vault. The default value is the latest version of the secret. Type: string - * (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface VerticaLinkedService extends LinkedService { + /** + * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString?: any; + /** + * The Azure key vault secret reference of password in connection string. + */ pwd?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the ZohoLinkedService class. - * @constructor * Zoho server linked service. - * - * @member {object} endpoint The endpoint of the Zoho server. (i.e. - * crm.zoho.com/crm/private) - * @member {object} [accessToken] The access token for Zoho authentication. - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface ZohoLinkedService extends LinkedService { + /** + * The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private) + */ endpoint: any; + /** + * The access token for Zoho authentication. + */ accessToken?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the XeroLinkedService class. - * @constructor - * Xero Serivce linked service. - * - * @member {object} host The endpoint of the Xero server. (i.e. api.xero.com) - * @member {object} [consumerKey] The consumer key associated with the Xero - * application. - * @member {string} [consumerKey.type] Polymorphic Discriminator - * @member {object} [privateKey] The private key from the .pem file that was - * generated for your Xero private application. You must include all the text - * from the .pem file, including the Unix line endings( - * ). - * @member {string} [privateKey.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). + * Xero Service linked service. */ export interface XeroLinkedService extends LinkedService { + /** + * The endpoint of the Xero server. (i.e. api.xero.com) + */ host: any; + /** + * The consumer key associated with the Xero application. + */ consumerKey?: SecretBase; + /** + * The private key from the .pem file that was generated for your Xero private application. You + * must include all the text from the .pem file, including the Unix line endings( + * ). + */ privateKey?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the SquareLinkedService class. - * @constructor - * Square Serivce linked service. - * - * @member {object} host The URL of the Square instance. (i.e. - * mystore.mysquare.com) - * @member {object} clientId The client ID associated with your Square - * application. - * @member {object} [clientSecret] The client secret associated with your - * Square application. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} redirectUri The redirect URL assigned in the Square - * application dashboard. (i.e. http://localhost:2500) - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). + * Square Service linked service. */ export interface SquareLinkedService extends LinkedService { + /** + * The URL of the Square instance. (i.e. mystore.mysquare.com) + */ host: any; + /** + * The client ID associated with your Square application. + */ clientId: any; + /** + * The client secret associated with your Square application. + */ clientSecret?: SecretBase; + /** + * The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500) + */ redirectUri: any; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the SparkLinkedService class. - * @constructor * Spark Server linked service. - * - * @member {object} host IP address or host name of the Spark server - * @member {object} port The TCP port that the Spark server uses to listen for - * client connections. - * @member {string} [serverType] The type of Spark server. Possible values - * include: 'SharkServer', 'SharkServer2', 'SparkThriftServer' - * @member {string} [thriftTransportProtocol] The transport protocol to use in - * the Thrift layer. Possible values include: 'Binary', 'SASL', 'HTTP ' - * @member {string} authenticationType The authentication method used to access - * the Spark server. Possible values include: 'Anonymous', 'Username', - * 'UsernameAndPassword', 'WindowsAzureHDInsightService' - * @member {object} [username] The user name that you use to access Spark - * Server. - * @member {object} [password] The password corresponding to the user name that - * you provided in the Username field - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [httpPath] The partial URL corresponding to the Spark - * server. - * @member {object} [enableSsl] Specifies whether the connections to the server - * are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file containing - * trusted CA certificates for verifying the server when connecting over SSL. - * This property can only be set when using SSL on self-hosted IR. The default - * value is the cacerts.pem file installed with the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA - * certificate from the system trust store or from a specified PEM file. The - * default value is false. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when - * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow - * self-signed certificates from the server. The default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface SparkLinkedService extends LinkedService { + /** + * IP address or host name of the Spark server + */ host: any; + /** + * The TCP port that the Spark server uses to listen for client connections. + */ port: any; + /** + * The type of Spark server. Possible values include: 'SharkServer', 'SharkServer2', + * 'SparkThriftServer' + */ serverType?: string; + /** + * The transport protocol to use in the Thrift layer. Possible values include: 'Binary', 'SASL', + * 'HTTP ' + */ thriftTransportProtocol?: string; + /** + * The authentication method used to access the Spark server. Possible values include: + * 'Anonymous', 'Username', 'UsernameAndPassword', 'WindowsAzureHDInsightService' + */ authenticationType: string; + /** + * The user name that you use to access Spark Server. + */ username?: any; + /** + * The password corresponding to the user name that you provided in the Username field + */ password?: SecretBase; + /** + * The partial URL corresponding to the Spark server. + */ httpPath?: any; + /** + * Specifies whether the connections to the server are encrypted using SSL. The default value is + * false. + */ enableSsl?: any; + /** + * The full path of the .pem file containing trusted CA certificates for verifying the server + * when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The + * default value is the cacerts.pem file installed with the IR. + */ trustedCertPath?: any; + /** + * Specifies whether to use a CA certificate from the system trust store or from a specified PEM + * file. The default value is false. + */ useSystemTrustStore?: any; + /** + * Specifies whether to require a CA-issued SSL certificate name to match the host name of the + * server when connecting over SSL. The default value is false. + */ allowHostNameCNMismatch?: any; + /** + * Specifies whether to allow self-signed certificates from the server. The default value is + * false. + */ allowSelfSignedServerCert?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the ShopifyLinkedService class. - * @constructor - * Shopify Serivce linked service. - * - * @member {object} host The endpoint of the Shopify server. (i.e. - * mystore.myshopify.com) - * @member {object} [accessToken] The API access token that can be used to - * access Shopify’s data. The token won't expire if it is offline mode. - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). + * Shopify Service linked service. */ export interface ShopifyLinkedService extends LinkedService { + /** + * The endpoint of the Shopify server. (i.e. mystore.myshopify.com) + */ host: any; + /** + * The API access token that can be used to access Shopify’s data. The token won't expire if it + * is offline mode. + */ accessToken?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the ServiceNowLinkedService class. - * @constructor * ServiceNow server linked service. - * - * @member {object} endpoint The endpoint of the ServiceNow server. (i.e. - * .service-now.com) - * @member {string} authenticationType The authentication type to use. Possible - * values include: 'Basic', 'OAuth2' - * @member {object} [username] The user name used to connect to the ServiceNow - * server for Basic and OAuth2 authentication. - * @member {object} [password] The password corresponding to the user name for - * Basic and OAuth2 authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [clientId] The client id for OAuth2 authentication. - * @member {object} [clientSecret] The client secret for OAuth2 authentication. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface ServiceNowLinkedService extends LinkedService { + /** + * The endpoint of the ServiceNow server. (i.e. .service-now.com) + */ endpoint: any; + /** + * The authentication type to use. Possible values include: 'Basic', 'OAuth2' + */ authenticationType: string; + /** + * The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication. + */ username?: any; + /** + * The password corresponding to the user name for Basic and OAuth2 authentication. + */ password?: SecretBase; + /** + * The client id for OAuth2 authentication. + */ clientId?: any; + /** + * The client secret for OAuth2 authentication. + */ clientSecret?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the QuickBooksLinkedService class. - * @constructor * QuickBooks server linked service. - * - * @member {object} endpoint The endpoint of the QuickBooks server. (i.e. - * quickbooks.api.intuit.com) - * @member {object} companyId The company ID of the QuickBooks company to - * authorize. - * @member {object} consumerKey The consumer key for OAuth 1.0 authentication. - * @member {object} consumerSecret The consumer secret for OAuth 1.0 - * authentication. - * @member {string} [consumerSecret.type] Polymorphic Discriminator - * @member {object} accessToken The access token for OAuth 1.0 authentication. - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} accessTokenSecret The access token secret for OAuth 1.0 - * authentication. - * @member {string} [accessTokenSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface QuickBooksLinkedService extends LinkedService { + /** + * The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com) + */ endpoint: any; + /** + * The company ID of the QuickBooks company to authorize. + */ companyId: any; + /** + * The consumer key for OAuth 1.0 authentication. + */ consumerKey: any; + /** + * The consumer secret for OAuth 1.0 authentication. + */ consumerSecret: SecretBase; + /** + * The access token for OAuth 1.0 authentication. + */ accessToken: SecretBase; + /** + * The access token secret for OAuth 1.0 authentication. + */ accessTokenSecret: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the PrestoLinkedService class. - * @constructor * Presto server linked service. - * - * @member {object} host The IP address or host name of the Presto server. - * (i.e. 192.168.222.160) - * @member {object} serverVersion The version of the Presto server. (i.e. - * 0.148-t) - * @member {object} catalog The catalog context for all request against the - * server. - * @member {object} [port] The TCP port that the Presto server uses to listen - * for client connections. The default value is 8080. - * @member {string} authenticationType The authentication mechanism used to - * connect to the Presto server. Possible values include: 'Anonymous', 'LDAP' - * @member {object} [username] The user name used to connect to the Presto - * server. - * @member {object} [password] The password corresponding to the user name. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [enableSsl] Specifies whether the connections to the server - * are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file containing - * trusted CA certificates for verifying the server when connecting over SSL. - * This property can only be set when using SSL on self-hosted IR. The default - * value is the cacerts.pem file installed with the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA - * certificate from the system trust store or from a specified PEM file. The - * default value is false. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when - * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow - * self-signed certificates from the server. The default value is false. - * @member {object} [timeZoneID] The local time zone used by the connection. - * Valid values for this option are specified in the IANA Time Zone Database. - * The default value is the system time zone. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface PrestoLinkedService extends LinkedService { + /** + * The IP address or host name of the Presto server. (i.e. 192.168.222.160) + */ host: any; + /** + * The version of the Presto server. (i.e. 0.148-t) + */ serverVersion: any; + /** + * The catalog context for all request against the server. + */ catalog: any; + /** + * The TCP port that the Presto server uses to listen for client connections. The default value + * is 8080. + */ port?: any; + /** + * The authentication mechanism used to connect to the Presto server. Possible values include: + * 'Anonymous', 'LDAP' + */ authenticationType: string; + /** + * The user name used to connect to the Presto server. + */ username?: any; + /** + * The password corresponding to the user name. + */ password?: SecretBase; + /** + * Specifies whether the connections to the server are encrypted using SSL. The default value is + * false. + */ enableSsl?: any; + /** + * The full path of the .pem file containing trusted CA certificates for verifying the server + * when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The + * default value is the cacerts.pem file installed with the IR. + */ trustedCertPath?: any; + /** + * Specifies whether to use a CA certificate from the system trust store or from a specified PEM + * file. The default value is false. + */ useSystemTrustStore?: any; + /** + * Specifies whether to require a CA-issued SSL certificate name to match the host name of the + * server when connecting over SSL. The default value is false. + */ allowHostNameCNMismatch?: any; + /** + * Specifies whether to allow self-signed certificates from the server. The default value is + * false. + */ allowSelfSignedServerCert?: any; + /** + * The local time zone used by the connection. Valid values for this option are specified in the + * IANA Time Zone Database. The default value is the system time zone. + */ timeZoneID?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the PhoenixLinkedService class. - * @constructor * Phoenix server linked service. - * - * @member {object} host The IP address or host name of the Phoenix server. - * (i.e. 192.168.222.160) - * @member {object} [port] The TCP port that the Phoenix server uses to listen - * for client connections. The default value is 8765. - * @member {object} [httpPath] The partial URL corresponding to the Phoenix - * server. (i.e. /gateway/sandbox/phoenix/version). The default value is - * hbasephoenix if using WindowsAzureHDInsightService. - * @member {string} authenticationType The authentication mechanism used to - * connect to the Phoenix server. Possible values include: 'Anonymous', - * 'UsernameAndPassword', 'WindowsAzureHDInsightService' - * @member {object} [username] The user name used to connect to the Phoenix - * server. - * @member {object} [password] The password corresponding to the user name. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [enableSsl] Specifies whether the connections to the server - * are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file containing - * trusted CA certificates for verifying the server when connecting over SSL. - * This property can only be set when using SSL on self-hosted IR. The default - * value is the cacerts.pem file installed with the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA - * certificate from the system trust store or from a specified PEM file. The - * default value is false. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when - * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow - * self-signed certificates from the server. The default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface PhoenixLinkedService extends LinkedService { + /** + * The IP address or host name of the Phoenix server. (i.e. 192.168.222.160) + */ host: any; + /** + * The TCP port that the Phoenix server uses to listen for client connections. The default value + * is 8765. + */ port?: any; + /** + * The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). + * The default value is hbasephoenix if using WindowsAzureHDInsightService. + */ httpPath?: any; + /** + * The authentication mechanism used to connect to the Phoenix server. Possible values include: + * 'Anonymous', 'UsernameAndPassword', 'WindowsAzureHDInsightService' + */ authenticationType: string; + /** + * The user name used to connect to the Phoenix server. + */ username?: any; + /** + * The password corresponding to the user name. + */ password?: SecretBase; + /** + * Specifies whether the connections to the server are encrypted using SSL. The default value is + * false. + */ enableSsl?: any; + /** + * The full path of the .pem file containing trusted CA certificates for verifying the server + * when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The + * default value is the cacerts.pem file installed with the IR. + */ trustedCertPath?: any; + /** + * Specifies whether to use a CA certificate from the system trust store or from a specified PEM + * file. The default value is false. + */ useSystemTrustStore?: any; + /** + * Specifies whether to require a CA-issued SSL certificate name to match the host name of the + * server when connecting over SSL. The default value is false. + */ allowHostNameCNMismatch?: any; + /** + * Specifies whether to allow self-signed certificates from the server. The default value is + * false. + */ allowSelfSignedServerCert?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the PaypalLinkedService class. - * @constructor - * Paypal Serivce linked service. - * - * @member {object} host The URL of the PayPal instance. (i.e. - * api.sandbox.paypal.com) - * @member {object} clientId The client ID associated with your PayPal - * application. - * @member {object} [clientSecret] The client secret associated with your - * PayPal application. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). + * Paypal Service linked service. */ export interface PaypalLinkedService extends LinkedService { + /** + * The URL of the PayPal instance. (i.e. api.sandbox.paypal.com) + */ host: any; + /** + * The client ID associated with your PayPal application. + */ clientId: any; + /** + * The client secret associated with your PayPal application. + */ clientSecret?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the MarketoLinkedService class. - * @constructor * Marketo server linked service. - * - * @member {object} endpoint The endpoint of the Marketo server. (i.e. - * 123-ABC-321.mktorest.com) - * @member {object} clientId The client Id of your Marketo service. - * @member {object} [clientSecret] The client secret of your Marketo service. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface MarketoLinkedService extends LinkedService { + /** + * The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com) + */ endpoint: any; + /** + * The client Id of your Marketo service. + */ clientId: any; + /** + * The client secret of your Marketo service. + */ clientSecret?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the MariaDBLinkedService class. - * @constructor * MariaDB server linked service. - * - * @member {object} [connectionString] An ODBC connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [pwd] The Azure key vault secret reference of password in - * connection string. - * @member {object} [pwd.store] The Azure Key Vault linked service reference. - * @member {string} [pwd.store.referenceName] Reference LinkedService name. - * @member {object} [pwd.store.parameters] Arguments for LinkedService. - * @member {object} [pwd.secretName] The name of the secret in Azure Key Vault. - * Type: string (or Expression with resultType string). - * @member {object} [pwd.secretVersion] The version of the secret in Azure Key - * Vault. The default value is the latest version of the secret. Type: string - * (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface MariaDBLinkedService extends LinkedService { + /** + * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString?: any; + /** + * The Azure key vault secret reference of password in connection string. + */ pwd?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the MagentoLinkedService class. - * @constructor * Magento server linked service. - * - * @member {object} host The URL of the Magento instance. (i.e. - * 192.168.222.110/magento3) - * @member {object} [accessToken] The access token from Magento. - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface MagentoLinkedService extends LinkedService { + /** + * The URL of the Magento instance. (i.e. 192.168.222.110/magento3) + */ host: any; + /** + * The access token from Magento. + */ accessToken?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the JiraLinkedService class. - * @constructor - * Jira Serivce linked service. - * - * @member {object} host The IP address or host name of the Jira service. (e.g. - * jira.example.com) - * @member {object} [port] The TCP port that the Jira server uses to listen for - * client connections. The default value is 443 if connecting through HTTPS, or - * 8080 if connecting through HTTP. - * @member {object} username The user name that you use to access Jira Service. - * @member {object} [password] The password corresponding to the user name that - * you provided in the username field. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). + * Jira Service linked service. */ export interface JiraLinkedService extends LinkedService { + /** + * The IP address or host name of the Jira service. (e.g. jira.example.com) + */ host: any; + /** + * The TCP port that the Jira server uses to listen for client connections. The default value is + * 443 if connecting through HTTPS, or 8080 if connecting through HTTP. + */ port?: any; + /** + * The user name that you use to access Jira Service. + */ username: any; + /** + * The password corresponding to the user name that you provided in the username field. + */ password?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the ImpalaLinkedService class. - * @constructor * Impala server linked service. - * - * @member {object} host The IP address or host name of the Impala server. - * (i.e. 192.168.222.160) - * @member {object} [port] The TCP port that the Impala server uses to listen - * for client connections. The default value is 21050. - * @member {string} authenticationType The authentication type to use. Possible - * values include: 'Anonymous', 'SASLUsername', 'UsernameAndPassword' - * @member {object} [username] The user name used to access the Impala server. - * The default value is anonymous when using SASLUsername. - * @member {object} [password] The password corresponding to the user name when - * using UsernameAndPassword. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [enableSsl] Specifies whether the connections to the server - * are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file containing - * trusted CA certificates for verifying the server when connecting over SSL. - * This property can only be set when using SSL on self-hosted IR. The default - * value is the cacerts.pem file installed with the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA - * certificate from the system trust store or from a specified PEM file. The - * default value is false. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when - * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow - * self-signed certificates from the server. The default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface ImpalaLinkedService extends LinkedService { + /** + * The IP address or host name of the Impala server. (i.e. 192.168.222.160) + */ host: any; + /** + * The TCP port that the Impala server uses to listen for client connections. The default value + * is 21050. + */ port?: any; + /** + * The authentication type to use. Possible values include: 'Anonymous', 'SASLUsername', + * 'UsernameAndPassword' + */ authenticationType: string; + /** + * The user name used to access the Impala server. The default value is anonymous when using + * SASLUsername. + */ username?: any; + /** + * The password corresponding to the user name when using UsernameAndPassword. + */ password?: SecretBase; + /** + * Specifies whether the connections to the server are encrypted using SSL. The default value is + * false. + */ enableSsl?: any; + /** + * The full path of the .pem file containing trusted CA certificates for verifying the server + * when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The + * default value is the cacerts.pem file installed with the IR. + */ trustedCertPath?: any; + /** + * Specifies whether to use a CA certificate from the system trust store or from a specified PEM + * file. The default value is false. + */ useSystemTrustStore?: any; + /** + * Specifies whether to require a CA-issued SSL certificate name to match the host name of the + * server when connecting over SSL. The default value is false. + */ allowHostNameCNMismatch?: any; + /** + * Specifies whether to allow self-signed certificates from the server. The default value is + * false. + */ allowSelfSignedServerCert?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the HubspotLinkedService class. - * @constructor - * Hubspot Serivce linked service. - * - * @member {object} clientId The client ID associated with your Hubspot - * application. - * @member {object} [clientSecret] The client secret associated with your - * Hubspot application. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [accessToken] The access token obtained when initially - * authenticating your OAuth integration. - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} [refreshToken] The refresh token obtained when initially - * authenticating your OAuth integration. - * @member {string} [refreshToken.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). + * Hubspot Service linked service. */ export interface HubspotLinkedService extends LinkedService { + /** + * The client ID associated with your Hubspot application. + */ clientId: any; + /** + * The client secret associated with your Hubspot application. + */ clientSecret?: SecretBase; + /** + * The access token obtained when initially authenticating your OAuth integration. + */ accessToken?: SecretBase; + /** + * The refresh token obtained when initially authenticating your OAuth integration. + */ refreshToken?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the HiveLinkedService class. - * @constructor * Hive Server linked service. - * - * @member {object} host IP address or host name of the Hive server, separated - * by ';' for multiple hosts (only when serviceDiscoveryMode is enable). - * @member {object} [port] The TCP port that the Hive server uses to listen for - * client connections. - * @member {string} [serverType] The type of Hive server. Possible values - * include: 'HiveServer1', 'HiveServer2', 'HiveThriftServer' - * @member {string} [thriftTransportProtocol] The transport protocol to use in - * the Thrift layer. Possible values include: 'Binary', 'SASL', 'HTTP ' - * @member {string} authenticationType The authentication method used to access - * the Hive server. Possible values include: 'Anonymous', 'Username', - * 'UsernameAndPassword', 'WindowsAzureHDInsightService' - * @member {object} [serviceDiscoveryMode] true to indicate using the ZooKeeper - * service, false not. - * @member {object} [zooKeeperNameSpace] The namespace on ZooKeeper under which - * Hive Server 2 nodes are added. - * @member {object} [useNativeQuery] Specifies whether the driver uses native - * HiveQL queries,or converts them into an equivalent form in HiveQL. - * @member {object} [username] The user name that you use to access Hive - * Server. - * @member {object} [password] The password corresponding to the user name that - * you provided in the Username field - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [httpPath] The partial URL corresponding to the Hive - * server. - * @member {object} [enableSsl] Specifies whether the connections to the server - * are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file containing - * trusted CA certificates for verifying the server when connecting over SSL. - * This property can only be set when using SSL on self-hosted IR. The default - * value is the cacerts.pem file installed with the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA - * certificate from the system trust store or from a specified PEM file. The - * default value is false. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when - * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow - * self-signed certificates from the server. The default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface HiveLinkedService extends LinkedService { + /** + * IP address or host name of the Hive server, separated by ';' for multiple hosts (only when + * serviceDiscoveryMode is enable). + */ host: any; + /** + * The TCP port that the Hive server uses to listen for client connections. + */ port?: any; + /** + * The type of Hive server. Possible values include: 'HiveServer1', 'HiveServer2', + * 'HiveThriftServer' + */ serverType?: string; + /** + * The transport protocol to use in the Thrift layer. Possible values include: 'Binary', 'SASL', + * 'HTTP ' + */ thriftTransportProtocol?: string; + /** + * The authentication method used to access the Hive server. Possible values include: + * 'Anonymous', 'Username', 'UsernameAndPassword', 'WindowsAzureHDInsightService' + */ authenticationType: string; + /** + * true to indicate using the ZooKeeper service, false not. + */ serviceDiscoveryMode?: any; + /** + * The namespace on ZooKeeper under which Hive Server 2 nodes are added. + */ zooKeeperNameSpace?: any; + /** + * Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent + * form in HiveQL. + */ useNativeQuery?: any; + /** + * The user name that you use to access Hive Server. + */ username?: any; + /** + * The password corresponding to the user name that you provided in the Username field + */ password?: SecretBase; + /** + * The partial URL corresponding to the Hive server. + */ httpPath?: any; + /** + * Specifies whether the connections to the server are encrypted using SSL. The default value is + * false. + */ enableSsl?: any; + /** + * The full path of the .pem file containing trusted CA certificates for verifying the server + * when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The + * default value is the cacerts.pem file installed with the IR. + */ trustedCertPath?: any; + /** + * Specifies whether to use a CA certificate from the system trust store or from a specified PEM + * file. The default value is false. + */ useSystemTrustStore?: any; + /** + * Specifies whether to require a CA-issued SSL certificate name to match the host name of the + * server when connecting over SSL. The default value is false. + */ allowHostNameCNMismatch?: any; + /** + * Specifies whether to allow self-signed certificates from the server. The default value is + * false. + */ allowSelfSignedServerCert?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the HBaseLinkedService class. - * @constructor * HBase server linked service. - * - * @member {object} host The IP address or host name of the HBase server. (i.e. - * 192.168.222.160) - * @member {object} [port] The TCP port that the HBase instance uses to listen - * for client connections. The default value is 9090. - * @member {object} [httpPath] The partial URL corresponding to the HBase - * server. (i.e. /gateway/sandbox/hbase/version) - * @member {string} authenticationType The authentication mechanism to use to - * connect to the HBase server. Possible values include: 'Anonymous', 'Basic' - * @member {object} [username] The user name used to connect to the HBase - * instance. - * @member {object} [password] The password corresponding to the user name. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [enableSsl] Specifies whether the connections to the server - * are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file containing - * trusted CA certificates for verifying the server when connecting over SSL. - * This property can only be set when using SSL on self-hosted IR. The default - * value is the cacerts.pem file installed with the IR. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when - * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow - * self-signed certificates from the server. The default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface HBaseLinkedService extends LinkedService { + /** + * The IP address or host name of the HBase server. (i.e. 192.168.222.160) + */ host: any; + /** + * The TCP port that the HBase instance uses to listen for client connections. The default value + * is 9090. + */ port?: any; + /** + * The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version) + */ httpPath?: any; + /** + * The authentication mechanism to use to connect to the HBase server. Possible values include: + * 'Anonymous', 'Basic' + */ authenticationType: string; + /** + * The user name used to connect to the HBase instance. + */ username?: any; + /** + * The password corresponding to the user name. + */ password?: SecretBase; + /** + * Specifies whether the connections to the server are encrypted using SSL. The default value is + * false. + */ enableSsl?: any; + /** + * The full path of the .pem file containing trusted CA certificates for verifying the server + * when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The + * default value is the cacerts.pem file installed with the IR. + */ trustedCertPath?: any; + /** + * Specifies whether to require a CA-issued SSL certificate name to match the host name of the + * server when connecting over SSL. The default value is false. + */ allowHostNameCNMismatch?: any; + /** + * Specifies whether to allow self-signed certificates from the server. The default value is + * false. + */ allowSelfSignedServerCert?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the GreenplumLinkedService class. - * @constructor * Greenplum Database linked service. - * - * @member {object} [connectionString] An ODBC connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [pwd] The Azure key vault secret reference of password in - * connection string. - * @member {object} [pwd.store] The Azure Key Vault linked service reference. - * @member {string} [pwd.store.referenceName] Reference LinkedService name. - * @member {object} [pwd.store.parameters] Arguments for LinkedService. - * @member {object} [pwd.secretName] The name of the secret in Azure Key Vault. - * Type: string (or Expression with resultType string). - * @member {object} [pwd.secretVersion] The version of the secret in Azure Key - * Vault. The default value is the latest version of the secret. Type: string - * (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface GreenplumLinkedService extends LinkedService { + /** + * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString?: any; + /** + * The Azure key vault secret reference of password in connection string. + */ pwd?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the GoogleBigQueryLinkedService class. - * @constructor * Google BigQuery service linked service. - * - * @member {object} project The default BigQuery project to query against. - * @member {object} [additionalProjects] A comma-separated list of public - * BigQuery projects to access. - * @member {object} [requestGoogleDriveScope] Whether to request access to - * Google Drive. Allowing Google Drive access enables support for federated - * tables that combine BigQuery data with data from Google Drive. The default - * value is false. - * @member {string} authenticationType The OAuth 2.0 authentication mechanism - * used for authentication. ServiceAuthentication can only be used on - * self-hosted IR. Possible values include: 'ServiceAuthentication', - * 'UserAuthentication' - * @member {object} [refreshToken] The refresh token obtained from Google for - * authorizing access to BigQuery for UserAuthentication. - * @member {string} [refreshToken.type] Polymorphic Discriminator - * @member {object} [clientId] The client id of the google application used to - * acquire the refresh token. - * @member {string} [clientId.type] Polymorphic Discriminator - * @member {object} [clientSecret] The client secret of the google application - * used to acquire the refresh token. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [email] The service account email ID that is used for - * ServiceAuthentication and can only be used on self-hosted IR. - * @member {object} [keyFilePath] The full path to the .p12 key file that is - * used to authenticate the service account email address and can only be used - * on self-hosted IR. - * @member {object} [trustedCertPath] The full path of the .pem file containing - * trusted CA certificates for verifying the server when connecting over SSL. - * This property can only be set when using SSL on self-hosted IR. The default - * value is the cacerts.pem file installed with the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA - * certificate from the system trust store or from a specified PEM file. The - * default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface GoogleBigQueryLinkedService extends LinkedService { + /** + * The default BigQuery project to query against. + */ project: any; + /** + * A comma-separated list of public BigQuery projects to access. + */ additionalProjects?: any; + /** + * Whether to request access to Google Drive. Allowing Google Drive access enables support for + * federated tables that combine BigQuery data with data from Google Drive. The default value is + * false. + */ requestGoogleDriveScope?: any; + /** + * The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only + * be used on self-hosted IR. Possible values include: 'ServiceAuthentication', + * 'UserAuthentication' + */ authenticationType: string; + /** + * The refresh token obtained from Google for authorizing access to BigQuery for + * UserAuthentication. + */ refreshToken?: SecretBase; + /** + * The client id of the google application used to acquire the refresh token. + */ clientId?: SecretBase; + /** + * The client secret of the google application used to acquire the refresh token. + */ clientSecret?: SecretBase; + /** + * The service account email ID that is used for ServiceAuthentication and can only be used on + * self-hosted IR. + */ email?: any; + /** + * The full path to the .p12 key file that is used to authenticate the service account email + * address and can only be used on self-hosted IR. + */ keyFilePath?: any; + /** + * The full path of the .pem file containing trusted CA certificates for verifying the server + * when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The + * default value is the cacerts.pem file installed with the IR. + */ trustedCertPath?: any; + /** + * Specifies whether to use a CA certificate from the system trust store or from a specified PEM + * file. The default value is false. + */ useSystemTrustStore?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the EloquaLinkedService class. - * @constructor * Eloqua server linked service. - * - * @member {object} endpoint The endpoint of the Eloqua server. (i.e. - * eloqua.example.com) - * @member {object} username The site name and user name of your Eloqua account - * in the form: sitename/username. (i.e. Eloqua/Alice) - * @member {object} [password] The password corresponding to the user name. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface EloquaLinkedService extends LinkedService { + /** + * The endpoint of the Eloqua server. (i.e. eloqua.example.com) + */ endpoint: any; + /** + * The site name and user name of your Eloqua account in the form: sitename/username. (i.e. + * Eloqua/Alice) + */ username: any; + /** + * The password corresponding to the user name. + */ password?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the DrillLinkedService class. - * @constructor * Drill server linked service. - * - * @member {object} [connectionString] An ODBC connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [pwd] The Azure key vault secret reference of password in - * connection string. - * @member {object} [pwd.store] The Azure Key Vault linked service reference. - * @member {string} [pwd.store.referenceName] Reference LinkedService name. - * @member {object} [pwd.store.parameters] Arguments for LinkedService. - * @member {object} [pwd.secretName] The name of the secret in Azure Key Vault. - * Type: string (or Expression with resultType string). - * @member {object} [pwd.secretVersion] The version of the secret in Azure Key - * Vault. The default value is the latest version of the secret. Type: string - * (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface DrillLinkedService extends LinkedService { + /** + * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString?: any; + /** + * The Azure key vault secret reference of password in connection string. + */ pwd?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the CouchbaseLinkedService class. - * @constructor * Couchbase server linked service. - * - * @member {object} [connectionString] An ODBC connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [credString] The Azure key vault secret reference of - * credString in connection string. - * @member {object} [credString.store] The Azure Key Vault linked service - * reference. - * @member {string} [credString.store.referenceName] Reference LinkedService - * name. - * @member {object} [credString.store.parameters] Arguments for LinkedService. - * @member {object} [credString.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [credString.secretVersion] The version of the secret in - * Azure Key Vault. The default value is the latest version of the secret. - * Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface CouchbaseLinkedService extends LinkedService { + /** + * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString?: any; + /** + * The Azure key vault secret reference of credString in connection string. + */ credString?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the ConcurLinkedService class. - * @constructor - * Concur Serivce linked service. - * - * @member {object} clientId Application client_id supplied by Concur App - * Management. - * @member {object} username The user name that you use to access Concur - * Service. - * @member {object} [password] The password corresponding to the user name that - * you provided in the username field. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). + * Concur Service linked service. */ export interface ConcurLinkedService extends LinkedService { + /** + * Application client_id supplied by Concur App Management. + */ clientId: any; + /** + * The user name that you use to access Concur Service. + */ username: any; + /** + * The password corresponding to the user name that you provided in the username field. + */ password?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AzurePostgreSqlLinkedService class. - * @constructor * Azure PostgreSQL linked service. - * - * @member {object} [connectionString] An ODBC connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [password] The Azure key vault secret reference of password - * in connection string. - * @member {object} [password.store] The Azure Key Vault linked service - * reference. - * @member {string} [password.store.referenceName] Reference LinkedService - * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in Azure - * Key Vault. The default value is the latest version of the secret. Type: - * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzurePostgreSqlLinkedService extends LinkedService { + /** + * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString?: any; + /** + * The Azure key vault secret reference of password in connection string. + */ password?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AmazonMWSLinkedService class. - * @constructor * Amazon Marketplace Web Service linked service. - * - * @member {object} endpoint The endpoint of the Amazon MWS server, (i.e. - * mws.amazonservices.com) - * @member {object} marketplaceID The Amazon Marketplace ID you want to - * retrieve data from. To retrive data from multiple Marketplace IDs, seperate - * them with a comma (,). (i.e. A2EUQ1WTGCTBG2) - * @member {object} sellerID The Amazon seller ID. - * @member {object} [mwsAuthToken] The Amazon MWS authentication token. - * @member {string} [mwsAuthToken.type] Polymorphic Discriminator - * @member {object} accessKeyId The access key id used to access data. - * @member {object} [secretKey] The secret key used to access data. - * @member {string} [secretKey.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the host - * name in the server's certificate to match the host name of the server when - * connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the - * identity of the server when connecting over SSL. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AmazonMWSLinkedService extends LinkedService { + /** + * The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com) + */ endpoint: any; + /** + * The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple + * Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2) + */ marketplaceID: any; + /** + * The Amazon seller ID. + */ sellerID: any; + /** + * The Amazon MWS authentication token. + */ mwsAuthToken?: SecretBase; + /** + * The access key id used to access data. + */ accessKeyId: any; + /** + * The secret key used to access data. + */ secretKey?: SecretBase; + /** + * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is + * true. + */ useEncryptedEndpoints?: any; + /** + * Specifies whether to require the host name in the server's certificate to match the host name + * of the server when connecting over SSL. The default value is true. + */ useHostVerification?: any; + /** + * Specifies whether to verify the identity of the server when connecting over SSL. The default + * value is true. + */ usePeerVerification?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the SapHanaLinkedService class. - * @constructor * SAP HANA Linked Service. - * - * @member {object} server Host name of the SAP HANA server. Type: string (or - * Expression with resultType string). - * @member {string} [authenticationType] The authentication type to be used to - * connect to the SAP HANA server. Possible values include: 'Basic', 'Windows' - * @member {object} [userName] Username to access the SAP HANA server. Type: - * string (or Expression with resultType string). - * @member {object} [password] Password to access the SAP HANA server. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface SapHanaLinkedService extends LinkedService { + /** + * Host name of the SAP HANA server. Type: string (or Expression with resultType string). + */ server: any; + /** + * The authentication type to be used to connect to the SAP HANA server. Possible values include: + * 'Basic', 'Windows' + */ authenticationType?: string; + /** + * Username to access the SAP HANA server. Type: string (or Expression with resultType string). + */ userName?: any; + /** + * Password to access the SAP HANA server. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the SapBWLinkedService class. - * @constructor * SAP Business Warehouse Linked Service. - * - * @member {object} server Host name of the SAP BW instance. Type: string (or - * Expression with resultType string). - * @member {object} systemNumber System number of the BW system. (Usually a - * two-digit decimal number represented as a string.) Type: string (or - * Expression with resultType string). - * @member {object} clientId Client ID of the client on the BW system. (Usually - * a three-digit decimal number represented as a string) Type: string (or - * Expression with resultType string). - * @member {object} [userName] Username to access the SAP BW server. Type: - * string (or Expression with resultType string). - * @member {object} [password] Password to access the SAP BW server. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface SapBWLinkedService extends LinkedService { + /** + * Host name of the SAP BW instance. Type: string (or Expression with resultType string). + */ server: any; + /** + * System number of the BW system. (Usually a two-digit decimal number represented as a string.) + * Type: string (or Expression with resultType string). + */ systemNumber: any; + /** + * Client ID of the client on the BW system. (Usually a three-digit decimal number represented as + * a string) Type: string (or Expression with resultType string). + */ clientId: any; + /** + * Username to access the SAP BW server. Type: string (or Expression with resultType string). + */ userName?: any; + /** + * Password to access the SAP BW server. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the SftpServerLinkedService class. - * @constructor * A linked service for an SSH File Transfer Protocol (SFTP) server. - * - * @member {object} host The SFTP server host name. Type: string (or Expression - * with resultType string). - * @member {object} [port] The TCP port number that the SFTP server uses to - * listen for client connections. Default value is 22. Type: integer (or - * Expression with resultType integer), minimum: 0. - * @member {string} [authenticationType] The authentication type to be used to - * connect to the FTP server. Possible values include: 'Basic', 'SshPublicKey' - * @member {object} [userName] The username used to log on to the SFTP server. - * Type: string (or Expression with resultType string). - * @member {object} [password] Password to logon the SFTP server for Basic - * authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). - * @member {object} [privateKeyPath] The SSH private key file path for - * SshPublicKey authentication. Only valid for on-premises copy. For - * on-premises copy with SshPublicKey authentication, either PrivateKeyPath or - * PrivateKeyContent should be specified. SSH private key should be OpenSSH - * format. Type: string (or Expression with resultType string). - * @member {object} [privateKeyContent] Base64 encoded SSH private key content - * for SshPublicKey authentication. For on-premises copy with SshPublicKey - * authentication, either PrivateKeyPath or PrivateKeyContent should be - * specified. SSH private key should be OpenSSH format. - * @member {string} [privateKeyContent.type] Polymorphic Discriminator - * @member {object} [passPhrase] The password to decrypt the SSH private key if - * the SSH private key is encrypted. - * @member {string} [passPhrase.type] Polymorphic Discriminator - * @member {object} [skipHostKeyValidation] If true, skip the SSH host key - * validation. Default value is false. Type: boolean (or Expression with - * resultType boolean). - * @member {object} [hostKeyFingerprint] The host key finger-print of the SFTP - * server. When SkipHostKeyValidation is false, HostKeyFingerprint should be - * specified. Type: string (or Expression with resultType string). */ export interface SftpServerLinkedService extends LinkedService { + /** + * The SFTP server host name. Type: string (or Expression with resultType string). + */ host: any; + /** + * The TCP port number that the SFTP server uses to listen for client connections. Default value + * is 22. Type: integer (or Expression with resultType integer), minimum: 0. + */ port?: any; + /** + * The authentication type to be used to connect to the FTP server. Possible values include: + * 'Basic', 'SshPublicKey' + */ authenticationType?: string; + /** + * The username used to log on to the SFTP server. Type: string (or Expression with resultType + * string). + */ userName?: any; + /** + * Password to logon the SFTP server for Basic authentication. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; + /** + * The SSH private key file path for SshPublicKey authentication. Only valid for on-premises + * copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or + * PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string + * (or Expression with resultType string). + */ privateKeyPath?: any; + /** + * Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy + * with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be + * specified. SSH private key should be OpenSSH format. + */ privateKeyContent?: SecretBase; + /** + * The password to decrypt the SSH private key if the SSH private key is encrypted. + */ passPhrase?: SecretBase; + /** + * If true, skip the SSH host key validation. Default value is false. Type: boolean (or + * Expression with resultType boolean). + */ skipHostKeyValidation?: any; + /** + * The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, + * HostKeyFingerprint should be specified. Type: string (or Expression with resultType string). + */ hostKeyFingerprint?: any; } /** - * @class - * Initializes a new instance of the FtpServerLinkedService class. - * @constructor * A FTP server Linked Service. - * - * @member {object} host Host name of the FTP server. Type: string (or - * Expression with resultType string). - * @member {object} [port] The TCP port number that the FTP server uses to - * listen for client connections. Default value is 21. Type: integer (or - * Expression with resultType integer), minimum: 0. - * @member {string} [authenticationType] The authentication type to be used to - * connect to the FTP server. Possible values include: 'Basic', 'Anonymous' - * @member {object} [userName] Username to logon the FTP server. Type: string - * (or Expression with resultType string). - * @member {object} [password] Password to logon the FTP server. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). - * @member {object} [enableSsl] If true, connect to the FTP server over SSL/TLS - * channel. Default value is true. Type: boolean (or Expression with resultType - * boolean). - * @member {object} [enableServerCertificateValidation] If true, validate the - * FTP server SSL certificate when connect over SSL/TLS channel. Default value - * is true. Type: boolean (or Expression with resultType boolean). */ export interface FtpServerLinkedService extends LinkedService { + /** + * Host name of the FTP server. Type: string (or Expression with resultType string). + */ host: any; + /** + * The TCP port number that the FTP server uses to listen for client connections. Default value + * is 21. Type: integer (or Expression with resultType integer), minimum: 0. + */ port?: any; + /** + * The authentication type to be used to connect to the FTP server. Possible values include: + * 'Basic', 'Anonymous' + */ authenticationType?: string; + /** + * Username to logon the FTP server. Type: string (or Expression with resultType string). + */ userName?: any; + /** + * Password to logon the FTP server. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; + /** + * If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean + * (or Expression with resultType boolean). + */ enableSsl?: any; + /** + * If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default + * value is true. Type: boolean (or Expression with resultType boolean). + */ enableServerCertificateValidation?: any; } /** - * @class - * Initializes a new instance of the HttpLinkedService class. - * @constructor * Linked service for an HTTP source. - * - * @member {object} url The base URL of the HTTP endpoint, e.g. - * http://www.microsoft.com. Type: string (or Expression with resultType - * string). - * @member {string} [authenticationType] The authentication type to be used to - * connect to the HTTP server. Possible values include: 'Basic', 'Anonymous', - * 'Digest', 'Windows', 'ClientCertificate' - * @member {object} [userName] User name for Basic, Digest, or Windows - * authentication. Type: string (or Expression with resultType string). - * @member {object} [password] Password for Basic, Digest, Windows, or - * ClientCertificate with EmbeddedCertData authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [embeddedCertData] Base64 encoded certificate data for - * ClientCertificate authentication. For on-premises copy with - * ClientCertificate authentication, either CertThumbprint or - * EmbeddedCertData/Password should be specified. Type: string (or Expression - * with resultType string). - * @member {object} [certThumbprint] Thumbprint of certificate for - * ClientCertificate authentication. Only valid for on-premises copy. For - * on-premises copy with ClientCertificate authentication, either - * CertThumbprint or EmbeddedCertData/Password should be specified. Type: - * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). - * @member {object} [enableServerCertificateValidation] If true, validate the - * HTTPS server SSL certificate. Default value is true. Type: boolean (or - * Expression with resultType boolean). */ export interface HttpLinkedService extends LinkedService { + /** + * The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression + * with resultType string). + */ url: any; + /** + * The authentication type to be used to connect to the HTTP server. Possible values include: + * 'Basic', 'Anonymous', 'Digest', 'Windows', 'ClientCertificate' + */ authenticationType?: string; + /** + * User name for Basic, Digest, or Windows authentication. Type: string (or Expression with + * resultType string). + */ userName?: any; + /** + * Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData + * authentication. + */ password?: SecretBase; + /** + * Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy + * with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password + * should be specified. Type: string (or Expression with resultType string). + */ embeddedCertData?: any; + /** + * Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises + * copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or + * EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType + * string). + */ certThumbprint?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; + /** + * If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or + * Expression with resultType boolean). + */ enableServerCertificateValidation?: any; } /** - * @class - * Initializes a new instance of the AzureSearchLinkedService class. - * @constructor * Linked service for Windows Azure Search Service. - * - * @member {object} url URL for Azure Search service. Type: string (or - * Expression with resultType string). - * @member {object} [key] Admin Key for Azure Search service - * @member {string} [key.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureSearchLinkedService extends LinkedService { + /** + * URL for Azure Search service. Type: string (or Expression with resultType string). + */ url: any; + /** + * Admin Key for Azure Search service + */ key?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the CustomDataSourceLinkedService class. - * @constructor * Custom linked service. - * - * @member {object} typeProperties Custom linked service properties. */ export interface CustomDataSourceLinkedService extends LinkedService { + /** + * Custom linked service properties. + */ typeProperties: any; } /** - * @class - * Initializes a new instance of the AmazonRedshiftLinkedService class. - * @constructor * Linked service for Amazon Redshift. - * - * @member {object} server The name of the Amazon Redshift server. Type: string - * (or Expression with resultType string). - * @member {object} [username] The username of the Amazon Redshift source. - * Type: string (or Expression with resultType string). - * @member {object} [password] The password of the Amazon Redshift source. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} database The database name of the Amazon Redshift source. - * Type: string (or Expression with resultType string). - * @member {object} [port] The TCP port number that the Amazon Redshift server - * uses to listen for client connections. The default value is 5439. Type: - * integer (or Expression with resultType integer). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AmazonRedshiftLinkedService extends LinkedService { + /** + * The name of the Amazon Redshift server. Type: string (or Expression with resultType string). + */ server: any; + /** + * The username of the Amazon Redshift source. Type: string (or Expression with resultType + * string). + */ username?: any; + /** + * The password of the Amazon Redshift source. + */ password?: SecretBase; + /** + * The database name of the Amazon Redshift source. Type: string (or Expression with resultType + * string). + */ database: any; + /** + * The TCP port number that the Amazon Redshift server uses to listen for client connections. The + * default value is 5439. Type: integer (or Expression with resultType integer). + */ port?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AmazonS3LinkedService class. - * @constructor * Linked service for Amazon S3. - * - * @member {object} [accessKeyId] The access key identifier of the Amazon S3 - * Identity and Access Management (IAM) user. Type: string (or Expression with - * resultType string). - * @member {object} [secretAccessKey] The secret access key of the Amazon S3 - * Identity and Access Management (IAM) user. - * @member {string} [secretAccessKey.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AmazonS3LinkedService extends LinkedService { + /** + * The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: + * string (or Expression with resultType string). + */ accessKeyId?: any; + /** + * The secret access key of the Amazon S3 Identity and Access Management (IAM) user. + */ secretAccessKey?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the SapEccLinkedService class. - * @constructor * Linked service for SAP ERP Central Component(SAP ECC). - * - * @member {string} url The URL of SAP ECC OData API. For example, - * '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or - * Expression with resultType string). - * @member {string} [username] The username for Basic authentication. Type: - * string (or Expression with resultType string). - * @member {object} [password] The password for Basic authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {string} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Either encryptedCredential or username/password must be - * provided. Type: string (or Expression with resultType string). */ export interface SapEccLinkedService extends LinkedService { + /** + * The URL of SAP ECC OData API. For example, + * '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with + * resultType string). + */ url: string; + /** + * The username for Basic authentication. Type: string (or Expression with resultType string). + */ username?: string; + /** + * The password for Basic authentication. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Either encryptedCredential or username/password must + * be provided. Type: string (or Expression with resultType string). + */ encryptedCredential?: string; } /** - * @class - * Initializes a new instance of the SapCloudForCustomerLinkedService class. - * @constructor * Linked service for SAP Cloud for Customer. - * - * @member {object} url The URL of SAP Cloud for Customer OData API. For - * example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: - * string (or Expression with resultType string). - * @member {object} [username] The username for Basic authentication. Type: - * string (or Expression with resultType string). - * @member {object} [password] The password for Basic authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Either encryptedCredential or username/password must be - * provided. Type: string (or Expression with resultType string). */ export interface SapCloudForCustomerLinkedService extends LinkedService { + /** + * The URL of SAP Cloud for Customer OData API. For example, + * '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with + * resultType string). + */ url: any; + /** + * The username for Basic authentication. Type: string (or Expression with resultType string). + */ username?: any; + /** + * The password for Basic authentication. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Either encryptedCredential or username/password must + * be provided. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the SalesforceLinkedService class. - * @constructor * Linked service for Salesforce. - * - * @member {object} [environmentUrl] The URL of Salesforce instance. Default is - * 'https://login.salesforce.com'. To copy data from sandbox, specify - * 'https://test.salesforce.com'. To copy data from custom domain, specify, for - * example, 'https://[domain].my.salesforce.com'. Type: string (or Expression - * with resultType string). - * @member {object} [username] The username for Basic authentication of the - * Salesforce instance. Type: string (or Expression with resultType string). - * @member {object} [password] The password for Basic authentication of the - * Salesforce instance. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [securityToken] The security token is required to remotely - * access Salesforce instance. - * @member {string} [securityToken.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface SalesforceLinkedService extends LinkedService { + /** + * The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from + * sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for + * example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType + * string). + */ environmentUrl?: any; + /** + * The username for Basic authentication of the Salesforce instance. Type: string (or Expression + * with resultType string). + */ username?: any; + /** + * The password for Basic authentication of the Salesforce instance. + */ password?: SecretBase; + /** + * The security token is required to remotely access Salesforce instance. + */ securityToken?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AzureDataLakeStoreLinkedService class. - * @constructor * Azure Data Lake Store linked service. - * - * @member {object} dataLakeStoreUri Data Lake Store service URI. Type: string - * (or Expression with resultType string). - * @member {object} [servicePrincipalId] The ID of the application used to - * authenticate against the Azure Data Lake Store account. Type: string (or - * Expression with resultType string). - * @member {object} [servicePrincipalKey] The Key of the application used to - * authenticate against the Azure Data Lake Store account. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} [tenant] The name or ID of the tenant to which the service - * principal belongs. Type: string (or Expression with resultType string). - * @member {object} [accountName] Data Lake Store account name. Type: string - * (or Expression with resultType string). - * @member {object} [subscriptionId] Data Lake Store account subscription ID - * (if different from Data Factory account). Type: string (or Expression with - * resultType string). - * @member {object} [resourceGroupName] Data Lake Store account resource group - * name (if different from Data Factory account). Type: string (or Expression - * with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureDataLakeStoreLinkedService extends LinkedService { + /** + * Data Lake Store service URI. Type: string (or Expression with resultType string). + */ dataLakeStoreUri: any; + /** + * The ID of the application used to authenticate against the Azure Data Lake Store account. + * Type: string (or Expression with resultType string). + */ servicePrincipalId?: any; + /** + * The Key of the application used to authenticate against the Azure Data Lake Store account. + */ servicePrincipalKey?: SecretBase; + /** + * The name or ID of the tenant to which the service principal belongs. Type: string (or + * Expression with resultType string). + */ tenant?: any; + /** + * Data Lake Store account name. Type: string (or Expression with resultType string). + */ accountName?: any; + /** + * Data Lake Store account subscription ID (if different from Data Factory account). Type: string + * (or Expression with resultType string). + */ subscriptionId?: any; + /** + * Data Lake Store account resource group name (if different from Data Factory account). Type: + * string (or Expression with resultType string). + */ resourceGroupName?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the MongoDbLinkedService class. - * @constructor * Linked service for MongoDb data source. - * - * @member {object} server The IP address or server name of the MongoDB server. - * Type: string (or Expression with resultType string). - * @member {string} [authenticationType] The authentication type to be used to - * connect to the MongoDB database. Possible values include: 'Basic', - * 'Anonymous' - * @member {object} databaseName The name of the MongoDB database that you want - * to access. Type: string (or Expression with resultType string). - * @member {object} [username] Username for authentication. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password for authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [authSource] Database to verify the username and password. - * Type: string (or Expression with resultType string). - * @member {object} [port] The TCP port number that the MongoDB server uses to - * listen for client connections. The default value is 27017. Type: integer (or - * Expression with resultType integer), minimum: 0. - * @member {object} [enableSsl] Specifies whether the connections to the server - * are encrypted using SSL. The default value is false. Type: boolean (or - * Expression with resultType boolean). - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow - * self-signed certificates from the server. The default value is false. Type: - * boolean (or Expression with resultType boolean). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface MongoDbLinkedService extends LinkedService { + /** + * The IP address or server name of the MongoDB server. Type: string (or Expression with + * resultType string). + */ server: any; + /** + * The authentication type to be used to connect to the MongoDB database. Possible values + * include: 'Basic', 'Anonymous' + */ authenticationType?: string; + /** + * The name of the MongoDB database that you want to access. Type: string (or Expression with + * resultType string). + */ databaseName: any; + /** + * Username for authentication. Type: string (or Expression with resultType string). + */ username?: any; + /** + * Password for authentication. + */ password?: SecretBase; + /** + * Database to verify the username and password. Type: string (or Expression with resultType + * string). + */ authSource?: any; + /** + * The TCP port number that the MongoDB server uses to listen for client connections. The default + * value is 27017. Type: integer (or Expression with resultType integer), minimum: 0. + */ port?: any; + /** + * Specifies whether the connections to the server are encrypted using SSL. The default value is + * false. Type: boolean (or Expression with resultType boolean). + */ enableSsl?: any; + /** + * Specifies whether to allow self-signed certificates from the server. The default value is + * false. Type: boolean (or Expression with resultType boolean). + */ allowSelfSignedServerCert?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the CassandraLinkedService class. - * @constructor * Linked service for Cassandra data source. - * - * @member {object} host Host name for connection. Type: string (or Expression - * with resultType string). - * @member {object} [authenticationType] AuthenticationType to be used for - * connection. Type: string (or Expression with resultType string). - * @member {object} [port] The port for the connection. Type: integer (or - * Expression with resultType integer). - * @member {object} [username] Username for authentication. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password for authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface CassandraLinkedService extends LinkedService { + /** + * Host name for connection. Type: string (or Expression with resultType string). + */ host: any; + /** + * AuthenticationType to be used for connection. Type: string (or Expression with resultType + * string). + */ authenticationType?: any; + /** + * The port for the connection. Type: integer (or Expression with resultType integer). + */ port?: any; + /** + * Username for authentication. Type: string (or Expression with resultType string). + */ username?: any; + /** + * Password for authentication. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the WebLinkedServiceTypeProperties class. - * @constructor - * Base definition of WebLinkedServiceTypeProperties, this typeProperties is - * polymorphic based on authenticationType, so not flattened in SDK models. - * - * @member {object} url The URL of the web service endpoint, e.g. - * http://www.microsoft.com . Type: string (or Expression with resultType - * string). - * @member {string} authenticationType Polymorphic Discriminator + * Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on + * authenticationType, so not flattened in SDK models. */ export interface WebLinkedServiceTypeProperties { + /** + * The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or + * Expression with resultType string). + */ url: any; + /** + * Polymorphic Discriminator + */ authenticationType: string; } /** - * @class - * Initializes a new instance of the WebClientCertificateAuthentication class. - * @constructor - * A WebLinkedService that uses client certificate based authentication to - * communicate with an HTTP endpoint. This scheme follows mutual - * authentication; the server must also provide valid credentials to the - * client. - * - * @member {object} pfx Base64-encoded contents of a PFX file. - * @member {string} [pfx.type] Polymorphic Discriminator - * @member {object} password Password for the PFX file. - * @member {string} [password.type] Polymorphic Discriminator + * A WebLinkedService that uses client certificate based authentication to communicate with an HTTP + * endpoint. This scheme follows mutual authentication; the server must also provide valid + * credentials to the client. */ export interface WebClientCertificateAuthentication extends WebLinkedServiceTypeProperties { + /** + * Base64-encoded contents of a PFX file. + */ pfx: SecretBase; + /** + * Password for the PFX file. + */ password: SecretBase; } /** - * @class - * Initializes a new instance of the WebBasicAuthentication class. - * @constructor - * A WebLinkedService that uses basic authentication to communicate with an - * HTTP endpoint. - * - * @member {object} username User name for Basic authentication. Type: string - * (or Expression with resultType string). - * @member {object} password The password for Basic authentication. - * @member {string} [password.type] Polymorphic Discriminator + * A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint. */ export interface WebBasicAuthentication extends WebLinkedServiceTypeProperties { + /** + * User name for Basic authentication. Type: string (or Expression with resultType string). + */ username: any; + /** + * The password for Basic authentication. + */ password: SecretBase; } /** - * @class - * Initializes a new instance of the WebAnonymousAuthentication class. - * @constructor - * A WebLinkedService that uses anonymous authentication to communicate with an - * HTTP endpoint. - * + * A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint. */ export interface WebAnonymousAuthentication extends WebLinkedServiceTypeProperties { } /** - * @class - * Initializes a new instance of the WebLinkedService class. - * @constructor * Web linked service. - * - * @member {object} typeProperties Web linked service properties. - * @member {object} [typeProperties.url] The URL of the web service endpoint, - * e.g. http://www.microsoft.com . Type: string (or Expression with resultType - * string). - * @member {string} [typeProperties.authenticationType] Polymorphic - * Discriminator */ export interface WebLinkedService extends LinkedService { + /** + * Web linked service properties. + */ typeProperties: WebLinkedServiceTypeProperties; } /** - * @class - * Initializes a new instance of the ODataLinkedService class. - * @constructor * Open Data Protocol (OData) linked service. - * - * @member {object} url The URL of the OData service endpoint. Type: string (or - * Expression with resultType string). - * @member {string} [authenticationType] Type of authentication used to connect - * to the OData service. Possible values include: 'Basic', 'Anonymous' - * @member {object} [userName] User name of the OData service. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password of the OData service. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface ODataLinkedService extends LinkedService { + /** + * The URL of the OData service endpoint. Type: string (or Expression with resultType string). + */ url: any; + /** + * Type of authentication used to connect to the OData service. Possible values include: 'Basic', + * 'Anonymous' + */ authenticationType?: string; + /** + * User name of the OData service. Type: string (or Expression with resultType string). + */ userName?: any; + /** + * Password of the OData service. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the HdfsLinkedService class. - * @constructor * Hadoop Distributed File System (HDFS) linked service. - * - * @member {object} url The URL of the HDFS service endpoint, e.g. - * http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with - * resultType string). - * @member {object} [authenticationType] Type of authentication used to connect - * to the HDFS. Possible values are: Anonymous and Windows. Type: string (or - * Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). - * @member {object} [userName] User name for Windows authentication. Type: - * string (or Expression with resultType string). - * @member {object} [password] Password for Windows authentication. - * @member {string} [password.type] Polymorphic Discriminator */ export interface HdfsLinkedService extends LinkedService { + /** + * The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string + * (or Expression with resultType string). + */ url: any; + /** + * Type of authentication used to connect to the HDFS. Possible values are: Anonymous and + * Windows. Type: string (or Expression with resultType string). + */ authenticationType?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; + /** + * User name for Windows authentication. Type: string (or Expression with resultType string). + */ userName?: any; + /** + * Password for Windows authentication. + */ password?: SecretBase; } /** - * @class - * Initializes a new instance of the OdbcLinkedService class. - * @constructor * Open Database Connectivity (ODBC) linked service. - * - * @member {object} connectionString The non-access credential portion of the - * connection string as well as an optional encrypted credential. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [authenticationType] Type of authentication used to connect - * to the ODBC data store. Possible values are: Anonymous and Basic. Type: - * string (or Expression with resultType string). - * @member {object} [credential] The access credential portion of the - * connection string specified in driver-specific property-value format. - * @member {string} [credential.type] Polymorphic Discriminator - * @member {object} [userName] User name for Basic authentication. Type: string - * (or Expression with resultType string). - * @member {object} [password] Password for Basic authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface OdbcLinkedService extends LinkedService { + /** + * The non-access credential portion of the connection string as well as an optional encrypted + * credential. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString: any; + /** + * Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous + * and Basic. Type: string (or Expression with resultType string). + */ authenticationType?: any; + /** + * The access credential portion of the connection string specified in driver-specific + * property-value format. + */ credential?: SecretBase; + /** + * User name for Basic authentication. Type: string (or Expression with resultType string). + */ userName?: any; + /** + * Password for Basic authentication. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AzureMLLinkedService class. - * @constructor * Azure ML Web Service linked service. - * - * @member {object} mlEndpoint The Batch Execution REST URL for an Azure ML Web - * Service endpoint. Type: string (or Expression with resultType string). - * @member {object} apiKey The API key for accessing the Azure ML model - * endpoint. - * @member {string} [apiKey.type] Polymorphic Discriminator - * @member {object} [updateResourceEndpoint] The Update Resource REST URL for - * an Azure ML Web Service endpoint. Type: string (or Expression with - * resultType string). - * @member {object} [servicePrincipalId] The ID of the service principal used - * to authenticate against the ARM-based updateResourceEndpoint of an Azure ML - * web service. Type: string (or Expression with resultType string). - * @member {object} [servicePrincipalKey] The key of the service principal used - * to authenticate against the ARM-based updateResourceEndpoint of an Azure ML - * web service. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} [tenant] The name or ID of the tenant to which the service - * principal belongs. Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureMLLinkedService extends LinkedService { + /** + * The Batch Execution REST URL for an Azure ML Web Service endpoint. Type: string (or Expression + * with resultType string). + */ mlEndpoint: any; + /** + * The API key for accessing the Azure ML model endpoint. + */ apiKey: SecretBase; + /** + * The Update Resource REST URL for an Azure ML Web Service endpoint. Type: string (or Expression + * with resultType string). + */ updateResourceEndpoint?: any; + /** + * The ID of the service principal used to authenticate against the ARM-based + * updateResourceEndpoint of an Azure ML web service. Type: string (or Expression with resultType + * string). + */ servicePrincipalId?: any; + /** + * The key of the service principal used to authenticate against the ARM-based + * updateResourceEndpoint of an Azure ML web service. + */ servicePrincipalKey?: SecretBase; + /** + * The name or ID of the tenant to which the service principal belongs. Type: string (or + * Expression with resultType string). + */ tenant?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the TeradataLinkedService class. - * @constructor * Linked service for Teradata data source. - * - * @member {object} server Server name for connection. Type: string (or - * Expression with resultType string). - * @member {string} [authenticationType] AuthenticationType to be used for - * connection. Possible values include: 'Basic', 'Windows' - * @member {object} [username] Username for authentication. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password for authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface TeradataLinkedService extends LinkedService { + /** + * Server name for connection. Type: string (or Expression with resultType string). + */ server: any; + /** + * AuthenticationType to be used for connection. Possible values include: 'Basic', 'Windows' + */ authenticationType?: string; + /** + * Username for authentication. Type: string (or Expression with resultType string). + */ username?: any; + /** + * Password for authentication. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the Db2LinkedService class. - * @constructor * Linked service for DB2 data source. - * - * @member {object} server Server name for connection. Type: string (or - * Expression with resultType string). - * @member {object} database Database name for connection. Type: string (or - * Expression with resultType string). - * @member {string} [authenticationType] AuthenticationType to be used for - * connection. Possible values include: 'Basic' - * @member {object} [username] Username for authentication. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password for authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface Db2LinkedService extends LinkedService { + /** + * Server name for connection. Type: string (or Expression with resultType string). + */ server: any; + /** + * Database name for connection. Type: string (or Expression with resultType string). + */ database: any; + /** + * AuthenticationType to be used for connection. Possible values include: 'Basic' + */ authenticationType?: string; + /** + * Username for authentication. Type: string (or Expression with resultType string). + */ username?: any; + /** + * Password for authentication. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the SybaseLinkedService class. - * @constructor * Linked service for Sybase data source. - * - * @member {object} server Server name for connection. Type: string (or - * Expression with resultType string). - * @member {object} database Database name for connection. Type: string (or - * Expression with resultType string). - * @member {object} [schema] Schema name for connection. Type: string (or - * Expression with resultType string). - * @member {string} [authenticationType] AuthenticationType to be used for - * connection. Possible values include: 'Basic', 'Windows' - * @member {object} [username] Username for authentication. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password for authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface SybaseLinkedService extends LinkedService { + /** + * Server name for connection. Type: string (or Expression with resultType string). + */ server: any; + /** + * Database name for connection. Type: string (or Expression with resultType string). + */ database: any; + /** + * Schema name for connection. Type: string (or Expression with resultType string). + */ schema?: any; + /** + * AuthenticationType to be used for connection. Possible values include: 'Basic', 'Windows' + */ authenticationType?: string; + /** + * Username for authentication. Type: string (or Expression with resultType string). + */ username?: any; + /** + * Password for authentication. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the PostgreSqlLinkedService class. - * @constructor * Linked service for PostgreSQL data source. - * - * @member {object} connectionString The connection string. - * @member {string} [connectionString.type] Polymorphic Discriminator - * @member {object} [password] The Azure key vault secret reference of password - * in connection string. - * @member {object} [password.store] The Azure Key Vault linked service - * reference. - * @member {string} [password.store.referenceName] Reference LinkedService - * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in Azure - * Key Vault. The default value is the latest version of the secret. Type: - * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface PostgreSqlLinkedService extends LinkedService { + /** + * The connection string. + */ connectionString: SecretBase; + /** + * The Azure key vault secret reference of password in connection string. + */ password?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the MySqlLinkedService class. - * @constructor * Linked service for MySQL data source. - * - * @member {object} connectionString The connection string. - * @member {string} [connectionString.type] Polymorphic Discriminator - * @member {object} [password] The Azure key vault secret reference of password - * in connection string. - * @member {object} [password.store] The Azure Key Vault linked service - * reference. - * @member {string} [password.store.referenceName] Reference LinkedService - * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in Azure - * Key Vault. The default value is the latest version of the secret. Type: - * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface MySqlLinkedService extends LinkedService { + /** + * The connection string. + */ connectionString: SecretBase; + /** + * The Azure key vault secret reference of password in connection string. + */ password?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AzureMySqlLinkedService class. - * @constructor * Azure MySQL database linked service. - * - * @member {object} connectionString The connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [password] The Azure key vault secret reference of password - * in connection string. - * @member {object} [password.store] The Azure Key Vault linked service - * reference. - * @member {string} [password.store.referenceName] Reference LinkedService - * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in Azure - * Key Vault. The default value is the latest version of the secret. Type: - * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureMySqlLinkedService extends LinkedService { + /** + * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString: any; + /** + * The Azure key vault secret reference of password in connection string. + */ password?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the OracleLinkedService class. - * @constructor * Oracle database. - * - * @member {object} connectionString The connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [password] The Azure key vault secret reference of password - * in connection string. - * @member {object} [password.store] The Azure Key Vault linked service - * reference. - * @member {string} [password.store.referenceName] Reference LinkedService - * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in Azure - * Key Vault. The default value is the latest version of the secret. Type: - * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface OracleLinkedService extends LinkedService { + /** + * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString: any; + /** + * The Azure key vault secret reference of password in connection string. + */ password?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the FileServerLinkedService class. - * @constructor * File system linked service. - * - * @member {object} host Host name of the server. Type: string (or Expression - * with resultType string). - * @member {object} [userId] User ID to logon the server. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password to logon the server. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface FileServerLinkedService extends LinkedService { + /** + * Host name of the server. Type: string (or Expression with resultType string). + */ host: any; + /** + * User ID to logon the server. Type: string (or Expression with resultType string). + */ userId?: any; + /** + * Password to logon the server. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the HDInsightLinkedService class. - * @constructor * HDInsight linked service. - * - * @member {object} clusterUri HDInsight cluster URI. Type: string (or - * Expression with resultType string). - * @member {object} [userName] HDInsight cluster user name. Type: string (or - * Expression with resultType string). - * @member {object} [password] HDInsight cluster password. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [linkedServiceName] The Azure Storage linked service - * reference. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for LinkedService. - * @member {object} [hcatalogLinkedServiceName] A reference to the Azure SQL - * linked service that points to the HCatalog database. - * @member {string} [hcatalogLinkedServiceName.referenceName] Reference - * LinkedService name. - * @member {object} [hcatalogLinkedServiceName.parameters] Arguments for - * LinkedService. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface HDInsightLinkedService extends LinkedService { + /** + * HDInsight cluster URI. Type: string (or Expression with resultType string). + */ clusterUri: any; + /** + * HDInsight cluster user name. Type: string (or Expression with resultType string). + */ userName?: any; + /** + * HDInsight cluster password. + */ password?: SecretBase; + /** + * The Azure Storage linked service reference. + */ linkedServiceName?: LinkedServiceReference; + /** + * A reference to the Azure SQL linked service that points to the HCatalog database. + */ hcatalogLinkedServiceName?: LinkedServiceReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the DynamicsLinkedService class. - * @constructor * Dynamics linked service. - * - * @member {object} deploymentType The deployment type of the Dynamics - * instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics - * on-premises with Ifd. Type: string (or Expression with resultType string). - * @member {object} [hostName] The host name of the on-premises Dynamics - * server. The property is required for on-prem and not allowed for online. - * Type: string (or Expression with resultType string). - * @member {object} [port] The port of on-premises Dynamics server. The - * property is required for on-prem and not allowed for online. Default is 443. - * Type: integer (or Expression with resultType integer), minimum: 0. - * @member {object} [serviceUri] The URL to the Microsoft Dynamics server. The - * property is required for on-line and not allowed for on-prem. Type: string - * (or Expression with resultType string). - * @member {object} [organizationName] The organization name of the Dynamics - * instance. The property is required for on-prem and required for online when - * there are more than one Dynamics instances associated with the user. Type: - * string (or Expression with resultType string). - * @member {object} authenticationType The authentication type to connect to - * Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with - * Ifd scenario. Type: string (or Expression with resultType string). - * @member {object} username User name to access the Dynamics instance. Type: - * string (or Expression with resultType string). - * @member {object} [password] Password to access the Dynamics instance. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface DynamicsLinkedService extends LinkedService { + /** + * The deployment type of the Dynamics instance. 'Online' for Dynamics Online and + * 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with + * resultType string). + */ deploymentType: any; + /** + * The host name of the on-premises Dynamics server. The property is required for on-prem and not + * allowed for online. Type: string (or Expression with resultType string). + */ hostName?: any; + /** + * The port of on-premises Dynamics server. The property is required for on-prem and not allowed + * for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0. + */ port?: any; + /** + * The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed + * for on-prem. Type: string (or Expression with resultType string). + */ serviceUri?: any; + /** + * The organization name of the Dynamics instance. The property is required for on-prem and + * required for online when there are more than one Dynamics instances associated with the user. + * Type: string (or Expression with resultType string). + */ organizationName?: any; + /** + * The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' + * for on-premises with Ifd scenario. Type: string (or Expression with resultType string). + */ authenticationType: any; + /** + * User name to access the Dynamics instance. Type: string (or Expression with resultType + * string). + */ username: any; + /** + * Password to access the Dynamics instance. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the CosmosDbLinkedService class. - * @constructor * Microsoft Azure Cosmos Database (CosmosDB) linked service. - * - * @member {object} connectionString The connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [accountKey] The Azure key vault secret reference of - * accountKey in connection string. - * @member {object} [accountKey.store] The Azure Key Vault linked service - * reference. - * @member {string} [accountKey.store.referenceName] Reference LinkedService - * name. - * @member {object} [accountKey.store.parameters] Arguments for LinkedService. - * @member {object} [accountKey.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [accountKey.secretVersion] The version of the secret in - * Azure Key Vault. The default value is the latest version of the secret. - * Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface CosmosDbLinkedService extends LinkedService { + /** + * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString: any; + /** + * The Azure key vault secret reference of accountKey in connection string. + */ accountKey?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AzureKeyVaultLinkedService class. - * @constructor * Azure Key Vault linked service. - * - * @member {object} baseUrl The base URL of the Azure Key Vault. e.g. - * https://myakv.vault.azure.net Type: string (or Expression with resultType - * string). */ export interface AzureKeyVaultLinkedService extends LinkedService { + /** + * The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or + * Expression with resultType string). + */ baseUrl: any; } /** - * @class - * Initializes a new instance of the AzureBatchLinkedService class. - * @constructor * Azure Batch linked service. - * - * @member {object} accountName The Azure Batch account name. Type: string (or - * Expression with resultType string). - * @member {object} [accessKey] The Azure Batch account access key. - * @member {string} [accessKey.type] Polymorphic Discriminator - * @member {object} batchUri The Azure Batch URI. Type: string (or Expression - * with resultType string). - * @member {object} poolName The Azure Batch pool name. Type: string (or - * Expression with resultType string). - * @member {object} linkedServiceName The Azure Storage linked service - * reference. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for LinkedService. - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureBatchLinkedService extends LinkedService { + /** + * The Azure Batch account name. Type: string (or Expression with resultType string). + */ accountName: any; + /** + * The Azure Batch account access key. + */ accessKey?: SecretBase; + /** + * The Azure Batch URI. Type: string (or Expression with resultType string). + */ batchUri: any; + /** + * The Azure Batch pool name. Type: string (or Expression with resultType string). + */ poolName: any; + /** + * The Azure Storage linked service reference. + */ linkedServiceName: LinkedServiceReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AzureSqlDatabaseLinkedService class. - * @constructor * Microsoft Azure SQL Database linked service. - * - * @member {object} connectionString The connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [password] The Azure key vault secret reference of password - * in connection string. - * @member {object} [password.store] The Azure Key Vault linked service - * reference. - * @member {string} [password.store.referenceName] Reference LinkedService - * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in Azure - * Key Vault. The default value is the latest version of the secret. Type: - * string (or Expression with resultType string). - * @member {object} [servicePrincipalId] The ID of the service principal used - * to authenticate against Azure SQL Database. Type: string (or Expression with - * resultType string). - * @member {object} [servicePrincipalKey] The key of the service principal used - * to authenticate against Azure SQL Database. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} [tenant] The name or ID of the tenant to which the service - * principal belongs. Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureSqlDatabaseLinkedService extends LinkedService { + /** + * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString: any; + /** + * The Azure key vault secret reference of password in connection string. + */ password?: AzureKeyVaultSecretReference; + /** + * The ID of the service principal used to authenticate against Azure SQL Database. Type: string + * (or Expression with resultType string). + */ servicePrincipalId?: any; + /** + * The key of the service principal used to authenticate against Azure SQL Database. + */ servicePrincipalKey?: SecretBase; + /** + * The name or ID of the tenant to which the service principal belongs. Type: string (or + * Expression with resultType string). + */ tenant?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the SqlServerLinkedService class. - * @constructor * SQL Server linked service. - * - * @member {object} connectionString The connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [userName] The on-premises Windows authentication user - * name. Type: string (or Expression with resultType string). - * @member {object} [password] The on-premises Windows authentication password. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface SqlServerLinkedService extends LinkedService { + /** + * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. + */ connectionString: any; + /** + * The on-premises Windows authentication user name. Type: string (or Expression with resultType + * string). + */ userName?: any; + /** + * The on-premises Windows authentication password. + */ password?: SecretBase; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AzureSqlDWLinkedService class. - * @constructor * Azure SQL Data Warehouse linked service. - * - * @member {object} connectionString The connection string. Type: string, - * SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or - * AzureKeyVaultSecretReference. - * @member {object} [password] The Azure key vault secret reference of password - * in connection string. - * @member {object} [password.store] The Azure Key Vault linked service - * reference. - * @member {string} [password.store.referenceName] Reference LinkedService - * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in Azure - * Key Vault. The default value is the latest version of the secret. Type: - * string (or Expression with resultType string). - * @member {object} [servicePrincipalId] The ID of the service principal used - * to authenticate against Azure SQL Data Warehouse. Type: string (or - * Expression with resultType string). - * @member {object} [servicePrincipalKey] The key of the service principal used - * to authenticate against Azure SQL Data Warehouse. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} [tenant] The name or ID of the tenant to which the service - * principal belongs. Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureSqlDWLinkedService extends LinkedService { + /** + * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: + * string, SecureString or AzureKeyVaultSecretReference. + */ connectionString: any; + /** + * The Azure key vault secret reference of password in connection string. + */ password?: AzureKeyVaultSecretReference; + /** + * The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: + * string (or Expression with resultType string). + */ servicePrincipalId?: any; + /** + * The key of the service principal used to authenticate against Azure SQL Data Warehouse. + */ servicePrincipalKey?: SecretBase; + /** + * The name or ID of the tenant to which the service principal belongs. Type: string (or + * Expression with resultType string). + */ tenant?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: any; } /** - * @class - * Initializes a new instance of the AzureTableStorageLinkedService class. - * @constructor * The azure table storage linked service. - * - * @member {object} [connectionString] The connection string. It is mutually - * exclusive with sasUri property. Type: string, SecureString or - * AzureKeyVaultSecretReference. - * @member {object} [accountKey] The Azure key vault secret reference of - * accountKey in connection string. - * @member {object} [accountKey.store] The Azure Key Vault linked service - * reference. - * @member {string} [accountKey.store.referenceName] Reference LinkedService - * name. - * @member {object} [accountKey.store.parameters] Arguments for LinkedService. - * @member {object} [accountKey.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [accountKey.secretVersion] The version of the secret in - * Azure Key Vault. The default value is the latest version of the secret. - * Type: string (or Expression with resultType string). - * @member {object} [sasUri] SAS URI of the Azure Storage resource. It is - * mutually exclusive with connectionString property. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [sasToken] The Azure key vault secret reference of sasToken - * in sas uri. - * @member {object} [sasToken.store] The Azure Key Vault linked service - * reference. - * @member {string} [sasToken.store.referenceName] Reference LinkedService - * name. - * @member {object} [sasToken.store.parameters] Arguments for LinkedService. - * @member {object} [sasToken.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [sasToken.secretVersion] The version of the secret in Azure - * Key Vault. The default value is the latest version of the secret. Type: - * string (or Expression with resultType string). - * @member {string} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureTableStorageLinkedService extends LinkedService { + /** + * The connection string. It is mutually exclusive with sasUri property. Type: string, + * SecureString or AzureKeyVaultSecretReference. + */ connectionString?: any; + /** + * The Azure key vault secret reference of accountKey in connection string. + */ accountKey?: AzureKeyVaultSecretReference; + /** + * SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString + * property. Type: string, SecureString or AzureKeyVaultSecretReference. + */ sasUri?: any; + /** + * The Azure key vault secret reference of sasToken in sas uri. + */ sasToken?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: string; } /** - * @class - * Initializes a new instance of the AzureBlobStorageLinkedService class. - * @constructor * The azure blob storage linked service. - * - * @member {object} [connectionString] The connection string. It is mutually - * exclusive with sasUri, serviceEndpoint property. Type: string, SecureString - * or AzureKeyVaultSecretReference. - * @member {object} [accountKey] The Azure key vault secret reference of - * accountKey in connection string. - * @member {object} [accountKey.store] The Azure Key Vault linked service - * reference. - * @member {string} [accountKey.store.referenceName] Reference LinkedService - * name. - * @member {object} [accountKey.store.parameters] Arguments for LinkedService. - * @member {object} [accountKey.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [accountKey.secretVersion] The version of the secret in - * Azure Key Vault. The default value is the latest version of the secret. - * Type: string (or Expression with resultType string). - * @member {object} [sasUri] SAS URI of the Azure Blob Storage resource. It is - * mutually exclusive with connectionString, serviceEndpoint property. Type: - * string, SecureString or AzureKeyVaultSecretReference. - * @member {object} [sasToken] The Azure key vault secret reference of sasToken - * in sas uri. - * @member {object} [sasToken.store] The Azure Key Vault linked service - * reference. - * @member {string} [sasToken.store.referenceName] Reference LinkedService - * name. - * @member {object} [sasToken.store.parameters] Arguments for LinkedService. - * @member {object} [sasToken.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [sasToken.secretVersion] The version of the secret in Azure - * Key Vault. The default value is the latest version of the secret. Type: - * string (or Expression with resultType string). - * @member {string} [serviceEndpoint] Blob service endpoint of the Azure Blob - * Storage resource. It is mutually exclusive with connectionString, sasUri - * property. - * @member {object} [servicePrincipalId] The ID of the service principal used - * to authenticate against Azure SQL Data Warehouse. Type: string (or - * Expression with resultType string). - * @member {object} [servicePrincipalKey] The key of the service principal used - * to authenticate against Azure SQL Data Warehouse. - * @member {string} [servicePrincipalKey.type] Polymorphic Discriminator - * @member {object} [tenant] The name or ID of the tenant to which the service - * principal belongs. Type: string (or Expression with resultType string). - * @member {string} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureBlobStorageLinkedService extends LinkedService { + /** + * The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: + * string, SecureString or AzureKeyVaultSecretReference. + */ connectionString?: any; + /** + * The Azure key vault secret reference of accountKey in connection string. + */ accountKey?: AzureKeyVaultSecretReference; + /** + * SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, + * serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. + */ sasUri?: any; + /** + * The Azure key vault secret reference of sasToken in sas uri. + */ sasToken?: AzureKeyVaultSecretReference; + /** + * Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with + * connectionString, sasUri property. + */ serviceEndpoint?: string; + /** + * The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: + * string (or Expression with resultType string). + */ servicePrincipalId?: any; + /** + * The key of the service principal used to authenticate against Azure SQL Data Warehouse. + */ servicePrincipalKey?: SecretBase; + /** + * The name or ID of the tenant to which the service principal belongs. Type: string (or + * Expression with resultType string). + */ tenant?: any; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: string; } /** - * @class - * Initializes a new instance of the AzureStorageLinkedService class. - * @constructor * The storage account linked service. - * - * @member {object} [connectionString] The connection string. It is mutually - * exclusive with sasUri property. Type: string, SecureString or - * AzureKeyVaultSecretReference. - * @member {object} [accountKey] The Azure key vault secret reference of - * accountKey in connection string. - * @member {object} [accountKey.store] The Azure Key Vault linked service - * reference. - * @member {string} [accountKey.store.referenceName] Reference LinkedService - * name. - * @member {object} [accountKey.store.parameters] Arguments for LinkedService. - * @member {object} [accountKey.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [accountKey.secretVersion] The version of the secret in - * Azure Key Vault. The default value is the latest version of the secret. - * Type: string (or Expression with resultType string). - * @member {object} [sasUri] SAS URI of the Azure Storage resource. It is - * mutually exclusive with connectionString property. Type: string, - * SecureString or AzureKeyVaultSecretReference. - * @member {object} [sasToken] The Azure key vault secret reference of sasToken - * in sas uri. - * @member {object} [sasToken.store] The Azure Key Vault linked service - * reference. - * @member {string} [sasToken.store.referenceName] Reference LinkedService - * name. - * @member {object} [sasToken.store.parameters] Arguments for LinkedService. - * @member {object} [sasToken.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [sasToken.secretVersion] The version of the secret in Azure - * Key Vault. The default value is the latest version of the secret. Type: - * string (or Expression with resultType string). - * @member {string} [encryptedCredential] The encrypted credential used for - * authentication. Credentials are encrypted using the integration runtime - * credential manager. Type: string (or Expression with resultType string). */ export interface AzureStorageLinkedService extends LinkedService { + /** + * The connection string. It is mutually exclusive with sasUri property. Type: string, + * SecureString or AzureKeyVaultSecretReference. + */ connectionString?: any; + /** + * The Azure key vault secret reference of accountKey in connection string. + */ accountKey?: AzureKeyVaultSecretReference; + /** + * SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString + * property. Type: string, SecureString or AzureKeyVaultSecretReference. + */ sasUri?: any; + /** + * The Azure key vault secret reference of sasToken in sas uri. + */ sasToken?: AzureKeyVaultSecretReference; + /** + * The encrypted credential used for authentication. Credentials are encrypted using the + * integration runtime credential manager. Type: string (or Expression with resultType string). + */ encryptedCredential?: string; } /** - * @class - * Initializes a new instance of the ResponsysObjectDataset class. - * @constructor * Responsys dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface ResponsysObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the SalesforceMarketingCloudObjectDataset class. - * @constructor * Salesforce Marketing Cloud dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface SalesforceMarketingCloudObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the VerticaTableDataset class. - * @constructor * Vertica dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface VerticaTableDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the NetezzaTableDataset class. - * @constructor * Netezza dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface NetezzaTableDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the ZohoObjectDataset class. - * @constructor * Zoho server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface ZohoObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the XeroObjectDataset class. - * @constructor * Xero Serivce dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface XeroObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the SquareObjectDataset class. - * @constructor * Square Serivce dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface SquareObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the SparkObjectDataset class. - * @constructor * Spark Server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface SparkObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the ShopifyObjectDataset class. - * @constructor * Shopify Serivce dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface ShopifyObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the ServiceNowObjectDataset class. - * @constructor * ServiceNow server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface ServiceNowObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the QuickBooksObjectDataset class. - * @constructor * QuickBooks server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface QuickBooksObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the PrestoObjectDataset class. - * @constructor * Presto server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface PrestoObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the PhoenixObjectDataset class. - * @constructor * Phoenix server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface PhoenixObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the PaypalObjectDataset class. - * @constructor * Paypal Serivce dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface PaypalObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the MarketoObjectDataset class. - * @constructor * Marketo server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface MarketoObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the MariaDBTableDataset class. - * @constructor * MariaDB server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface MariaDBTableDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the MagentoObjectDataset class. - * @constructor * Magento server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface MagentoObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the JiraObjectDataset class. - * @constructor * Jira Serivce dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface JiraObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the ImpalaObjectDataset class. - * @constructor * Impala server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface ImpalaObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the HubspotObjectDataset class. - * @constructor * Hubspot Serivce dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface HubspotObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the HiveObjectDataset class. - * @constructor * Hive Server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface HiveObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the HBaseObjectDataset class. - * @constructor * HBase server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface HBaseObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the GreenplumTableDataset class. - * @constructor * Greenplum Database dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface GreenplumTableDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the GoogleBigQueryObjectDataset class. - * @constructor * Google BigQuery service dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface GoogleBigQueryObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the EloquaObjectDataset class. - * @constructor * Eloqua server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface EloquaObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the DrillTableDataset class. - * @constructor * Drill server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface DrillTableDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the CouchbaseTableDataset class. - * @constructor * Couchbase server dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface CouchbaseTableDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the ConcurObjectDataset class. - * @constructor * Concur Serivce dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface ConcurObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the AzurePostgreSqlTableDataset class. - * @constructor * Azure PostgreSQL dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface AzurePostgreSqlTableDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the AmazonMWSObjectDataset class. - * @constructor * Amazon Marketplace Web Service dataset. - * - * @member {object} [tableName] The table name. Type: string (or Expression - * with resultType string). */ export interface AmazonMWSObjectDataset extends Dataset { + /** + * The table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the DatasetCompression class. - * @constructor * The compression method used on a dataset. - * - * @member {string} type Polymorphic Discriminator */ export interface DatasetCompression { + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the DatasetZipDeflateCompression class. - * @constructor * The ZipDeflate compression method used on a dataset. - * - * @member {string} [level] The ZipDeflate compression level. Possible values - * include: 'Optimal', 'Fastest' */ export interface DatasetZipDeflateCompression extends DatasetCompression { + /** + * The ZipDeflate compression level. Possible values include: 'Optimal', 'Fastest' + */ level?: string; } /** - * @class - * Initializes a new instance of the DatasetDeflateCompression class. - * @constructor * The Deflate compression method used on a dataset. - * - * @member {string} [level] The Deflate compression level. Possible values - * include: 'Optimal', 'Fastest' */ export interface DatasetDeflateCompression extends DatasetCompression { + /** + * The Deflate compression level. Possible values include: 'Optimal', 'Fastest' + */ level?: string; } /** - * @class - * Initializes a new instance of the DatasetGZipCompression class. - * @constructor * The GZip compression method used on a dataset. - * - * @member {string} [level] The GZip compression level. Possible values - * include: 'Optimal', 'Fastest' */ export interface DatasetGZipCompression extends DatasetCompression { + /** + * The GZip compression level. Possible values include: 'Optimal', 'Fastest' + */ level?: string; } /** - * @class - * Initializes a new instance of the DatasetBZip2Compression class. - * @constructor * The BZip2 compression method used on a dataset. - * */ export interface DatasetBZip2Compression extends DatasetCompression { } /** - * @class - * Initializes a new instance of the DatasetStorageFormat class. - * @constructor * The format definition of a storage. - * - * @member {object} [serializer] Serializer. Type: string (or Expression with - * resultType string). - * @member {object} [deserializer] Deserializer. Type: string (or Expression - * with resultType string). - * @member {string} type Polymorphic Discriminator */ export interface DatasetStorageFormat { + /** + * Serializer. Type: string (or Expression with resultType string). + */ serializer?: any; + /** + * Deserializer. Type: string (or Expression with resultType string). + */ deserializer?: any; + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ParquetFormat class. - * @constructor * The data stored in Parquet format. - * */ export interface ParquetFormat extends DatasetStorageFormat { } /** - * @class - * Initializes a new instance of the OrcFormat class. - * @constructor * The data stored in Optimized Row Columnar (ORC) format. - * */ export interface OrcFormat extends DatasetStorageFormat { } /** - * @class - * Initializes a new instance of the AvroFormat class. - * @constructor * The data stored in Avro format. - * */ export interface AvroFormat extends DatasetStorageFormat { } /** - * @class - * Initializes a new instance of the JsonFormat class. - * @constructor * The data stored in JSON format. - * - * @member {string} [filePattern] File pattern of JSON. To be more specific, - * the way of separating a collection of JSON objects. The default value is - * 'setOfObjects'. It is case-sensitive. Possible values include: - * 'setOfObjects', 'arrayOfObjects' - * @member {object} [nestingSeparator] The character used to separate nesting - * levels. Default value is '.' (dot). Type: string (or Expression with - * resultType string). - * @member {object} [encodingName] The code page name of the preferred - * encoding. If not provided, the default value is 'utf-8', unless the byte - * order mark (BOM) denotes another Unicode encoding. The full list of - * supported values can be found in the 'Name' column of the table of encodings - * in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. - * Type: string (or Expression with resultType string). - * @member {object} [jsonNodeReference] The JSONPath of the JSON array element - * to be flattened. Example: "$.ArrayPath". Type: string (or Expression with - * resultType string). - * @member {object} [jsonPathDefinition] The JSONPath definition for each - * column mapping with a customized column name to extract data from JSON file. - * For fields under root object, start with "$"; for fields inside the array - * chosen by jsonNodeReference property, start from the array element. Example: - * {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object - * (or Expression with resultType object). */ export interface JsonFormat extends DatasetStorageFormat { + /** + * File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. + * The default value is 'setOfObjects'. It is case-sensitive. Possible values include: + * 'setOfObjects', 'arrayOfObjects' + */ filePattern?: string; + /** + * The character used to separate nesting levels. Default value is '.' (dot). Type: string (or + * Expression with resultType string). + */ nestingSeparator?: any; + /** + * The code page name of the preferred encoding. If not provided, the default value is 'utf-8', + * unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported + * values can be found in the 'Name' column of the table of encodings in the following reference: + * https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType + * string). + */ encodingName?: any; + /** + * The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string + * (or Expression with resultType string). + */ jsonNodeReference?: any; + /** + * The JSONPath definition for each column mapping with a customized column name to extract data + * from JSON file. For fields under root object, start with "$"; for fields inside the array + * chosen by jsonNodeReference property, start from the array element. Example: {"Column1": + * "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType + * object). + */ jsonPathDefinition?: any; } /** - * @class - * Initializes a new instance of the TextFormat class. - * @constructor * The data stored in text format. - * - * @member {object} [columnDelimiter] The column delimiter. Type: string (or - * Expression with resultType string). - * @member {object} [rowDelimiter] The row delimiter. Type: string (or - * Expression with resultType string). - * @member {object} [escapeChar] The escape character. Type: string (or - * Expression with resultType string). - * @member {object} [quoteChar] The quote character. Type: string (or - * Expression with resultType string). - * @member {object} [nullValue] The null value string. Type: string (or - * Expression with resultType string). - * @member {object} [encodingName] The code page name of the preferred - * encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes - * another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the - * following link to set supported values: - * https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string - * (or Expression with resultType string). - * @member {object} [treatEmptyAsNull] Treat empty column values in the text - * file as null. The default value is true. Type: boolean (or Expression with - * resultType boolean). - * @member {object} [skipLineCount] The number of lines/rows to be skipped when - * parsing text files. The default value is 0. Type: integer (or Expression - * with resultType integer). - * @member {object} [firstRowAsHeader] When used as input, treat the first row - * of data as headers. When used as output,write the headers into the output as - * the first row of data. The default value is false. Type: boolean (or - * Expression with resultType boolean). */ export interface TextFormat extends DatasetStorageFormat { + /** + * The column delimiter. Type: string (or Expression with resultType string). + */ columnDelimiter?: any; + /** + * The row delimiter. Type: string (or Expression with resultType string). + */ rowDelimiter?: any; + /** + * The escape character. Type: string (or Expression with resultType string). + */ escapeChar?: any; + /** + * The quote character. Type: string (or Expression with resultType string). + */ quoteChar?: any; + /** + * The null value string. Type: string (or Expression with resultType string). + */ nullValue?: any; + /** + * The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, + * unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in + * the following link to set supported values: + * https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with + * resultType string). + */ encodingName?: any; + /** + * Treat empty column values in the text file as null. The default value is true. Type: boolean + * (or Expression with resultType boolean). + */ treatEmptyAsNull?: any; + /** + * The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: + * integer (or Expression with resultType integer). + */ skipLineCount?: any; + /** + * When used as input, treat the first row of data as headers. When used as output,write the + * headers into the output as the first row of data. The default value is false. Type: boolean + * (or Expression with resultType boolean). + */ firstRowAsHeader?: any; } /** - * @class - * Initializes a new instance of the HttpDataset class. - * @constructor * A file in an HTTP web server. - * - * @member {object} [relativeUrl] The relative URL based on the URL in the - * HttpLinkedService refers to an HTTP file Type: string (or Expression with - * resultType string). - * @member {object} [requestMethod] The HTTP method for the HTTP request. Type: - * string (or Expression with resultType string). - * @member {object} [requestBody] The body for the HTTP request. Type: string - * (or Expression with resultType string). - * @member {object} [additionalHeaders] The headers for the HTTP Request. e.g. - * request-header-name-1:request-header-value-1 - * ... - * request-header-name-n:request-header-value-n Type: string (or Expression - * with resultType string). - * @member {object} [format] The format of files. - * @member {object} [format.serializer] Serializer. Type: string (or Expression - * with resultType string). - * @member {object} [format.deserializer] Deserializer. Type: string (or - * Expression with resultType string). - * @member {string} [format.type] Polymorphic Discriminator - * @member {object} [compression] The data compression method used on files. - * @member {string} [compression.type] Polymorphic Discriminator */ export interface HttpDataset extends Dataset { + /** + * The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string + * (or Expression with resultType string). + */ relativeUrl?: any; + /** + * The HTTP method for the HTTP request. Type: string (or Expression with resultType string). + */ requestMethod?: any; + /** + * The body for the HTTP request. Type: string (or Expression with resultType string). + */ requestBody?: any; + /** + * The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 + * ... + * request-header-name-n:request-header-value-n Type: string (or Expression with resultType + * string). + */ additionalHeaders?: any; + /** + * The format of files. + */ format?: DatasetStorageFormat; + /** + * The data compression method used on files. + */ compression?: DatasetCompression; } /** - * @class - * Initializes a new instance of the AzureSearchIndexDataset class. - * @constructor * The Azure Search Index. - * - * @member {object} indexName The name of the Azure Search Index. Type: string - * (or Expression with resultType string). */ export interface AzureSearchIndexDataset extends Dataset { + /** + * The name of the Azure Search Index. Type: string (or Expression with resultType string). + */ indexName: any; } /** - * @class - * Initializes a new instance of the WebTableDataset class. - * @constructor * The dataset points to a HTML table in the web page. - * - * @member {object} index The zero-based index of the table in the web page. - * Type: integer (or Expression with resultType integer), minimum: 0. - * @member {object} [path] The relative URL to the web page from the linked - * service URL. Type: string (or Expression with resultType string). */ export interface WebTableDataset extends Dataset { + /** + * The zero-based index of the table in the web page. Type: integer (or Expression with + * resultType integer), minimum: 0. + */ index: any; + /** + * The relative URL to the web page from the linked service URL. Type: string (or Expression with + * resultType string). + */ path?: any; } /** - * @class - * Initializes a new instance of the SqlServerTableDataset class. - * @constructor * The on-premises SQL Server dataset. - * - * @member {object} tableName The table name of the SQL Server dataset. Type: - * string (or Expression with resultType string). */ export interface SqlServerTableDataset extends Dataset { + /** + * The table name of the SQL Server dataset. Type: string (or Expression with resultType string). + */ tableName: any; } /** - * @class - * Initializes a new instance of the SapEccResourceDataset class. - * @constructor * The path of the SAP ECC OData entity. - * - * @member {string} path The path of the SAP ECC OData entity. Type: string (or - * Expression with resultType string). */ export interface SapEccResourceDataset extends Dataset { + /** + * The path of the SAP ECC OData entity. Type: string (or Expression with resultType string). + */ path: string; } /** - * @class - * Initializes a new instance of the SapCloudForCustomerResourceDataset class. - * @constructor * The path of the SAP Cloud for Customer OData entity. - * - * @member {object} path The path of the SAP Cloud for Customer OData entity. - * Type: string (or Expression with resultType string). */ export interface SapCloudForCustomerResourceDataset extends Dataset { + /** + * The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with + * resultType string). + */ path: any; } /** - * @class - * Initializes a new instance of the SalesforceObjectDataset class. - * @constructor * The Salesforce object dataset. - * - * @member {object} [objectApiName] The Salesforce object API name. Type: - * string (or Expression with resultType string). */ export interface SalesforceObjectDataset extends Dataset { + /** + * The Salesforce object API name. Type: string (or Expression with resultType string). + */ objectApiName?: any; } /** - * @class - * Initializes a new instance of the RelationalTableDataset class. - * @constructor * The relational table dataset. - * - * @member {object} [tableName] The relational table name. Type: string (or - * Expression with resultType string). */ export interface RelationalTableDataset extends Dataset { + /** + * The relational table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the AzureMySqlTableDataset class. - * @constructor * The Azure MySQL database dataset. - * - * @member {object} [tableName] The Azure MySQL database table name. Type: - * string (or Expression with resultType string). */ export interface AzureMySqlTableDataset extends Dataset { + /** + * The Azure MySQL database table name. Type: string (or Expression with resultType string). + */ tableName?: any; } /** - * @class - * Initializes a new instance of the OracleTableDataset class. - * @constructor * The on-premises Oracle database dataset. - * - * @member {object} tableName The table name of the on-premises Oracle - * database. Type: string (or Expression with resultType string). */ export interface OracleTableDataset extends Dataset { + /** + * The table name of the on-premises Oracle database. Type: string (or Expression with resultType + * string). + */ tableName: any; } /** - * @class - * Initializes a new instance of the ODataResourceDataset class. - * @constructor * The Open Data Protocol (OData) resource dataset. - * - * @member {object} [path] The OData resource path. Type: string (or Expression - * with resultType string). */ export interface ODataResourceDataset extends Dataset { + /** + * The OData resource path. Type: string (or Expression with resultType string). + */ path?: any; } /** - * @class - * Initializes a new instance of the MongoDbCollectionDataset class. - * @constructor * The MongoDB database dataset. - * - * @member {object} collectionName The table name of the MongoDB database. - * Type: string (or Expression with resultType string). */ export interface MongoDbCollectionDataset extends Dataset { + /** + * The table name of the MongoDB database. Type: string (or Expression with resultType string). + */ collectionName: any; } /** - * @class - * Initializes a new instance of the FileShareDataset class. - * @constructor * An on-premises file system dataset. - * - * @member {object} [folderPath] The path of the on-premises file system. Type: - * string (or Expression with resultType string). - * @member {object} [fileName] The name of the on-premises file system. Type: - * string (or Expression with resultType string). - * @member {object} [format] The format of the files. - * @member {object} [format.serializer] Serializer. Type: string (or Expression - * with resultType string). - * @member {object} [format.deserializer] Deserializer. Type: string (or - * Expression with resultType string). - * @member {string} [format.type] Polymorphic Discriminator - * @member {object} [fileFilter] Specify a filter to be used to select a subset - * of files in the folderPath rather than all files. Type: string (or - * Expression with resultType string). - * @member {object} [compression] The data compression method used for the file - * system. - * @member {string} [compression.type] Polymorphic Discriminator */ export interface FileShareDataset extends Dataset { + /** + * The path of the on-premises file system. Type: string (or Expression with resultType string). + */ folderPath?: any; + /** + * The name of the on-premises file system. Type: string (or Expression with resultType string). + */ fileName?: any; + /** + * The format of the files. + */ format?: DatasetStorageFormat; + /** + * Specify a filter to be used to select a subset of files in the folderPath rather than all + * files. Type: string (or Expression with resultType string). + */ fileFilter?: any; + /** + * The data compression method used for the file system. + */ compression?: DatasetCompression; } /** - * @class - * Initializes a new instance of the AzureDataLakeStoreDataset class. - * @constructor * Azure Data Lake Store dataset. - * - * @member {object} folderPath Path to the folder in the Azure Data Lake Store. - * Type: string (or Expression with resultType string). - * @member {object} [fileName] The name of the file in the Azure Data Lake - * Store. Type: string (or Expression with resultType string). - * @member {object} [format] The format of the Data Lake Store. - * @member {object} [format.serializer] Serializer. Type: string (or Expression - * with resultType string). - * @member {object} [format.deserializer] Deserializer. Type: string (or - * Expression with resultType string). - * @member {string} [format.type] Polymorphic Discriminator - * @member {object} [compression] The data compression method used for the - * item(s) in the Azure Data Lake Store. - * @member {string} [compression.type] Polymorphic Discriminator */ export interface AzureDataLakeStoreDataset extends Dataset { + /** + * Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType + * string). + */ folderPath: any; + /** + * The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType + * string). + */ fileName?: any; + /** + * The format of the Data Lake Store. + */ format?: DatasetStorageFormat; + /** + * The data compression method used for the item(s) in the Azure Data Lake Store. + */ compression?: DatasetCompression; } /** - * @class - * Initializes a new instance of the DynamicsEntityDataset class. - * @constructor * The Dynamics entity dataset. - * - * @member {object} [entityName] The logical name of the entity. Type: string - * (or Expression with resultType string). */ export interface DynamicsEntityDataset extends Dataset { + /** + * The logical name of the entity. Type: string (or Expression with resultType string). + */ entityName?: any; } /** - * @class - * Initializes a new instance of the DocumentDbCollectionDataset class. - * @constructor * Microsoft Azure Document Database Collection dataset. - * - * @member {object} collectionName Document Database collection name. Type: - * string (or Expression with resultType string). */ export interface DocumentDbCollectionDataset extends Dataset { + /** + * Document Database collection name. Type: string (or Expression with resultType string). + */ collectionName: any; } /** - * @class - * Initializes a new instance of the CustomDataset class. - * @constructor * The custom dataset. - * - * @member {object} typeProperties Custom dataset properties. */ export interface CustomDataset extends Dataset { + /** + * Custom dataset properties. + */ typeProperties: any; } /** - * @class - * Initializes a new instance of the CassandraTableDataset class. - * @constructor * The Cassandra database dataset. - * - * @member {object} [tableName] The table name of the Cassandra database. Type: - * string (or Expression with resultType string). - * @member {object} [keyspace] The keyspace of the Cassandra database. Type: - * string (or Expression with resultType string). */ export interface CassandraTableDataset extends Dataset { + /** + * The table name of the Cassandra database. Type: string (or Expression with resultType string). + */ tableName?: any; + /** + * The keyspace of the Cassandra database. Type: string (or Expression with resultType string). + */ keyspace?: any; } /** - * @class - * Initializes a new instance of the AzureSqlDWTableDataset class. - * @constructor * The Azure SQL Data Warehouse dataset. - * - * @member {object} tableName The table name of the Azure SQL Data Warehouse. - * Type: string (or Expression with resultType string). */ export interface AzureSqlDWTableDataset extends Dataset { + /** + * The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType + * string). + */ tableName: any; } /** - * @class - * Initializes a new instance of the AzureSqlTableDataset class. - * @constructor * The Azure SQL Server database dataset. - * - * @member {object} tableName The table name of the Azure SQL database. Type: - * string (or Expression with resultType string). */ export interface AzureSqlTableDataset extends Dataset { + /** + * The table name of the Azure SQL database. Type: string (or Expression with resultType string). + */ tableName: any; } /** - * @class - * Initializes a new instance of the AzureTableDataset class. - * @constructor * The Azure Table storage dataset. - * - * @member {object} tableName The table name of the Azure Table storage. Type: - * string (or Expression with resultType string). */ export interface AzureTableDataset extends Dataset { + /** + * The table name of the Azure Table storage. Type: string (or Expression with resultType + * string). + */ tableName: any; } /** - * @class - * Initializes a new instance of the AzureBlobDataset class. - * @constructor * The Azure Blob storage. - * - * @member {object} [folderPath] The path of the Azure Blob storage. Type: - * string (or Expression with resultType string). - * @member {object} [tableRootLocation] The root of blob path. Type: string (or - * Expression with resultType string). - * @member {object} [fileName] The name of the Azure Blob. Type: string (or - * Expression with resultType string). - * @member {object} [format] The format of the Azure Blob storage. - * @member {object} [format.serializer] Serializer. Type: string (or Expression - * with resultType string). - * @member {object} [format.deserializer] Deserializer. Type: string (or - * Expression with resultType string). - * @member {string} [format.type] Polymorphic Discriminator - * @member {object} [compression] The data compression method used for the blob - * storage. - * @member {string} [compression.type] Polymorphic Discriminator */ export interface AzureBlobDataset extends Dataset { + /** + * The path of the Azure Blob storage. Type: string (or Expression with resultType string). + */ folderPath?: any; + /** + * The root of blob path. Type: string (or Expression with resultType string). + */ tableRootLocation?: any; + /** + * The name of the Azure Blob. Type: string (or Expression with resultType string). + */ fileName?: any; + /** + * The format of the Azure Blob storage. + */ format?: DatasetStorageFormat; + /** + * The data compression method used for the blob storage. + */ compression?: DatasetCompression; } /** - * @class - * Initializes a new instance of the AmazonS3Dataset class. - * @constructor * A single Amazon Simple Storage Service (S3) object or a set of S3 objects. - * - * @member {object} bucketName The name of the Amazon S3 bucket. Type: string - * (or Expression with resultType string). - * @member {object} [key] The key of the Amazon S3 object. Type: string (or - * Expression with resultType string). - * @member {object} [prefix] The prefix filter for the S3 object name. Type: - * string (or Expression with resultType string). - * @member {object} [version] The version for the S3 object. Type: string (or - * Expression with resultType string). - * @member {object} [format] The format of files. - * @member {object} [format.serializer] Serializer. Type: string (or Expression - * with resultType string). - * @member {object} [format.deserializer] Deserializer. Type: string (or - * Expression with resultType string). - * @member {string} [format.type] Polymorphic Discriminator - * @member {object} [compression] The data compression method used for the - * Amazon S3 object. - * @member {string} [compression.type] Polymorphic Discriminator */ export interface AmazonS3Dataset extends Dataset { + /** + * The name of the Amazon S3 bucket. Type: string (or Expression with resultType string). + */ bucketName: any; + /** + * The key of the Amazon S3 object. Type: string (or Expression with resultType string). + */ key?: any; + /** + * The prefix filter for the S3 object name. Type: string (or Expression with resultType string). + */ prefix?: any; + /** + * The version for the S3 object. Type: string (or Expression with resultType string). + */ version?: any; + /** + * The format of files. + */ format?: DatasetStorageFormat; + /** + * The data compression method used for the Amazon S3 object. + */ compression?: DatasetCompression; } /** - * @class - * Initializes a new instance of the ActivityPolicy class. - * @constructor * Execution policy for an activity. - * - * @member {object} [timeout] Specifies the timeout for the activity to run. - * The default timeout is 7 days. Type: string (or Expression with resultType - * string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {object} [retry] Maximum ordinary retry attempts. Default is 0. - * Type: integer (or Expression with resultType integer), minimum: 0. - * @member {number} [retryIntervalInSeconds] Interval between each retry - * attempt (in seconds). The default is 30 sec. - * @member {boolean} [secureInput] When set to true, Input from activity is - * considered as secure and will not be logged to monitoring. - * @member {boolean} [secureOutput] When set to true, Output from activity is - * considered as secure and will not be logged to monitoring. */ export interface ActivityPolicy { + /** + * Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or + * Expression with resultType string), pattern: + * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). + */ timeout?: any; + /** + * Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType + * integer), minimum: 0. + */ retry?: any; + /** + * Interval between each retry attempt (in seconds). The default is 30 sec. + */ retryIntervalInSeconds?: number; + /** + * When set to true, Input from activity is considered as secure and will not be logged to + * monitoring. + */ secureInput?: boolean; + /** + * When set to true, Output from activity is considered as secure and will not be logged to + * monitoring. + */ secureOutput?: boolean; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ExecutionActivity class. - * @constructor * Base class for all execution activities. - * - * @member {object} [linkedServiceName] Linked service reference. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for LinkedService. - * @member {object} [policy] Activity policy. - * @member {object} [policy.timeout] Specifies the timeout for the activity to - * run. The default timeout is 7 days. Type: string (or Expression with - * resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {object} [policy.retry] Maximum ordinary retry attempts. Default is - * 0. Type: integer (or Expression with resultType integer), minimum: 0. - * @member {number} [policy.retryIntervalInSeconds] Interval between each retry - * attempt (in seconds). The default is 30 sec. - * @member {boolean} [policy.secureInput] When set to true, Input from activity - * is considered as secure and will not be logged to monitoring. - * @member {boolean} [policy.secureOutput] When set to true, Output from - * activity is considered as secure and will not be logged to monitoring. */ export interface ExecutionActivity extends Activity { + /** + * Linked service reference. + */ linkedServiceName?: LinkedServiceReference; + /** + * Activity policy. + */ policy?: ActivityPolicy; } /** - * @class - * Initializes a new instance of the DatabricksSparkPythonActivity class. - * @constructor * DatabricksSparkPython activity. - * - * @member {object} pythonFile The URI of the Python file to be executed. DBFS - * paths are supported. Type: string (or Expression with resultType string). - * @member {array} [parameters] Command line parameters that will be passed to - * the Python file. - * @member {array} [libraries] A list of libraries to be installed on the - * cluster that will execute the job. */ export interface DatabricksSparkPythonActivity extends ExecutionActivity { + /** + * The URI of the Python file to be executed. DBFS paths are supported. Type: string (or + * Expression with resultType string). + */ pythonFile: any; + /** + * Command line parameters that will be passed to the Python file. + */ parameters?: any[]; + /** + * A list of libraries to be installed on the cluster that will execute the job. + */ libraries?: { [propertyName: string]: any }[]; } /** - * @class - * Initializes a new instance of the DatabricksSparkJarActivity class. - * @constructor * DatabricksSparkJar activity. - * - * @member {object} mainClassName The full name of the class containing the - * main method to be executed. This class must be contained in a JAR provided - * as a library. Type: string (or Expression with resultType string). - * @member {array} [parameters] Parameters that will be passed to the main - * method. - * @member {array} [libraries] A list of libraries to be installed on the - * cluster that will execute the job. */ export interface DatabricksSparkJarActivity extends ExecutionActivity { + /** + * The full name of the class containing the main method to be executed. This class must be + * contained in a JAR provided as a library. Type: string (or Expression with resultType string). + */ mainClassName: any; + /** + * Parameters that will be passed to the main method. + */ parameters?: any[]; + /** + * A list of libraries to be installed on the cluster that will execute the job. + */ libraries?: { [propertyName: string]: any }[]; } /** - * @class - * Initializes a new instance of the DatabricksNotebookActivity class. - * @constructor * DatabricksNotebook activity. - * - * @member {object} notebookPath The absolute path of the notebook to be run in - * the Databricks Workspace. This path must begin with a slash. Type: string - * (or Expression with resultType string). - * @member {object} [baseParameters] Base parameters to be used for each run of - * this job.If the notebook takes a parameter that is not specified, the - * default value from the notebook will be used. - * @member {array} [libraries] A list of libraries to be installed on the - * cluster that will execute the job. */ export interface DatabricksNotebookActivity extends ExecutionActivity { + /** + * The absolute path of the notebook to be run in the Databricks Workspace. This path must begin + * with a slash. Type: string (or Expression with resultType string). + */ notebookPath: any; + /** + * Base parameters to be used for each run of this job.If the notebook takes a parameter that is + * not specified, the default value from the notebook will be used. + */ baseParameters?: { [propertyName: string]: any }; + /** + * A list of libraries to be installed on the cluster that will execute the job. + */ libraries?: { [propertyName: string]: any }[]; } /** - * @class - * Initializes a new instance of the DataLakeAnalyticsUSQLActivity class. - * @constructor * Data Lake Analytics U-SQL activity. - * - * @member {object} scriptPath Case-sensitive path to folder that contains the - * U-SQL script. Type: string (or Expression with resultType string). - * @member {object} scriptLinkedService Script linked service reference. - * @member {string} [scriptLinkedService.referenceName] Reference LinkedService - * name. - * @member {object} [scriptLinkedService.parameters] Arguments for - * LinkedService. - * @member {object} [degreeOfParallelism] The maximum number of nodes - * simultaneously used to run the job. Default value is 1. Type: integer (or - * Expression with resultType integer), minimum: 1. - * @member {object} [priority] Determines which jobs out of all that are queued - * should be selected to run first. The lower the number, the higher the - * priority. Default value is 1000. Type: integer (or Expression with - * resultType integer), minimum: 1. - * @member {object} [parameters] Parameters for U-SQL job request. - * @member {object} [runtimeVersion] Runtime version of the U-SQL engine to - * use. Type: string (or Expression with resultType string). - * @member {object} [compilationMode] Compilation mode of U-SQL. Must be one of - * these values : Semantic, Full and SingleBox. Type: string (or Expression - * with resultType string). */ export interface DataLakeAnalyticsUSQLActivity extends ExecutionActivity { + /** + * Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with + * resultType string). + */ scriptPath: any; + /** + * Script linked service reference. + */ scriptLinkedService: LinkedServiceReference; + /** + * The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: + * integer (or Expression with resultType integer), minimum: 1. + */ degreeOfParallelism?: any; + /** + * Determines which jobs out of all that are queued should be selected to run first. The lower + * the number, the higher the priority. Default value is 1000. Type: integer (or Expression with + * resultType integer), minimum: 1. + */ priority?: any; + /** + * Parameters for U-SQL job request. + */ parameters?: { [propertyName: string]: any }; + /** + * Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType + * string). + */ runtimeVersion?: any; + /** + * Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: + * string (or Expression with resultType string). + */ compilationMode?: any; } /** - * @class - * Initializes a new instance of the AzureMLUpdateResourceActivity class. - * @constructor * Azure ML Update Resource management activity. - * - * @member {object} trainedModelName Name of the Trained Model module in the - * Web Service experiment to be updated. Type: string (or Expression with - * resultType string). - * @member {object} trainedModelLinkedServiceName Name of Azure Storage linked - * service holding the .ilearner file that will be uploaded by the update - * operation. - * @member {string} [trainedModelLinkedServiceName.referenceName] Reference - * LinkedService name. - * @member {object} [trainedModelLinkedServiceName.parameters] Arguments for - * LinkedService. - * @member {object} trainedModelFilePath The relative file path in - * trainedModelLinkedService to represent the .ilearner file that will be - * uploaded by the update operation. Type: string (or Expression with - * resultType string). */ export interface AzureMLUpdateResourceActivity extends ExecutionActivity { + /** + * Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or + * Expression with resultType string). + */ trainedModelName: any; + /** + * Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the + * update operation. + */ trainedModelLinkedServiceName: LinkedServiceReference; + /** + * The relative file path in trainedModelLinkedService to represent the .ilearner file that will + * be uploaded by the update operation. Type: string (or Expression with resultType string). + */ trainedModelFilePath: any; } /** - * @class - * Initializes a new instance of the AzureMLWebServiceFile class. - * @constructor * Azure ML WebService Input/Output file - * - * @member {object} filePath The relative file path, including container name, - * in the Azure Blob Storage specified by the LinkedService. Type: string (or - * Expression with resultType string). - * @member {object} linkedServiceName Reference to an Azure Storage - * LinkedService, where Azure ML WebService Input/Output file located. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for LinkedService. */ export interface AzureMLWebServiceFile { + /** + * The relative file path, including container name, in the Azure Blob Storage specified by the + * LinkedService. Type: string (or Expression with resultType string). + */ filePath: any; + /** + * Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file + * located. + */ linkedServiceName: LinkedServiceReference; } /** - * @class - * Initializes a new instance of the AzureMLBatchExecutionActivity class. - * @constructor * Azure ML Batch Execution activity. - * - * @member {object} [globalParameters] Key,Value pairs to be passed to the - * Azure ML Batch Execution Service endpoint. Keys must match the names of web - * service parameters defined in the published Azure ML web service. Values - * will be passed in the GlobalParameters property of the Azure ML batch - * execution request. - * @member {object} [webServiceOutputs] Key,Value pairs, mapping the names of - * Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects - * specifying the output Blob locations. This information will be passed in the - * WebServiceOutputs property of the Azure ML batch execution request. - * @member {object} [webServiceInputs] Key,Value pairs, mapping the names of - * Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects - * specifying the input Blob locations.. This information will be passed in the - * WebServiceInputs property of the Azure ML batch execution request. */ export interface AzureMLBatchExecutionActivity extends ExecutionActivity { + /** + * Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match + * the names of web service parameters defined in the published Azure ML web service. Values will + * be passed in the GlobalParameters property of the Azure ML batch execution request. + */ globalParameters?: { [propertyName: string]: any }; + /** + * Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to + * AzureMLWebServiceFile objects specifying the output Blob locations. This information will be + * passed in the WebServiceOutputs property of the Azure ML batch execution request. + */ webServiceOutputs?: { [propertyName: string]: AzureMLWebServiceFile }; + /** + * Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to + * AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be + * passed in the WebServiceInputs property of the Azure ML batch execution request. + */ webServiceInputs?: { [propertyName: string]: AzureMLWebServiceFile }; } /** - * @class - * Initializes a new instance of the GetMetadataActivity class. - * @constructor * Activity to get metadata of dataset - * - * @member {object} dataset GetMetadata activity dataset reference. - * @member {string} [dataset.referenceName] Reference dataset name. - * @member {object} [dataset.parameters] Arguments for dataset. - * @member {array} [fieldList] Fields of metadata to get from dataset. */ export interface GetMetadataActivity extends ExecutionActivity { + /** + * GetMetadata activity dataset reference. + */ dataset: DatasetReference; + /** + * Fields of metadata to get from dataset. + */ fieldList?: any[]; } /** - * @class - * Initializes a new instance of the WebActivityAuthentication class. - * @constructor * Web activity authentication properties. - * - * @member {string} type Web activity authentication - * (Basic/ClientCertificate/MSI) - * @member {object} [pfx] Base64-encoded contents of a PFX file. - * @member {string} [pfx.value] Value of secure string. - * @member {string} [username] Web activity authentication user name for basic - * authentication. - * @member {object} [password] Password for the PFX file or basic - * authentication. - * @member {string} [password.value] Value of secure string. - * @member {string} [resource] Resource for which Azure Auth token will be - * requested when using MSI Authentication. */ export interface WebActivityAuthentication { + /** + * Web activity authentication (Basic/ClientCertificate/MSI) + */ type: string; + /** + * Base64-encoded contents of a PFX file. + */ pfx?: SecureString; + /** + * Web activity authentication user name for basic authentication. + */ username?: string; + /** + * Password for the PFX file or basic authentication. + */ password?: SecureString; + /** + * Resource for which Azure Auth token will be requested when using MSI Authentication. + */ resource?: string; } /** - * @class - * Initializes a new instance of the WebActivity class. - * @constructor * Web activity. - * - * @member {string} method Rest API method for target endpoint. Possible values - * include: 'GET', 'POST', 'PUT', 'DELETE' - * @member {object} url Web activity target endpoint and path. Type: string (or - * Expression with resultType string). - * @member {object} [headers] Represents the headers that will be sent to the - * request. For example, to set the language and type on a request: "headers" : - * { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: - * string (or Expression with resultType string). - * @member {object} [body] Represents the payload that will be sent to the - * endpoint. Required for POST/PUT method, not allowed for GET method Type: - * string (or Expression with resultType string). - * @member {object} [authentication] Authentication method used for calling the - * endpoint. - * @member {string} [authentication.type] Web activity authentication - * (Basic/ClientCertificate/MSI) - * @member {object} [authentication.pfx] Base64-encoded contents of a PFX file. - * @member {string} [authentication.pfx.value] Value of secure string. - * @member {string} [authentication.username] Web activity authentication user - * name for basic authentication. - * @member {object} [authentication.password] Password for the PFX file or - * basic authentication. - * @member {string} [authentication.password.value] Value of secure string. - * @member {string} [authentication.resource] Resource for which Azure Auth - * token will be requested when using MSI Authentication. - * @member {array} [datasets] List of datasets passed to web endpoint. - * @member {array} [linkedServices] List of linked services passed to web - * endpoint. */ export interface WebActivity extends ExecutionActivity { + /** + * Rest API method for target endpoint. Possible values include: 'GET', 'POST', 'PUT', 'DELETE' + */ method: string; + /** + * Web activity target endpoint and path. Type: string (or Expression with resultType string). + */ url: any; + /** + * Represents the headers that will be sent to the request. For example, to set the language and + * type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": + * "application/json" }. Type: string (or Expression with resultType string). + */ headers?: any; + /** + * Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not + * allowed for GET method Type: string (or Expression with resultType string). + */ body?: any; + /** + * Authentication method used for calling the endpoint. + */ authentication?: WebActivityAuthentication; + /** + * List of datasets passed to web endpoint. + */ datasets?: DatasetReference[]; + /** + * List of linked services passed to web endpoint. + */ linkedServices?: LinkedServiceReference[]; } /** - * @class - * Initializes a new instance of the RedshiftUnloadSettings class. - * @constructor - * The Amazon S3 settings needed for the interim Amazon S3 when copying from - * Amazon Redshift with unload. With this, data from Amazon Redshift source - * will be unloaded into S3 first and then copied into the targeted sink from - * the interim S3. - * - * @member {object} s3LinkedServiceName The name of the Amazon S3 linked - * service which will be used for the unload operation when copying from the - * Amazon Redshift source. - * @member {string} [s3LinkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [s3LinkedServiceName.parameters] Arguments for - * LinkedService. - * @member {object} bucketName The bucket of the interim Amazon S3 which will - * be used to store the unloaded data from Amazon Redshift source. The bucket - * must be in the same region as the Amazon Redshift source. Type: string (or - * Expression with resultType string). + * The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with + * unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then + * copied into the targeted sink from the interim S3. */ export interface RedshiftUnloadSettings { + /** + * The name of the Amazon S3 linked service which will be used for the unload operation when + * copying from the Amazon Redshift source. + */ s3LinkedServiceName: LinkedServiceReference; + /** + * The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon + * Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: + * string (or Expression with resultType string). + */ bucketName: any; } /** - * @class - * Initializes a new instance of the CopySource class. - * @constructor * A copy activity source. - * - * @member {object} [sourceRetryCount] Source retry count. Type: integer (or - * Expression with resultType integer). - * @member {object} [sourceRetryWait] Source retry wait. Type: string (or - * Expression with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {string} type Polymorphic Discriminator */ export interface CopySource { + /** + * Source retry count. Type: integer (or Expression with resultType integer). + */ sourceRetryCount?: any; + /** + * Source retry wait. Type: string (or Expression with resultType string), pattern: + * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). + */ sourceRetryWait?: any; + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the AmazonRedshiftSource class. - * @constructor * A copy activity source for Amazon Redshift Source. - * - * @member {object} [query] Database query. Type: string (or Expression with - * resultType string). - * @member {object} [redshiftUnloadSettings] The Amazon S3 settings needed for - * the interim Amazon S3 when copying from Amazon Redshift with unload. With - * this, data from Amazon Redshift source will be unloaded into S3 first and - * then copied into the targeted sink from the interim S3. - * @member {object} [redshiftUnloadSettings.s3LinkedServiceName] The name of - * the Amazon S3 linked service which will be used for the unload operation - * when copying from the Amazon Redshift source. - * @member {string} [redshiftUnloadSettings.s3LinkedServiceName.referenceName] - * Reference LinkedService name. - * @member {object} [redshiftUnloadSettings.s3LinkedServiceName.parameters] - * Arguments for LinkedService. - * @member {object} [redshiftUnloadSettings.bucketName] The bucket of the - * interim Amazon S3 which will be used to store the unloaded data from Amazon - * Redshift source. The bucket must be in the same region as the Amazon - * Redshift source. Type: string (or Expression with resultType string). */ export interface AmazonRedshiftSource extends CopySource { + /** + * Database query. Type: string (or Expression with resultType string). + */ query?: any; + /** + * The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with + * unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then + * copied into the targeted sink from the interim S3. + */ redshiftUnloadSettings?: RedshiftUnloadSettings; } /** - * @class - * Initializes a new instance of the ResponsysSource class. - * @constructor * A copy activity Responsys source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface ResponsysSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the SalesforceMarketingCloudSource class. - * @constructor * A copy activity Salesforce Marketing Cloud source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface SalesforceMarketingCloudSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the VerticaSource class. - * @constructor * A copy activity Vertica source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface VerticaSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the NetezzaSource class. - * @constructor * A copy activity Netezza source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface NetezzaSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the ZohoSource class. - * @constructor * A copy activity Zoho server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface ZohoSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the XeroSource class. - * @constructor * A copy activity Xero Serivce source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface XeroSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the SquareSource class. - * @constructor * A copy activity Square Serivce source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface SquareSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the SparkSource class. - * @constructor * A copy activity Spark Server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface SparkSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the ShopifySource class. - * @constructor * A copy activity Shopify Serivce source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface ShopifySource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the ServiceNowSource class. - * @constructor * A copy activity ServiceNow server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface ServiceNowSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the QuickBooksSource class. - * @constructor * A copy activity QuickBooks server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface QuickBooksSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the PrestoSource class. - * @constructor * A copy activity Presto server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface PrestoSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the PhoenixSource class. - * @constructor * A copy activity Phoenix server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface PhoenixSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the PaypalSource class. - * @constructor * A copy activity Paypal Serivce source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface PaypalSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the MarketoSource class. - * @constructor * A copy activity Marketo server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface MarketoSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the MariaDBSource class. - * @constructor * A copy activity MariaDB server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface MariaDBSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the MagentoSource class. - * @constructor * A copy activity Magento server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface MagentoSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the JiraSource class. - * @constructor * A copy activity Jira Serivce source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface JiraSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the ImpalaSource class. - * @constructor * A copy activity Impala server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface ImpalaSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the HubspotSource class. - * @constructor * A copy activity Hubspot Serivce source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface HubspotSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the HiveSource class. - * @constructor * A copy activity Hive Server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface HiveSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the HBaseSource class. - * @constructor * A copy activity HBase server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface HBaseSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the GreenplumSource class. - * @constructor * A copy activity Greenplum Database source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface GreenplumSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the GoogleBigQuerySource class. - * @constructor * A copy activity Google BigQuery service source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface GoogleBigQuerySource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the EloquaSource class. - * @constructor * A copy activity Eloqua server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface EloquaSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the DrillSource class. - * @constructor * A copy activity Drill server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface DrillSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the CouchbaseSource class. - * @constructor * A copy activity Couchbase server source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface CouchbaseSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the ConcurSource class. - * @constructor * A copy activity Concur Serivce source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface ConcurSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the AzurePostgreSqlSource class. - * @constructor * A copy activity Azure PostgreSQL source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface AzurePostgreSqlSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the AmazonMWSSource class. - * @constructor * A copy activity Amazon Marketplace Web Service source. - * - * @member {object} [query] A query to retrieve data from source. Type: string - * (or Expression with resultType string). */ export interface AmazonMWSSource extends CopySource { + /** + * A query to retrieve data from source. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the HttpSource class. - * @constructor * A copy activity source for an HTTP file. - * - * @member {object} [httpRequestTimeout] Specifies the timeout for a HTTP - * client to get HTTP response from HTTP server. The default value is - * equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression - * with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ export interface HttpSource extends CopySource { + /** + * Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default + * value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with + * resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). + */ httpRequestTimeout?: any; } /** - * @class - * Initializes a new instance of the AzureDataLakeStoreSource class. - * @constructor * A copy activity Azure Data Lake source. - * - * @member {object} [recursive] If true, files under the folder path will be - * read recursively. Default is true. Type: boolean (or Expression with - * resultType boolean). */ export interface AzureDataLakeStoreSource extends CopySource { + /** + * If true, files under the folder path will be read recursively. Default is true. Type: boolean + * (or Expression with resultType boolean). + */ recursive?: any; } /** - * @class - * Initializes a new instance of the MongoDbSource class. - * @constructor * A copy activity source for a MongoDB database. - * - * @member {object} [query] Database query. Should be a SQL-92 query - * expression. Type: string (or Expression with resultType string). */ export interface MongoDbSource extends CopySource { + /** + * Database query. Should be a SQL-92 query expression. Type: string (or Expression with + * resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the CassandraSource class. - * @constructor * A copy activity source for a Cassandra database. - * - * @member {object} [query] Database query. Should be a SQL-92 query expression - * or Cassandra Query Language (CQL) command. Type: string (or Expression with - * resultType string). - * @member {string} [consistencyLevel] The consistency level specifies how many - * Cassandra servers must respond to a read request before returning data to - * the client application. Cassandra checks the specified number of Cassandra - * servers for data to satisfy the read request. Must be one of - * cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is - * case-insensitive. Possible values include: 'ALL', 'EACH_QUORUM', 'QUORUM', - * 'LOCAL_QUORUM', 'ONE', 'TWO', 'THREE', 'LOCAL_ONE', 'SERIAL', 'LOCAL_SERIAL' */ export interface CassandraSource extends CopySource { + /** + * Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. + * Type: string (or Expression with resultType string). + */ query?: any; + /** + * The consistency level specifies how many Cassandra servers must respond to a read request + * before returning data to the client application. Cassandra checks the specified number of + * Cassandra servers for data to satisfy the read request. Must be one of + * cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive. + * Possible values include: 'ALL', 'EACH_QUORUM', 'QUORUM', 'LOCAL_QUORUM', 'ONE', 'TWO', + * 'THREE', 'LOCAL_ONE', 'SERIAL', 'LOCAL_SERIAL' + */ consistencyLevel?: string; } /** - * @class - * Initializes a new instance of the WebSource class. - * @constructor * A copy activity source for web page table. - * */ export interface WebSource extends CopySource { } /** - * @class - * Initializes a new instance of the OracleSource class. - * @constructor * A copy activity Oracle source. - * - * @member {object} [oracleReaderQuery] Oracle reader query. Type: string (or - * Expression with resultType string). - * @member {object} [queryTimeout] Query timeout. Type: string (or Expression - * with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ export interface OracleSource extends CopySource { + /** + * Oracle reader query. Type: string (or Expression with resultType string). + */ oracleReaderQuery?: any; + /** + * Query timeout. Type: string (or Expression with resultType string), pattern: + * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). + */ queryTimeout?: any; } /** - * @class - * Initializes a new instance of the AzureMySqlSource class. - * @constructor * A copy activity Azure MySQL source. - * - * @member {object} [query] Database query. Type: string (or Expression with - * resultType string). */ export interface AzureMySqlSource extends CopySource { + /** + * Database query. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the DistcpSettings class. - * @constructor * Distcp settings. - * - * @member {object} resourceManagerEndpoint Specifies the Yarn ResourceManager - * endpoint. Type: string (or Expression with resultType string). - * @member {object} tempScriptPath Specifies an existing folder path which will - * be used to store temp Distcp command script. The script file is generated by - * ADF and will be removed after Copy job finished. Type: string (or Expression - * with resultType string). - * @member {object} [distcpOptions] Specifies the Distcp options. Type: string - * (or Expression with resultType string). */ export interface DistcpSettings { + /** + * Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType + * string). + */ resourceManagerEndpoint: any; + /** + * Specifies an existing folder path which will be used to store temp Distcp command script. The + * script file is generated by ADF and will be removed after Copy job finished. Type: string (or + * Expression with resultType string). + */ tempScriptPath: any; + /** + * Specifies the Distcp options. Type: string (or Expression with resultType string). + */ distcpOptions?: any; } /** - * @class - * Initializes a new instance of the HdfsSource class. - * @constructor * A copy activity HDFS source. - * - * @member {object} [recursive] If true, files under the folder path will be - * read recursively. Default is true. Type: boolean (or Expression with - * resultType boolean). - * @member {object} [distcpSettings] Specifies Distcp-related settings. - * @member {object} [distcpSettings.resourceManagerEndpoint] Specifies the Yarn - * ResourceManager endpoint. Type: string (or Expression with resultType - * string). - * @member {object} [distcpSettings.tempScriptPath] Specifies an existing - * folder path which will be used to store temp Distcp command script. The - * script file is generated by ADF and will be removed after Copy job finished. - * Type: string (or Expression with resultType string). - * @member {object} [distcpSettings.distcpOptions] Specifies the Distcp - * options. Type: string (or Expression with resultType string). */ export interface HdfsSource extends CopySource { + /** + * If true, files under the folder path will be read recursively. Default is true. Type: boolean + * (or Expression with resultType boolean). + */ recursive?: any; + /** + * Specifies Distcp-related settings. + */ distcpSettings?: DistcpSettings; } /** - * @class - * Initializes a new instance of the FileSystemSource class. - * @constructor * A copy activity file system source. - * - * @member {object} [recursive] If true, files under the folder path will be - * read recursively. Default is true. Type: boolean (or Expression with - * resultType boolean). */ export interface FileSystemSource extends CopySource { + /** + * If true, files under the folder path will be read recursively. Default is true. Type: boolean + * (or Expression with resultType boolean). + */ recursive?: any; } /** - * @class - * Initializes a new instance of the SqlDWSource class. - * @constructor * A copy activity SQL Data Warehouse source. - * - * @member {object} [sqlReaderQuery] SQL Data Warehouse reader query. Type: - * string (or Expression with resultType string). - * @member {object} [sqlReaderStoredProcedureName] Name of the stored procedure - * for a SQL Data Warehouse source. This cannot be used at the same time as - * SqlReaderQuery. Type: string (or Expression with resultType string). - * @member {object} [storedProcedureParameters] Value and type setting for - * stored procedure parameters. Example: "{Parameter1: {value: "1", type: - * "int"}}". Type: object (or Expression with resultType object), itemType: - * StoredProcedureParameter. */ export interface SqlDWSource extends CopySource { + /** + * SQL Data Warehouse reader query. Type: string (or Expression with resultType string). + */ sqlReaderQuery?: any; + /** + * Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same + * time as SqlReaderQuery. Type: string (or Expression with resultType string). + */ sqlReaderStoredProcedureName?: any; + /** + * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", + * type: "int"}}". Type: object (or Expression with resultType object), itemType: + * StoredProcedureParameter. + */ storedProcedureParameters?: any; } /** - * @class - * Initializes a new instance of the StoredProcedureParameter class. - * @constructor * SQL stored procedure parameter. - * - * @member {object} [value] Stored procedure parameter value. Type: string (or - * Expression with resultType string). - * @member {string} [type] Stored procedure parameter type. Possible values - * include: 'String', 'Int', 'Decimal', 'Guid', 'Boolean', 'Date' */ export interface StoredProcedureParameter { + /** + * Stored procedure parameter value. Type: string (or Expression with resultType string). + */ value?: any; + /** + * Stored procedure parameter type. Possible values include: 'String', 'Int', 'Decimal', 'Guid', + * 'Boolean', 'Date' + */ type?: string; } /** - * @class - * Initializes a new instance of the SqlSource class. - * @constructor * A copy activity SQL source. - * - * @member {object} [sqlReaderQuery] SQL reader query. Type: string (or - * Expression with resultType string). - * @member {object} [sqlReaderStoredProcedureName] Name of the stored procedure - * for a SQL Database source. This cannot be used at the same time as - * SqlReaderQuery. Type: string (or Expression with resultType string). - * @member {object} [storedProcedureParameters] Value and type setting for - * stored procedure parameters. Example: "{Parameter1: {value: "1", type: - * "int"}}". */ export interface SqlSource extends CopySource { + /** + * SQL reader query. Type: string (or Expression with resultType string). + */ sqlReaderQuery?: any; + /** + * Name of the stored procedure for a SQL Database source. This cannot be used at the same time + * as SqlReaderQuery. Type: string (or Expression with resultType string). + */ sqlReaderStoredProcedureName?: any; + /** + * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", + * type: "int"}}". + */ storedProcedureParameters?: { [propertyName: string]: StoredProcedureParameter }; } /** - * @class - * Initializes a new instance of the SapEccSource class. - * @constructor * A copy activity source for SAP ECC source. - * - * @member {string} [query] SAP ECC OData query. For example, "$top=1". Type: - * string (or Expression with resultType string). */ export interface SapEccSource extends CopySource { + /** + * SAP ECC OData query. For example, "$top=1". Type: string (or Expression with resultType + * string). + */ query?: string; } /** - * @class - * Initializes a new instance of the SapCloudForCustomerSource class. - * @constructor * A copy activity source for SAP Cloud for Customer source. - * - * @member {object} [query] SAP Cloud for Customer OData query. For example, - * "$top=1". Type: string (or Expression with resultType string). */ export interface SapCloudForCustomerSource extends CopySource { + /** + * SAP Cloud for Customer OData query. For example, "$top=1". Type: string (or Expression with + * resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the SalesforceSource class. - * @constructor * A copy activity Salesforce source. - * - * @member {object} [query] Database query. Type: string (or Expression with - * resultType string). - * @member {string} [readBehavior] The read behavior for the operation. Default - * is Query. Possible values include: 'Query', 'QueryAll' */ export interface SalesforceSource extends CopySource { + /** + * Database query. Type: string (or Expression with resultType string). + */ query?: any; + /** + * The read behavior for the operation. Default is Query. Possible values include: 'Query', + * 'QueryAll' + */ readBehavior?: string; } /** - * @class - * Initializes a new instance of the RelationalSource class. - * @constructor * A copy activity source for various relational databases. - * - * @member {object} [query] Database query. Type: string (or Expression with - * resultType string). */ export interface RelationalSource extends CopySource { + /** + * Database query. Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the DynamicsSource class. - * @constructor * A copy activity Dynamics source. - * - * @member {object} [query] FetchXML is a proprietary query language that is - * used in Microsoft Dynamics (online & on-premises). Type: string (or - * Expression with resultType string). */ export interface DynamicsSource extends CopySource { + /** + * FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & + * on-premises). Type: string (or Expression with resultType string). + */ query?: any; } /** - * @class - * Initializes a new instance of the DocumentDbCollectionSource class. - * @constructor * A copy activity Document Database Collection source. - * - * @member {object} [query] Documents query. Type: string (or Expression with - * resultType string). - * @member {object} [nestingSeparator] Nested properties separator. Type: - * string (or Expression with resultType string). */ export interface DocumentDbCollectionSource extends CopySource { + /** + * Documents query. Type: string (or Expression with resultType string). + */ query?: any; + /** + * Nested properties separator. Type: string (or Expression with resultType string). + */ nestingSeparator?: any; } /** - * @class - * Initializes a new instance of the BlobSource class. - * @constructor * A copy activity Azure Blob source. - * - * @member {object} [treatEmptyAsNull] Treat empty as null. Type: boolean (or - * Expression with resultType boolean). - * @member {object} [skipHeaderLineCount] Number of header lines to skip from - * each blob. Type: integer (or Expression with resultType integer). - * @member {object} [recursive] If true, files under the folder path will be - * read recursively. Default is true. Type: boolean (or Expression with - * resultType boolean). */ export interface BlobSource extends CopySource { + /** + * Treat empty as null. Type: boolean (or Expression with resultType boolean). + */ treatEmptyAsNull?: any; + /** + * Number of header lines to skip from each blob. Type: integer (or Expression with resultType + * integer). + */ skipHeaderLineCount?: any; + /** + * If true, files under the folder path will be read recursively. Default is true. Type: boolean + * (or Expression with resultType boolean). + */ recursive?: any; } /** - * @class - * Initializes a new instance of the AzureTableSource class. - * @constructor * A copy activity Azure Table source. - * - * @member {object} [azureTableSourceQuery] Azure Table source query. Type: - * string (or Expression with resultType string). - * @member {object} [azureTableSourceIgnoreTableNotFound] Azure Table source - * ignore table not found. Type: boolean (or Expression with resultType - * boolean). */ export interface AzureTableSource extends CopySource { + /** + * Azure Table source query. Type: string (or Expression with resultType string). + */ azureTableSourceQuery?: any; + /** + * Azure Table source ignore table not found. Type: boolean (or Expression with resultType + * boolean). + */ azureTableSourceIgnoreTableNotFound?: any; } /** - * @class - * Initializes a new instance of the LookupActivity class. - * @constructor * Lookup activity. - * - * @member {object} source Dataset-specific source properties, same as copy - * activity source. - * @member {object} [source.sourceRetryCount] Source retry count. Type: integer - * (or Expression with resultType integer). - * @member {object} [source.sourceRetryWait] Source retry wait. Type: string - * (or Expression with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {string} [source.type] Polymorphic Discriminator - * @member {object} dataset Lookup activity dataset reference. - * @member {string} [dataset.referenceName] Reference dataset name. - * @member {object} [dataset.parameters] Arguments for dataset. - * @member {object} [firstRowOnly] Whether to return first row or all rows. - * Default value is true. Type: boolean (or Expression with resultType - * boolean). */ export interface LookupActivity extends ExecutionActivity { + /** + * Dataset-specific source properties, same as copy activity source. + */ source: CopySource; + /** + * Lookup activity dataset reference. + */ dataset: DatasetReference; + /** + * Whether to return first row or all rows. Default value is true. Type: boolean (or Expression + * with resultType boolean). + */ firstRowOnly?: any; } /** - * @class - * Initializes a new instance of the DeleteActivity class. - * @constructor * Delete activity. - * - * @member {object} [recursive] If true, files under the folder path will be - * deleted recursively. Default is true. Type: boolean (or Expression with - * resultType boolean). - * @member {object} dataset Delete activity dataset reference. - * @member {string} [dataset.referenceName] Reference dataset name. - * @member {object} [dataset.parameters] Arguments for dataset. */ export interface DeleteActivity extends ExecutionActivity { + /** + * If true, files under the folder path will be deleted recursively. Default is true. Type: + * boolean (or Expression with resultType boolean). + */ recursive?: any; + /** + * Delete activity dataset reference. + */ dataset: DatasetReference; } /** - * @class - * Initializes a new instance of the SqlServerStoredProcedureActivity class. - * @constructor * SQL stored procedure activity type. - * - * @member {object} storedProcedureName Stored procedure name. Type: string (or - * Expression with resultType string). - * @member {object} [storedProcedureParameters] Value and type setting for - * stored procedure parameters. Example: "{Parameter1: {value: "1", type: - * "int"}}". */ export interface SqlServerStoredProcedureActivity extends ExecutionActivity { + /** + * Stored procedure name. Type: string (or Expression with resultType string). + */ storedProcedureName: any; + /** + * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", + * type: "int"}}". + */ storedProcedureParameters?: { [propertyName: string]: StoredProcedureParameter }; } /** - * @class - * Initializes a new instance of the CustomActivityReferenceObject class. - * @constructor * Reference objects for custom activity - * - * @member {array} [linkedServices] Linked service references. - * @member {array} [datasets] Dataset references. */ export interface CustomActivityReferenceObject { + /** + * Linked service references. + */ linkedServices?: LinkedServiceReference[]; + /** + * Dataset references. + */ datasets?: DatasetReference[]; } /** - * @class - * Initializes a new instance of the CustomActivity class. - * @constructor * Custom activity type. - * - * @member {object} command Command for custom activity Type: string (or - * Expression with resultType string). - * @member {object} [resourceLinkedService] Resource linked service reference. - * @member {string} [resourceLinkedService.referenceName] Reference - * LinkedService name. - * @member {object} [resourceLinkedService.parameters] Arguments for - * LinkedService. - * @member {object} [folderPath] Folder path for resource files Type: string - * (or Expression with resultType string). - * @member {object} [referenceObjects] Reference objects - * @member {array} [referenceObjects.linkedServices] Linked service references. - * @member {array} [referenceObjects.datasets] Dataset references. - * @member {object} [extendedProperties] User defined property bag. There is no - * restriction on the keys or values that can be used. The user specified - * custom activity has the full responsibility to consume and interpret the - * content defined. */ export interface CustomActivity extends ExecutionActivity { + /** + * Command for custom activity Type: string (or Expression with resultType string). + */ command: any; + /** + * Resource linked service reference. + */ resourceLinkedService?: LinkedServiceReference; + /** + * Folder path for resource files Type: string (or Expression with resultType string). + */ folderPath?: any; + /** + * Reference objects + */ referenceObjects?: CustomActivityReferenceObject; + /** + * User defined property bag. There is no restriction on the keys or values that can be used. The + * user specified custom activity has the full responsibility to consume and interpret the + * content defined. + */ extendedProperties?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the SSISPropertyOverride class. - * @constructor * SSIS property override. - * - * @member {object} value SSIS package property override value. Type: string - * (or Expression with resultType string). - * @member {boolean} [isSensitive] Whether SSIS package property override value - * is sensitive data. Value will be encrypted in SSISDB if it is true */ export interface SSISPropertyOverride { + /** + * SSIS package property override value. Type: string (or Expression with resultType string). + */ value: any; + /** + * Whether SSIS package property override value is sensitive data. Value will be encrypted in + * SSISDB if it is true + */ isSensitive?: boolean; } /** - * @class - * Initializes a new instance of the SSISExecutionParameter class. - * @constructor * SSIS execution parameter. - * - * @member {object} value SSIS package execution parameter value. Type: string - * (or Expression with resultType string). */ export interface SSISExecutionParameter { + /** + * SSIS package execution parameter value. Type: string (or Expression with resultType string). + */ value: any; } /** - * @class - * Initializes a new instance of the SSISPackageLocation class. - * @constructor * SSIS package location. - * - * @member {string} packagePath The SSIS package path. */ export interface SSISPackageLocation { + /** + * The SSIS package path. + */ packagePath: string; } /** - * @class - * Initializes a new instance of the ExecuteSSISPackageActivity class. - * @constructor * Execute SSIS package activity. - * - * @member {object} packageLocation SSIS package location. - * @member {string} [packageLocation.packagePath] The SSIS package path. - * @member {string} [runtime] Specifies the runtime to execute SSIS package. - * Possible values include: 'x64', 'x86' - * @member {string} [loggingLevel] The logging level of SSIS package execution. - * @member {string} [environmentPath] The environment path to execute the SSIS - * package. - * @member {object} connectVia The integration runtime reference. - * @member {string} [connectVia.referenceName] Reference integration runtime - * name. - * @member {object} [connectVia.parameters] Arguments for integration runtime. - * @member {object} [projectParameters] The project level parameters to execute - * the SSIS package. - * @member {object} [packageParameters] The package level parameters to execute - * the SSIS package. - * @member {object} [projectConnectionManagers] The project level connection - * managers to execute the SSIS package. - * @member {object} [packageConnectionManagers] The package level connection - * managers to execute the SSIS package. - * @member {object} [propertyOverrides] The property overrides to execute the - * SSIS package. */ export interface ExecuteSSISPackageActivity extends ExecutionActivity { + /** + * SSIS package location. + */ packageLocation: SSISPackageLocation; + /** + * Specifies the runtime to execute SSIS package. Possible values include: 'x64', 'x86' + */ runtime?: string; + /** + * The logging level of SSIS package execution. + */ loggingLevel?: string; + /** + * The environment path to execute the SSIS package. + */ environmentPath?: string; + /** + * The integration runtime reference. + */ connectVia: IntegrationRuntimeReference; + /** + * The project level parameters to execute the SSIS package. + */ projectParameters?: { [propertyName: string]: SSISExecutionParameter }; + /** + * The package level parameters to execute the SSIS package. + */ packageParameters?: { [propertyName: string]: SSISExecutionParameter }; + /** + * The project level connection managers to execute the SSIS package. + */ projectConnectionManagers?: { [propertyName: string]: { [propertyName: string]: SSISExecutionParameter } }; + /** + * The package level connection managers to execute the SSIS package. + */ packageConnectionManagers?: { [propertyName: string]: { [propertyName: string]: SSISExecutionParameter } }; + /** + * The property overrides to execute the SSIS package. + */ propertyOverrides?: { [propertyName: string]: SSISPropertyOverride }; } /** - * @class - * Initializes a new instance of the HDInsightSparkActivity class. - * @constructor * HDInsight Spark activity. - * - * @member {object} rootPath The root path in 'sparkJobLinkedService' for all - * the job’s files. Type: string (or Expression with resultType string). - * @member {object} entryFilePath The relative path to the root folder of the - * code/package to be executed. Type: string (or Expression with resultType - * string). - * @member {array} [argumentsProperty] The user-specified arguments to - * HDInsightSparkActivity. - * @member {string} [getDebugInfo] Debug info option. Possible values include: - * 'None', 'Always', 'Failure' - * @member {object} [sparkJobLinkedService] The storage linked service for - * uploading the entry file and dependencies, and for receiving logs. - * @member {string} [sparkJobLinkedService.referenceName] Reference - * LinkedService name. - * @member {object} [sparkJobLinkedService.parameters] Arguments for - * LinkedService. - * @member {string} [className] The application's Java/Spark main class. - * @member {object} [proxyUser] The user to impersonate that will execute the - * job. Type: string (or Expression with resultType string). - * @member {object} [sparkConfig] Spark configuration property. */ export interface HDInsightSparkActivity extends ExecutionActivity { + /** + * The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression + * with resultType string). + */ rootPath: any; + /** + * The relative path to the root folder of the code/package to be executed. Type: string (or + * Expression with resultType string). + */ entryFilePath: any; + /** + * The user-specified arguments to HDInsightSparkActivity. + */ argumentsProperty?: any[]; + /** + * Debug info option. Possible values include: 'None', 'Always', 'Failure' + */ getDebugInfo?: string; + /** + * The storage linked service for uploading the entry file and dependencies, and for receiving + * logs. + */ sparkJobLinkedService?: LinkedServiceReference; + /** + * The application's Java/Spark main class. + */ className?: string; + /** + * The user to impersonate that will execute the job. Type: string (or Expression with resultType + * string). + */ proxyUser?: any; + /** + * Spark configuration property. + */ sparkConfig?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the HDInsightStreamingActivity class. - * @constructor * HDInsight streaming activity type. - * - * @member {array} [storageLinkedServices] Storage linked service references. - * @member {array} [argumentsProperty] User specified arguments to - * HDInsightActivity. - * @member {string} [getDebugInfo] Debug info option. Possible values include: - * 'None', 'Always', 'Failure' - * @member {object} mapper Mapper executable name. Type: string (or Expression - * with resultType string). - * @member {object} reducer Reducer executable name. Type: string (or - * Expression with resultType string). - * @member {object} input Input blob path. Type: string (or Expression with - * resultType string). - * @member {object} output Output blob path. Type: string (or Expression with - * resultType string). - * @member {array} filePaths Paths to streaming job files. Can be directories. - * @member {object} [fileLinkedService] Linked service reference where the - * files are located. - * @member {string} [fileLinkedService.referenceName] Reference LinkedService - * name. - * @member {object} [fileLinkedService.parameters] Arguments for LinkedService. - * @member {object} [combiner] Combiner executable name. Type: string (or - * Expression with resultType string). - * @member {array} [commandEnvironment] Command line environment values. - * @member {object} [defines] Allows user to specify defines for streaming job - * request. */ export interface HDInsightStreamingActivity extends ExecutionActivity { + /** + * Storage linked service references. + */ storageLinkedServices?: LinkedServiceReference[]; + /** + * User specified arguments to HDInsightActivity. + */ argumentsProperty?: any[]; + /** + * Debug info option. Possible values include: 'None', 'Always', 'Failure' + */ getDebugInfo?: string; + /** + * Mapper executable name. Type: string (or Expression with resultType string). + */ mapper: any; + /** + * Reducer executable name. Type: string (or Expression with resultType string). + */ reducer: any; + /** + * Input blob path. Type: string (or Expression with resultType string). + */ input: any; + /** + * Output blob path. Type: string (or Expression with resultType string). + */ output: any; + /** + * Paths to streaming job files. Can be directories. + */ filePaths: any[]; + /** + * Linked service reference where the files are located. + */ fileLinkedService?: LinkedServiceReference; + /** + * Combiner executable name. Type: string (or Expression with resultType string). + */ combiner?: any; + /** + * Command line environment values. + */ commandEnvironment?: any[]; + /** + * Allows user to specify defines for streaming job request. + */ defines?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the HDInsightMapReduceActivity class. - * @constructor * HDInsight MapReduce activity type. - * - * @member {array} [storageLinkedServices] Storage linked service references. - * @member {array} [argumentsProperty] User specified arguments to - * HDInsightActivity. - * @member {string} [getDebugInfo] Debug info option. Possible values include: - * 'None', 'Always', 'Failure' - * @member {object} className Class name. Type: string (or Expression with - * resultType string). - * @member {object} jarFilePath Jar path. Type: string (or Expression with - * resultType string). - * @member {object} [jarLinkedService] Jar linked service reference. - * @member {string} [jarLinkedService.referenceName] Reference LinkedService - * name. - * @member {object} [jarLinkedService.parameters] Arguments for LinkedService. - * @member {array} [jarLibs] Jar libs. - * @member {object} [defines] Allows user to specify defines for the MapReduce - * job request. */ export interface HDInsightMapReduceActivity extends ExecutionActivity { + /** + * Storage linked service references. + */ storageLinkedServices?: LinkedServiceReference[]; + /** + * User specified arguments to HDInsightActivity. + */ argumentsProperty?: any[]; + /** + * Debug info option. Possible values include: 'None', 'Always', 'Failure' + */ getDebugInfo?: string; + /** + * Class name. Type: string (or Expression with resultType string). + */ className: any; + /** + * Jar path. Type: string (or Expression with resultType string). + */ jarFilePath: any; + /** + * Jar linked service reference. + */ jarLinkedService?: LinkedServiceReference; + /** + * Jar libs. + */ jarLibs?: any[]; + /** + * Allows user to specify defines for the MapReduce job request. + */ defines?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the HDInsightPigActivity class. - * @constructor * HDInsight Pig activity type. - * - * @member {array} [storageLinkedServices] Storage linked service references. - * @member {array} [argumentsProperty] User specified arguments to - * HDInsightActivity. - * @member {string} [getDebugInfo] Debug info option. Possible values include: - * 'None', 'Always', 'Failure' - * @member {object} [scriptPath] Script path. Type: string (or Expression with - * resultType string). - * @member {object} [scriptLinkedService] Script linked service reference. - * @member {string} [scriptLinkedService.referenceName] Reference LinkedService - * name. - * @member {object} [scriptLinkedService.parameters] Arguments for - * LinkedService. - * @member {object} [defines] Allows user to specify defines for Pig job - * request. */ export interface HDInsightPigActivity extends ExecutionActivity { + /** + * Storage linked service references. + */ storageLinkedServices?: LinkedServiceReference[]; + /** + * User specified arguments to HDInsightActivity. + */ argumentsProperty?: any[]; + /** + * Debug info option. Possible values include: 'None', 'Always', 'Failure' + */ getDebugInfo?: string; + /** + * Script path. Type: string (or Expression with resultType string). + */ scriptPath?: any; + /** + * Script linked service reference. + */ scriptLinkedService?: LinkedServiceReference; + /** + * Allows user to specify defines for Pig job request. + */ defines?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the HDInsightHiveActivity class. - * @constructor * HDInsight Hive activity type. - * - * @member {array} [storageLinkedServices] Storage linked service references. - * @member {array} [argumentsProperty] User specified arguments to - * HDInsightActivity. - * @member {string} [getDebugInfo] Debug info option. Possible values include: - * 'None', 'Always', 'Failure' - * @member {object} [scriptPath] Script path. Type: string (or Expression with - * resultType string). - * @member {object} [scriptLinkedService] Script linked service reference. - * @member {string} [scriptLinkedService.referenceName] Reference LinkedService - * name. - * @member {object} [scriptLinkedService.parameters] Arguments for - * LinkedService. - * @member {object} [defines] Allows user to specify defines for Hive job - * request. */ export interface HDInsightHiveActivity extends ExecutionActivity { + /** + * Storage linked service references. + */ storageLinkedServices?: LinkedServiceReference[]; + /** + * User specified arguments to HDInsightActivity. + */ argumentsProperty?: any[]; + /** + * Debug info option. Possible values include: 'None', 'Always', 'Failure' + */ getDebugInfo?: string; + /** + * Script path. Type: string (or Expression with resultType string). + */ scriptPath?: any; + /** + * Script linked service reference. + */ scriptLinkedService?: LinkedServiceReference; + /** + * Allows user to specify defines for Hive job request. + */ defines?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the RedirectIncompatibleRowSettings class. - * @constructor * Redirect incompatible row settings - * - * @member {object} linkedServiceName Name of the Azure Storage, Storage SAS, - * or Azure Data Lake Store linked service used for redirecting incompatible - * row. Must be specified if redirectIncompatibleRowSettings is specified. - * Type: string (or Expression with resultType string). - * @member {object} [path] The path for storing the redirect incompatible row - * data. Type: string (or Expression with resultType string). */ export interface RedirectIncompatibleRowSettings { + /** + * Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for + * redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is + * specified. Type: string (or Expression with resultType string). + */ linkedServiceName: any; + /** + * The path for storing the redirect incompatible row data. Type: string (or Expression with + * resultType string). + */ path?: any; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the StagingSettings class. - * @constructor * Staging settings. - * - * @member {object} linkedServiceName Staging linked service reference. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for LinkedService. - * @member {object} [path] The path to storage for storing the interim data. - * Type: string (or Expression with resultType string). - * @member {object} [enableCompression] Specifies whether to use compression - * when copying data via an interim staging. Default value is false. Type: - * boolean (or Expression with resultType boolean). */ export interface StagingSettings { + /** + * Staging linked service reference. + */ linkedServiceName: LinkedServiceReference; + /** + * The path to storage for storing the interim data. Type: string (or Expression with resultType + * string). + */ path?: any; + /** + * Specifies whether to use compression when copying data via an interim staging. Default value + * is false. Type: boolean (or Expression with resultType boolean). + */ enableCompression?: any; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the CopyTranslator class. - * @constructor * A copy activity translator. - * - * @member {string} type Polymorphic Discriminator */ export interface CopyTranslator { + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the TabularTranslator class. - * @constructor * A copy activity tabular translator. - * - * @member {object} [columnMappings] Column mappings. Example: "UserId: - * MyUserId, Group: MyGroup, Name: MyName" Type: string (or Expression with - * resultType string). - * @member {object} [schemaMapping] The schema mapping to map between tabular - * data and hierarchical data. Example: {"Column1": "$.Column1", "Column2": - * "$.Column2.Property1", "Column3": "$.Column2.Property2"}. Type: object (or - * Expression with resultType object). */ export interface TabularTranslator extends CopyTranslator { + /** + * Column mappings. Example: "UserId: MyUserId, Group: MyGroup, Name: MyName" Type: string (or + * Expression with resultType string). + */ columnMappings?: any; + /** + * The schema mapping to map between tabular data and hierarchical data. Example: {"Column1": + * "$.Column1", "Column2": "$.Column2.Property1", "Column3": "$.Column2.Property2"}. Type: object + * (or Expression with resultType object). + */ schemaMapping?: any; } /** - * @class - * Initializes a new instance of the CopySink class. - * @constructor * A copy activity sink. - * - * @member {object} [writeBatchSize] Write batch size. Type: integer (or - * Expression with resultType integer), minimum: 0. - * @member {object} [writeBatchTimeout] Write batch timeout. Type: string (or - * Expression with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {object} [sinkRetryCount] Sink retry count. Type: integer (or - * Expression with resultType integer). - * @member {object} [sinkRetryWait] Sink retry wait. Type: string (or - * Expression with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {string} type Polymorphic Discriminator */ export interface CopySink { + /** + * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. + */ writeBatchSize?: any; + /** + * Write batch timeout. Type: string (or Expression with resultType string), pattern: + * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). + */ writeBatchTimeout?: any; + /** + * Sink retry count. Type: integer (or Expression with resultType integer). + */ sinkRetryCount?: any; + /** + * Sink retry wait. Type: string (or Expression with resultType string), pattern: + * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). + */ sinkRetryWait?: any; + /** + * Polymorphic Discriminator + */ type: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the SalesforceSink class. - * @constructor * A copy activity Salesforce sink. - * - * @member {string} [writeBehavior] The write behavior for the operation. - * Default is Insert. Possible values include: 'Insert', 'Upsert' - * @member {object} [externalIdFieldName] The name of the external ID field for - * upsert operation. Default value is 'Id' column. Type: string (or Expression - * with resultType string). - * @member {object} [ignoreNullValues] The flag indicating whether or not to - * ignore null values from input dataset (except key fields) during write - * operation. Default value is false. If set it to true, it means ADF will - * leave the data in the destination object unchanged when doing upsert/update - * operation and insert defined default value when doing insert operation, - * versus ADF will update the data in the destination object to NULL when doing - * upsert/update operation and insert NULL value when doing insert operation. - * Type: boolean (or Expression with resultType boolean). */ export interface SalesforceSink extends CopySink { + /** + * The write behavior for the operation. Default is Insert. Possible values include: 'Insert', + * 'Upsert' + */ writeBehavior?: string; + /** + * The name of the external ID field for upsert operation. Default value is 'Id' column. Type: + * string (or Expression with resultType string). + */ externalIdFieldName?: any; + /** + * The flag indicating whether or not to ignore null values from input dataset (except key + * fields) during write operation. Default value is false. If set it to true, it means ADF will + * leave the data in the destination object unchanged when doing upsert/update operation and + * insert defined default value when doing insert operation, versus ADF will update the data in + * the destination object to NULL when doing upsert/update operation and insert NULL value when + * doing insert operation. Type: boolean (or Expression with resultType boolean). + */ ignoreNullValues?: any; } /** - * @class - * Initializes a new instance of the DynamicsSink class. - * @constructor * A copy activity Dynamics sink. - * - * @member {object} [ignoreNullValues] The flag indicating whether ignore null - * values from input dataset (except key fields) during write operation. - * Default is false. Type: boolean (or Expression with resultType boolean). */ export interface DynamicsSink extends CopySink { + /** + * The flag indicating whether ignore null values from input dataset (except key fields) during + * write operation. Default is false. Type: boolean (or Expression with resultType boolean). + */ ignoreNullValues?: any; } /** - * @class - * Initializes a new instance of the OdbcSink class. - * @constructor * A copy activity ODBC sink. - * - * @member {object} [preCopyScript] A query to execute before starting the - * copy. Type: string (or Expression with resultType string). */ export interface OdbcSink extends CopySink { + /** + * A query to execute before starting the copy. Type: string (or Expression with resultType + * string). + */ preCopyScript?: any; } /** - * @class - * Initializes a new instance of the AzureSearchIndexSink class. - * @constructor * A copy activity Azure Search Index sink. - * - * @member {string} [writeBehavior] Specify the write behavior when upserting - * documents into Azure Search Index. Possible values include: 'Merge', - * 'Upload' */ export interface AzureSearchIndexSink extends CopySink { + /** + * Specify the write behavior when upserting documents into Azure Search Index. Possible values + * include: 'Merge', 'Upload' + */ writeBehavior?: string; } /** - * @class - * Initializes a new instance of the AzureDataLakeStoreSink class. - * @constructor * A copy activity Azure Data Lake Store sink. - * - * @member {string} [copyBehavior] The type of copy behavior for copy sink. - * Possible values include: 'PreserveHierarchy', 'FlattenHierarchy', - * 'MergeFiles' */ export interface AzureDataLakeStoreSink extends CopySink { + /** + * The type of copy behavior for copy sink. Possible values include: 'PreserveHierarchy', + * 'FlattenHierarchy', 'MergeFiles' + */ copyBehavior?: string; } /** - * @class - * Initializes a new instance of the OracleSink class. - * @constructor * A copy activity Oracle sink. - * - * @member {object} [preCopyScript] SQL pre-copy script. Type: string (or - * Expression with resultType string). */ export interface OracleSink extends CopySink { + /** + * SQL pre-copy script. Type: string (or Expression with resultType string). + */ preCopyScript?: any; } /** - * @class - * Initializes a new instance of the PolybaseSettings class. - * @constructor * PolyBase settings. - * - * @member {string} [rejectType] Reject type. Possible values include: 'value', - * 'percentage' - * @member {object} [rejectValue] Specifies the value or the percentage of rows - * that can be rejected before the query fails. Type: number (or Expression - * with resultType number), minimum: 0. - * @member {object} [rejectSampleValue] Determines the number of rows to - * attempt to retrieve before the PolyBase recalculates the percentage of - * rejected rows. Type: integer (or Expression with resultType integer), - * minimum: 0. - * @member {object} [useTypeDefault] Specifies how to handle missing values in - * delimited text files when PolyBase retrieves data from the text file. Type: - * boolean (or Expression with resultType boolean). */ export interface PolybaseSettings { + /** + * Reject type. Possible values include: 'value', 'percentage' + */ rejectType?: string; + /** + * Specifies the value or the percentage of rows that can be rejected before the query fails. + * Type: number (or Expression with resultType number), minimum: 0. + */ rejectValue?: any; + /** + * Determines the number of rows to attempt to retrieve before the PolyBase recalculates the + * percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: + * 0. + */ rejectSampleValue?: any; + /** + * Specifies how to handle missing values in delimited text files when PolyBase retrieves data + * from the text file. Type: boolean (or Expression with resultType boolean). + */ useTypeDefault?: any; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the SqlDWSink class. - * @constructor * A copy activity SQL Data Warehouse sink. - * - * @member {object} [preCopyScript] SQL pre-copy script. Type: string (or - * Expression with resultType string). - * @member {object} [allowPolyBase] Indicates to use PolyBase to copy data into - * SQL Data Warehouse when applicable. Type: boolean (or Expression with - * resultType boolean). - * @member {object} [polyBaseSettings] Specifies PolyBase-related settings when - * allowPolyBase is true. - * @member {string} [polyBaseSettings.rejectType] Reject type. Possible values - * include: 'value', 'percentage' - * @member {object} [polyBaseSettings.rejectValue] Specifies the value or the - * percentage of rows that can be rejected before the query fails. Type: number - * (or Expression with resultType number), minimum: 0. - * @member {object} [polyBaseSettings.rejectSampleValue] Determines the number - * of rows to attempt to retrieve before the PolyBase recalculates the - * percentage of rejected rows. Type: integer (or Expression with resultType - * integer), minimum: 0. - * @member {object} [polyBaseSettings.useTypeDefault] Specifies how to handle - * missing values in delimited text files when PolyBase retrieves data from the - * text file. Type: boolean (or Expression with resultType boolean). */ export interface SqlDWSink extends CopySink { + /** + * SQL pre-copy script. Type: string (or Expression with resultType string). + */ preCopyScript?: any; + /** + * Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean + * (or Expression with resultType boolean). + */ allowPolyBase?: any; + /** + * Specifies PolyBase-related settings when allowPolyBase is true. + */ polyBaseSettings?: PolybaseSettings; } /** - * @class - * Initializes a new instance of the SqlSink class. - * @constructor * A copy activity SQL sink. - * - * @member {object} [sqlWriterStoredProcedureName] SQL writer stored procedure - * name. Type: string (or Expression with resultType string). - * @member {object} [sqlWriterTableType] SQL writer table type. Type: string - * (or Expression with resultType string). - * @member {object} [preCopyScript] SQL pre-copy script. Type: string (or - * Expression with resultType string). - * @member {object} [storedProcedureParameters] SQL stored procedure - * parameters. */ export interface SqlSink extends CopySink { + /** + * SQL writer stored procedure name. Type: string (or Expression with resultType string). + */ sqlWriterStoredProcedureName?: any; + /** + * SQL writer table type. Type: string (or Expression with resultType string). + */ sqlWriterTableType?: any; + /** + * SQL pre-copy script. Type: string (or Expression with resultType string). + */ preCopyScript?: any; + /** + * SQL stored procedure parameters. + */ storedProcedureParameters?: { [propertyName: string]: StoredProcedureParameter }; } /** - * @class - * Initializes a new instance of the DocumentDbCollectionSink class. - * @constructor * A copy activity Document Database Collection sink. - * - * @member {object} [nestingSeparator] Nested properties separator. Default is - * . (dot). Type: string (or Expression with resultType string). */ export interface DocumentDbCollectionSink extends CopySink { + /** + * Nested properties separator. Default is . (dot). Type: string (or Expression with resultType + * string). + */ nestingSeparator?: any; } /** - * @class - * Initializes a new instance of the FileSystemSink class. - * @constructor * A copy activity file system sink. - * - * @member {string} [copyBehavior] The type of copy behavior for copy sink. - * Possible values include: 'PreserveHierarchy', 'FlattenHierarchy', - * 'MergeFiles' */ export interface FileSystemSink extends CopySink { + /** + * The type of copy behavior for copy sink. Possible values include: 'PreserveHierarchy', + * 'FlattenHierarchy', 'MergeFiles' + */ copyBehavior?: string; } /** - * @class - * Initializes a new instance of the BlobSink class. - * @constructor * A copy activity Azure Blob sink. - * - * @member {object} [blobWriterOverwriteFiles] Blob writer overwrite files. - * Type: boolean (or Expression with resultType boolean). - * @member {object} [blobWriterDateTimeFormat] Blob writer date time format. - * Type: string (or Expression with resultType string). - * @member {object} [blobWriterAddHeader] Blob writer add header. Type: boolean - * (or Expression with resultType boolean). - * @member {string} [copyBehavior] The type of copy behavior for copy sink. - * Possible values include: 'PreserveHierarchy', 'FlattenHierarchy', - * 'MergeFiles' */ export interface BlobSink extends CopySink { + /** + * Blob writer overwrite files. Type: boolean (or Expression with resultType boolean). + */ blobWriterOverwriteFiles?: any; + /** + * Blob writer date time format. Type: string (or Expression with resultType string). + */ blobWriterDateTimeFormat?: any; + /** + * Blob writer add header. Type: boolean (or Expression with resultType boolean). + */ blobWriterAddHeader?: any; + /** + * The type of copy behavior for copy sink. Possible values include: 'PreserveHierarchy', + * 'FlattenHierarchy', 'MergeFiles' + */ copyBehavior?: string; } /** - * @class - * Initializes a new instance of the AzureTableSink class. - * @constructor * A copy activity Azure Table sink. - * - * @member {object} [azureTableDefaultPartitionKeyValue] Azure Table default - * partition key value. Type: string (or Expression with resultType string). - * @member {object} [azureTablePartitionKeyName] Azure Table partition key - * name. Type: string (or Expression with resultType string). - * @member {object} [azureTableRowKeyName] Azure Table row key name. Type: - * string (or Expression with resultType string). - * @member {object} [azureTableInsertType] Azure Table insert type. Type: - * string (or Expression with resultType string). */ export interface AzureTableSink extends CopySink { + /** + * Azure Table default partition key value. Type: string (or Expression with resultType string). + */ azureTableDefaultPartitionKeyValue?: any; + /** + * Azure Table partition key name. Type: string (or Expression with resultType string). + */ azureTablePartitionKeyName?: any; + /** + * Azure Table row key name. Type: string (or Expression with resultType string). + */ azureTableRowKeyName?: any; + /** + * Azure Table insert type. Type: string (or Expression with resultType string). + */ azureTableInsertType?: any; } /** - * @class - * Initializes a new instance of the AzureQueueSink class. - * @constructor * A copy activity Azure Queue sink. - * */ export interface AzureQueueSink extends CopySink { } /** - * @class - * Initializes a new instance of the SapCloudForCustomerSink class. - * @constructor * A copy activity SAP Cloud for Customer sink. - * - * @member {string} [writeBehavior] The write behavior for the operation. - * Default is 'Insert'. Possible values include: 'Insert', 'Update' */ export interface SapCloudForCustomerSink extends CopySink { + /** + * The write behavior for the operation. Default is 'Insert'. Possible values include: 'Insert', + * 'Update' + */ writeBehavior?: string; } /** - * @class - * Initializes a new instance of the CopyActivity class. - * @constructor * Copy activity. - * - * @member {object} source Copy activity source. - * @member {object} [source.sourceRetryCount] Source retry count. Type: integer - * (or Expression with resultType integer). - * @member {object} [source.sourceRetryWait] Source retry wait. Type: string - * (or Expression with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {string} [source.type] Polymorphic Discriminator - * @member {object} sink Copy activity sink. - * @member {object} [sink.writeBatchSize] Write batch size. Type: integer (or - * Expression with resultType integer), minimum: 0. - * @member {object} [sink.writeBatchTimeout] Write batch timeout. Type: string - * (or Expression with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {object} [sink.sinkRetryCount] Sink retry count. Type: integer (or - * Expression with resultType integer). - * @member {object} [sink.sinkRetryWait] Sink retry wait. Type: string (or - * Expression with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {string} [sink.type] Polymorphic Discriminator - * @member {object} [translator] Copy activity translator. If not specificed, - * tabular translator is used. - * @member {string} [translator.type] Polymorphic Discriminator - * @member {object} [enableStaging] Specifies whether to copy data via an - * interim staging. Default value is false. Type: boolean (or Expression with - * resultType boolean). - * @member {object} [stagingSettings] Specifies interim staging settings when - * EnableStaging is true. - * @member {object} [stagingSettings.linkedServiceName] Staging linked service - * reference. - * @member {string} [stagingSettings.linkedServiceName.referenceName] Reference - * LinkedService name. - * @member {object} [stagingSettings.linkedServiceName.parameters] Arguments - * for LinkedService. - * @member {object} [stagingSettings.path] The path to storage for storing the - * interim data. Type: string (or Expression with resultType string). - * @member {object} [stagingSettings.enableCompression] Specifies whether to - * use compression when copying data via an interim staging. Default value is - * false. Type: boolean (or Expression with resultType boolean). - * @member {object} [parallelCopies] Maximum number of concurrent sessions - * opened on the source or sink to avoid overloading the data store. Type: - * integer (or Expression with resultType integer), minimum: 0. - * @member {object} [dataIntegrationUnits] Maximum number of data integration - * units that can be used to perform this data movement. Type: integer (or - * Expression with resultType integer), minimum: 0. - * @member {object} [enableSkipIncompatibleRow] Whether to skip incompatible - * row. Default value is false. Type: boolean (or Expression with resultType - * boolean). - * @member {object} [redirectIncompatibleRowSettings] Redirect incompatible row - * settings when EnableSkipIncompatibleRow is true. - * @member {object} [redirectIncompatibleRowSettings.linkedServiceName] Name of - * the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used - * for redirecting incompatible row. Must be specified if - * redirectIncompatibleRowSettings is specified. Type: string (or Expression - * with resultType string). - * @member {object} [redirectIncompatibleRowSettings.path] The path for storing - * the redirect incompatible row data. Type: string (or Expression with - * resultType string). - * @member {array} [inputs] List of inputs for the activity. - * @member {array} [outputs] List of outputs for the activity. */ export interface CopyActivity extends ExecutionActivity { + /** + * Copy activity source. + */ source: CopySource; + /** + * Copy activity sink. + */ sink: CopySink; + /** + * Copy activity translator. If not specificed, tabular translator is used. + */ translator?: CopyTranslator; + /** + * Specifies whether to copy data via an interim staging. Default value is false. Type: boolean + * (or Expression with resultType boolean). + */ enableStaging?: any; + /** + * Specifies interim staging settings when EnableStaging is true. + */ stagingSettings?: StagingSettings; + /** + * Maximum number of concurrent sessions opened on the source or sink to avoid overloading the + * data store. Type: integer (or Expression with resultType integer), minimum: 0. + */ parallelCopies?: any; + /** + * Maximum number of data integration units that can be used to perform this data movement. Type: + * integer (or Expression with resultType integer), minimum: 0. + */ dataIntegrationUnits?: any; + /** + * Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with + * resultType boolean). + */ enableSkipIncompatibleRow?: any; + /** + * Redirect incompatible row settings when EnableSkipIncompatibleRow is true. + */ redirectIncompatibleRowSettings?: RedirectIncompatibleRowSettings; + /** + * List of inputs for the activity. + */ inputs?: DatasetReference[]; + /** + * List of outputs for the activity. + */ outputs?: DatasetReference[]; } /** - * @class - * Initializes a new instance of the ControlActivity class. - * @constructor * Base class for all control activities like IfCondition, ForEach , Until. - * */ export interface ControlActivity extends Activity { } /** - * @class - * Initializes a new instance of the AppendVariableActivity class. - * @constructor * Append value for a Variable of type Array. - * - * @member {string} [variableName] Name of the variable whose value needs to be - * appended to. - * @member {object} [value] Value to be appended. Could be a static value or - * Expression */ export interface AppendVariableActivity extends ControlActivity { + /** + * Name of the variable whose value needs to be appended to. + */ variableName?: string; + /** + * Value to be appended. Could be a static value or Expression + */ value?: any; } /** - * @class - * Initializes a new instance of the SetVariableActivity class. - * @constructor * Set value for a Variable. - * - * @member {string} [variableName] Name of the variable whose value needs to be - * set. - * @member {object} [value] Value to be set. Could be a static value or - * Expression */ export interface SetVariableActivity extends ControlActivity { + /** + * Name of the variable whose value needs to be set. + */ variableName?: string; + /** + * Value to be set. Could be a static value or Expression + */ value?: any; } /** - * @class - * Initializes a new instance of the FilterActivity class. - * @constructor * Filter and return results from input array based on the conditions. - * - * @member {object} items Input array on which filter should be applied. - * @member {string} [items.value] Expression value. - * @member {object} condition Condition to be used for filtering the input. - * @member {string} [condition.value] Expression value. */ export interface FilterActivity extends ControlActivity { + /** + * Input array on which filter should be applied. + */ items: Expression; + /** + * Condition to be used for filtering the input. + */ condition: Expression; } /** - * @class - * Initializes a new instance of the UntilActivity class. - * @constructor - * This activity executes inner activities until the specified boolean - * expression results to true or timeout is reached, whichever is earlier. - * - * @member {object} expression An expression that would evaluate to Boolean. - * The loop will continue until this expression evaluates to true - * @member {string} [expression.value] Expression value. - * @member {object} [timeout] Specifies the timeout for the activity to run. If - * there is no value specified, it takes the value of TimeSpan.FromDays(7) - * which is 1 week as default. Type: string (or Expression with resultType - * string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * Type: string (or Expression with resultType string), pattern: - * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {array} activities List of activities to execute. + * This activity executes inner activities until the specified boolean expression results to true + * or timeout is reached, whichever is earlier. */ export interface UntilActivity extends ControlActivity { + /** + * An expression that would evaluate to Boolean. The loop will continue until this expression + * evaluates to true + */ expression: Expression; + /** + * Specifies the timeout for the activity to run. If there is no value specified, it takes the + * value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with + * resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: + * string (or Expression with resultType string), pattern: + * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). + */ timeout?: any; + /** + * List of activities to execute. + */ activities: Activity[]; } /** - * @class - * Initializes a new instance of the WaitActivity class. - * @constructor * This activity suspends pipeline execution for the specified interval. - * - * @member {number} waitTimeInSeconds Duration in seconds. */ export interface WaitActivity extends ControlActivity { + /** + * Duration in seconds. + */ waitTimeInSeconds: number; } /** - * @class - * Initializes a new instance of the ForEachActivity class. - * @constructor - * This activity is used for iterating over a collection and execute given - * activities. - * - * @member {boolean} [isSequential] Should the loop be executed in sequence or - * in parallel (max 50) - * @member {number} [batchCount] Batch count to be used for controlling the - * number of parallel execution (when isSequential is set to false). - * @member {object} items Collection to iterate. - * @member {string} [items.value] Expression value. - * @member {array} activities List of activities to execute . + * This activity is used for iterating over a collection and execute given activities. */ export interface ForEachActivity extends ControlActivity { + /** + * Should the loop be executed in sequence or in parallel (max 50) + */ isSequential?: boolean; + /** + * Batch count to be used for controlling the number of parallel execution (when isSequential is + * set to false). + */ batchCount?: number; + /** + * Collection to iterate. + */ items: Expression; + /** + * List of activities to execute . + */ activities: Activity[]; } /** - * @class - * Initializes a new instance of the IfConditionActivity class. - * @constructor - * This activity evaluates a boolean expression and executes either the - * activities under the ifTrueActivities property or the ifFalseActivities - * property depending on the result of the expression. - * - * @member {object} expression An expression that would evaluate to Boolean. - * This is used to determine the block of activities (ifTrueActivities or - * ifFalseActivities) that will be executed. - * @member {string} [expression.value] Expression value. - * @member {array} [ifTrueActivities] List of activities to execute if - * expression is evaluated to true. This is an optional property and if not - * provided, the activity will exit without any action. - * @member {array} [ifFalseActivities] List of activities to execute if - * expression is evaluated to false. This is an optional property and if not - * provided, the activity will exit without any action. + * This activity evaluates a boolean expression and executes either the activities under the + * ifTrueActivities property or the ifFalseActivities property depending on the result of the + * expression. */ export interface IfConditionActivity extends ControlActivity { + /** + * An expression that would evaluate to Boolean. This is used to determine the block of + * activities (ifTrueActivities or ifFalseActivities) that will be executed. + */ expression: Expression; + /** + * List of activities to execute if expression is evaluated to true. This is an optional property + * and if not provided, the activity will exit without any action. + */ ifTrueActivities?: Activity[]; + /** + * List of activities to execute if expression is evaluated to false. This is an optional + * property and if not provided, the activity will exit without any action. + */ ifFalseActivities?: Activity[]; } /** - * @class - * Initializes a new instance of the ExecutePipelineActivity class. - * @constructor * Execute pipeline activity. - * - * @member {object} pipelineProperty Pipeline reference. - * @member {string} [pipelineProperty.referenceName] Reference pipeline name. - * @member {string} [pipelineProperty.name] Reference name. - * @member {object} [parameters] Pipeline parameters. - * @member {boolean} [waitOnCompletion] Defines whether activity execution will - * wait for the dependent pipeline execution to finish. Default is false. */ export interface ExecutePipelineActivity extends ControlActivity { + /** + * Pipeline reference. + */ pipelineProperty: PipelineReference; + /** + * Pipeline parameters. + */ parameters?: { [propertyName: string]: any }; + /** + * Defines whether activity execution will wait for the dependent pipeline execution to finish. + * Default is false. + */ waitOnCompletion?: boolean; } /** - * @class - * Initializes a new instance of the LinkedIntegrationRuntime class. - * @constructor * The linked integration runtime information. - * - * @member {string} [name] The name of the linked integration runtime. - * @member {string} [subscriptionId] The subscription ID for which the linked - * integration runtime belong to. - * @member {string} [dataFactoryName] The name of the data factory for which - * the linked integration runtime belong to. - * @member {string} [dataFactoryLocation] The location of the data factory for - * which the linked integration runtime belong to. - * @member {date} [createTime] The creating time of the linked integration - * runtime. */ export interface LinkedIntegrationRuntime { + /** + * The name of the linked integration runtime. + */ readonly name?: string; + /** + * The subscription ID for which the linked integration runtime belong to. + */ readonly subscriptionId?: string; + /** + * The name of the data factory for which the linked integration runtime belong to. + */ readonly dataFactoryName?: string; + /** + * The location of the data factory for which the linked integration runtime belong to. + */ readonly dataFactoryLocation?: string; + /** + * The creating time of the linked integration runtime. + */ readonly createTime?: Date; } /** - * @class - * Initializes a new instance of the SelfHostedIntegrationRuntimeNode class. - * @constructor * Properties of Self-hosted integration runtime node. - * - * @member {string} [nodeName] Name of the integration runtime node. - * @member {string} [machineName] Machine name of the integration runtime node. - * @member {string} [hostServiceUri] URI for the host machine of the - * integration runtime. - * @member {string} [status] Status of the integration runtime node. Possible - * values include: 'NeedRegistration', 'Online', 'Limited', 'Offline', - * 'Upgrading', 'Initializing', 'InitializeFailed' - * @member {object} [capabilities] The integration runtime capabilities - * dictionary - * @member {string} [versionStatus] Status of the integration runtime node - * version. - * @member {string} [version] Version of the integration runtime node. - * @member {date} [registerTime] The time at which the integration runtime node - * was registered in ISO8601 format. - * @member {date} [lastConnectTime] The most recent time at which the - * integration runtime was connected in ISO8601 format. - * @member {date} [expiryTime] The time at which the integration runtime will - * expire in ISO8601 format. - * @member {date} [lastStartTime] The time the node last started up. - * @member {date} [lastStopTime] The integration runtime node last stop time. - * @member {string} [lastUpdateResult] The result of the last integration - * runtime node update. Possible values include: 'None', 'Succeed', 'Fail' - * @member {date} [lastStartUpdateTime] The last time for the integration - * runtime node update start. - * @member {date} [lastEndUpdateTime] The last time for the integration runtime - * node update end. - * @member {boolean} [isActiveDispatcher] Indicates whether this node is the - * active dispatcher for integration runtime requests. - * @member {number} [concurrentJobsLimit] Maximum concurrent jobs on the - * integration runtime node. - * @member {number} [maxConcurrentJobs] The maximum concurrent jobs in this - * integration runtime. */ export interface SelfHostedIntegrationRuntimeNode { + /** + * Name of the integration runtime node. + */ readonly nodeName?: string; + /** + * Machine name of the integration runtime node. + */ readonly machineName?: string; + /** + * URI for the host machine of the integration runtime. + */ readonly hostServiceUri?: string; + /** + * Status of the integration runtime node. Possible values include: 'NeedRegistration', 'Online', + * 'Limited', 'Offline', 'Upgrading', 'Initializing', 'InitializeFailed' + */ readonly status?: string; + /** + * The integration runtime capabilities dictionary + */ readonly capabilities?: { [propertyName: string]: string }; + /** + * Status of the integration runtime node version. + */ readonly versionStatus?: string; + /** + * Version of the integration runtime node. + */ readonly version?: string; + /** + * The time at which the integration runtime node was registered in ISO8601 format. + */ readonly registerTime?: Date; + /** + * The most recent time at which the integration runtime was connected in ISO8601 format. + */ readonly lastConnectTime?: Date; + /** + * The time at which the integration runtime will expire in ISO8601 format. + */ readonly expiryTime?: Date; + /** + * The time the node last started up. + */ readonly lastStartTime?: Date; + /** + * The integration runtime node last stop time. + */ readonly lastStopTime?: Date; + /** + * The result of the last integration runtime node update. Possible values include: 'None', + * 'Succeed', 'Fail' + */ readonly lastUpdateResult?: string; + /** + * The last time for the integration runtime node update start. + */ readonly lastStartUpdateTime?: Date; + /** + * The last time for the integration runtime node update end. + */ readonly lastEndUpdateTime?: Date; + /** + * Indicates whether this node is the active dispatcher for integration runtime requests. + */ readonly isActiveDispatcher?: boolean; + /** + * Maximum concurrent jobs on the integration runtime node. + */ readonly concurrentJobsLimit?: number; + /** + * The maximum concurrent jobs in this integration runtime. + */ readonly maxConcurrentJobs?: number; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the SelfHostedIntegrationRuntimeStatus class. - * @constructor * Self-hosted integration runtime status. - * - * @member {date} [createTime] The time at which the integration runtime was - * created, in ISO8601 format. - * @member {string} [taskQueueId] The task queue id of the integration runtime. - * @member {string} [internalChannelEncryption] It is used to set the - * encryption mode for node-node communication channel (when more than 2 - * self-hosted integration runtime nodes exist). Possible values include: - * 'NotSet', 'SslEncrypted', 'NotEncrypted' - * @member {string} [version] Version of the integration runtime. - * @member {array} [nodes] The list of nodes for this integration runtime. - * @member {date} [scheduledUpdateDate] The date at which the integration - * runtime will be scheduled to update, in ISO8601 format. - * @member {string} [updateDelayOffset] The time in the date scheduled by - * service to update the integration runtime, e.g., PT03H is 3 hours - * @member {string} [localTimeZoneOffset] The local time zone offset in hours. - * @member {object} [capabilities] Object with additional information about - * integration runtime capabilities. - * @member {array} [serviceUrls] The URLs for the services used in integration - * runtime backend service. - * @member {string} [autoUpdate] Whether Self-hosted integration runtime auto - * update has been turned on. Possible values include: 'On', 'Off' - * @member {string} [versionStatus] Status of the integration runtime version. - * @member {array} [links] The list of linked integration runtimes that are - * created to share with this integration runtime. - * @member {string} [pushedVersion] The version that the integration runtime is - * going to update to. - * @member {string} [latestVersion] The latest version on download center. - * @member {date} [autoUpdateETA] The estimated time when the self-hosted - * integration runtime will be updated. */ export interface SelfHostedIntegrationRuntimeStatus extends IntegrationRuntimeStatus { + /** + * The time at which the integration runtime was created, in ISO8601 format. + */ readonly createTime?: Date; + /** + * The task queue id of the integration runtime. + */ readonly taskQueueId?: string; + /** + * It is used to set the encryption mode for node-node communication channel (when more than 2 + * self-hosted integration runtime nodes exist). Possible values include: 'NotSet', + * 'SslEncrypted', 'NotEncrypted' + */ readonly internalChannelEncryption?: string; + /** + * Version of the integration runtime. + */ readonly version?: string; + /** + * The list of nodes for this integration runtime. + */ nodes?: SelfHostedIntegrationRuntimeNode[]; + /** + * The date at which the integration runtime will be scheduled to update, in ISO8601 format. + */ readonly scheduledUpdateDate?: Date; + /** + * The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 + * hours + */ readonly updateDelayOffset?: string; + /** + * The local time zone offset in hours. + */ readonly localTimeZoneOffset?: string; + /** + * Object with additional information about integration runtime capabilities. + */ readonly capabilities?: { [propertyName: string]: string }; + /** + * The URLs for the services used in integration runtime backend service. + */ readonly serviceUrls?: string[]; + /** + * Whether Self-hosted integration runtime auto update has been turned on. Possible values + * include: 'On', 'Off' + */ readonly autoUpdate?: string; + /** + * Status of the integration runtime version. + */ readonly versionStatus?: string; + /** + * The list of linked integration runtimes that are created to share with this integration + * runtime. + */ links?: LinkedIntegrationRuntime[]; + /** + * The version that the integration runtime is going to update to. + */ readonly pushedVersion?: string; + /** + * The latest version on download center. + */ readonly latestVersion?: string; + /** + * The estimated time when the self-hosted integration runtime will be updated. + */ readonly autoUpdateETA?: Date; } /** - * @class - * Initializes a new instance of the ManagedIntegrationRuntimeOperationResult class. - * @constructor * Properties of managed integration runtime operation result. - * - * @member {string} [type] The operation type. Could be start or stop. - * @member {date} [startTime] The start time of the operation. - * @member {string} [result] The operation result. - * @member {string} [errorCode] The error code. - * @member {array} [parameters] Managed integration runtime error parameters. - * @member {string} [activityId] The activity id for the operation request. */ export interface ManagedIntegrationRuntimeOperationResult { + /** + * The operation type. Could be start or stop. + */ readonly type?: string; + /** + * The start time of the operation. + */ readonly startTime?: Date; + /** + * The operation result. + */ readonly result?: string; + /** + * The error code. + */ readonly errorCode?: string; + /** + * Managed integration runtime error parameters. + */ readonly parameters?: string[]; + /** + * The activity id for the operation request. + */ readonly activityId?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ManagedIntegrationRuntimeError class. - * @constructor * Error definition for managed integration runtime. - * - * @member {date} [time] The time when the error occurred. - * @member {string} [code] Error code. - * @member {array} [parameters] Managed integration runtime error parameters. - * @member {string} [message] Error message. */ export interface ManagedIntegrationRuntimeError { + /** + * The time when the error occurred. + */ readonly time?: Date; + /** + * Error code. + */ readonly code?: string; + /** + * Managed integration runtime error parameters. + */ readonly parameters?: string[]; + /** + * Error message. + */ readonly message?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ManagedIntegrationRuntimeNode class. - * @constructor * Properties of integration runtime node. - * - * @member {string} [nodeId] The managed integration runtime node id. - * @member {string} [status] The managed integration runtime node status. - * Possible values include: 'Starting', 'Available', 'Recycling', 'Unavailable' - * @member {array} [errors] The errors that occurred on this integration - * runtime node. */ export interface ManagedIntegrationRuntimeNode { + /** + * The managed integration runtime node id. + */ readonly nodeId?: string; + /** + * The managed integration runtime node status. Possible values include: 'Starting', 'Available', + * 'Recycling', 'Unavailable' + */ readonly status?: string; + /** + * The errors that occurred on this integration runtime node. + */ errors?: ManagedIntegrationRuntimeError[]; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ManagedIntegrationRuntimeStatus class. - * @constructor * Managed integration runtime status. - * - * @member {date} [createTime] The time at which the integration runtime was - * created, in ISO8601 format. - * @member {array} [nodes] The list of nodes for managed integration runtime. - * @member {array} [otherErrors] The errors that occurred on this integration - * runtime. - * @member {object} [lastOperation] The last operation result that occurred on - * this integration runtime. - * @member {string} [lastOperation.type] The operation type. Could be start or - * stop. - * @member {date} [lastOperation.startTime] The start time of the operation. - * @member {string} [lastOperation.result] The operation result. - * @member {string} [lastOperation.errorCode] The error code. - * @member {array} [lastOperation.parameters] Managed integration runtime error - * parameters. - * @member {string} [lastOperation.activityId] The activity id for the - * operation request. */ export interface ManagedIntegrationRuntimeStatus extends IntegrationRuntimeStatus { + /** + * The time at which the integration runtime was created, in ISO8601 format. + */ readonly createTime?: Date; + /** + * The list of nodes for managed integration runtime. + */ readonly nodes?: ManagedIntegrationRuntimeNode[]; + /** + * The errors that occurred on this integration runtime. + */ readonly otherErrors?: ManagedIntegrationRuntimeError[]; + /** + * The last operation result that occurred on this integration runtime. + */ readonly lastOperation?: ManagedIntegrationRuntimeOperationResult; } /** - * @class - * Initializes a new instance of the LinkedIntegrationRuntimeType class. - * @constructor * The base definition of a linked integration runtime. - * - * @member {string} authorizationType Polymorphic Discriminator */ export interface LinkedIntegrationRuntimeType { + /** + * Polymorphic Discriminator + */ authorizationType: string; } /** - * @class - * Initializes a new instance of the LinkedIntegrationRuntimeRbacAuthorization class. - * @constructor * The role based access control (RBAC) authorization type integration runtime. - * - * @member {string} resourceId The resource identifier of the integration - * runtime to be shared. */ export interface LinkedIntegrationRuntimeRbacAuthorization extends LinkedIntegrationRuntimeType { + /** + * The resource identifier of the integration runtime to be shared. + */ resourceId: string; } /** - * @class - * Initializes a new instance of the LinkedIntegrationRuntimeKeyAuthorization class. - * @constructor * The key authorization type integration runtime. - * - * @member {object} key The key used for authorization. - * @member {string} [key.value] Value of secure string. */ export interface LinkedIntegrationRuntimeKeyAuthorization extends LinkedIntegrationRuntimeType { + /** + * The key used for authorization. + */ key: SecureString; } /** - * @class - * Initializes a new instance of the SelfHostedIntegrationRuntime class. - * @constructor * Self-hosted integration runtime. - * - * @member {object} [linkedInfo] - * @member {string} [linkedInfo.authorizationType] Polymorphic Discriminator */ export interface SelfHostedIntegrationRuntime extends IntegrationRuntime { linkedInfo?: LinkedIntegrationRuntimeType; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeCustomSetupScriptProperties class. - * @constructor * Custom setup script properties for a managed dedicated integration runtime. - * - * @member {string} [blobContainerUri] The URI of the Azure blob container that - * contains the custom setup script. - * @member {object} [sasToken] The SAS token of the Azure blob container. - * @member {string} [sasToken.value] Value of secure string. - */ +*/ export interface IntegrationRuntimeCustomSetupScriptProperties { + /** + * The URI of the Azure blob container that contains the custom setup script. + */ blobContainerUri?: string; + /** + * The SAS token of the Azure blob container. + */ sasToken?: SecureString; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeSsisCatalogInfo class. - * @constructor * Catalog information for managed dedicated integration runtime. - * - * @member {string} [catalogServerEndpoint] The catalog database server URL. - * @member {string} [catalogAdminUserName] The administrator user name of - * catalog database. - * @member {object} [catalogAdminPassword] The password of the administrator - * user account of the catalog database. - * @member {string} [catalogAdminPassword.value] Value of secure string. - * @member {string} [catalogPricingTier] The pricing tier for the catalog - * database. The valid values could be found in - * https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible - * values include: 'Basic', 'Standard', 'Premium', 'PremiumRS' - */ +*/ export interface IntegrationRuntimeSsisCatalogInfo { + /** + * The catalog database server URL. + */ catalogServerEndpoint?: string; + /** + * The administrator user name of catalog database. + */ catalogAdminUserName?: string; + /** + * The password of the administrator user account of the catalog database. + */ catalogAdminPassword?: SecureString; + /** + * The pricing tier for the catalog database. The valid values could be found in + * https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible values include: + * 'Basic', 'Standard', 'Premium', 'PremiumRS' + */ catalogPricingTier?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeSsisProperties class. - * @constructor * SSIS properties for managed integration runtime. - * - * @member {object} [catalogInfo] Catalog information for managed dedicated - * integration runtime. - * @member {string} [catalogInfo.catalogServerEndpoint] The catalog database - * server URL. - * @member {string} [catalogInfo.catalogAdminUserName] The administrator user - * name of catalog database. - * @member {object} [catalogInfo.catalogAdminPassword] The password of the - * administrator user account of the catalog database. - * @member {string} [catalogInfo.catalogAdminPassword.value] Value of secure - * string. - * @member {string} [catalogInfo.catalogPricingTier] The pricing tier for the - * catalog database. The valid values could be found in - * https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible - * values include: 'Basic', 'Standard', 'Premium', 'PremiumRS' - * @member {string} [licenseType] License type for bringing your own license - * scenario. Possible values include: 'BasePrice', 'LicenseIncluded' - * @member {object} [customSetupScriptProperties] Custom setup script - * properties for a managed dedicated integration runtime. - * @member {string} [customSetupScriptProperties.blobContainerUri] The URI of - * the Azure blob container that contains the custom setup script. - * @member {object} [customSetupScriptProperties.sasToken] The SAS token of the - * Azure blob container. - * @member {string} [customSetupScriptProperties.sasToken.value] Value of - * secure string. - * @member {string} [edition] The edition for the SSIS Integration Runtime. - * Possible values include: 'Standard', 'Enterprise' - */ +*/ export interface IntegrationRuntimeSsisProperties { + /** + * Catalog information for managed dedicated integration runtime. + */ catalogInfo?: IntegrationRuntimeSsisCatalogInfo; + /** + * License type for bringing your own license scenario. Possible values include: 'BasePrice', + * 'LicenseIncluded' + */ licenseType?: string; + /** + * Custom setup script properties for a managed dedicated integration runtime. + */ customSetupScriptProperties?: IntegrationRuntimeCustomSetupScriptProperties; + /** + * The edition for the SSIS Integration Runtime. Possible values include: 'Standard', + * 'Enterprise' + */ edition?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeVNetProperties class. - * @constructor * VNet properties for managed integration runtime. - * - * @member {string} [vNetId] The ID of the VNet that this integration runtime - * will join. - * @member {string} [subnet] The name of the subnet this integration runtime - * will join. - */ +*/ export interface IntegrationRuntimeVNetProperties { + /** + * The ID of the VNet that this integration runtime will join. + */ vNetId?: string; + /** + * The name of the subnet this integration runtime will join. + */ subnet?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeComputeProperties class. - * @constructor * The compute resource properties for managed integration runtime. - * - * @member {string} [location] The location for managed integration runtime. - * The supported regions could be found on - * https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities - * @member {string} [nodeSize] The node size requirement to managed integration - * runtime. - * @member {number} [numberOfNodes] The required number of nodes for managed - * integration runtime. - * @member {number} [maxParallelExecutionsPerNode] Maximum parallel executions - * count per node for managed integration runtime. - * @member {object} [vNetProperties] VNet properties for managed integration - * runtime. - * @member {string} [vNetProperties.vNetId] The ID of the VNet that this - * integration runtime will join. - * @member {string} [vNetProperties.subnet] The name of the subnet this - * integration runtime will join. - */ +*/ export interface IntegrationRuntimeComputeProperties { + /** + * The location for managed integration runtime. The supported regions could be found on + * https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities + */ location?: string; + /** + * The node size requirement to managed integration runtime. + */ nodeSize?: string; + /** + * The required number of nodes for managed integration runtime. + */ numberOfNodes?: number; + /** + * Maximum parallel executions count per node for managed integration runtime. + */ maxParallelExecutionsPerNode?: number; + /** + * VNet properties for managed integration runtime. + */ vNetProperties?: IntegrationRuntimeVNetProperties; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ManagedIntegrationRuntime class. - * @constructor - * Managed integration runtime, including managed elastic and managed dedicated - * integration runtimes. - * - * @member {string} [state] Integration runtime state, only valid for managed - * dedicated integration runtime. Possible values include: 'Initial', - * 'Stopped', 'Started', 'Starting', 'Stopping', 'NeedRegistration', 'Online', - * 'Limited', 'Offline', 'AccessDenied' - * @member {object} [computeProperties] The compute resource for managed - * integration runtime. - * @member {string} [computeProperties.location] The location for managed - * integration runtime. The supported regions could be found on - * https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities - * @member {string} [computeProperties.nodeSize] The node size requirement to - * managed integration runtime. - * @member {number} [computeProperties.numberOfNodes] The required number of - * nodes for managed integration runtime. - * @member {number} [computeProperties.maxParallelExecutionsPerNode] Maximum - * parallel executions count per node for managed integration runtime. - * @member {object} [computeProperties.vNetProperties] VNet properties for - * managed integration runtime. - * @member {string} [computeProperties.vNetProperties.vNetId] The ID of the - * VNet that this integration runtime will join. - * @member {string} [computeProperties.vNetProperties.subnet] The name of the - * subnet this integration runtime will join. - * @member {object} [ssisProperties] SSIS properties for managed integration - * runtime. - * @member {object} [ssisProperties.catalogInfo] Catalog information for - * managed dedicated integration runtime. - * @member {string} [ssisProperties.catalogInfo.catalogServerEndpoint] The - * catalog database server URL. - * @member {string} [ssisProperties.catalogInfo.catalogAdminUserName] The - * administrator user name of catalog database. - * @member {object} [ssisProperties.catalogInfo.catalogAdminPassword] The - * password of the administrator user account of the catalog database. - * @member {string} [ssisProperties.catalogInfo.catalogAdminPassword.value] - * Value of secure string. - * @member {string} [ssisProperties.catalogInfo.catalogPricingTier] The pricing - * tier for the catalog database. The valid values could be found in - * https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible - * values include: 'Basic', 'Standard', 'Premium', 'PremiumRS' - * @member {string} [ssisProperties.licenseType] License type for bringing your - * own license scenario. Possible values include: 'BasePrice', - * 'LicenseIncluded' - * @member {object} [ssisProperties.customSetupScriptProperties] Custom setup - * script properties for a managed dedicated integration runtime. - * @member {string} - * [ssisProperties.customSetupScriptProperties.blobContainerUri] The URI of the - * Azure blob container that contains the custom setup script. - * @member {object} [ssisProperties.customSetupScriptProperties.sasToken] The - * SAS token of the Azure blob container. - * @member {string} [ssisProperties.customSetupScriptProperties.sasToken.value] - * Value of secure string. - * @member {string} [ssisProperties.edition] The edition for the SSIS - * Integration Runtime. Possible values include: 'Standard', 'Enterprise' - */ + * Managed integration runtime, including managed elastic and managed dedicated integration + * runtimes. +*/ export interface ManagedIntegrationRuntime extends IntegrationRuntime { + /** + * Integration runtime state, only valid for managed dedicated integration runtime. Possible + * values include: 'Initial', 'Stopped', 'Started', 'Starting', 'Stopping', 'NeedRegistration', + * 'Online', 'Limited', 'Offline', 'AccessDenied' + */ readonly state?: string; + /** + * The compute resource for managed integration runtime. + */ computeProperties?: IntegrationRuntimeComputeProperties; + /** + * SSIS properties for managed integration runtime. + */ ssisProperties?: IntegrationRuntimeSsisProperties; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeNodeIpAddress class. - * @constructor * The IP address of self-hosted integration runtime node. - * - * @member {string} [ipAddress] The IP address of self-hosted integration - * runtime node. - */ +*/ export interface IntegrationRuntimeNodeIpAddress { + /** + * The IP address of self-hosted integration runtime node. + */ readonly ipAddress?: string; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeNodeMonitoringData class. - * @constructor * Monitoring data for integration runtime node. - * - * @member {string} [nodeName] Name of the integration runtime node. - * @member {number} [availableMemoryInMB] Available memory (MB) on the - * integration runtime node. - * @member {number} [cpuUtilization] CPU percentage on the integration runtime - * node. - * @member {number} [concurrentJobsLimit] Maximum concurrent jobs on the - * integration runtime node. - * @member {number} [concurrentJobsRunning] The number of jobs currently - * running on the integration runtime node. - * @member {number} [maxConcurrentJobs] The maximum concurrent jobs in this - * integration runtime. - * @member {number} [sentBytes] Sent bytes on the integration runtime node. - * @member {number} [receivedBytes] Received bytes on the integration runtime - * node. - */ +*/ export interface IntegrationRuntimeNodeMonitoringData { + /** + * Name of the integration runtime node. + */ readonly nodeName?: string; + /** + * Available memory (MB) on the integration runtime node. + */ readonly availableMemoryInMB?: number; + /** + * CPU percentage on the integration runtime node. + */ readonly cpuUtilization?: number; + /** + * Maximum concurrent jobs on the integration runtime node. + */ readonly concurrentJobsLimit?: number; + /** + * The number of jobs currently running on the integration runtime node. + */ readonly concurrentJobsRunning?: number; + /** + * The maximum concurrent jobs in this integration runtime. + */ readonly maxConcurrentJobs?: number; + /** + * Sent bytes on the integration runtime node. + */ readonly sentBytes?: number; + /** + * Received bytes on the integration runtime node. + */ readonly receivedBytes?: number; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeMonitoringData class. - * @constructor * Get monitoring data response. - * - * @member {string} [name] Integration runtime name. - * @member {array} [nodes] Integration runtime node monitoring data. - */ +*/ export interface IntegrationRuntimeMonitoringData { + /** + * Integration runtime name. + */ name?: string; + /** + * Integration runtime node monitoring data. + */ nodes?: IntegrationRuntimeNodeMonitoringData[]; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeAuthKeys class. - * @constructor * The integration runtime authentication keys. - * - * @member {string} [authKey1] The primary integration runtime authentication - * key. - * @member {string} [authKey2] The secondary integration runtime authentication - * key. - */ +*/ export interface IntegrationRuntimeAuthKeys { + /** + * The primary integration runtime authentication key. + */ authKey1?: string; + /** + * The secondary integration runtime authentication key. + */ authKey2?: string; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeRegenerateKeyParameters class. - * @constructor * Parameters to regenerate the authentication key. - * - * @member {string} [keyName] The name of the authentication key to regenerate. - * Possible values include: 'authKey1', 'authKey2' - */ +*/ export interface IntegrationRuntimeRegenerateKeyParameters { + /** + * The name of the authentication key to regenerate. Possible values include: 'authKey1', + * 'authKey2' + */ keyName?: string; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeConnectionInfo class. - * @constructor - * Connection information for encrypting the on-premises data source - * credentials. - * - * @member {string} [serviceToken] The token generated in service. Callers use - * this token to authenticate to integration runtime. - * @member {string} [identityCertThumbprint] The integration runtime SSL - * certificate thumbprint. Click-Once application uses it to do server - * validation. - * @member {string} [hostServiceUri] The on-premises integration runtime host - * URL. - * @member {string} [version] The integration runtime version. - * @member {string} [publicKey] The public key for encrypting a credential when - * transferring the credential to the integration runtime. - * @member {boolean} [isIdentityCertExprired] Whether the identity certificate - * is expired. - */ + * Connection information for encrypting the on-premises data source credentials. +*/ export interface IntegrationRuntimeConnectionInfo { + /** + * The token generated in service. Callers use this token to authenticate to integration runtime. + */ readonly serviceToken?: string; + /** + * The integration runtime SSL certificate thumbprint. Click-Once application uses it to do + * server validation. + */ readonly identityCertThumbprint?: string; + /** + * The on-premises integration runtime host URL. + */ readonly hostServiceUri?: string; + /** + * The integration runtime version. + */ readonly version?: string; + /** + * The public key for encrypting a credential when transferring the credential to the integration + * runtime. + */ readonly publicKey?: string; + /** + * Whether the identity certificate is expired. + */ readonly isIdentityCertExprired?: boolean; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } - /** - * @class - * Initializes a new instance of the OperationListResponse class. - * @constructor * A list of operations that can be performed by the Data Factory service. - * - * @member {string} [nextLink] The link to the next page of results, if any - * remaining results exist. - */ +*/ export interface OperationListResponse extends Array { + /** + * The link to the next page of results, if any remaining results exist. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the FactoryListResponse class. - * @constructor * A list of factory resources. - * - * @member {string} [nextLink] The link to the next page of results, if any - * remaining results exist. - */ +*/ export interface FactoryListResponse extends Array { + /** + * The link to the next page of results, if any remaining results exist. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the IntegrationRuntimeListResponse class. - * @constructor * A list of integration runtime resources. - * - * @member {string} [nextLink] The link to the next page of results, if any - * remaining results exist. - */ +*/ export interface IntegrationRuntimeListResponse extends Array { + /** + * The link to the next page of results, if any remaining results exist. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the LinkedServiceListResponse class. - * @constructor * A list of linked service resources. - * - * @member {string} [nextLink] The link to the next page of results, if any - * remaining results exist. - */ +*/ export interface LinkedServiceListResponse extends Array { + /** + * The link to the next page of results, if any remaining results exist. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the DatasetListResponse class. - * @constructor * A list of dataset resources. - * - * @member {string} [nextLink] The link to the next page of results, if any - * remaining results exist. - */ +*/ export interface DatasetListResponse extends Array { + /** + * The link to the next page of results, if any remaining results exist. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the PipelineListResponse class. - * @constructor * A list of pipeline resources. - * - * @member {string} [nextLink] The link to the next page of results, if any - * remaining results exist. - */ +*/ export interface PipelineListResponse extends Array { + /** + * The link to the next page of results, if any remaining results exist. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the TriggerListResponse class. - * @constructor * A list of trigger resources. - * - * @member {string} [nextLink] The link to the next page of results, if any - * remaining results exist. - */ +*/ export interface TriggerListResponse extends Array { + /** + * The link to the next page of results, if any remaining results exist. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RerunTriggerListResponse class. - * @constructor * A list of rerun triggers. - * - * @member {string} [nextLink] The continuation token for getting the next page - * of results, if any remaining results exist, null otherwise. - */ +*/ export interface RerunTriggerListResponse extends Array { + /** + * The continuation token for getting the next page of results, if any remaining results exist, + * null otherwise. + */ readonly nextLink?: string; } diff --git a/lib/services/datafactoryManagement/lib/models/index.js b/lib/services/datafactoryManagement/lib/models/index.js index 145cd61a59..68f4533586 100644 --- a/lib/services/datafactoryManagement/lib/models/index.js +++ b/lib/services/datafactoryManagement/lib/models/index.js @@ -58,6 +58,8 @@ exports.FactoryGitHubConfiguration = require('./factoryGitHubConfiguration'); exports.FactoryRepoUpdate = require('./factoryRepoUpdate'); exports.GitHubAccessTokenRequest = require('./gitHubAccessTokenRequest'); exports.GitHubAccessTokenResponse = require('./gitHubAccessTokenResponse'); +exports.UserAccessPolicy = require('./userAccessPolicy'); +exports.AccessPolicyResponse = require('./accessPolicyResponse'); exports.PipelineReference = require('./pipelineReference'); exports.TriggerPipelineReference = require('./triggerPipelineReference'); exports.FactoryUpdateParameters = require('./factoryUpdateParameters'); diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntime.js b/lib/services/datafactoryManagement/lib/models/integrationRuntime.js index e4db5cc0f4..5934753470 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntime.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntime.js @@ -18,8 +18,8 @@ class IntegrationRuntime { /** * Create a IntegrationRuntime. - * @member {string} [description] Integration runtime description. - * @member {string} type Polymorphic Discriminator + * @property {string} [description] Integration runtime description. + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeAuthKeys.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeAuthKeys.js index f185d0c5b2..639b788f33 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeAuthKeys.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeAuthKeys.js @@ -17,9 +17,9 @@ class IntegrationRuntimeAuthKeys { /** * Create a IntegrationRuntimeAuthKeys. - * @member {string} [authKey1] The primary integration runtime authentication - * key. - * @member {string} [authKey2] The secondary integration runtime + * @property {string} [authKey1] The primary integration runtime + * authentication key. + * @property {string} [authKey2] The secondary integration runtime * authentication key. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeComputeProperties.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeComputeProperties.js index a7488bb60f..3c5be7a903 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeComputeProperties.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeComputeProperties.js @@ -17,20 +17,20 @@ class IntegrationRuntimeComputeProperties { /** * Create a IntegrationRuntimeComputeProperties. - * @member {string} [location] The location for managed integration runtime. - * The supported regions could be found on + * @property {string} [location] The location for managed integration + * runtime. The supported regions could be found on * https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities - * @member {string} [nodeSize] The node size requirement to managed + * @property {string} [nodeSize] The node size requirement to managed * integration runtime. - * @member {number} [numberOfNodes] The required number of nodes for managed - * integration runtime. - * @member {number} [maxParallelExecutionsPerNode] Maximum parallel + * @property {number} [numberOfNodes] The required number of nodes for + * managed integration runtime. + * @property {number} [maxParallelExecutionsPerNode] Maximum parallel * executions count per node for managed integration runtime. - * @member {object} [vNetProperties] VNet properties for managed integration - * runtime. - * @member {string} [vNetProperties.vNetId] The ID of the VNet that this + * @property {object} [vNetProperties] VNet properties for managed + * integration runtime. + * @property {string} [vNetProperties.vNetId] The ID of the VNet that this * integration runtime will join. - * @member {string} [vNetProperties.subnet] The name of the subnet this + * @property {string} [vNetProperties.subnet] The name of the subnet this * integration runtime will join. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeConnectionInfo.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeConnectionInfo.js index 881aafa9f5..80bb6e3808 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeConnectionInfo.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeConnectionInfo.js @@ -18,17 +18,17 @@ class IntegrationRuntimeConnectionInfo { /** * Create a IntegrationRuntimeConnectionInfo. - * @member {string} [serviceToken] The token generated in service. Callers + * @property {string} [serviceToken] The token generated in service. Callers * use this token to authenticate to integration runtime. - * @member {string} [identityCertThumbprint] The integration runtime SSL + * @property {string} [identityCertThumbprint] The integration runtime SSL * certificate thumbprint. Click-Once application uses it to do server * validation. - * @member {string} [hostServiceUri] The on-premises integration runtime host - * URL. - * @member {string} [version] The integration runtime version. - * @member {string} [publicKey] The public key for encrypting a credential + * @property {string} [hostServiceUri] The on-premises integration runtime + * host URL. + * @property {string} [version] The integration runtime version. + * @property {string} [publicKey] The public key for encrypting a credential * when transferring the credential to the integration runtime. - * @member {boolean} [isIdentityCertExprired] Whether the identity + * @property {boolean} [isIdentityCertExprired] Whether the identity * certificate is expired. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeCustomSetupScriptProperties.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeCustomSetupScriptProperties.js index 904f95a41b..69030eed4c 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeCustomSetupScriptProperties.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeCustomSetupScriptProperties.js @@ -17,10 +17,10 @@ class IntegrationRuntimeCustomSetupScriptProperties { /** * Create a IntegrationRuntimeCustomSetupScriptProperties. - * @member {string} [blobContainerUri] The URI of the Azure blob container + * @property {string} [blobContainerUri] The URI of the Azure blob container * that contains the custom setup script. - * @member {object} [sasToken] The SAS token of the Azure blob container. - * @member {string} [sasToken.value] Value of secure string. + * @property {object} [sasToken] The SAS token of the Azure blob container. + * @property {string} [sasToken.value] Value of secure string. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeListResponse.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeListResponse.js index e8943ebf41..5158c598ce 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeListResponse.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeListResponse.js @@ -16,7 +16,7 @@ class IntegrationRuntimeListResponse extends Array { /** * Create a IntegrationRuntimeListResponse. - * @member {string} [nextLink] The link to the next page of results, if any + * @property {string} [nextLink] The link to the next page of results, if any * remaining results exist. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeMonitoringData.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeMonitoringData.js index adc167e9f4..3104a88cad 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeMonitoringData.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeMonitoringData.js @@ -17,8 +17,8 @@ class IntegrationRuntimeMonitoringData { /** * Create a IntegrationRuntimeMonitoringData. - * @member {string} [name] Integration runtime name. - * @member {array} [nodes] Integration runtime node monitoring data. + * @property {string} [name] Integration runtime name. + * @property {array} [nodes] Integration runtime node monitoring data. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeNodeIpAddress.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeNodeIpAddress.js index 7e8c6be426..0abe9d8af1 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeNodeIpAddress.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeNodeIpAddress.js @@ -17,7 +17,7 @@ class IntegrationRuntimeNodeIpAddress { /** * Create a IntegrationRuntimeNodeIpAddress. - * @member {string} [ipAddress] The IP address of self-hosted integration + * @property {string} [ipAddress] The IP address of self-hosted integration * runtime node. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeNodeMonitoringData.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeNodeMonitoringData.js index 8d355cb972..63f02e190f 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeNodeMonitoringData.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeNodeMonitoringData.js @@ -17,20 +17,20 @@ class IntegrationRuntimeNodeMonitoringData { /** * Create a IntegrationRuntimeNodeMonitoringData. - * @member {string} [nodeName] Name of the integration runtime node. - * @member {number} [availableMemoryInMB] Available memory (MB) on the + * @property {string} [nodeName] Name of the integration runtime node. + * @property {number} [availableMemoryInMB] Available memory (MB) on the * integration runtime node. - * @member {number} [cpuUtilization] CPU percentage on the integration + * @property {number} [cpuUtilization] CPU percentage on the integration * runtime node. - * @member {number} [concurrentJobsLimit] Maximum concurrent jobs on the + * @property {number} [concurrentJobsLimit] Maximum concurrent jobs on the * integration runtime node. - * @member {number} [concurrentJobsRunning] The number of jobs currently + * @property {number} [concurrentJobsRunning] The number of jobs currently * running on the integration runtime node. - * @member {number} [maxConcurrentJobs] The maximum concurrent jobs in this + * @property {number} [maxConcurrentJobs] The maximum concurrent jobs in this * integration runtime. - * @member {number} [sentBytes] Sent bytes on the integration runtime node. - * @member {number} [receivedBytes] Received bytes on the integration runtime - * node. + * @property {number} [sentBytes] Sent bytes on the integration runtime node. + * @property {number} [receivedBytes] Received bytes on the integration + * runtime node. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeReference.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeReference.js index 9d126c0c8b..c177ef3784 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeReference.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeReference.js @@ -17,8 +17,8 @@ class IntegrationRuntimeReference { /** * Create a IntegrationRuntimeReference. - * @member {string} referenceName Reference integration runtime name. - * @member {object} [parameters] Arguments for integration runtime. + * @property {string} referenceName Reference integration runtime name. + * @property {object} [parameters] Arguments for integration runtime. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeRegenerateKeyParameters.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeRegenerateKeyParameters.js index 3e084bddc4..1f8e27e767 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeRegenerateKeyParameters.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeRegenerateKeyParameters.js @@ -17,7 +17,7 @@ class IntegrationRuntimeRegenerateKeyParameters { /** * Create a IntegrationRuntimeRegenerateKeyParameters. - * @member {string} [keyName] The name of the authentication key to + * @property {string} [keyName] The name of the authentication key to * regenerate. Possible values include: 'authKey1', 'authKey2' */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeResource.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeResource.js index e059e8b254..690259a096 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeResource.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeResource.js @@ -20,9 +20,10 @@ const models = require('./index'); class IntegrationRuntimeResource extends models['SubResource'] { /** * Create a IntegrationRuntimeResource. - * @member {object} properties Integration runtime properties. - * @member {string} [properties.description] Integration runtime description. - * @member {string} [properties.type] Polymorphic Discriminator + * @property {object} properties Integration runtime properties. + * @property {string} [properties.description] Integration runtime + * description. + * @property {string} [properties.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeSsisCatalogInfo.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeSsisCatalogInfo.js index 5ed2eb2dd6..ac0f87b115 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeSsisCatalogInfo.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeSsisCatalogInfo.js @@ -17,13 +17,14 @@ class IntegrationRuntimeSsisCatalogInfo { /** * Create a IntegrationRuntimeSsisCatalogInfo. - * @member {string} [catalogServerEndpoint] The catalog database server URL. - * @member {string} [catalogAdminUserName] The administrator user name of + * @property {string} [catalogServerEndpoint] The catalog database server + * URL. + * @property {string} [catalogAdminUserName] The administrator user name of * catalog database. - * @member {object} [catalogAdminPassword] The password of the administrator - * user account of the catalog database. - * @member {string} [catalogAdminPassword.value] Value of secure string. - * @member {string} [catalogPricingTier] The pricing tier for the catalog + * @property {object} [catalogAdminPassword] The password of the + * administrator user account of the catalog database. + * @property {string} [catalogAdminPassword.value] Value of secure string. + * @property {string} [catalogPricingTier] The pricing tier for the catalog * database. The valid values could be found in * https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible * values include: 'Basic', 'Standard', 'Premium', 'PremiumRS' diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeSsisProperties.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeSsisProperties.js index ea953568e6..2ed2af1b69 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeSsisProperties.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeSsisProperties.js @@ -17,31 +17,31 @@ class IntegrationRuntimeSsisProperties { /** * Create a IntegrationRuntimeSsisProperties. - * @member {object} [catalogInfo] Catalog information for managed dedicated + * @property {object} [catalogInfo] Catalog information for managed dedicated * integration runtime. - * @member {string} [catalogInfo.catalogServerEndpoint] The catalog database - * server URL. - * @member {string} [catalogInfo.catalogAdminUserName] The administrator user - * name of catalog database. - * @member {object} [catalogInfo.catalogAdminPassword] The password of the + * @property {string} [catalogInfo.catalogServerEndpoint] The catalog + * database server URL. + * @property {string} [catalogInfo.catalogAdminUserName] The administrator + * user name of catalog database. + * @property {object} [catalogInfo.catalogAdminPassword] The password of the * administrator user account of the catalog database. - * @member {string} [catalogInfo.catalogAdminPassword.value] Value of secure - * string. - * @member {string} [catalogInfo.catalogPricingTier] The pricing tier for the - * catalog database. The valid values could be found in + * @property {string} [catalogInfo.catalogAdminPassword.value] Value of + * secure string. + * @property {string} [catalogInfo.catalogPricingTier] The pricing tier for + * the catalog database. The valid values could be found in * https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible * values include: 'Basic', 'Standard', 'Premium', 'PremiumRS' - * @member {string} [licenseType] License type for bringing your own license - * scenario. Possible values include: 'BasePrice', 'LicenseIncluded' - * @member {object} [customSetupScriptProperties] Custom setup script + * @property {string} [licenseType] License type for bringing your own + * license scenario. Possible values include: 'BasePrice', 'LicenseIncluded' + * @property {object} [customSetupScriptProperties] Custom setup script * properties for a managed dedicated integration runtime. - * @member {string} [customSetupScriptProperties.blobContainerUri] The URI of - * the Azure blob container that contains the custom setup script. - * @member {object} [customSetupScriptProperties.sasToken] The SAS token of + * @property {string} [customSetupScriptProperties.blobContainerUri] The URI + * of the Azure blob container that contains the custom setup script. + * @property {object} [customSetupScriptProperties.sasToken] The SAS token of * the Azure blob container. - * @member {string} [customSetupScriptProperties.sasToken.value] Value of + * @property {string} [customSetupScriptProperties.sasToken.value] Value of * secure string. - * @member {string} [edition] The edition for the SSIS Integration Runtime. + * @property {string} [edition] The edition for the SSIS Integration Runtime. * Possible values include: 'Standard', 'Enterprise' */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatus.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatus.js index 4a86511a30..3804cceaae 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatus.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatus.js @@ -17,12 +17,12 @@ class IntegrationRuntimeStatus { /** * Create a IntegrationRuntimeStatus. - * @member {string} [dataFactoryName] The data factory name which the + * @property {string} [dataFactoryName] The data factory name which the * integration runtime belong to. - * @member {string} [state] The state of integration runtime. Possible values - * include: 'Initial', 'Stopped', 'Started', 'Starting', 'Stopping', + * @property {string} [state] The state of integration runtime. Possible + * values include: 'Initial', 'Stopped', 'Started', 'Starting', 'Stopping', * 'NeedRegistration', 'Online', 'Limited', 'Offline', 'AccessDenied' - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatusListResponse.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatusListResponse.js index 4f34ccbdac..a115ef099f 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatusListResponse.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatusListResponse.js @@ -17,8 +17,8 @@ class IntegrationRuntimeStatusListResponse { /** * Create a IntegrationRuntimeStatusListResponse. - * @member {array} value List of integration runtime status. - * @member {string} [nextLink] The link to the next page of results, if any + * @property {array} value List of integration runtime status. + * @property {string} [nextLink] The link to the next page of results, if any * remaining results exist. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatusResponse.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatusResponse.js index 44584c0246..4d2f816b3e 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatusResponse.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeStatusResponse.js @@ -17,15 +17,15 @@ class IntegrationRuntimeStatusResponse { /** * Create a IntegrationRuntimeStatusResponse. - * @member {string} [name] The integration runtime name. - * @member {object} properties Integration runtime properties. - * @member {string} [properties.dataFactoryName] The data factory name which - * the integration runtime belong to. - * @member {string} [properties.state] The state of integration runtime. + * @property {string} [name] The integration runtime name. + * @property {object} properties Integration runtime properties. + * @property {string} [properties.dataFactoryName] The data factory name + * which the integration runtime belong to. + * @property {string} [properties.state] The state of integration runtime. * Possible values include: 'Initial', 'Stopped', 'Started', 'Starting', * 'Stopping', 'NeedRegistration', 'Online', 'Limited', 'Offline', * 'AccessDenied' - * @member {string} [properties.type] Polymorphic Discriminator + * @property {string} [properties.type] Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/integrationRuntimeVNetProperties.js b/lib/services/datafactoryManagement/lib/models/integrationRuntimeVNetProperties.js index 9993d07e9b..fad6f97c5e 100644 --- a/lib/services/datafactoryManagement/lib/models/integrationRuntimeVNetProperties.js +++ b/lib/services/datafactoryManagement/lib/models/integrationRuntimeVNetProperties.js @@ -17,10 +17,10 @@ class IntegrationRuntimeVNetProperties { /** * Create a IntegrationRuntimeVNetProperties. - * @member {string} [vNetId] The ID of the VNet that this integration runtime - * will join. - * @member {string} [subnet] The name of the subnet this integration runtime - * will join. + * @property {string} [vNetId] The ID of the VNet that this integration + * runtime will join. + * @property {string} [subnet] The name of the subnet this integration + * runtime will join. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/jiraLinkedService.js b/lib/services/datafactoryManagement/lib/models/jiraLinkedService.js index ca7e177f8a..e76499c72f 100644 --- a/lib/services/datafactoryManagement/lib/models/jiraLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/jiraLinkedService.js @@ -13,32 +13,32 @@ const models = require('./index'); /** - * Jira Serivce linked service. + * Jira Service linked service. * * @extends models['LinkedService'] */ class JiraLinkedService extends models['LinkedService'] { /** * Create a JiraLinkedService. - * @member {object} host The IP address or host name of the Jira service. + * @property {object} host The IP address or host name of the Jira service. * (e.g. jira.example.com) - * @member {object} [port] The TCP port that the Jira server uses to listen + * @property {object} [port] The TCP port that the Jira server uses to listen * for client connections. The default value is 443 if connecting through * HTTPS, or 8080 if connecting through HTTP. - * @member {object} username The user name that you use to access Jira + * @property {object} username The user name that you use to access Jira * Service. - * @member {object} [password] The password corresponding to the user name + * @property {object} [password] The password corresponding to the user name * that you provided in the username field. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/jiraObjectDataset.js b/lib/services/datafactoryManagement/lib/models/jiraObjectDataset.js index 2432a298b8..40c46e9f3e 100644 --- a/lib/services/datafactoryManagement/lib/models/jiraObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/jiraObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class JiraObjectDataset extends models['Dataset'] { /** * Create a JiraObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/jiraSource.js b/lib/services/datafactoryManagement/lib/models/jiraSource.js index 6d1c0b79bc..5f8cfae9fd 100644 --- a/lib/services/datafactoryManagement/lib/models/jiraSource.js +++ b/lib/services/datafactoryManagement/lib/models/jiraSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class JiraSource extends models['CopySource'] { /** * Create a JiraSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/jsonFormat.js b/lib/services/datafactoryManagement/lib/models/jsonFormat.js index 2ddc8f8bc9..84ef3a345d 100644 --- a/lib/services/datafactoryManagement/lib/models/jsonFormat.js +++ b/lib/services/datafactoryManagement/lib/models/jsonFormat.js @@ -20,24 +20,24 @@ const models = require('./index'); class JsonFormat extends models['DatasetStorageFormat'] { /** * Create a JsonFormat. - * @member {string} [filePattern] File pattern of JSON. To be more specific, - * the way of separating a collection of JSON objects. The default value is - * 'setOfObjects'. It is case-sensitive. Possible values include: + * @property {string} [filePattern] File pattern of JSON. To be more + * specific, the way of separating a collection of JSON objects. The default + * value is 'setOfObjects'. It is case-sensitive. Possible values include: * 'setOfObjects', 'arrayOfObjects' - * @member {object} [nestingSeparator] The character used to separate nesting - * levels. Default value is '.' (dot). Type: string (or Expression with - * resultType string). - * @member {object} [encodingName] The code page name of the preferred + * @property {object} [nestingSeparator] The character used to separate + * nesting levels. Default value is '.' (dot). Type: string (or Expression + * with resultType string). + * @property {object} [encodingName] The code page name of the preferred * encoding. If not provided, the default value is 'utf-8', unless the byte * order mark (BOM) denotes another Unicode encoding. The full list of * supported values can be found in the 'Name' column of the table of * encodings in the following reference: * https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or * Expression with resultType string). - * @member {object} [jsonNodeReference] The JSONPath of the JSON array + * @property {object} [jsonNodeReference] The JSONPath of the JSON array * element to be flattened. Example: "$.ArrayPath". Type: string (or * Expression with resultType string). - * @member {object} [jsonPathDefinition] The JSONPath definition for each + * @property {object} [jsonPathDefinition] The JSONPath definition for each * column mapping with a customized column name to extract data from JSON * file. For fields under root object, start with "$"; for fields inside the * array chosen by jsonNodeReference property, start from the array element. diff --git a/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntime.js b/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntime.js index dd674fb676..de2d4a0af7 100644 --- a/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntime.js +++ b/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntime.js @@ -17,14 +17,14 @@ class LinkedIntegrationRuntime { /** * Create a LinkedIntegrationRuntime. - * @member {string} [name] The name of the linked integration runtime. - * @member {string} [subscriptionId] The subscription ID for which the linked - * integration runtime belong to. - * @member {string} [dataFactoryName] The name of the data factory for which - * the linked integration runtime belong to. - * @member {string} [dataFactoryLocation] The location of the data factory + * @property {string} [name] The name of the linked integration runtime. + * @property {string} [subscriptionId] The subscription ID for which the + * linked integration runtime belong to. + * @property {string} [dataFactoryName] The name of the data factory for + * which the linked integration runtime belong to. + * @property {string} [dataFactoryLocation] The location of the data factory * for which the linked integration runtime belong to. - * @member {date} [createTime] The creating time of the linked integration + * @property {date} [createTime] The creating time of the linked integration * runtime. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeKeyAuthorization.js b/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeKeyAuthorization.js index 362bdd9254..a0831af51d 100644 --- a/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeKeyAuthorization.js +++ b/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeKeyAuthorization.js @@ -20,8 +20,8 @@ const models = require('./index'); class LinkedIntegrationRuntimeKeyAuthorization extends models['LinkedIntegrationRuntimeType'] { /** * Create a LinkedIntegrationRuntimeKeyAuthorization. - * @member {object} key The key used for authorization. - * @member {string} [key.value] Value of secure string. + * @property {object} key The key used for authorization. + * @property {string} [key.value] Value of secure string. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeRbacAuthorization.js b/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeRbacAuthorization.js index 90fba529f6..775be18669 100644 --- a/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeRbacAuthorization.js +++ b/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeRbacAuthorization.js @@ -20,7 +20,7 @@ const models = require('./index'); class LinkedIntegrationRuntimeRbacAuthorization extends models['LinkedIntegrationRuntimeType'] { /** * Create a LinkedIntegrationRuntimeRbacAuthorization. - * @member {string} resourceId The resource identifier of the integration + * @property {string} resourceId The resource identifier of the integration * runtime to be shared. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeRequest.js b/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeRequest.js index fbb127a49e..c3bf56d6f3 100644 --- a/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeRequest.js +++ b/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeRequest.js @@ -17,7 +17,7 @@ class LinkedIntegrationRuntimeRequest { /** * Create a LinkedIntegrationRuntimeRequest. - * @member {string} linkedFactoryName The data factory name for linked + * @property {string} linkedFactoryName The data factory name for linked * integration runtime. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeType.js b/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeType.js index d17395999d..cde6927e4f 100644 --- a/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeType.js +++ b/lib/services/datafactoryManagement/lib/models/linkedIntegrationRuntimeType.js @@ -17,7 +17,7 @@ class LinkedIntegrationRuntimeType { /** * Create a LinkedIntegrationRuntimeType. - * @member {string} authorizationType Polymorphic Discriminator + * @property {string} authorizationType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/linkedService.js b/lib/services/datafactoryManagement/lib/models/linkedService.js index 3d831cc9de..58de63c34d 100644 --- a/lib/services/datafactoryManagement/lib/models/linkedService.js +++ b/lib/services/datafactoryManagement/lib/models/linkedService.js @@ -19,16 +19,16 @@ class LinkedService { /** * Create a LinkedService. - * @member {object} [connectVia] The integration runtime reference. - * @member {string} [connectVia.referenceName] Reference integration runtime - * name. - * @member {object} [connectVia.parameters] Arguments for integration + * @property {object} [connectVia] The integration runtime reference. + * @property {string} [connectVia.referenceName] Reference integration + * runtime name. + * @property {object} [connectVia.parameters] Arguments for integration * runtime. - * @member {string} [description] Linked service description. - * @member {object} [parameters] Parameters for linked service. - * @member {array} [annotations] List of tags that can be used for describing - * the Dataset. - * @member {string} type Polymorphic Discriminator + * @property {string} [description] Linked service description. + * @property {object} [parameters] Parameters for linked service. + * @property {array} [annotations] List of tags that can be used for + * describing the Dataset. + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/linkedServiceListResponse.js b/lib/services/datafactoryManagement/lib/models/linkedServiceListResponse.js index 2dcfd07f0c..26ae460e02 100644 --- a/lib/services/datafactoryManagement/lib/models/linkedServiceListResponse.js +++ b/lib/services/datafactoryManagement/lib/models/linkedServiceListResponse.js @@ -16,7 +16,7 @@ class LinkedServiceListResponse extends Array { /** * Create a LinkedServiceListResponse. - * @member {string} [nextLink] The link to the next page of results, if any + * @property {string} [nextLink] The link to the next page of results, if any * remaining results exist. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/linkedServiceReference.js b/lib/services/datafactoryManagement/lib/models/linkedServiceReference.js index 3bd3baacb6..8b1d005cdc 100644 --- a/lib/services/datafactoryManagement/lib/models/linkedServiceReference.js +++ b/lib/services/datafactoryManagement/lib/models/linkedServiceReference.js @@ -17,8 +17,8 @@ class LinkedServiceReference { /** * Create a LinkedServiceReference. - * @member {string} referenceName Reference LinkedService name. - * @member {object} [parameters] Arguments for LinkedService. + * @property {string} referenceName Reference LinkedService name. + * @property {object} [parameters] Arguments for LinkedService. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/linkedServiceResource.js b/lib/services/datafactoryManagement/lib/models/linkedServiceResource.js index 0d767d32f3..395ba4ad88 100644 --- a/lib/services/datafactoryManagement/lib/models/linkedServiceResource.js +++ b/lib/services/datafactoryManagement/lib/models/linkedServiceResource.js @@ -20,18 +20,18 @@ const models = require('./index'); class LinkedServiceResource extends models['SubResource'] { /** * Create a LinkedServiceResource. - * @member {object} properties Properties of linked service. - * @member {object} [properties.connectVia] The integration runtime + * @property {object} properties Properties of linked service. + * @property {object} [properties.connectVia] The integration runtime * reference. - * @member {string} [properties.connectVia.referenceName] Reference + * @property {string} [properties.connectVia.referenceName] Reference * integration runtime name. - * @member {object} [properties.connectVia.parameters] Arguments for + * @property {object} [properties.connectVia.parameters] Arguments for * integration runtime. - * @member {string} [properties.description] Linked service description. - * @member {object} [properties.parameters] Parameters for linked service. - * @member {array} [properties.annotations] List of tags that can be used for - * describing the Dataset. - * @member {string} [properties.type] Polymorphic Discriminator + * @property {string} [properties.description] Linked service description. + * @property {object} [properties.parameters] Parameters for linked service. + * @property {array} [properties.annotations] List of tags that can be used + * for describing the Dataset. + * @property {string} [properties.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/lookupActivity.js b/lib/services/datafactoryManagement/lib/models/lookupActivity.js index 871e245727..c95897926b 100644 --- a/lib/services/datafactoryManagement/lib/models/lookupActivity.js +++ b/lib/services/datafactoryManagement/lib/models/lookupActivity.js @@ -20,18 +20,18 @@ const models = require('./index'); class LookupActivity extends models['ExecutionActivity'] { /** * Create a LookupActivity. - * @member {object} source Dataset-specific source properties, same as copy + * @property {object} source Dataset-specific source properties, same as copy * activity source. - * @member {object} [source.sourceRetryCount] Source retry count. Type: + * @property {object} [source.sourceRetryCount] Source retry count. Type: * integer (or Expression with resultType integer). - * @member {object} [source.sourceRetryWait] Source retry wait. Type: string - * (or Expression with resultType string), pattern: + * @property {object} [source.sourceRetryWait] Source retry wait. Type: + * string (or Expression with resultType string), pattern: * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {string} [source.type] Polymorphic Discriminator - * @member {object} dataset Lookup activity dataset reference. - * @member {string} [dataset.referenceName] Reference dataset name. - * @member {object} [dataset.parameters] Arguments for dataset. - * @member {object} [firstRowOnly] Whether to return first row or all rows. + * @property {string} [source.type] Polymorphic Discriminator + * @property {object} dataset Lookup activity dataset reference. + * @property {string} [dataset.referenceName] Reference dataset name. + * @property {object} [dataset.parameters] Arguments for dataset. + * @property {object} [firstRowOnly] Whether to return first row or all rows. * Default value is true. Type: boolean (or Expression with resultType * boolean). */ diff --git a/lib/services/datafactoryManagement/lib/models/magentoLinkedService.js b/lib/services/datafactoryManagement/lib/models/magentoLinkedService.js index f3f1f45037..cb7bd58a0a 100644 --- a/lib/services/datafactoryManagement/lib/models/magentoLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/magentoLinkedService.js @@ -20,19 +20,19 @@ const models = require('./index'); class MagentoLinkedService extends models['LinkedService'] { /** * Create a MagentoLinkedService. - * @member {object} host The URL of the Magento instance. (i.e. + * @property {object} host The URL of the Magento instance. (i.e. * 192.168.222.110/magento3) - * @member {object} [accessToken] The access token from Magento. - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {object} [accessToken] The access token from Magento. + * @property {string} [accessToken.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/magentoObjectDataset.js b/lib/services/datafactoryManagement/lib/models/magentoObjectDataset.js index 9e42144adc..3d915682a4 100644 --- a/lib/services/datafactoryManagement/lib/models/magentoObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/magentoObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class MagentoObjectDataset extends models['Dataset'] { /** * Create a MagentoObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/magentoSource.js b/lib/services/datafactoryManagement/lib/models/magentoSource.js index 9a68a18f02..c6a14128cf 100644 --- a/lib/services/datafactoryManagement/lib/models/magentoSource.js +++ b/lib/services/datafactoryManagement/lib/models/magentoSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class MagentoSource extends models['CopySource'] { /** * Create a MagentoSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntime.js b/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntime.js index ab054421a2..dbab2b799e 100644 --- a/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntime.js +++ b/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntime.js @@ -21,57 +21,58 @@ const models = require('./index'); class ManagedIntegrationRuntime extends models['IntegrationRuntime'] { /** * Create a ManagedIntegrationRuntime. - * @member {string} [state] Integration runtime state, only valid for managed - * dedicated integration runtime. Possible values include: 'Initial', + * @property {string} [state] Integration runtime state, only valid for + * managed dedicated integration runtime. Possible values include: 'Initial', * 'Stopped', 'Started', 'Starting', 'Stopping', 'NeedRegistration', * 'Online', 'Limited', 'Offline', 'AccessDenied' - * @member {object} [computeProperties] The compute resource for managed + * @property {object} [computeProperties] The compute resource for managed * integration runtime. - * @member {string} [computeProperties.location] The location for managed + * @property {string} [computeProperties.location] The location for managed * integration runtime. The supported regions could be found on * https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities - * @member {string} [computeProperties.nodeSize] The node size requirement to - * managed integration runtime. - * @member {number} [computeProperties.numberOfNodes] The required number of - * nodes for managed integration runtime. - * @member {number} [computeProperties.maxParallelExecutionsPerNode] Maximum - * parallel executions count per node for managed integration runtime. - * @member {object} [computeProperties.vNetProperties] VNet properties for + * @property {string} [computeProperties.nodeSize] The node size requirement + * to managed integration runtime. + * @property {number} [computeProperties.numberOfNodes] The required number + * of nodes for managed integration runtime. + * @property {number} [computeProperties.maxParallelExecutionsPerNode] + * Maximum parallel executions count per node for managed integration + * runtime. + * @property {object} [computeProperties.vNetProperties] VNet properties for * managed integration runtime. - * @member {string} [computeProperties.vNetProperties.vNetId] The ID of the + * @property {string} [computeProperties.vNetProperties.vNetId] The ID of the * VNet that this integration runtime will join. - * @member {string} [computeProperties.vNetProperties.subnet] The name of the - * subnet this integration runtime will join. - * @member {object} [ssisProperties] SSIS properties for managed integration - * runtime. - * @member {object} [ssisProperties.catalogInfo] Catalog information for + * @property {string} [computeProperties.vNetProperties.subnet] The name of + * the subnet this integration runtime will join. + * @property {object} [ssisProperties] SSIS properties for managed + * integration runtime. + * @property {object} [ssisProperties.catalogInfo] Catalog information for * managed dedicated integration runtime. - * @member {string} [ssisProperties.catalogInfo.catalogServerEndpoint] The + * @property {string} [ssisProperties.catalogInfo.catalogServerEndpoint] The * catalog database server URL. - * @member {string} [ssisProperties.catalogInfo.catalogAdminUserName] The + * @property {string} [ssisProperties.catalogInfo.catalogAdminUserName] The * administrator user name of catalog database. - * @member {object} [ssisProperties.catalogInfo.catalogAdminPassword] The + * @property {object} [ssisProperties.catalogInfo.catalogAdminPassword] The * password of the administrator user account of the catalog database. - * @member {string} [ssisProperties.catalogInfo.catalogAdminPassword.value] + * @property {string} [ssisProperties.catalogInfo.catalogAdminPassword.value] * Value of secure string. - * @member {string} [ssisProperties.catalogInfo.catalogPricingTier] The + * @property {string} [ssisProperties.catalogInfo.catalogPricingTier] The * pricing tier for the catalog database. The valid values could be found in * https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible * values include: 'Basic', 'Standard', 'Premium', 'PremiumRS' - * @member {string} [ssisProperties.licenseType] License type for bringing + * @property {string} [ssisProperties.licenseType] License type for bringing * your own license scenario. Possible values include: 'BasePrice', * 'LicenseIncluded' - * @member {object} [ssisProperties.customSetupScriptProperties] Custom setup - * script properties for a managed dedicated integration runtime. - * @member {string} + * @property {object} [ssisProperties.customSetupScriptProperties] Custom + * setup script properties for a managed dedicated integration runtime. + * @property {string} * [ssisProperties.customSetupScriptProperties.blobContainerUri] The URI of * the Azure blob container that contains the custom setup script. - * @member {object} [ssisProperties.customSetupScriptProperties.sasToken] The - * SAS token of the Azure blob container. - * @member {string} + * @property {object} [ssisProperties.customSetupScriptProperties.sasToken] + * The SAS token of the Azure blob container. + * @property {string} * [ssisProperties.customSetupScriptProperties.sasToken.value] Value of * secure string. - * @member {string} [ssisProperties.edition] The edition for the SSIS + * @property {string} [ssisProperties.edition] The edition for the SSIS * Integration Runtime. Possible values include: 'Standard', 'Enterprise' */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeError.js b/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeError.js index a3e54fc310..c4826ebf8d 100644 --- a/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeError.js +++ b/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeError.js @@ -17,10 +17,11 @@ class ManagedIntegrationRuntimeError { /** * Create a ManagedIntegrationRuntimeError. - * @member {date} [time] The time when the error occurred. - * @member {string} [code] Error code. - * @member {array} [parameters] Managed integration runtime error parameters. - * @member {string} [message] Error message. + * @property {date} [time] The time when the error occurred. + * @property {string} [code] Error code. + * @property {array} [parameters] Managed integration runtime error + * parameters. + * @property {string} [message] Error message. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeNode.js b/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeNode.js index fe419bacb0..012cf2b292 100644 --- a/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeNode.js +++ b/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeNode.js @@ -17,11 +17,11 @@ class ManagedIntegrationRuntimeNode { /** * Create a ManagedIntegrationRuntimeNode. - * @member {string} [nodeId] The managed integration runtime node id. - * @member {string} [status] The managed integration runtime node status. + * @property {string} [nodeId] The managed integration runtime node id. + * @property {string} [status] The managed integration runtime node status. * Possible values include: 'Starting', 'Available', 'Recycling', * 'Unavailable' - * @member {array} [errors] The errors that occurred on this integration + * @property {array} [errors] The errors that occurred on this integration * runtime node. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeOperationResult.js b/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeOperationResult.js index f970d1a9db..639c0597ce 100644 --- a/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeOperationResult.js +++ b/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeOperationResult.js @@ -17,12 +17,13 @@ class ManagedIntegrationRuntimeOperationResult { /** * Create a ManagedIntegrationRuntimeOperationResult. - * @member {string} [type] The operation type. Could be start or stop. - * @member {date} [startTime] The start time of the operation. - * @member {string} [result] The operation result. - * @member {string} [errorCode] The error code. - * @member {array} [parameters] Managed integration runtime error parameters. - * @member {string} [activityId] The activity id for the operation request. + * @property {string} [type] The operation type. Could be start or stop. + * @property {date} [startTime] The start time of the operation. + * @property {string} [result] The operation result. + * @property {string} [errorCode] The error code. + * @property {array} [parameters] Managed integration runtime error + * parameters. + * @property {string} [activityId] The activity id for the operation request. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeStatus.js b/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeStatus.js index 19f3aa9717..58614ae11a 100644 --- a/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeStatus.js +++ b/lib/services/datafactoryManagement/lib/models/managedIntegrationRuntimeStatus.js @@ -20,21 +20,23 @@ const models = require('./index'); class ManagedIntegrationRuntimeStatus extends models['IntegrationRuntimeStatus'] { /** * Create a ManagedIntegrationRuntimeStatus. - * @member {date} [createTime] The time at which the integration runtime was - * created, in ISO8601 format. - * @member {array} [nodes] The list of nodes for managed integration runtime. - * @member {array} [otherErrors] The errors that occurred on this integration + * @property {date} [createTime] The time at which the integration runtime + * was created, in ISO8601 format. + * @property {array} [nodes] The list of nodes for managed integration * runtime. - * @member {object} [lastOperation] The last operation result that occurred + * @property {array} [otherErrors] The errors that occurred on this + * integration runtime. + * @property {object} [lastOperation] The last operation result that occurred * on this integration runtime. - * @member {string} [lastOperation.type] The operation type. Could be start + * @property {string} [lastOperation.type] The operation type. Could be start * or stop. - * @member {date} [lastOperation.startTime] The start time of the operation. - * @member {string} [lastOperation.result] The operation result. - * @member {string} [lastOperation.errorCode] The error code. - * @member {array} [lastOperation.parameters] Managed integration runtime + * @property {date} [lastOperation.startTime] The start time of the + * operation. + * @property {string} [lastOperation.result] The operation result. + * @property {string} [lastOperation.errorCode] The error code. + * @property {array} [lastOperation.parameters] Managed integration runtime * error parameters. - * @member {string} [lastOperation.activityId] The activity id for the + * @property {string} [lastOperation.activityId] The activity id for the * operation request. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/mariaDBLinkedService.js b/lib/services/datafactoryManagement/lib/models/mariaDBLinkedService.js index 3e4ab0af68..57b0269f91 100644 --- a/lib/services/datafactoryManagement/lib/models/mariaDBLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/mariaDBLinkedService.js @@ -20,19 +20,20 @@ const models = require('./index'); class MariaDBLinkedService extends models['LinkedService'] { /** * Create a MariaDBLinkedService. - * @member {object} [connectionString] An ODBC connection string. Type: + * @property {object} [connectionString] An ODBC connection string. Type: * string, SecureString or AzureKeyVaultSecretReference. - * @member {object} [pwd] The Azure key vault secret reference of password in - * connection string. - * @member {object} [pwd.store] The Azure Key Vault linked service reference. - * @member {string} [pwd.store.referenceName] Reference LinkedService name. - * @member {object} [pwd.store.parameters] Arguments for LinkedService. - * @member {object} [pwd.secretName] The name of the secret in Azure Key + * @property {object} [pwd] The Azure key vault secret reference of password + * in connection string. + * @property {object} [pwd.store] The Azure Key Vault linked service + * reference. + * @property {string} [pwd.store.referenceName] Reference LinkedService name. + * @property {object} [pwd.store.parameters] Arguments for LinkedService. + * @property {object} [pwd.secretName] The name of the secret in Azure Key * Vault. Type: string (or Expression with resultType string). - * @member {object} [pwd.secretVersion] The version of the secret in Azure + * @property {object} [pwd.secretVersion] The version of the secret in Azure * Key Vault. The default value is the latest version of the secret. Type: * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/mariaDBSource.js b/lib/services/datafactoryManagement/lib/models/mariaDBSource.js index 4b330ab8fe..c091e7d1ac 100644 --- a/lib/services/datafactoryManagement/lib/models/mariaDBSource.js +++ b/lib/services/datafactoryManagement/lib/models/mariaDBSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class MariaDBSource extends models['CopySource'] { /** * Create a MariaDBSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/mariaDBTableDataset.js b/lib/services/datafactoryManagement/lib/models/mariaDBTableDataset.js index 873432f31a..27b8b79538 100644 --- a/lib/services/datafactoryManagement/lib/models/mariaDBTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/mariaDBTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class MariaDBTableDataset extends models['Dataset'] { /** * Create a MariaDBTableDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/marketoLinkedService.js b/lib/services/datafactoryManagement/lib/models/marketoLinkedService.js index ed39818371..f84319b784 100644 --- a/lib/services/datafactoryManagement/lib/models/marketoLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/marketoLinkedService.js @@ -20,20 +20,21 @@ const models = require('./index'); class MarketoLinkedService extends models['LinkedService'] { /** * Create a MarketoLinkedService. - * @member {object} endpoint The endpoint of the Marketo server. (i.e. + * @property {object} endpoint The endpoint of the Marketo server. (i.e. * 123-ABC-321.mktorest.com) - * @member {object} clientId The client Id of your Marketo service. - * @member {object} [clientSecret] The client secret of your Marketo service. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {object} clientId The client Id of your Marketo service. + * @property {object} [clientSecret] The client secret of your Marketo + * service. + * @property {string} [clientSecret.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/marketoObjectDataset.js b/lib/services/datafactoryManagement/lib/models/marketoObjectDataset.js index 1d8d337a9e..2573d5976a 100644 --- a/lib/services/datafactoryManagement/lib/models/marketoObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/marketoObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class MarketoObjectDataset extends models['Dataset'] { /** * Create a MarketoObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/marketoSource.js b/lib/services/datafactoryManagement/lib/models/marketoSource.js index d0b0a0648c..1718b4df0e 100644 --- a/lib/services/datafactoryManagement/lib/models/marketoSource.js +++ b/lib/services/datafactoryManagement/lib/models/marketoSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class MarketoSource extends models['CopySource'] { /** * Create a MarketoSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/mongoDbCollectionDataset.js b/lib/services/datafactoryManagement/lib/models/mongoDbCollectionDataset.js index cb0c17418f..5deca5d3e7 100644 --- a/lib/services/datafactoryManagement/lib/models/mongoDbCollectionDataset.js +++ b/lib/services/datafactoryManagement/lib/models/mongoDbCollectionDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class MongoDbCollectionDataset extends models['Dataset'] { /** * Create a MongoDbCollectionDataset. - * @member {object} collectionName The table name of the MongoDB database. + * @property {object} collectionName The table name of the MongoDB database. * Type: string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/mongoDbLinkedService.js b/lib/services/datafactoryManagement/lib/models/mongoDbLinkedService.js index 5da4ea0198..0a6a1b4204 100644 --- a/lib/services/datafactoryManagement/lib/models/mongoDbLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/mongoDbLinkedService.js @@ -20,29 +20,29 @@ const models = require('./index'); class MongoDbLinkedService extends models['LinkedService'] { /** * Create a MongoDbLinkedService. - * @member {object} server The IP address or server name of the MongoDB + * @property {object} server The IP address or server name of the MongoDB * server. Type: string (or Expression with resultType string). - * @member {string} [authenticationType] The authentication type to be used + * @property {string} [authenticationType] The authentication type to be used * to connect to the MongoDB database. Possible values include: 'Basic', * 'Anonymous' - * @member {object} databaseName The name of the MongoDB database that you + * @property {object} databaseName The name of the MongoDB database that you * want to access. Type: string (or Expression with resultType string). - * @member {object} [username] Username for authentication. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password for authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [authSource] Database to verify the username and + * @property {object} [username] Username for authentication. Type: string + * (or Expression with resultType string). + * @property {object} [password] Password for authentication. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [authSource] Database to verify the username and * password. Type: string (or Expression with resultType string). - * @member {object} [port] The TCP port number that the MongoDB server uses + * @property {object} [port] The TCP port number that the MongoDB server uses * to listen for client connections. The default value is 27017. Type: * integer (or Expression with resultType integer), minimum: 0. - * @member {object} [enableSsl] Specifies whether the connections to the + * @property {object} [enableSsl] Specifies whether the connections to the * server are encrypted using SSL. The default value is false. Type: boolean * (or Expression with resultType boolean). - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow + * @property {object} [allowSelfSignedServerCert] Specifies whether to allow * self-signed certificates from the server. The default value is false. * Type: boolean (or Expression with resultType boolean). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/mongoDbSource.js b/lib/services/datafactoryManagement/lib/models/mongoDbSource.js index 0dd1c81ac4..9416fd4f46 100644 --- a/lib/services/datafactoryManagement/lib/models/mongoDbSource.js +++ b/lib/services/datafactoryManagement/lib/models/mongoDbSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class MongoDbSource extends models['CopySource'] { /** * Create a MongoDbSource. - * @member {object} [query] Database query. Should be a SQL-92 query + * @property {object} [query] Database query. Should be a SQL-92 query * expression. Type: string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/multiplePipelineTrigger.js b/lib/services/datafactoryManagement/lib/models/multiplePipelineTrigger.js index 46ea6ac034..34646abe36 100644 --- a/lib/services/datafactoryManagement/lib/models/multiplePipelineTrigger.js +++ b/lib/services/datafactoryManagement/lib/models/multiplePipelineTrigger.js @@ -21,7 +21,7 @@ const models = require('./index'); class MultiplePipelineTrigger extends models['Trigger'] { /** * Create a MultiplePipelineTrigger. - * @member {array} [pipelines] Pipelines that need to be started. + * @property {array} [pipelines] Pipelines that need to be started. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/mySqlLinkedService.js b/lib/services/datafactoryManagement/lib/models/mySqlLinkedService.js index 489060e78f..f44eeed34b 100644 --- a/lib/services/datafactoryManagement/lib/models/mySqlLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/mySqlLinkedService.js @@ -20,21 +20,22 @@ const models = require('./index'); class MySqlLinkedService extends models['LinkedService'] { /** * Create a MySqlLinkedService. - * @member {object} connectionString The connection string. - * @member {string} [connectionString.type] Polymorphic Discriminator - * @member {object} [password] The Azure key vault secret reference of + * @property {object} connectionString The connection string. + * @property {string} [connectionString.type] Polymorphic Discriminator + * @property {object} [password] The Azure key vault secret reference of * password in connection string. - * @member {object} [password.store] The Azure Key Vault linked service + * @property {object} [password.store] The Azure Key Vault linked service * reference. - * @member {string} [password.store.referenceName] Reference LinkedService + * @property {string} [password.store.referenceName] Reference LinkedService * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in + * @property {object} [password.store.parameters] Arguments for + * LinkedService. + * @property {object} [password.secretName] The name of the secret in Azure + * Key Vault. Type: string (or Expression with resultType string). + * @property {object} [password.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/netezzaLinkedService.js b/lib/services/datafactoryManagement/lib/models/netezzaLinkedService.js index 447b43c558..9884fe2c52 100644 --- a/lib/services/datafactoryManagement/lib/models/netezzaLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/netezzaLinkedService.js @@ -20,19 +20,20 @@ const models = require('./index'); class NetezzaLinkedService extends models['LinkedService'] { /** * Create a NetezzaLinkedService. - * @member {object} [connectionString] An ODBC connection string. Type: + * @property {object} [connectionString] An ODBC connection string. Type: * string, SecureString or AzureKeyVaultSecretReference. - * @member {object} [pwd] The Azure key vault secret reference of password in - * connection string. - * @member {object} [pwd.store] The Azure Key Vault linked service reference. - * @member {string} [pwd.store.referenceName] Reference LinkedService name. - * @member {object} [pwd.store.parameters] Arguments for LinkedService. - * @member {object} [pwd.secretName] The name of the secret in Azure Key + * @property {object} [pwd] The Azure key vault secret reference of password + * in connection string. + * @property {object} [pwd.store] The Azure Key Vault linked service + * reference. + * @property {string} [pwd.store.referenceName] Reference LinkedService name. + * @property {object} [pwd.store.parameters] Arguments for LinkedService. + * @property {object} [pwd.secretName] The name of the secret in Azure Key * Vault. Type: string (or Expression with resultType string). - * @member {object} [pwd.secretVersion] The version of the secret in Azure + * @property {object} [pwd.secretVersion] The version of the secret in Azure * Key Vault. The default value is the latest version of the secret. Type: * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/netezzaSource.js b/lib/services/datafactoryManagement/lib/models/netezzaSource.js index c18fc59d4b..d948433e76 100644 --- a/lib/services/datafactoryManagement/lib/models/netezzaSource.js +++ b/lib/services/datafactoryManagement/lib/models/netezzaSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class NetezzaSource extends models['CopySource'] { /** * Create a NetezzaSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/netezzaTableDataset.js b/lib/services/datafactoryManagement/lib/models/netezzaTableDataset.js index c9a04f823b..6b8ef3cf36 100644 --- a/lib/services/datafactoryManagement/lib/models/netezzaTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/netezzaTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class NetezzaTableDataset extends models['Dataset'] { /** * Create a NetezzaTableDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/oDataLinkedService.js b/lib/services/datafactoryManagement/lib/models/oDataLinkedService.js index 325ad7a867..7e30e13507 100644 --- a/lib/services/datafactoryManagement/lib/models/oDataLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/oDataLinkedService.js @@ -20,16 +20,16 @@ const models = require('./index'); class ODataLinkedService extends models['LinkedService'] { /** * Create a ODataLinkedService. - * @member {object} url The URL of the OData service endpoint. Type: string + * @property {object} url The URL of the OData service endpoint. Type: string * (or Expression with resultType string). - * @member {string} [authenticationType] Type of authentication used to + * @property {string} [authenticationType] Type of authentication used to * connect to the OData service. Possible values include: 'Basic', * 'Anonymous' - * @member {object} [userName] User name of the OData service. Type: string + * @property {object} [userName] User name of the OData service. Type: string * (or Expression with resultType string). - * @member {object} [password] Password of the OData service. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [password] Password of the OData service. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/oDataResourceDataset.js b/lib/services/datafactoryManagement/lib/models/oDataResourceDataset.js index e886bad14d..49c552c285 100644 --- a/lib/services/datafactoryManagement/lib/models/oDataResourceDataset.js +++ b/lib/services/datafactoryManagement/lib/models/oDataResourceDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class ODataResourceDataset extends models['Dataset'] { /** * Create a ODataResourceDataset. - * @member {object} [path] The OData resource path. Type: string (or + * @property {object} [path] The OData resource path. Type: string (or * Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/odbcLinkedService.js b/lib/services/datafactoryManagement/lib/models/odbcLinkedService.js index 9dda0660a4..804d49a8c2 100644 --- a/lib/services/datafactoryManagement/lib/models/odbcLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/odbcLinkedService.js @@ -20,20 +20,20 @@ const models = require('./index'); class OdbcLinkedService extends models['LinkedService'] { /** * Create a OdbcLinkedService. - * @member {object} connectionString The non-access credential portion of the - * connection string as well as an optional encrypted credential. Type: + * @property {object} connectionString The non-access credential portion of + * the connection string as well as an optional encrypted credential. Type: * string, SecureString or AzureKeyVaultSecretReference. - * @member {object} [authenticationType] Type of authentication used to + * @property {object} [authenticationType] Type of authentication used to * connect to the ODBC data store. Possible values are: Anonymous and Basic. * Type: string (or Expression with resultType string). - * @member {object} [credential] The access credential portion of the + * @property {object} [credential] The access credential portion of the * connection string specified in driver-specific property-value format. - * @member {string} [credential.type] Polymorphic Discriminator - * @member {object} [userName] User name for Basic authentication. Type: + * @property {string} [credential.type] Polymorphic Discriminator + * @property {object} [userName] User name for Basic authentication. Type: * string (or Expression with resultType string). - * @member {object} [password] Password for Basic authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [password] Password for Basic authentication. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/odbcSink.js b/lib/services/datafactoryManagement/lib/models/odbcSink.js index eeeefe27c5..f2d91270b7 100644 --- a/lib/services/datafactoryManagement/lib/models/odbcSink.js +++ b/lib/services/datafactoryManagement/lib/models/odbcSink.js @@ -20,7 +20,7 @@ const models = require('./index'); class OdbcSink extends models['CopySink'] { /** * Create a OdbcSink. - * @member {object} [preCopyScript] A query to execute before starting the + * @property {object} [preCopyScript] A query to execute before starting the * copy. Type: string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/operation.js b/lib/services/datafactoryManagement/lib/models/operation.js index 4a090ac126..092bccef4b 100644 --- a/lib/services/datafactoryManagement/lib/models/operation.js +++ b/lib/services/datafactoryManagement/lib/models/operation.js @@ -17,20 +17,22 @@ class Operation { /** * Create a Operation. - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {string} [origin] The intended executor of the operation. - * @member {object} [display] Metadata associated with the operation. - * @member {string} [display.description] The description of the operation. - * @member {string} [display.provider] The name of the provider. - * @member {string} [display.resource] The name of the resource type on which - * the operation is performed. - * @member {string} [display.operation] The type of operation: get, read, + * @property {string} [name] Operation name: + * {provider}/{resource}/{operation} + * @property {string} [origin] The intended executor of the operation. + * @property {object} [display] Metadata associated with the operation. + * @property {string} [display.description] The description of the operation. + * @property {string} [display.provider] The name of the provider. + * @property {string} [display.resource] The name of the resource type on + * which the operation is performed. + * @property {string} [display.operation] The type of operation: get, read, * delete, etc. - * @member {object} [serviceSpecification] Details about a service operation. - * @member {array} [serviceSpecification.logSpecifications] Details about + * @property {object} [serviceSpecification] Details about a service + * operation. + * @property {array} [serviceSpecification.logSpecifications] Details about * operations related to logs. - * @member {array} [serviceSpecification.metricSpecifications] Details about - * operations related to metrics. + * @property {array} [serviceSpecification.metricSpecifications] Details + * about operations related to metrics. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/operationDisplay.js b/lib/services/datafactoryManagement/lib/models/operationDisplay.js index bd4e5d5058..9357dcbe78 100644 --- a/lib/services/datafactoryManagement/lib/models/operationDisplay.js +++ b/lib/services/datafactoryManagement/lib/models/operationDisplay.js @@ -17,11 +17,11 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [description] The description of the operation. - * @member {string} [provider] The name of the provider. - * @member {string} [resource] The name of the resource type on which the + * @property {string} [description] The description of the operation. + * @property {string} [provider] The name of the provider. + * @property {string} [resource] The name of the resource type on which the * operation is performed. - * @member {string} [operation] The type of operation: get, read, delete, + * @property {string} [operation] The type of operation: get, read, delete, * etc. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/operationListResponse.js b/lib/services/datafactoryManagement/lib/models/operationListResponse.js index ca69da361e..55a8810f9a 100644 --- a/lib/services/datafactoryManagement/lib/models/operationListResponse.js +++ b/lib/services/datafactoryManagement/lib/models/operationListResponse.js @@ -16,7 +16,7 @@ class OperationListResponse extends Array { /** * Create a OperationListResponse. - * @member {string} [nextLink] The link to the next page of results, if any + * @property {string} [nextLink] The link to the next page of results, if any * remaining results exist. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/operationLogSpecification.js b/lib/services/datafactoryManagement/lib/models/operationLogSpecification.js index 2e92fc69b3..da614179fb 100644 --- a/lib/services/datafactoryManagement/lib/models/operationLogSpecification.js +++ b/lib/services/datafactoryManagement/lib/models/operationLogSpecification.js @@ -17,9 +17,9 @@ class OperationLogSpecification { /** * Create a OperationLogSpecification. - * @member {string} [name] The name of the log category. - * @member {string} [displayName] Localized display name. - * @member {string} [blobDuration] Blobs created in the customer storage + * @property {string} [name] The name of the log category. + * @property {string} [displayName] Localized display name. + * @property {string} [blobDuration] Blobs created in the customer storage * account, per hour. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/operationMetricAvailability.js b/lib/services/datafactoryManagement/lib/models/operationMetricAvailability.js index 15ebbbda0b..ba7a749604 100644 --- a/lib/services/datafactoryManagement/lib/models/operationMetricAvailability.js +++ b/lib/services/datafactoryManagement/lib/models/operationMetricAvailability.js @@ -17,8 +17,8 @@ class OperationMetricAvailability { /** * Create a OperationMetricAvailability. - * @member {string} [timeGrain] The granularity for the metric. - * @member {string} [blobDuration] Blob created in the customer storage + * @property {string} [timeGrain] The granularity for the metric. + * @property {string} [blobDuration] Blob created in the customer storage * account, per hour. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/operationMetricDimension.js b/lib/services/datafactoryManagement/lib/models/operationMetricDimension.js index 2026d5dc7f..3cb032b97c 100644 --- a/lib/services/datafactoryManagement/lib/models/operationMetricDimension.js +++ b/lib/services/datafactoryManagement/lib/models/operationMetricDimension.js @@ -17,10 +17,10 @@ class OperationMetricDimension { /** * Create a OperationMetricDimension. - * @member {string} [name] The name of the dimension for the metric. - * @member {string} [displayName] The display name of the metric dimension. - * @member {boolean} [toBeExportedForShoebox] Whether the dimension should be - * exported to Azure Monitor. + * @property {string} [name] The name of the dimension for the metric. + * @property {string} [displayName] The display name of the metric dimension. + * @property {boolean} [toBeExportedForShoebox] Whether the dimension should + * be exported to Azure Monitor. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/operationMetricSpecification.js b/lib/services/datafactoryManagement/lib/models/operationMetricSpecification.js index 88eb059f42..e7ccba1090 100644 --- a/lib/services/datafactoryManagement/lib/models/operationMetricSpecification.js +++ b/lib/services/datafactoryManagement/lib/models/operationMetricSpecification.js @@ -17,18 +17,18 @@ class OperationMetricSpecification { /** * Create a OperationMetricSpecification. - * @member {string} [name] The name of the metric. - * @member {string} [displayName] Localized display name of the metric. - * @member {string} [displayDescription] The description of the metric. - * @member {string} [unit] The unit that the metric is measured in. - * @member {string} [aggregationType] The type of metric aggregation. - * @member {string} [enableRegionalMdmAccount] Whether or not the service is - * using regional MDM accounts. - * @member {string} [sourceMdmAccount] The name of the MDM account. - * @member {string} [sourceMdmNamespace] The name of the MDM namespace. - * @member {array} [availabilities] Defines how often data for metrics + * @property {string} [name] The name of the metric. + * @property {string} [displayName] Localized display name of the metric. + * @property {string} [displayDescription] The description of the metric. + * @property {string} [unit] The unit that the metric is measured in. + * @property {string} [aggregationType] The type of metric aggregation. + * @property {string} [enableRegionalMdmAccount] Whether or not the service + * is using regional MDM accounts. + * @property {string} [sourceMdmAccount] The name of the MDM account. + * @property {string} [sourceMdmNamespace] The name of the MDM namespace. + * @property {array} [availabilities] Defines how often data for metrics * becomes available. - * @member {array} [dimensions] Defines the metric dimension. + * @property {array} [dimensions] Defines the metric dimension. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/operationServiceSpecification.js b/lib/services/datafactoryManagement/lib/models/operationServiceSpecification.js index 4855871b0c..c1a72bd8b1 100644 --- a/lib/services/datafactoryManagement/lib/models/operationServiceSpecification.js +++ b/lib/services/datafactoryManagement/lib/models/operationServiceSpecification.js @@ -17,10 +17,10 @@ class OperationServiceSpecification { /** * Create a OperationServiceSpecification. - * @member {array} [logSpecifications] Details about operations related to + * @property {array} [logSpecifications] Details about operations related to * logs. - * @member {array} [metricSpecifications] Details about operations related to - * metrics. + * @property {array} [metricSpecifications] Details about operations related + * to metrics. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/oracleLinkedService.js b/lib/services/datafactoryManagement/lib/models/oracleLinkedService.js index ba88e9013a..8dd0fe0743 100644 --- a/lib/services/datafactoryManagement/lib/models/oracleLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/oracleLinkedService.js @@ -20,21 +20,22 @@ const models = require('./index'); class OracleLinkedService extends models['LinkedService'] { /** * Create a OracleLinkedService. - * @member {object} connectionString The connection string. Type: string, + * @property {object} connectionString The connection string. Type: string, * SecureString or AzureKeyVaultSecretReference. - * @member {object} [password] The Azure key vault secret reference of + * @property {object} [password] The Azure key vault secret reference of * password in connection string. - * @member {object} [password.store] The Azure Key Vault linked service + * @property {object} [password.store] The Azure Key Vault linked service * reference. - * @member {string} [password.store.referenceName] Reference LinkedService + * @property {string} [password.store.referenceName] Reference LinkedService * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in + * @property {object} [password.store.parameters] Arguments for + * LinkedService. + * @property {object} [password.secretName] The name of the secret in Azure + * Key Vault. Type: string (or Expression with resultType string). + * @property {object} [password.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/oracleSink.js b/lib/services/datafactoryManagement/lib/models/oracleSink.js index 6d8a1c70e6..d7f7ba4d43 100644 --- a/lib/services/datafactoryManagement/lib/models/oracleSink.js +++ b/lib/services/datafactoryManagement/lib/models/oracleSink.js @@ -20,7 +20,7 @@ const models = require('./index'); class OracleSink extends models['CopySink'] { /** * Create a OracleSink. - * @member {object} [preCopyScript] SQL pre-copy script. Type: string (or + * @property {object} [preCopyScript] SQL pre-copy script. Type: string (or * Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/oracleSource.js b/lib/services/datafactoryManagement/lib/models/oracleSource.js index 64a27bb682..ae04ca4a4c 100644 --- a/lib/services/datafactoryManagement/lib/models/oracleSource.js +++ b/lib/services/datafactoryManagement/lib/models/oracleSource.js @@ -20,10 +20,10 @@ const models = require('./index'); class OracleSource extends models['CopySource'] { /** * Create a OracleSource. - * @member {object} [oracleReaderQuery] Oracle reader query. Type: string (or - * Expression with resultType string). - * @member {object} [queryTimeout] Query timeout. Type: string (or Expression - * with resultType string), pattern: + * @property {object} [oracleReaderQuery] Oracle reader query. Type: string + * (or Expression with resultType string). + * @property {object} [queryTimeout] Query timeout. Type: string (or + * Expression with resultType string), pattern: * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/oracleTableDataset.js b/lib/services/datafactoryManagement/lib/models/oracleTableDataset.js index 35bb377550..7ea98972cf 100644 --- a/lib/services/datafactoryManagement/lib/models/oracleTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/oracleTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class OracleTableDataset extends models['Dataset'] { /** * Create a OracleTableDataset. - * @member {object} tableName The table name of the on-premises Oracle + * @property {object} tableName The table name of the on-premises Oracle * database. Type: string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/parameterSpecification.js b/lib/services/datafactoryManagement/lib/models/parameterSpecification.js index 8df992264a..5948f6f91d 100644 --- a/lib/services/datafactoryManagement/lib/models/parameterSpecification.js +++ b/lib/services/datafactoryManagement/lib/models/parameterSpecification.js @@ -17,9 +17,9 @@ class ParameterSpecification { /** * Create a ParameterSpecification. - * @member {string} type Parameter type. Possible values include: 'Object', + * @property {string} type Parameter type. Possible values include: 'Object', * 'String', 'Int', 'Float', 'Bool', 'Array', 'SecureString' - * @member {object} [defaultValue] Default value of parameter. + * @property {object} [defaultValue] Default value of parameter. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/paypalLinkedService.js b/lib/services/datafactoryManagement/lib/models/paypalLinkedService.js index 0944d97a12..79ac13f057 100644 --- a/lib/services/datafactoryManagement/lib/models/paypalLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/paypalLinkedService.js @@ -13,29 +13,29 @@ const models = require('./index'); /** - * Paypal Serivce linked service. + * Paypal Service linked service. * * @extends models['LinkedService'] */ class PaypalLinkedService extends models['LinkedService'] { /** * Create a PaypalLinkedService. - * @member {object} host The URL of the PayPal instance. (i.e. + * @property {object} host The URL of the PayPal instance. (i.e. * api.sandbox.paypal.com) - * @member {object} clientId The client ID associated with your PayPal + * @property {object} clientId The client ID associated with your PayPal * application. - * @member {object} [clientSecret] The client secret associated with your + * @property {object} [clientSecret] The client secret associated with your * PayPal application. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {string} [clientSecret.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/paypalObjectDataset.js b/lib/services/datafactoryManagement/lib/models/paypalObjectDataset.js index b71a622b43..5137e9d080 100644 --- a/lib/services/datafactoryManagement/lib/models/paypalObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/paypalObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class PaypalObjectDataset extends models['Dataset'] { /** * Create a PaypalObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/paypalSource.js b/lib/services/datafactoryManagement/lib/models/paypalSource.js index 69d3e2ce30..3702cc375e 100644 --- a/lib/services/datafactoryManagement/lib/models/paypalSource.js +++ b/lib/services/datafactoryManagement/lib/models/paypalSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class PaypalSource extends models['CopySource'] { /** * Create a PaypalSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/phoenixLinkedService.js b/lib/services/datafactoryManagement/lib/models/phoenixLinkedService.js index 1bdf8ec74a..d1ae53f6ee 100644 --- a/lib/services/datafactoryManagement/lib/models/phoenixLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/phoenixLinkedService.js @@ -20,36 +20,36 @@ const models = require('./index'); class PhoenixLinkedService extends models['LinkedService'] { /** * Create a PhoenixLinkedService. - * @member {object} host The IP address or host name of the Phoenix server. + * @property {object} host The IP address or host name of the Phoenix server. * (i.e. 192.168.222.160) - * @member {object} [port] The TCP port that the Phoenix server uses to + * @property {object} [port] The TCP port that the Phoenix server uses to * listen for client connections. The default value is 8765. - * @member {object} [httpPath] The partial URL corresponding to the Phoenix + * @property {object} [httpPath] The partial URL corresponding to the Phoenix * server. (i.e. /gateway/sandbox/phoenix/version). The default value is * hbasephoenix if using WindowsAzureHDInsightService. - * @member {string} authenticationType The authentication mechanism used to + * @property {string} authenticationType The authentication mechanism used to * connect to the Phoenix server. Possible values include: 'Anonymous', * 'UsernameAndPassword', 'WindowsAzureHDInsightService' - * @member {object} [username] The user name used to connect to the Phoenix + * @property {object} [username] The user name used to connect to the Phoenix * server. - * @member {object} [password] The password corresponding to the user name. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [enableSsl] Specifies whether the connections to the + * @property {object} [password] The password corresponding to the user name. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [enableSsl] Specifies whether the connections to the * server are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file + * @property {object} [trustedCertPath] The full path of the .pem file * containing trusted CA certificates for verifying the server when * connecting over SSL. This property can only be set when using SSL on * self-hosted IR. The default value is the cacerts.pem file installed with * the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA + * @property {object} [useSystemTrustStore] Specifies whether to use a CA * certificate from the system trust store or from a specified PEM file. The * default value is false. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when + * @property {object} [allowHostNameCNMismatch] Specifies whether to require + * a CA-issued SSL certificate name to match the host name of the server when * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow + * @property {object} [allowSelfSignedServerCert] Specifies whether to allow * self-signed certificates from the server. The default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/phoenixObjectDataset.js b/lib/services/datafactoryManagement/lib/models/phoenixObjectDataset.js index ae8ff35b09..4bcae4f6c7 100644 --- a/lib/services/datafactoryManagement/lib/models/phoenixObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/phoenixObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class PhoenixObjectDataset extends models['Dataset'] { /** * Create a PhoenixObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/phoenixSource.js b/lib/services/datafactoryManagement/lib/models/phoenixSource.js index 103665b661..0f5b201793 100644 --- a/lib/services/datafactoryManagement/lib/models/phoenixSource.js +++ b/lib/services/datafactoryManagement/lib/models/phoenixSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class PhoenixSource extends models['CopySource'] { /** * Create a PhoenixSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/pipelineFolder.js b/lib/services/datafactoryManagement/lib/models/pipelineFolder.js index b238b19249..45c36921b0 100644 --- a/lib/services/datafactoryManagement/lib/models/pipelineFolder.js +++ b/lib/services/datafactoryManagement/lib/models/pipelineFolder.js @@ -18,7 +18,7 @@ class PipelineFolder { /** * Create a PipelineFolder. - * @member {string} [name] The name of the folder that this Pipeline is in. + * @property {string} [name] The name of the folder that this Pipeline is in. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/pipelineListResponse.js b/lib/services/datafactoryManagement/lib/models/pipelineListResponse.js index 5f69ce4505..3594b7f6fc 100644 --- a/lib/services/datafactoryManagement/lib/models/pipelineListResponse.js +++ b/lib/services/datafactoryManagement/lib/models/pipelineListResponse.js @@ -16,7 +16,7 @@ class PipelineListResponse extends Array { /** * Create a PipelineListResponse. - * @member {string} [nextLink] The link to the next page of results, if any + * @property {string} [nextLink] The link to the next page of results, if any * remaining results exist. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/pipelineReference.js b/lib/services/datafactoryManagement/lib/models/pipelineReference.js index 5d8a784a28..ea802ba3ad 100644 --- a/lib/services/datafactoryManagement/lib/models/pipelineReference.js +++ b/lib/services/datafactoryManagement/lib/models/pipelineReference.js @@ -17,8 +17,8 @@ class PipelineReference { /** * Create a PipelineReference. - * @member {string} referenceName Reference pipeline name. - * @member {string} [name] Reference name. + * @property {string} referenceName Reference pipeline name. + * @property {string} [name] Reference name. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/pipelineResource.js b/lib/services/datafactoryManagement/lib/models/pipelineResource.js index 2dcfd3b1af..06bbb28cff 100644 --- a/lib/services/datafactoryManagement/lib/models/pipelineResource.js +++ b/lib/services/datafactoryManagement/lib/models/pipelineResource.js @@ -20,17 +20,17 @@ const models = require('./index'); class PipelineResource extends models['SubResource'] { /** * Create a PipelineResource. - * @member {string} [description] The description of the pipeline. - * @member {array} [activities] List of activities in pipeline. - * @member {object} [parameters] List of parameters for pipeline. - * @member {object} [variables] List of variables for pipeline. - * @member {number} [concurrency] The max number of concurrent runs for the + * @property {string} [description] The description of the pipeline. + * @property {array} [activities] List of activities in pipeline. + * @property {object} [parameters] List of parameters for pipeline. + * @property {object} [variables] List of variables for pipeline. + * @property {number} [concurrency] The max number of concurrent runs for the * pipeline. - * @member {array} [annotations] List of tags that can be used for describing - * the Pipeline. - * @member {object} [folder] The folder that this Pipeline is in. If not + * @property {array} [annotations] List of tags that can be used for + * describing the Pipeline. + * @property {object} [folder] The folder that this Pipeline is in. If not * specified, Pipeline will appear at the root level. - * @member {string} [folder.name] The name of the folder that this Pipeline + * @property {string} [folder.name] The name of the folder that this Pipeline * is in. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/pipelineRun.js b/lib/services/datafactoryManagement/lib/models/pipelineRun.js index 86dc7f9d4f..4038e3995f 100644 --- a/lib/services/datafactoryManagement/lib/models/pipelineRun.js +++ b/lib/services/datafactoryManagement/lib/models/pipelineRun.js @@ -17,24 +17,26 @@ class PipelineRun { /** * Create a PipelineRun. - * @member {string} [runId] Identifier of a run. - * @member {string} [pipelineName] The pipeline name. - * @member {object} [parameters] The full or partial list of parameter name, - * value pair used in the pipeline run. - * @member {object} [invokedBy] Entity that started the pipeline run. - * @member {string} [invokedBy.name] Name of the entity that started the + * @property {string} [runId] Identifier of a run. + * @property {string} [pipelineName] The pipeline name. + * @property {object} [parameters] The full or partial list of parameter + * name, value pair used in the pipeline run. + * @property {object} [invokedBy] Entity that started the pipeline run. + * @property {string} [invokedBy.name] Name of the entity that started the * pipeline run. - * @member {string} [invokedBy.id] The ID of the entity that started the run. - * @member {string} [invokedBy.invokedByType] The type of the entity that + * @property {string} [invokedBy.id] The ID of the entity that started the + * run. + * @property {string} [invokedBy.invokedByType] The type of the entity that * started the run. - * @member {date} [lastUpdated] The last updated timestamp for the pipeline + * @property {date} [lastUpdated] The last updated timestamp for the pipeline * run event in ISO8601 format. - * @member {date} [runStart] The start time of a pipeline run in ISO8601 + * @property {date} [runStart] The start time of a pipeline run in ISO8601 * format. - * @member {date} [runEnd] The end time of a pipeline run in ISO8601 format. - * @member {number} [durationInMs] The duration of a pipeline run. - * @member {string} [status] The status of a pipeline run. - * @member {string} [message] The message from a pipeline run. + * @property {date} [runEnd] The end time of a pipeline run in ISO8601 + * format. + * @property {number} [durationInMs] The duration of a pipeline run. + * @property {string} [status] The status of a pipeline run. + * @property {string} [message] The message from a pipeline run. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/pipelineRunInvokedBy.js b/lib/services/datafactoryManagement/lib/models/pipelineRunInvokedBy.js index 7144f11342..c4aafcf5aa 100644 --- a/lib/services/datafactoryManagement/lib/models/pipelineRunInvokedBy.js +++ b/lib/services/datafactoryManagement/lib/models/pipelineRunInvokedBy.js @@ -17,9 +17,10 @@ class PipelineRunInvokedBy { /** * Create a PipelineRunInvokedBy. - * @member {string} [name] Name of the entity that started the pipeline run. - * @member {string} [id] The ID of the entity that started the run. - * @member {string} [invokedByType] The type of the entity that started the + * @property {string} [name] Name of the entity that started the pipeline + * run. + * @property {string} [id] The ID of the entity that started the run. + * @property {string} [invokedByType] The type of the entity that started the * run. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/pipelineRunsQueryResponse.js b/lib/services/datafactoryManagement/lib/models/pipelineRunsQueryResponse.js index 1d496f3b18..11a80b7de2 100644 --- a/lib/services/datafactoryManagement/lib/models/pipelineRunsQueryResponse.js +++ b/lib/services/datafactoryManagement/lib/models/pipelineRunsQueryResponse.js @@ -17,8 +17,8 @@ class PipelineRunsQueryResponse { /** * Create a PipelineRunsQueryResponse. - * @member {array} value List of pipeline runs. - * @member {string} [continuationToken] The continuation token for getting + * @property {array} value List of pipeline runs. + * @property {string} [continuationToken] The continuation token for getting * the next page of results, if any remaining results exist, null otherwise. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/polybaseSettings.js b/lib/services/datafactoryManagement/lib/models/polybaseSettings.js index 0546c26e30..1773f34bce 100644 --- a/lib/services/datafactoryManagement/lib/models/polybaseSettings.js +++ b/lib/services/datafactoryManagement/lib/models/polybaseSettings.js @@ -17,16 +17,16 @@ class PolybaseSettings { /** * Create a PolybaseSettings. - * @member {string} [rejectType] Reject type. Possible values include: + * @property {string} [rejectType] Reject type. Possible values include: * 'value', 'percentage' - * @member {object} [rejectValue] Specifies the value or the percentage of + * @property {object} [rejectValue] Specifies the value or the percentage of * rows that can be rejected before the query fails. Type: number (or * Expression with resultType number), minimum: 0. - * @member {object} [rejectSampleValue] Determines the number of rows to + * @property {object} [rejectSampleValue] Determines the number of rows to * attempt to retrieve before the PolyBase recalculates the percentage of * rejected rows. Type: integer (or Expression with resultType integer), * minimum: 0. - * @member {object} [useTypeDefault] Specifies how to handle missing values + * @property {object} [useTypeDefault] Specifies how to handle missing values * in delimited text files when PolyBase retrieves data from the text file. * Type: boolean (or Expression with resultType boolean). */ diff --git a/lib/services/datafactoryManagement/lib/models/postgreSqlLinkedService.js b/lib/services/datafactoryManagement/lib/models/postgreSqlLinkedService.js index 86d6441760..a167ab5136 100644 --- a/lib/services/datafactoryManagement/lib/models/postgreSqlLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/postgreSqlLinkedService.js @@ -20,21 +20,22 @@ const models = require('./index'); class PostgreSqlLinkedService extends models['LinkedService'] { /** * Create a PostgreSqlLinkedService. - * @member {object} connectionString The connection string. - * @member {string} [connectionString.type] Polymorphic Discriminator - * @member {object} [password] The Azure key vault secret reference of + * @property {object} connectionString The connection string. + * @property {string} [connectionString.type] Polymorphic Discriminator + * @property {object} [password] The Azure key vault secret reference of * password in connection string. - * @member {object} [password.store] The Azure Key Vault linked service + * @property {object} [password.store] The Azure Key Vault linked service * reference. - * @member {string} [password.store.referenceName] Reference LinkedService + * @property {string} [password.store.referenceName] Reference LinkedService * name. - * @member {object} [password.store.parameters] Arguments for LinkedService. - * @member {object} [password.secretName] The name of the secret in Azure Key - * Vault. Type: string (or Expression with resultType string). - * @member {object} [password.secretVersion] The version of the secret in + * @property {object} [password.store.parameters] Arguments for + * LinkedService. + * @property {object} [password.secretName] The name of the secret in Azure + * Key Vault. Type: string (or Expression with resultType string). + * @property {object} [password.secretVersion] The version of the secret in * Azure Key Vault. The default value is the latest version of the secret. * Type: string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/prestoLinkedService.js b/lib/services/datafactoryManagement/lib/models/prestoLinkedService.js index 83b87cc817..93dfee3337 100644 --- a/lib/services/datafactoryManagement/lib/models/prestoLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/prestoLinkedService.js @@ -20,39 +20,39 @@ const models = require('./index'); class PrestoLinkedService extends models['LinkedService'] { /** * Create a PrestoLinkedService. - * @member {object} host The IP address or host name of the Presto server. + * @property {object} host The IP address or host name of the Presto server. * (i.e. 192.168.222.160) - * @member {object} serverVersion The version of the Presto server. (i.e. + * @property {object} serverVersion The version of the Presto server. (i.e. * 0.148-t) - * @member {object} catalog The catalog context for all request against the + * @property {object} catalog The catalog context for all request against the * server. - * @member {object} [port] The TCP port that the Presto server uses to listen - * for client connections. The default value is 8080. - * @member {string} authenticationType The authentication mechanism used to + * @property {object} [port] The TCP port that the Presto server uses to + * listen for client connections. The default value is 8080. + * @property {string} authenticationType The authentication mechanism used to * connect to the Presto server. Possible values include: 'Anonymous', 'LDAP' - * @member {object} [username] The user name used to connect to the Presto + * @property {object} [username] The user name used to connect to the Presto * server. - * @member {object} [password] The password corresponding to the user name. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [enableSsl] Specifies whether the connections to the + * @property {object} [password] The password corresponding to the user name. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [enableSsl] Specifies whether the connections to the * server are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file + * @property {object} [trustedCertPath] The full path of the .pem file * containing trusted CA certificates for verifying the server when * connecting over SSL. This property can only be set when using SSL on * self-hosted IR. The default value is the cacerts.pem file installed with * the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA + * @property {object} [useSystemTrustStore] Specifies whether to use a CA * certificate from the system trust store or from a specified PEM file. The * default value is false. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when + * @property {object} [allowHostNameCNMismatch] Specifies whether to require + * a CA-issued SSL certificate name to match the host name of the server when * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow + * @property {object} [allowSelfSignedServerCert] Specifies whether to allow * self-signed certificates from the server. The default value is false. - * @member {object} [timeZoneID] The local time zone used by the connection. - * Valid values for this option are specified in the IANA Time Zone Database. - * The default value is the system time zone. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [timeZoneID] The local time zone used by the + * connection. Valid values for this option are specified in the IANA Time + * Zone Database. The default value is the system time zone. + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/prestoObjectDataset.js b/lib/services/datafactoryManagement/lib/models/prestoObjectDataset.js index 7a277f5d46..76bc6cdb1a 100644 --- a/lib/services/datafactoryManagement/lib/models/prestoObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/prestoObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class PrestoObjectDataset extends models['Dataset'] { /** * Create a PrestoObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/prestoSource.js b/lib/services/datafactoryManagement/lib/models/prestoSource.js index d0c0f706e6..a2926a154e 100644 --- a/lib/services/datafactoryManagement/lib/models/prestoSource.js +++ b/lib/services/datafactoryManagement/lib/models/prestoSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class PrestoSource extends models['CopySource'] { /** * Create a PrestoSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/quickBooksLinkedService.js b/lib/services/datafactoryManagement/lib/models/quickBooksLinkedService.js index 848db2d54d..28095e6384 100644 --- a/lib/services/datafactoryManagement/lib/models/quickBooksLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/quickBooksLinkedService.js @@ -20,24 +20,24 @@ const models = require('./index'); class QuickBooksLinkedService extends models['LinkedService'] { /** * Create a QuickBooksLinkedService. - * @member {object} endpoint The endpoint of the QuickBooks server. (i.e. + * @property {object} endpoint The endpoint of the QuickBooks server. (i.e. * quickbooks.api.intuit.com) - * @member {object} companyId The company ID of the QuickBooks company to + * @property {object} companyId The company ID of the QuickBooks company to * authorize. - * @member {object} consumerKey The consumer key for OAuth 1.0 + * @property {object} consumerKey The consumer key for OAuth 1.0 * authentication. - * @member {object} consumerSecret The consumer secret for OAuth 1.0 + * @property {object} consumerSecret The consumer secret for OAuth 1.0 * authentication. - * @member {string} [consumerSecret.type] Polymorphic Discriminator - * @member {object} accessToken The access token for OAuth 1.0 + * @property {string} [consumerSecret.type] Polymorphic Discriminator + * @property {object} accessToken The access token for OAuth 1.0 * authentication. - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} accessTokenSecret The access token secret for OAuth 1.0 + * @property {string} [accessToken.type] Polymorphic Discriminator + * @property {object} accessTokenSecret The access token secret for OAuth 1.0 * authentication. - * @member {string} [accessTokenSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {string} [accessTokenSecret.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/quickBooksObjectDataset.js b/lib/services/datafactoryManagement/lib/models/quickBooksObjectDataset.js index dfeade617a..11e8527dbf 100644 --- a/lib/services/datafactoryManagement/lib/models/quickBooksObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/quickBooksObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class QuickBooksObjectDataset extends models['Dataset'] { /** * Create a QuickBooksObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/quickBooksSource.js b/lib/services/datafactoryManagement/lib/models/quickBooksSource.js index 28c6f40def..70321d842e 100644 --- a/lib/services/datafactoryManagement/lib/models/quickBooksSource.js +++ b/lib/services/datafactoryManagement/lib/models/quickBooksSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class QuickBooksSource extends models['CopySource'] { /** * Create a QuickBooksSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/recurrenceSchedule.js b/lib/services/datafactoryManagement/lib/models/recurrenceSchedule.js index 3d8ea0c58f..0051de230c 100644 --- a/lib/services/datafactoryManagement/lib/models/recurrenceSchedule.js +++ b/lib/services/datafactoryManagement/lib/models/recurrenceSchedule.js @@ -17,11 +17,11 @@ class RecurrenceSchedule { /** * Create a RecurrenceSchedule. - * @member {array} [minutes] The minutes. - * @member {array} [hours] The hours. - * @member {array} [weekDays] The days of the week. - * @member {array} [monthDays] The month days. - * @member {array} [monthlyOccurrences] The monthly occurrences. + * @property {array} [minutes] The minutes. + * @property {array} [hours] The hours. + * @property {array} [weekDays] The days of the week. + * @property {array} [monthDays] The month days. + * @property {array} [monthlyOccurrences] The monthly occurrences. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/recurrenceScheduleOccurrence.js b/lib/services/datafactoryManagement/lib/models/recurrenceScheduleOccurrence.js index ae8c948ff3..84b0889ddf 100644 --- a/lib/services/datafactoryManagement/lib/models/recurrenceScheduleOccurrence.js +++ b/lib/services/datafactoryManagement/lib/models/recurrenceScheduleOccurrence.js @@ -17,10 +17,10 @@ class RecurrenceScheduleOccurrence { /** * Create a RecurrenceScheduleOccurrence. - * @member {string} [day] The day of the week. Possible values include: + * @property {string} [day] The day of the week. Possible values include: * 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', * 'Saturday' - * @member {number} [occurrence] The occurrence. + * @property {number} [occurrence] The occurrence. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/redirectIncompatibleRowSettings.js b/lib/services/datafactoryManagement/lib/models/redirectIncompatibleRowSettings.js index ef85230631..cab3fa4d23 100644 --- a/lib/services/datafactoryManagement/lib/models/redirectIncompatibleRowSettings.js +++ b/lib/services/datafactoryManagement/lib/models/redirectIncompatibleRowSettings.js @@ -17,12 +17,12 @@ class RedirectIncompatibleRowSettings { /** * Create a RedirectIncompatibleRowSettings. - * @member {object} linkedServiceName Name of the Azure Storage, Storage SAS, - * or Azure Data Lake Store linked service used for redirecting incompatible - * row. Must be specified if redirectIncompatibleRowSettings is specified. - * Type: string (or Expression with resultType string). - * @member {object} [path] The path for storing the redirect incompatible row - * data. Type: string (or Expression with resultType string). + * @property {object} linkedServiceName Name of the Azure Storage, Storage + * SAS, or Azure Data Lake Store linked service used for redirecting + * incompatible row. Must be specified if redirectIncompatibleRowSettings is + * specified. Type: string (or Expression with resultType string). + * @property {object} [path] The path for storing the redirect incompatible + * row data. Type: string (or Expression with resultType string). */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/redshiftUnloadSettings.js b/lib/services/datafactoryManagement/lib/models/redshiftUnloadSettings.js index a9ec022557..96b6e1000a 100644 --- a/lib/services/datafactoryManagement/lib/models/redshiftUnloadSettings.js +++ b/lib/services/datafactoryManagement/lib/models/redshiftUnloadSettings.js @@ -20,17 +20,17 @@ class RedshiftUnloadSettings { /** * Create a RedshiftUnloadSettings. - * @member {object} s3LinkedServiceName The name of the Amazon S3 linked + * @property {object} s3LinkedServiceName The name of the Amazon S3 linked * service which will be used for the unload operation when copying from the * Amazon Redshift source. - * @member {string} [s3LinkedServiceName.referenceName] Reference + * @property {string} [s3LinkedServiceName.referenceName] Reference * LinkedService name. - * @member {object} [s3LinkedServiceName.parameters] Arguments for + * @property {object} [s3LinkedServiceName.parameters] Arguments for * LinkedService. - * @member {object} bucketName The bucket of the interim Amazon S3 which will - * be used to store the unloaded data from Amazon Redshift source. The bucket - * must be in the same region as the Amazon Redshift source. Type: string (or - * Expression with resultType string). + * @property {object} bucketName The bucket of the interim Amazon S3 which + * will be used to store the unloaded data from Amazon Redshift source. The + * bucket must be in the same region as the Amazon Redshift source. Type: + * string (or Expression with resultType string). */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/relationalSource.js b/lib/services/datafactoryManagement/lib/models/relationalSource.js index 05de4df076..ff3ee6598a 100644 --- a/lib/services/datafactoryManagement/lib/models/relationalSource.js +++ b/lib/services/datafactoryManagement/lib/models/relationalSource.js @@ -20,8 +20,8 @@ const models = require('./index'); class RelationalSource extends models['CopySource'] { /** * Create a RelationalSource. - * @member {object} [query] Database query. Type: string (or Expression with - * resultType string). + * @property {object} [query] Database query. Type: string (or Expression + * with resultType string). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/relationalTableDataset.js b/lib/services/datafactoryManagement/lib/models/relationalTableDataset.js index 8b7ca64109..c5ac873491 100644 --- a/lib/services/datafactoryManagement/lib/models/relationalTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/relationalTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class RelationalTableDataset extends models['Dataset'] { /** * Create a RelationalTableDataset. - * @member {object} [tableName] The relational table name. Type: string (or + * @property {object} [tableName] The relational table name. Type: string (or * Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/rerunTriggerListResponse.js b/lib/services/datafactoryManagement/lib/models/rerunTriggerListResponse.js index 0dd667a69e..6c11a68aeb 100644 --- a/lib/services/datafactoryManagement/lib/models/rerunTriggerListResponse.js +++ b/lib/services/datafactoryManagement/lib/models/rerunTriggerListResponse.js @@ -16,7 +16,7 @@ class RerunTriggerListResponse extends Array { /** * Create a RerunTriggerListResponse. - * @member {string} [nextLink] The continuation token for getting the next + * @property {string} [nextLink] The continuation token for getting the next * page of results, if any remaining results exist, null otherwise. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/rerunTriggerResource.js b/lib/services/datafactoryManagement/lib/models/rerunTriggerResource.js index b950057a39..7fc054e997 100644 --- a/lib/services/datafactoryManagement/lib/models/rerunTriggerResource.js +++ b/lib/services/datafactoryManagement/lib/models/rerunTriggerResource.js @@ -20,15 +20,16 @@ const models = require('./index'); class RerunTriggerResource extends models['SubResource'] { /** * Create a RerunTriggerResource. - * @member {object} properties Properties of the rerun trigger. - * @member {object} [properties.parentTrigger] The parent trigger reference. - * @member {date} [properties.requestedStartTime] The start time for the time - * period for which restatement is initiated. Only UTC time is currently + * @property {object} properties Properties of the rerun trigger. + * @property {object} [properties.parentTrigger] The parent trigger + * reference. + * @property {date} [properties.requestedStartTime] The start time for the + * time period for which restatement is initiated. Only UTC time is currently * supported. - * @member {date} [properties.requestedEndTime] The end time for the time + * @property {date} [properties.requestedEndTime] The end time for the time * period for which restatement is initiated. Only UTC time is currently * supported. - * @member {number} [properties.maxConcurrency] The max number of parallel + * @property {number} [properties.maxConcurrency] The max number of parallel * time windows (ready for execution) for which a rerun is triggered. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/rerunTumblingWindowTrigger.js b/lib/services/datafactoryManagement/lib/models/rerunTumblingWindowTrigger.js index 9dedbfd9dc..561e08e93e 100644 --- a/lib/services/datafactoryManagement/lib/models/rerunTumblingWindowTrigger.js +++ b/lib/services/datafactoryManagement/lib/models/rerunTumblingWindowTrigger.js @@ -21,12 +21,12 @@ const models = require('./index'); class RerunTumblingWindowTrigger extends models['Trigger'] { /** * Create a RerunTumblingWindowTrigger. - * @member {object} [parentTrigger] The parent trigger reference. - * @member {date} requestedStartTime The start time for the time period for + * @property {object} [parentTrigger] The parent trigger reference. + * @property {date} requestedStartTime The start time for the time period for * which restatement is initiated. Only UTC time is currently supported. - * @member {date} requestedEndTime The end time for the time period for which - * restatement is initiated. Only UTC time is currently supported. - * @member {number} maxConcurrency The max number of parallel time windows + * @property {date} requestedEndTime The end time for the time period for + * which restatement is initiated. Only UTC time is currently supported. + * @property {number} maxConcurrency The max number of parallel time windows * (ready for execution) for which a rerun is triggered. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/rerunTumblingWindowTriggerActionParameters.js b/lib/services/datafactoryManagement/lib/models/rerunTumblingWindowTriggerActionParameters.js index a0df1b3381..29198f5982 100644 --- a/lib/services/datafactoryManagement/lib/models/rerunTumblingWindowTriggerActionParameters.js +++ b/lib/services/datafactoryManagement/lib/models/rerunTumblingWindowTriggerActionParameters.js @@ -17,11 +17,11 @@ class RerunTumblingWindowTriggerActionParameters { /** * Create a RerunTumblingWindowTriggerActionParameters. - * @member {date} startTime The start time for the time period for which + * @property {date} startTime The start time for the time period for which * restatement is initiated. Only UTC time is currently supported. - * @member {date} endTime The end time for the time period for which + * @property {date} endTime The end time for the time period for which * restatement is initiated. Only UTC time is currently supported. - * @member {number} maxConcurrency The max number of parallel time windows + * @property {number} maxConcurrency The max number of parallel time windows * (ready for execution) for which a rerun is triggered. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/resource.js b/lib/services/datafactoryManagement/lib/models/resource.js index 33e84ad70e..8e93c6b019 100644 --- a/lib/services/datafactoryManagement/lib/models/resource.js +++ b/lib/services/datafactoryManagement/lib/models/resource.js @@ -20,12 +20,12 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] The resource identifier. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. - * @member {string} [location] The resource location. - * @member {object} [tags] The resource tags. - * @member {string} [eTag] Etag identifies change in the resource. + * @property {string} [id] The resource identifier. + * @property {string} [name] The resource name. + * @property {string} [type] The resource type. + * @property {string} [location] The resource location. + * @property {object} [tags] The resource tags. + * @property {string} [eTag] Etag identifies change in the resource. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/responsysLinkedService.js b/lib/services/datafactoryManagement/lib/models/responsysLinkedService.js index 20ed7ca768..cfd1529320 100644 --- a/lib/services/datafactoryManagement/lib/models/responsysLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/responsysLinkedService.js @@ -20,24 +20,24 @@ const models = require('./index'); class ResponsysLinkedService extends models['LinkedService'] { /** * Create a ResponsysLinkedService. - * @member {object} endpoint The endpoint of the Responsys server. - * @member {object} clientId The client ID associated with the Responsys + * @property {object} endpoint The endpoint of the Responsys server. + * @property {object} clientId The client ID associated with the Responsys * application. Type: string (or Expression with resultType string). - * @member {object} [clientSecret] The client secret associated with the + * @property {object} [clientSecret] The client secret associated with the * Responsys application. Type: string (or Expression with resultType * string). - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. Type: - * boolean (or Expression with resultType boolean). - * @member {object} [useHostVerification] Specifies whether to require the + * @property {string} [clientSecret.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * Type: boolean (or Expression with resultType boolean). + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. Type: boolean (or * Expression with resultType boolean). - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. Type: boolean (or Expression with resultType boolean). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/responsysObjectDataset.js b/lib/services/datafactoryManagement/lib/models/responsysObjectDataset.js index e6916ab6c7..5f7706c341 100644 --- a/lib/services/datafactoryManagement/lib/models/responsysObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/responsysObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class ResponsysObjectDataset extends models['Dataset'] { /** * Create a ResponsysObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/responsysSource.js b/lib/services/datafactoryManagement/lib/models/responsysSource.js index a5caeed0f7..62af697950 100644 --- a/lib/services/datafactoryManagement/lib/models/responsysSource.js +++ b/lib/services/datafactoryManagement/lib/models/responsysSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class ResponsysSource extends models['CopySource'] { /** * Create a ResponsysSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/retryPolicy.js b/lib/services/datafactoryManagement/lib/models/retryPolicy.js index 3ec427f9da..040458487b 100644 --- a/lib/services/datafactoryManagement/lib/models/retryPolicy.js +++ b/lib/services/datafactoryManagement/lib/models/retryPolicy.js @@ -17,10 +17,10 @@ class RetryPolicy { /** * Create a RetryPolicy. - * @member {object} [count] Maximum ordinary retry attempts. Default is 0. + * @property {object} [count] Maximum ordinary retry attempts. Default is 0. * Type: integer (or Expression with resultType integer), minimum: 0. - * @member {number} [intervalInSeconds] Interval between retries in seconds. - * Default is 30. + * @property {number} [intervalInSeconds] Interval between retries in + * seconds. Default is 30. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/runFilterParameters.js b/lib/services/datafactoryManagement/lib/models/runFilterParameters.js index f7a5f9050a..c0bbdfbed9 100644 --- a/lib/services/datafactoryManagement/lib/models/runFilterParameters.js +++ b/lib/services/datafactoryManagement/lib/models/runFilterParameters.js @@ -17,14 +17,14 @@ class RunFilterParameters { /** * Create a RunFilterParameters. - * @member {string} [continuationToken] The continuation token for getting + * @property {string} [continuationToken] The continuation token for getting * the next page of results. Null for first page. - * @member {date} lastUpdatedAfter The time at or after which the run event + * @property {date} lastUpdatedAfter The time at or after which the run event * was updated in 'ISO 8601' format. - * @member {date} lastUpdatedBefore The time at or before which the run event - * was updated in 'ISO 8601' format. - * @member {array} [filters] List of filters. - * @member {array} [orderBy] List of OrderBy option. + * @property {date} lastUpdatedBefore The time at or before which the run + * event was updated in 'ISO 8601' format. + * @property {array} [filters] List of filters. + * @property {array} [orderBy] List of OrderBy option. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/runQueryFilter.js b/lib/services/datafactoryManagement/lib/models/runQueryFilter.js index c13698f3d2..43dc9fb793 100644 --- a/lib/services/datafactoryManagement/lib/models/runQueryFilter.js +++ b/lib/services/datafactoryManagement/lib/models/runQueryFilter.js @@ -17,17 +17,17 @@ class RunQueryFilter { /** * Create a RunQueryFilter. - * @member {string} operand Parameter name to be used for filter. The allowed - * operands to query pipeline runs are PipelineName, RunStart, RunEnd and - * Status; to query activity runs are ActivityName, ActivityRunStart, + * @property {string} operand Parameter name to be used for filter. The + * allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd + * and Status; to query activity runs are ActivityName, ActivityRunStart, * ActivityRunEnd, ActivityType and Status, and to query trigger runs are * TriggerName, TriggerRunTimestamp and Status. Possible values include: * 'PipelineName', 'Status', 'RunStart', 'RunEnd', 'ActivityName', * 'ActivityRunStart', 'ActivityRunEnd', 'ActivityType', 'TriggerName', * 'TriggerRunTimestamp' - * @member {string} operator Operator to be used for filter. Possible values - * include: 'Equals', 'NotEquals', 'In', 'NotIn' - * @member {array} values List of filter values. + * @property {string} operator Operator to be used for filter. Possible + * values include: 'Equals', 'NotEquals', 'In', 'NotIn' + * @property {array} values List of filter values. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/runQueryOrderBy.js b/lib/services/datafactoryManagement/lib/models/runQueryOrderBy.js index fd3e86097c..8d665c87ca 100644 --- a/lib/services/datafactoryManagement/lib/models/runQueryOrderBy.js +++ b/lib/services/datafactoryManagement/lib/models/runQueryOrderBy.js @@ -17,14 +17,14 @@ class RunQueryOrderBy { /** * Create a RunQueryOrderBy. - * @member {string} orderBy Parameter name to be used for order by. The + * @property {string} orderBy Parameter name to be used for order by. The * allowed parameters to order by for pipeline runs are PipelineName, * RunStart, RunEnd and Status; for activity runs are ActivityName, * ActivityRunStart, ActivityRunEnd and Status; for trigger runs are * TriggerName, TriggerRunTimestamp and Status. Possible values include: * 'RunStart', 'RunEnd', 'PipelineName', 'Status', 'ActivityName', * 'ActivityRunStart', 'ActivityRunEnd', 'TriggerName', 'TriggerRunTimestamp' - * @member {string} order Sorting order of the parameter. Possible values + * @property {string} order Sorting order of the parameter. Possible values * include: 'ASC', 'DESC' */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/sSISExecutionParameter.js b/lib/services/datafactoryManagement/lib/models/sSISExecutionParameter.js index d74ade25b1..5cecb5d0af 100644 --- a/lib/services/datafactoryManagement/lib/models/sSISExecutionParameter.js +++ b/lib/services/datafactoryManagement/lib/models/sSISExecutionParameter.js @@ -17,7 +17,7 @@ class SSISExecutionParameter { /** * Create a SSISExecutionParameter. - * @member {object} value SSIS package execution parameter value. Type: + * @property {object} value SSIS package execution parameter value. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/sSISPackageLocation.js b/lib/services/datafactoryManagement/lib/models/sSISPackageLocation.js index 55392c698b..03d330ff6b 100644 --- a/lib/services/datafactoryManagement/lib/models/sSISPackageLocation.js +++ b/lib/services/datafactoryManagement/lib/models/sSISPackageLocation.js @@ -17,7 +17,7 @@ class SSISPackageLocation { /** * Create a SSISPackageLocation. - * @member {string} packagePath The SSIS package path. + * @property {string} packagePath The SSIS package path. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/sSISPropertyOverride.js b/lib/services/datafactoryManagement/lib/models/sSISPropertyOverride.js index 7b54b21d53..ed1cbc7c62 100644 --- a/lib/services/datafactoryManagement/lib/models/sSISPropertyOverride.js +++ b/lib/services/datafactoryManagement/lib/models/sSISPropertyOverride.js @@ -17,9 +17,9 @@ class SSISPropertyOverride { /** * Create a SSISPropertyOverride. - * @member {object} value SSIS package property override value. Type: string - * (or Expression with resultType string). - * @member {boolean} [isSensitive] Whether SSIS package property override + * @property {object} value SSIS package property override value. Type: + * string (or Expression with resultType string). + * @property {boolean} [isSensitive] Whether SSIS package property override * value is sensitive data. Value will be encrypted in SSISDB if it is true */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/salesforceLinkedService.js b/lib/services/datafactoryManagement/lib/models/salesforceLinkedService.js index 4ac04f20ac..bc51e43658 100644 --- a/lib/services/datafactoryManagement/lib/models/salesforceLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/salesforceLinkedService.js @@ -20,20 +20,20 @@ const models = require('./index'); class SalesforceLinkedService extends models['LinkedService'] { /** * Create a SalesforceLinkedService. - * @member {object} [environmentUrl] The URL of Salesforce instance. Default - * is 'https://login.salesforce.com'. To copy data from sandbox, specify - * 'https://test.salesforce.com'. To copy data from custom domain, specify, - * for example, 'https://[domain].my.salesforce.com'. Type: string (or - * Expression with resultType string). - * @member {object} [username] The username for Basic authentication of the + * @property {object} [environmentUrl] The URL of Salesforce instance. + * Default is 'https://login.salesforce.com'. To copy data from sandbox, + * specify 'https://test.salesforce.com'. To copy data from custom domain, + * specify, for example, 'https://[domain].my.salesforce.com'. Type: string + * (or Expression with resultType string). + * @property {object} [username] The username for Basic authentication of the * Salesforce instance. Type: string (or Expression with resultType string). - * @member {object} [password] The password for Basic authentication of the + * @property {object} [password] The password for Basic authentication of the * Salesforce instance. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [securityToken] The security token is required to + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [securityToken] The security token is required to * remotely access Salesforce instance. - * @member {string} [securityToken.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {string} [securityToken.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudLinkedService.js b/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudLinkedService.js index fec1c08d77..6fe0f8091c 100644 --- a/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudLinkedService.js @@ -20,24 +20,24 @@ const models = require('./index'); class SalesforceMarketingCloudLinkedService extends models['LinkedService'] { /** * Create a SalesforceMarketingCloudLinkedService. - * @member {object} clientId The client ID associated with the Salesforce + * @property {object} clientId The client ID associated with the Salesforce * Marketing Cloud application. Type: string (or Expression with resultType * string). - * @member {object} [clientSecret] The client secret associated with the + * @property {object} [clientSecret] The client secret associated with the * Salesforce Marketing Cloud application. Type: string (or Expression with * resultType string). - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. Type: - * boolean (or Expression with resultType boolean). - * @member {object} [useHostVerification] Specifies whether to require the + * @property {string} [clientSecret.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * Type: boolean (or Expression with resultType boolean). + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. Type: boolean (or * Expression with resultType boolean). - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. Type: boolean (or Expression with resultType boolean). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudObjectDataset.js b/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudObjectDataset.js index e0897d6b1e..f36d3748cd 100644 --- a/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class SalesforceMarketingCloudObjectDataset extends models['Dataset'] { /** * Create a SalesforceMarketingCloudObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudSource.js b/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudSource.js index 91b7b84bb9..8e3780fc44 100644 --- a/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudSource.js +++ b/lib/services/datafactoryManagement/lib/models/salesforceMarketingCloudSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class SalesforceMarketingCloudSource extends models['CopySource'] { /** * Create a SalesforceMarketingCloudSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/salesforceObjectDataset.js b/lib/services/datafactoryManagement/lib/models/salesforceObjectDataset.js index 2f5beaf301..3a6a16b04e 100644 --- a/lib/services/datafactoryManagement/lib/models/salesforceObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/salesforceObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class SalesforceObjectDataset extends models['Dataset'] { /** * Create a SalesforceObjectDataset. - * @member {object} [objectApiName] The Salesforce object API name. Type: + * @property {object} [objectApiName] The Salesforce object API name. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/salesforceSink.js b/lib/services/datafactoryManagement/lib/models/salesforceSink.js index c790becb2a..aef162648d 100644 --- a/lib/services/datafactoryManagement/lib/models/salesforceSink.js +++ b/lib/services/datafactoryManagement/lib/models/salesforceSink.js @@ -20,13 +20,13 @@ const models = require('./index'); class SalesforceSink extends models['CopySink'] { /** * Create a SalesforceSink. - * @member {string} [writeBehavior] The write behavior for the operation. + * @property {string} [writeBehavior] The write behavior for the operation. * Default is Insert. Possible values include: 'Insert', 'Upsert' - * @member {object} [externalIdFieldName] The name of the external ID field + * @property {object} [externalIdFieldName] The name of the external ID field * for upsert operation. Default value is 'Id' column. Type: string (or * Expression with resultType string). - * @member {object} [ignoreNullValues] The flag indicating whether or not to - * ignore null values from input dataset (except key fields) during write + * @property {object} [ignoreNullValues] The flag indicating whether or not + * to ignore null values from input dataset (except key fields) during write * operation. Default value is false. If set it to true, it means ADF will * leave the data in the destination object unchanged when doing * upsert/update operation and insert defined default value when doing insert diff --git a/lib/services/datafactoryManagement/lib/models/salesforceSource.js b/lib/services/datafactoryManagement/lib/models/salesforceSource.js index 579ca4467e..147bb9c65f 100644 --- a/lib/services/datafactoryManagement/lib/models/salesforceSource.js +++ b/lib/services/datafactoryManagement/lib/models/salesforceSource.js @@ -20,9 +20,9 @@ const models = require('./index'); class SalesforceSource extends models['CopySource'] { /** * Create a SalesforceSource. - * @member {object} [query] Database query. Type: string (or Expression with - * resultType string). - * @member {string} [readBehavior] The read behavior for the operation. + * @property {object} [query] Database query. Type: string (or Expression + * with resultType string). + * @property {string} [readBehavior] The read behavior for the operation. * Default is Query. Possible values include: 'Query', 'QueryAll' */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/sapBWLinkedService.js b/lib/services/datafactoryManagement/lib/models/sapBWLinkedService.js index a4574122b2..e7c81ad984 100644 --- a/lib/services/datafactoryManagement/lib/models/sapBWLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/sapBWLinkedService.js @@ -20,19 +20,19 @@ const models = require('./index'); class SapBWLinkedService extends models['LinkedService'] { /** * Create a SapBWLinkedService. - * @member {object} server Host name of the SAP BW instance. Type: string (or - * Expression with resultType string). - * @member {object} systemNumber System number of the BW system. (Usually a + * @property {object} server Host name of the SAP BW instance. Type: string + * (or Expression with resultType string). + * @property {object} systemNumber System number of the BW system. (Usually a * two-digit decimal number represented as a string.) Type: string (or * Expression with resultType string). - * @member {object} clientId Client ID of the client on the BW system. + * @property {object} clientId Client ID of the client on the BW system. * (Usually a three-digit decimal number represented as a string) Type: * string (or Expression with resultType string). - * @member {object} [userName] Username to access the SAP BW server. Type: + * @property {object} [userName] Username to access the SAP BW server. Type: * string (or Expression with resultType string). - * @member {object} [password] Password to access the SAP BW server. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [password] Password to access the SAP BW server. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerLinkedService.js b/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerLinkedService.js index 909a12d1f1..bd17d39cd7 100644 --- a/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerLinkedService.js @@ -20,14 +20,14 @@ const models = require('./index'); class SapCloudForCustomerLinkedService extends models['LinkedService'] { /** * Create a SapCloudForCustomerLinkedService. - * @member {object} url The URL of SAP Cloud for Customer OData API. For + * @property {object} url The URL of SAP Cloud for Customer OData API. For * example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: * string (or Expression with resultType string). - * @member {object} [username] The username for Basic authentication. Type: + * @property {object} [username] The username for Basic authentication. Type: * string (or Expression with resultType string). - * @member {object} [password] The password for Basic authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [password] The password for Basic authentication. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Either encryptedCredential or username/password must * be provided. Type: string (or Expression with resultType string). diff --git a/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerResourceDataset.js b/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerResourceDataset.js index fdd1a2734c..6038f05726 100644 --- a/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerResourceDataset.js +++ b/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerResourceDataset.js @@ -20,8 +20,8 @@ const models = require('./index'); class SapCloudForCustomerResourceDataset extends models['Dataset'] { /** * Create a SapCloudForCustomerResourceDataset. - * @member {object} path The path of the SAP Cloud for Customer OData entity. - * Type: string (or Expression with resultType string). + * @property {object} path The path of the SAP Cloud for Customer OData + * entity. Type: string (or Expression with resultType string). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerSink.js b/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerSink.js index 354c0552ac..e54988b153 100644 --- a/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerSink.js +++ b/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerSink.js @@ -20,7 +20,7 @@ const models = require('./index'); class SapCloudForCustomerSink extends models['CopySink'] { /** * Create a SapCloudForCustomerSink. - * @member {string} [writeBehavior] The write behavior for the operation. + * @property {string} [writeBehavior] The write behavior for the operation. * Default is 'Insert'. Possible values include: 'Insert', 'Update' */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerSource.js b/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerSource.js index 84c60656b8..13a59066fb 100644 --- a/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerSource.js +++ b/lib/services/datafactoryManagement/lib/models/sapCloudForCustomerSource.js @@ -20,8 +20,8 @@ const models = require('./index'); class SapCloudForCustomerSource extends models['CopySource'] { /** * Create a SapCloudForCustomerSource. - * @member {object} [query] SAP Cloud for Customer OData query. For example, - * "$top=1". Type: string (or Expression with resultType string). + * @property {object} [query] SAP Cloud for Customer OData query. For + * example, "$top=1". Type: string (or Expression with resultType string). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/sapEccLinkedService.js b/lib/services/datafactoryManagement/lib/models/sapEccLinkedService.js index 4bd036ec0a..6dd348a14b 100644 --- a/lib/services/datafactoryManagement/lib/models/sapEccLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/sapEccLinkedService.js @@ -20,14 +20,14 @@ const models = require('./index'); class SapEccLinkedService extends models['LinkedService'] { /** * Create a SapEccLinkedService. - * @member {string} url The URL of SAP ECC OData API. For example, + * @property {string} url The URL of SAP ECC OData API. For example, * '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or * Expression with resultType string). - * @member {string} [username] The username for Basic authentication. Type: + * @property {string} [username] The username for Basic authentication. Type: * string (or Expression with resultType string). - * @member {object} [password] The password for Basic authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {string} [encryptedCredential] The encrypted credential used for + * @property {object} [password] The password for Basic authentication. + * @property {string} [password.type] Polymorphic Discriminator + * @property {string} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Either encryptedCredential or username/password must * be provided. Type: string (or Expression with resultType string). diff --git a/lib/services/datafactoryManagement/lib/models/sapEccResourceDataset.js b/lib/services/datafactoryManagement/lib/models/sapEccResourceDataset.js index 8a67d10c19..7de41f4f97 100644 --- a/lib/services/datafactoryManagement/lib/models/sapEccResourceDataset.js +++ b/lib/services/datafactoryManagement/lib/models/sapEccResourceDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class SapEccResourceDataset extends models['Dataset'] { /** * Create a SapEccResourceDataset. - * @member {string} path The path of the SAP ECC OData entity. Type: string + * @property {string} path The path of the SAP ECC OData entity. Type: string * (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/sapEccSource.js b/lib/services/datafactoryManagement/lib/models/sapEccSource.js index 0c03f52ef3..a27841d9ef 100644 --- a/lib/services/datafactoryManagement/lib/models/sapEccSource.js +++ b/lib/services/datafactoryManagement/lib/models/sapEccSource.js @@ -20,8 +20,8 @@ const models = require('./index'); class SapEccSource extends models['CopySource'] { /** * Create a SapEccSource. - * @member {string} [query] SAP ECC OData query. For example, "$top=1". Type: - * string (or Expression with resultType string). + * @property {string} [query] SAP ECC OData query. For example, "$top=1". + * Type: string (or Expression with resultType string). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/sapHanaLinkedService.js b/lib/services/datafactoryManagement/lib/models/sapHanaLinkedService.js index 32236e2d52..b204fd0658 100644 --- a/lib/services/datafactoryManagement/lib/models/sapHanaLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/sapHanaLinkedService.js @@ -20,16 +20,16 @@ const models = require('./index'); class SapHanaLinkedService extends models['LinkedService'] { /** * Create a SapHanaLinkedService. - * @member {object} server Host name of the SAP HANA server. Type: string (or - * Expression with resultType string). - * @member {string} [authenticationType] The authentication type to be used + * @property {object} server Host name of the SAP HANA server. Type: string + * (or Expression with resultType string). + * @property {string} [authenticationType] The authentication type to be used * to connect to the SAP HANA server. Possible values include: 'Basic', * 'Windows' - * @member {object} [userName] Username to access the SAP HANA server. Type: - * string (or Expression with resultType string). - * @member {object} [password] Password to access the SAP HANA server. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [userName] Username to access the SAP HANA server. + * Type: string (or Expression with resultType string). + * @property {object} [password] Password to access the SAP HANA server. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/scheduleTrigger.js b/lib/services/datafactoryManagement/lib/models/scheduleTrigger.js index 185df95067..9d5a668b0d 100644 --- a/lib/services/datafactoryManagement/lib/models/scheduleTrigger.js +++ b/lib/services/datafactoryManagement/lib/models/scheduleTrigger.js @@ -20,19 +20,19 @@ const models = require('./index'); class ScheduleTrigger extends models['MultiplePipelineTrigger'] { /** * Create a ScheduleTrigger. - * @member {object} recurrence Recurrence schedule configuration. - * @member {string} [recurrence.frequency] The frequency. Possible values + * @property {object} recurrence Recurrence schedule configuration. + * @property {string} [recurrence.frequency] The frequency. Possible values * include: 'NotSpecified', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year' - * @member {number} [recurrence.interval] The interval. - * @member {date} [recurrence.startTime] The start time. - * @member {date} [recurrence.endTime] The end time. - * @member {string} [recurrence.timeZone] The time zone. - * @member {object} [recurrence.schedule] The recurrence schedule. - * @member {array} [recurrence.schedule.minutes] The minutes. - * @member {array} [recurrence.schedule.hours] The hours. - * @member {array} [recurrence.schedule.weekDays] The days of the week. - * @member {array} [recurrence.schedule.monthDays] The month days. - * @member {array} [recurrence.schedule.monthlyOccurrences] The monthly + * @property {number} [recurrence.interval] The interval. + * @property {date} [recurrence.startTime] The start time. + * @property {date} [recurrence.endTime] The end time. + * @property {string} [recurrence.timeZone] The time zone. + * @property {object} [recurrence.schedule] The recurrence schedule. + * @property {array} [recurrence.schedule.minutes] The minutes. + * @property {array} [recurrence.schedule.hours] The hours. + * @property {array} [recurrence.schedule.weekDays] The days of the week. + * @property {array} [recurrence.schedule.monthDays] The month days. + * @property {array} [recurrence.schedule.monthlyOccurrences] The monthly * occurrences. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/scheduleTriggerRecurrence.js b/lib/services/datafactoryManagement/lib/models/scheduleTriggerRecurrence.js index 242369efe8..d085ca4168 100644 --- a/lib/services/datafactoryManagement/lib/models/scheduleTriggerRecurrence.js +++ b/lib/services/datafactoryManagement/lib/models/scheduleTriggerRecurrence.js @@ -17,18 +17,18 @@ class ScheduleTriggerRecurrence { /** * Create a ScheduleTriggerRecurrence. - * @member {string} [frequency] The frequency. Possible values include: + * @property {string} [frequency] The frequency. Possible values include: * 'NotSpecified', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year' - * @member {number} [interval] The interval. - * @member {date} [startTime] The start time. - * @member {date} [endTime] The end time. - * @member {string} [timeZone] The time zone. - * @member {object} [schedule] The recurrence schedule. - * @member {array} [schedule.minutes] The minutes. - * @member {array} [schedule.hours] The hours. - * @member {array} [schedule.weekDays] The days of the week. - * @member {array} [schedule.monthDays] The month days. - * @member {array} [schedule.monthlyOccurrences] The monthly occurrences. + * @property {number} [interval] The interval. + * @property {date} [startTime] The start time. + * @property {date} [endTime] The end time. + * @property {string} [timeZone] The time zone. + * @property {object} [schedule] The recurrence schedule. + * @property {array} [schedule.minutes] The minutes. + * @property {array} [schedule.hours] The hours. + * @property {array} [schedule.weekDays] The days of the week. + * @property {array} [schedule.monthDays] The month days. + * @property {array} [schedule.monthlyOccurrences] The monthly occurrences. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/scriptAction.js b/lib/services/datafactoryManagement/lib/models/scriptAction.js index 4fc07a67fd..56f9af9bd1 100644 --- a/lib/services/datafactoryManagement/lib/models/scriptAction.js +++ b/lib/services/datafactoryManagement/lib/models/scriptAction.js @@ -17,11 +17,11 @@ class ScriptAction { /** * Create a ScriptAction. - * @member {string} name The user provided name of the script action. - * @member {string} uri The URI for the script action. - * @member {object} roles The node types on which the script action should be - * executed. - * @member {string} [parameters] The parameters for the script action. + * @property {string} name The user provided name of the script action. + * @property {string} uri The URI for the script action. + * @property {object} roles The node types on which the script action should + * be executed. + * @property {string} [parameters] The parameters for the script action. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/secretBase.js b/lib/services/datafactoryManagement/lib/models/secretBase.js index 58ab3a67a2..05b098543b 100644 --- a/lib/services/datafactoryManagement/lib/models/secretBase.js +++ b/lib/services/datafactoryManagement/lib/models/secretBase.js @@ -17,7 +17,7 @@ class SecretBase { /** * Create a SecretBase. - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/secureString.js b/lib/services/datafactoryManagement/lib/models/secureString.js index 1df97aaa80..0f7db14046 100644 --- a/lib/services/datafactoryManagement/lib/models/secureString.js +++ b/lib/services/datafactoryManagement/lib/models/secureString.js @@ -21,7 +21,7 @@ const models = require('./index'); class SecureString extends models['SecretBase'] { /** * Create a SecureString. - * @member {string} value Value of secure string. + * @property {string} value Value of secure string. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/selfDependencyTumblingWindowTriggerReference.js b/lib/services/datafactoryManagement/lib/models/selfDependencyTumblingWindowTriggerReference.js index bcf04d7a7e..5b9979ef29 100644 --- a/lib/services/datafactoryManagement/lib/models/selfDependencyTumblingWindowTriggerReference.js +++ b/lib/services/datafactoryManagement/lib/models/selfDependencyTumblingWindowTriggerReference.js @@ -20,9 +20,9 @@ const models = require('./index'); class SelfDependencyTumblingWindowTriggerReference extends models['DependencyReference'] { /** * Create a SelfDependencyTumblingWindowTriggerReference. - * @member {string} offset Timespan applied to the start time of a tumbling + * @property {string} offset Timespan applied to the start time of a tumbling * window when evaluating dependency. - * @member {string} [size] The size of the window when evaluating the + * @property {string} [size] The size of the window when evaluating the * dependency. If undefined the frequency of the tumbling window will be * used. */ diff --git a/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntime.js b/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntime.js index b3d67f9fd0..9db50770d2 100644 --- a/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntime.js +++ b/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntime.js @@ -20,8 +20,9 @@ const models = require('./index'); class SelfHostedIntegrationRuntime extends models['IntegrationRuntime'] { /** * Create a SelfHostedIntegrationRuntime. - * @member {object} [linkedInfo] - * @member {string} [linkedInfo.authorizationType] Polymorphic Discriminator + * @property {object} [linkedInfo] + * @property {string} [linkedInfo.authorizationType] Polymorphic + * Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntimeNode.js b/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntimeNode.js index 1631a5ba75..9ac3d2147b 100644 --- a/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntimeNode.js +++ b/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntimeNode.js @@ -17,38 +17,39 @@ class SelfHostedIntegrationRuntimeNode { /** * Create a SelfHostedIntegrationRuntimeNode. - * @member {string} [nodeName] Name of the integration runtime node. - * @member {string} [machineName] Machine name of the integration runtime + * @property {string} [nodeName] Name of the integration runtime node. + * @property {string} [machineName] Machine name of the integration runtime * node. - * @member {string} [hostServiceUri] URI for the host machine of the + * @property {string} [hostServiceUri] URI for the host machine of the * integration runtime. - * @member {string} [status] Status of the integration runtime node. Possible - * values include: 'NeedRegistration', 'Online', 'Limited', 'Offline', - * 'Upgrading', 'Initializing', 'InitializeFailed' - * @member {object} [capabilities] The integration runtime capabilities + * @property {string} [status] Status of the integration runtime node. + * Possible values include: 'NeedRegistration', 'Online', 'Limited', + * 'Offline', 'Upgrading', 'Initializing', 'InitializeFailed' + * @property {object} [capabilities] The integration runtime capabilities * dictionary - * @member {string} [versionStatus] Status of the integration runtime node + * @property {string} [versionStatus] Status of the integration runtime node * version. - * @member {string} [version] Version of the integration runtime node. - * @member {date} [registerTime] The time at which the integration runtime + * @property {string} [version] Version of the integration runtime node. + * @property {date} [registerTime] The time at which the integration runtime * node was registered in ISO8601 format. - * @member {date} [lastConnectTime] The most recent time at which the + * @property {date} [lastConnectTime] The most recent time at which the * integration runtime was connected in ISO8601 format. - * @member {date} [expiryTime] The time at which the integration runtime will - * expire in ISO8601 format. - * @member {date} [lastStartTime] The time the node last started up. - * @member {date} [lastStopTime] The integration runtime node last stop time. - * @member {string} [lastUpdateResult] The result of the last integration + * @property {date} [expiryTime] The time at which the integration runtime + * will expire in ISO8601 format. + * @property {date} [lastStartTime] The time the node last started up. + * @property {date} [lastStopTime] The integration runtime node last stop + * time. + * @property {string} [lastUpdateResult] The result of the last integration * runtime node update. Possible values include: 'None', 'Succeed', 'Fail' - * @member {date} [lastStartUpdateTime] The last time for the integration + * @property {date} [lastStartUpdateTime] The last time for the integration * runtime node update start. - * @member {date} [lastEndUpdateTime] The last time for the integration + * @property {date} [lastEndUpdateTime] The last time for the integration * runtime node update end. - * @member {boolean} [isActiveDispatcher] Indicates whether this node is the - * active dispatcher for integration runtime requests. - * @member {number} [concurrentJobsLimit] Maximum concurrent jobs on the + * @property {boolean} [isActiveDispatcher] Indicates whether this node is + * the active dispatcher for integration runtime requests. + * @property {number} [concurrentJobsLimit] Maximum concurrent jobs on the * integration runtime node. - * @member {number} [maxConcurrentJobs] The maximum concurrent jobs in this + * @property {number} [maxConcurrentJobs] The maximum concurrent jobs in this * integration runtime. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntimeStatus.js b/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntimeStatus.js index 90e39520b5..28f3f2e55b 100644 --- a/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntimeStatus.js +++ b/lib/services/datafactoryManagement/lib/models/selfHostedIntegrationRuntimeStatus.js @@ -20,36 +20,36 @@ const models = require('./index'); class SelfHostedIntegrationRuntimeStatus extends models['IntegrationRuntimeStatus'] { /** * Create a SelfHostedIntegrationRuntimeStatus. - * @member {date} [createTime] The time at which the integration runtime was - * created, in ISO8601 format. - * @member {string} [taskQueueId] The task queue id of the integration + * @property {date} [createTime] The time at which the integration runtime + * was created, in ISO8601 format. + * @property {string} [taskQueueId] The task queue id of the integration * runtime. - * @member {string} [internalChannelEncryption] It is used to set the + * @property {string} [internalChannelEncryption] It is used to set the * encryption mode for node-node communication channel (when more than 2 * self-hosted integration runtime nodes exist). Possible values include: * 'NotSet', 'SslEncrypted', 'NotEncrypted' - * @member {string} [version] Version of the integration runtime. - * @member {array} [nodes] The list of nodes for this integration runtime. - * @member {date} [scheduledUpdateDate] The date at which the integration + * @property {string} [version] Version of the integration runtime. + * @property {array} [nodes] The list of nodes for this integration runtime. + * @property {date} [scheduledUpdateDate] The date at which the integration * runtime will be scheduled to update, in ISO8601 format. - * @member {string} [updateDelayOffset] The time in the date scheduled by + * @property {string} [updateDelayOffset] The time in the date scheduled by * service to update the integration runtime, e.g., PT03H is 3 hours - * @member {string} [localTimeZoneOffset] The local time zone offset in + * @property {string} [localTimeZoneOffset] The local time zone offset in * hours. - * @member {object} [capabilities] Object with additional information about + * @property {object} [capabilities] Object with additional information about * integration runtime capabilities. - * @member {array} [serviceUrls] The URLs for the services used in + * @property {array} [serviceUrls] The URLs for the services used in * integration runtime backend service. - * @member {string} [autoUpdate] Whether Self-hosted integration runtime auto - * update has been turned on. Possible values include: 'On', 'Off' - * @member {string} [versionStatus] Status of the integration runtime + * @property {string} [autoUpdate] Whether Self-hosted integration runtime + * auto update has been turned on. Possible values include: 'On', 'Off' + * @property {string} [versionStatus] Status of the integration runtime * version. - * @member {array} [links] The list of linked integration runtimes that are + * @property {array} [links] The list of linked integration runtimes that are * created to share with this integration runtime. - * @member {string} [pushedVersion] The version that the integration runtime - * is going to update to. - * @member {string} [latestVersion] The latest version on download center. - * @member {date} [autoUpdateETA] The estimated time when the self-hosted + * @property {string} [pushedVersion] The version that the integration + * runtime is going to update to. + * @property {string} [latestVersion] The latest version on download center. + * @property {date} [autoUpdateETA] The estimated time when the self-hosted * integration runtime will be updated. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/serviceNowLinkedService.js b/lib/services/datafactoryManagement/lib/models/serviceNowLinkedService.js index 51dce7e1ef..e33dc25642 100644 --- a/lib/services/datafactoryManagement/lib/models/serviceNowLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/serviceNowLinkedService.js @@ -20,28 +20,28 @@ const models = require('./index'); class ServiceNowLinkedService extends models['LinkedService'] { /** * Create a ServiceNowLinkedService. - * @member {object} endpoint The endpoint of the ServiceNow server. (i.e. + * @property {object} endpoint The endpoint of the ServiceNow server. (i.e. * .service-now.com) - * @member {string} authenticationType The authentication type to use. + * @property {string} authenticationType The authentication type to use. * Possible values include: 'Basic', 'OAuth2' - * @member {object} [username] The user name used to connect to the + * @property {object} [username] The user name used to connect to the * ServiceNow server for Basic and OAuth2 authentication. - * @member {object} [password] The password corresponding to the user name + * @property {object} [password] The password corresponding to the user name * for Basic and OAuth2 authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [clientId] The client id for OAuth2 authentication. - * @member {object} [clientSecret] The client secret for OAuth2 + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [clientId] The client id for OAuth2 authentication. + * @property {object} [clientSecret] The client secret for OAuth2 * authentication. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {string} [clientSecret.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/serviceNowObjectDataset.js b/lib/services/datafactoryManagement/lib/models/serviceNowObjectDataset.js index 5af6358e34..178b7ebc62 100644 --- a/lib/services/datafactoryManagement/lib/models/serviceNowObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/serviceNowObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class ServiceNowObjectDataset extends models['Dataset'] { /** * Create a ServiceNowObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/serviceNowSource.js b/lib/services/datafactoryManagement/lib/models/serviceNowSource.js index 1c57739010..439cc2da75 100644 --- a/lib/services/datafactoryManagement/lib/models/serviceNowSource.js +++ b/lib/services/datafactoryManagement/lib/models/serviceNowSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class ServiceNowSource extends models['CopySource'] { /** * Create a ServiceNowSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/setVariableActivity.js b/lib/services/datafactoryManagement/lib/models/setVariableActivity.js index cd4a98ca71..2cc6ae77c1 100644 --- a/lib/services/datafactoryManagement/lib/models/setVariableActivity.js +++ b/lib/services/datafactoryManagement/lib/models/setVariableActivity.js @@ -20,9 +20,9 @@ const models = require('./index'); class SetVariableActivity extends models['ControlActivity'] { /** * Create a SetVariableActivity. - * @member {string} [variableName] Name of the variable whose value needs to - * be set. - * @member {object} [value] Value to be set. Could be a static value or + * @property {string} [variableName] Name of the variable whose value needs + * to be set. + * @property {object} [value] Value to be set. Could be a static value or * Expression */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/sftpServerLinkedService.js b/lib/services/datafactoryManagement/lib/models/sftpServerLinkedService.js index 3c705ccf50..ae851f1298 100644 --- a/lib/services/datafactoryManagement/lib/models/sftpServerLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/sftpServerLinkedService.js @@ -20,39 +20,39 @@ const models = require('./index'); class SftpServerLinkedService extends models['LinkedService'] { /** * Create a SftpServerLinkedService. - * @member {object} host The SFTP server host name. Type: string (or + * @property {object} host The SFTP server host name. Type: string (or * Expression with resultType string). - * @member {object} [port] The TCP port number that the SFTP server uses to + * @property {object} [port] The TCP port number that the SFTP server uses to * listen for client connections. Default value is 22. Type: integer (or * Expression with resultType integer), minimum: 0. - * @member {string} [authenticationType] The authentication type to be used + * @property {string} [authenticationType] The authentication type to be used * to connect to the FTP server. Possible values include: 'Basic', * 'SshPublicKey' - * @member {object} [userName] The username used to log on to the SFTP + * @property {object} [userName] The username used to log on to the SFTP * server. Type: string (or Expression with resultType string). - * @member {object} [password] Password to logon the SFTP server for Basic + * @property {object} [password] Password to logon the SFTP server for Basic * authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). - * @member {object} [privateKeyPath] The SSH private key file path for + * @property {object} [privateKeyPath] The SSH private key file path for * SshPublicKey authentication. Only valid for on-premises copy. For * on-premises copy with SshPublicKey authentication, either PrivateKeyPath * or PrivateKeyContent should be specified. SSH private key should be * OpenSSH format. Type: string (or Expression with resultType string). - * @member {object} [privateKeyContent] Base64 encoded SSH private key + * @property {object} [privateKeyContent] Base64 encoded SSH private key * content for SshPublicKey authentication. For on-premises copy with * SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent * should be specified. SSH private key should be OpenSSH format. - * @member {string} [privateKeyContent.type] Polymorphic Discriminator - * @member {object} [passPhrase] The password to decrypt the SSH private key - * if the SSH private key is encrypted. - * @member {string} [passPhrase.type] Polymorphic Discriminator - * @member {object} [skipHostKeyValidation] If true, skip the SSH host key + * @property {string} [privateKeyContent.type] Polymorphic Discriminator + * @property {object} [passPhrase] The password to decrypt the SSH private + * key if the SSH private key is encrypted. + * @property {string} [passPhrase.type] Polymorphic Discriminator + * @property {object} [skipHostKeyValidation] If true, skip the SSH host key * validation. Default value is false. Type: boolean (or Expression with * resultType boolean). - * @member {object} [hostKeyFingerprint] The host key finger-print of the + * @property {object} [hostKeyFingerprint] The host key finger-print of the * SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint * should be specified. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/shopifyLinkedService.js b/lib/services/datafactoryManagement/lib/models/shopifyLinkedService.js index f8156cac8c..30e9112f16 100644 --- a/lib/services/datafactoryManagement/lib/models/shopifyLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/shopifyLinkedService.js @@ -13,27 +13,27 @@ const models = require('./index'); /** - * Shopify Serivce linked service. + * Shopify Service linked service. * * @extends models['LinkedService'] */ class ShopifyLinkedService extends models['LinkedService'] { /** * Create a ShopifyLinkedService. - * @member {object} host The endpoint of the Shopify server. (i.e. + * @property {object} host The endpoint of the Shopify server. (i.e. * mystore.myshopify.com) - * @member {object} [accessToken] The API access token that can be used to + * @property {object} [accessToken] The API access token that can be used to * access Shopify’s data. The token won't expire if it is offline mode. - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {string} [accessToken.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/shopifyObjectDataset.js b/lib/services/datafactoryManagement/lib/models/shopifyObjectDataset.js index 530a2e7aa0..eb1796ab64 100644 --- a/lib/services/datafactoryManagement/lib/models/shopifyObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/shopifyObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class ShopifyObjectDataset extends models['Dataset'] { /** * Create a ShopifyObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/shopifySource.js b/lib/services/datafactoryManagement/lib/models/shopifySource.js index f44e8bc57d..8054e684f4 100644 --- a/lib/services/datafactoryManagement/lib/models/shopifySource.js +++ b/lib/services/datafactoryManagement/lib/models/shopifySource.js @@ -20,7 +20,7 @@ const models = require('./index'); class ShopifySource extends models['CopySource'] { /** * Create a ShopifySource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/sparkLinkedService.js b/lib/services/datafactoryManagement/lib/models/sparkLinkedService.js index e5c4fc6e03..973c09e6e9 100644 --- a/lib/services/datafactoryManagement/lib/models/sparkLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/sparkLinkedService.js @@ -20,39 +20,39 @@ const models = require('./index'); class SparkLinkedService extends models['LinkedService'] { /** * Create a SparkLinkedService. - * @member {object} host IP address or host name of the Spark server - * @member {object} port The TCP port that the Spark server uses to listen + * @property {object} host IP address or host name of the Spark server + * @property {object} port The TCP port that the Spark server uses to listen * for client connections. - * @member {string} [serverType] The type of Spark server. Possible values + * @property {string} [serverType] The type of Spark server. Possible values * include: 'SharkServer', 'SharkServer2', 'SparkThriftServer' - * @member {string} [thriftTransportProtocol] The transport protocol to use + * @property {string} [thriftTransportProtocol] The transport protocol to use * in the Thrift layer. Possible values include: 'Binary', 'SASL', 'HTTP ' - * @member {string} authenticationType The authentication method used to + * @property {string} authenticationType The authentication method used to * access the Spark server. Possible values include: 'Anonymous', 'Username', * 'UsernameAndPassword', 'WindowsAzureHDInsightService' - * @member {object} [username] The user name that you use to access Spark + * @property {object} [username] The user name that you use to access Spark * Server. - * @member {object} [password] The password corresponding to the user name + * @property {object} [password] The password corresponding to the user name * that you provided in the Username field - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [httpPath] The partial URL corresponding to the Spark + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [httpPath] The partial URL corresponding to the Spark * server. - * @member {object} [enableSsl] Specifies whether the connections to the + * @property {object} [enableSsl] Specifies whether the connections to the * server are encrypted using SSL. The default value is false. - * @member {object} [trustedCertPath] The full path of the .pem file + * @property {object} [trustedCertPath] The full path of the .pem file * containing trusted CA certificates for verifying the server when * connecting over SSL. This property can only be set when using SSL on * self-hosted IR. The default value is the cacerts.pem file installed with * the IR. - * @member {object} [useSystemTrustStore] Specifies whether to use a CA + * @property {object} [useSystemTrustStore] Specifies whether to use a CA * certificate from the system trust store or from a specified PEM file. The * default value is false. - * @member {object} [allowHostNameCNMismatch] Specifies whether to require a - * CA-issued SSL certificate name to match the host name of the server when + * @property {object} [allowHostNameCNMismatch] Specifies whether to require + * a CA-issued SSL certificate name to match the host name of the server when * connecting over SSL. The default value is false. - * @member {object} [allowSelfSignedServerCert] Specifies whether to allow + * @property {object} [allowSelfSignedServerCert] Specifies whether to allow * self-signed certificates from the server. The default value is false. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/sparkObjectDataset.js b/lib/services/datafactoryManagement/lib/models/sparkObjectDataset.js index 69514d4639..23d9ae386b 100644 --- a/lib/services/datafactoryManagement/lib/models/sparkObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/sparkObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class SparkObjectDataset extends models['Dataset'] { /** * Create a SparkObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/sparkSource.js b/lib/services/datafactoryManagement/lib/models/sparkSource.js index 13b2ab636a..ce13a393bf 100644 --- a/lib/services/datafactoryManagement/lib/models/sparkSource.js +++ b/lib/services/datafactoryManagement/lib/models/sparkSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class SparkSource extends models['CopySource'] { /** * Create a SparkSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/sqlDWSink.js b/lib/services/datafactoryManagement/lib/models/sqlDWSink.js index de761daab0..5806f4b130 100644 --- a/lib/services/datafactoryManagement/lib/models/sqlDWSink.js +++ b/lib/services/datafactoryManagement/lib/models/sqlDWSink.js @@ -20,25 +20,25 @@ const models = require('./index'); class SqlDWSink extends models['CopySink'] { /** * Create a SqlDWSink. - * @member {object} [preCopyScript] SQL pre-copy script. Type: string (or + * @property {object} [preCopyScript] SQL pre-copy script. Type: string (or * Expression with resultType string). - * @member {object} [allowPolyBase] Indicates to use PolyBase to copy data + * @property {object} [allowPolyBase] Indicates to use PolyBase to copy data * into SQL Data Warehouse when applicable. Type: boolean (or Expression with * resultType boolean). - * @member {object} [polyBaseSettings] Specifies PolyBase-related settings + * @property {object} [polyBaseSettings] Specifies PolyBase-related settings * when allowPolyBase is true. - * @member {string} [polyBaseSettings.rejectType] Reject type. Possible + * @property {string} [polyBaseSettings.rejectType] Reject type. Possible * values include: 'value', 'percentage' - * @member {object} [polyBaseSettings.rejectValue] Specifies the value or the - * percentage of rows that can be rejected before the query fails. Type: + * @property {object} [polyBaseSettings.rejectValue] Specifies the value or + * the percentage of rows that can be rejected before the query fails. Type: * number (or Expression with resultType number), minimum: 0. - * @member {object} [polyBaseSettings.rejectSampleValue] Determines the + * @property {object} [polyBaseSettings.rejectSampleValue] Determines the * number of rows to attempt to retrieve before the PolyBase recalculates the * percentage of rejected rows. Type: integer (or Expression with resultType * integer), minimum: 0. - * @member {object} [polyBaseSettings.useTypeDefault] Specifies how to handle - * missing values in delimited text files when PolyBase retrieves data from - * the text file. Type: boolean (or Expression with resultType boolean). + * @property {object} [polyBaseSettings.useTypeDefault] Specifies how to + * handle missing values in delimited text files when PolyBase retrieves data + * from the text file. Type: boolean (or Expression with resultType boolean). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/sqlDWSource.js b/lib/services/datafactoryManagement/lib/models/sqlDWSource.js index 97aef33b9a..af1bd0cfe6 100644 --- a/lib/services/datafactoryManagement/lib/models/sqlDWSource.js +++ b/lib/services/datafactoryManagement/lib/models/sqlDWSource.js @@ -20,13 +20,13 @@ const models = require('./index'); class SqlDWSource extends models['CopySource'] { /** * Create a SqlDWSource. - * @member {object} [sqlReaderQuery] SQL Data Warehouse reader query. Type: + * @property {object} [sqlReaderQuery] SQL Data Warehouse reader query. Type: * string (or Expression with resultType string). - * @member {object} [sqlReaderStoredProcedureName] Name of the stored + * @property {object} [sqlReaderStoredProcedureName] Name of the stored * procedure for a SQL Data Warehouse source. This cannot be used at the same * time as SqlReaderQuery. Type: string (or Expression with resultType * string). - * @member {object} [storedProcedureParameters] Value and type setting for + * @property {object} [storedProcedureParameters] Value and type setting for * stored procedure parameters. Example: "{Parameter1: {value: "1", type: * "int"}}". Type: object (or Expression with resultType object), itemType: * StoredProcedureParameter. diff --git a/lib/services/datafactoryManagement/lib/models/sqlServerLinkedService.js b/lib/services/datafactoryManagement/lib/models/sqlServerLinkedService.js index 70102f7501..cf49f39a19 100644 --- a/lib/services/datafactoryManagement/lib/models/sqlServerLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/sqlServerLinkedService.js @@ -20,14 +20,14 @@ const models = require('./index'); class SqlServerLinkedService extends models['LinkedService'] { /** * Create a SqlServerLinkedService. - * @member {object} connectionString The connection string. Type: string, + * @property {object} connectionString The connection string. Type: string, * SecureString or AzureKeyVaultSecretReference. - * @member {object} [userName] The on-premises Windows authentication user + * @property {object} [userName] The on-premises Windows authentication user * name. Type: string (or Expression with resultType string). - * @member {object} [password] The on-premises Windows authentication + * @property {object} [password] The on-premises Windows authentication * password. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/sqlServerStoredProcedureActivity.js b/lib/services/datafactoryManagement/lib/models/sqlServerStoredProcedureActivity.js index b82aec1f1f..35ed813bfe 100644 --- a/lib/services/datafactoryManagement/lib/models/sqlServerStoredProcedureActivity.js +++ b/lib/services/datafactoryManagement/lib/models/sqlServerStoredProcedureActivity.js @@ -20,9 +20,9 @@ const models = require('./index'); class SqlServerStoredProcedureActivity extends models['ExecutionActivity'] { /** * Create a SqlServerStoredProcedureActivity. - * @member {object} storedProcedureName Stored procedure name. Type: string + * @property {object} storedProcedureName Stored procedure name. Type: string * (or Expression with resultType string). - * @member {object} [storedProcedureParameters] Value and type setting for + * @property {object} [storedProcedureParameters] Value and type setting for * stored procedure parameters. Example: "{Parameter1: {value: "1", type: * "int"}}". */ diff --git a/lib/services/datafactoryManagement/lib/models/sqlServerTableDataset.js b/lib/services/datafactoryManagement/lib/models/sqlServerTableDataset.js index 1b883fbe27..9959ee2b55 100644 --- a/lib/services/datafactoryManagement/lib/models/sqlServerTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/sqlServerTableDataset.js @@ -20,8 +20,8 @@ const models = require('./index'); class SqlServerTableDataset extends models['Dataset'] { /** * Create a SqlServerTableDataset. - * @member {object} tableName The table name of the SQL Server dataset. Type: - * string (or Expression with resultType string). + * @property {object} tableName The table name of the SQL Server dataset. + * Type: string (or Expression with resultType string). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/sqlSink.js b/lib/services/datafactoryManagement/lib/models/sqlSink.js index c4b1e68e30..91dac85fbe 100644 --- a/lib/services/datafactoryManagement/lib/models/sqlSink.js +++ b/lib/services/datafactoryManagement/lib/models/sqlSink.js @@ -20,13 +20,13 @@ const models = require('./index'); class SqlSink extends models['CopySink'] { /** * Create a SqlSink. - * @member {object} [sqlWriterStoredProcedureName] SQL writer stored + * @property {object} [sqlWriterStoredProcedureName] SQL writer stored * procedure name. Type: string (or Expression with resultType string). - * @member {object} [sqlWriterTableType] SQL writer table type. Type: string - * (or Expression with resultType string). - * @member {object} [preCopyScript] SQL pre-copy script. Type: string (or + * @property {object} [sqlWriterTableType] SQL writer table type. Type: + * string (or Expression with resultType string). + * @property {object} [preCopyScript] SQL pre-copy script. Type: string (or * Expression with resultType string). - * @member {object} [storedProcedureParameters] SQL stored procedure + * @property {object} [storedProcedureParameters] SQL stored procedure * parameters. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/sqlSource.js b/lib/services/datafactoryManagement/lib/models/sqlSource.js index 6ce8bb1f6e..e1c7222c6e 100644 --- a/lib/services/datafactoryManagement/lib/models/sqlSource.js +++ b/lib/services/datafactoryManagement/lib/models/sqlSource.js @@ -20,12 +20,12 @@ const models = require('./index'); class SqlSource extends models['CopySource'] { /** * Create a SqlSource. - * @member {object} [sqlReaderQuery] SQL reader query. Type: string (or + * @property {object} [sqlReaderQuery] SQL reader query. Type: string (or * Expression with resultType string). - * @member {object} [sqlReaderStoredProcedureName] Name of the stored + * @property {object} [sqlReaderStoredProcedureName] Name of the stored * procedure for a SQL Database source. This cannot be used at the same time * as SqlReaderQuery. Type: string (or Expression with resultType string). - * @member {object} [storedProcedureParameters] Value and type setting for + * @property {object} [storedProcedureParameters] Value and type setting for * stored procedure parameters. Example: "{Parameter1: {value: "1", type: * "int"}}". */ diff --git a/lib/services/datafactoryManagement/lib/models/squareLinkedService.js b/lib/services/datafactoryManagement/lib/models/squareLinkedService.js index 35c9de330d..e5a38ede43 100644 --- a/lib/services/datafactoryManagement/lib/models/squareLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/squareLinkedService.js @@ -13,31 +13,31 @@ const models = require('./index'); /** - * Square Serivce linked service. + * Square Service linked service. * * @extends models['LinkedService'] */ class SquareLinkedService extends models['LinkedService'] { /** * Create a SquareLinkedService. - * @member {object} host The URL of the Square instance. (i.e. + * @property {object} host The URL of the Square instance. (i.e. * mystore.mysquare.com) - * @member {object} clientId The client ID associated with your Square + * @property {object} clientId The client ID associated with your Square * application. - * @member {object} [clientSecret] The client secret associated with your + * @property {object} [clientSecret] The client secret associated with your * Square application. - * @member {string} [clientSecret.type] Polymorphic Discriminator - * @member {object} redirectUri The redirect URL assigned in the Square + * @property {string} [clientSecret.type] Polymorphic Discriminator + * @property {object} redirectUri The redirect URL assigned in the Square * application dashboard. (i.e. http://localhost:2500) - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/squareObjectDataset.js b/lib/services/datafactoryManagement/lib/models/squareObjectDataset.js index 555f504922..24f28d029d 100644 --- a/lib/services/datafactoryManagement/lib/models/squareObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/squareObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class SquareObjectDataset extends models['Dataset'] { /** * Create a SquareObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/squareSource.js b/lib/services/datafactoryManagement/lib/models/squareSource.js index b5286b6d34..aad14d325b 100644 --- a/lib/services/datafactoryManagement/lib/models/squareSource.js +++ b/lib/services/datafactoryManagement/lib/models/squareSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class SquareSource extends models['CopySource'] { /** * Create a SquareSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/stagingSettings.js b/lib/services/datafactoryManagement/lib/models/stagingSettings.js index ffe94eb2dc..8f95dff5e4 100644 --- a/lib/services/datafactoryManagement/lib/models/stagingSettings.js +++ b/lib/services/datafactoryManagement/lib/models/stagingSettings.js @@ -17,16 +17,16 @@ class StagingSettings { /** * Create a StagingSettings. - * @member {object} linkedServiceName Staging linked service reference. - * @member {string} [linkedServiceName.referenceName] Reference LinkedService - * name. - * @member {object} [linkedServiceName.parameters] Arguments for + * @property {object} linkedServiceName Staging linked service reference. + * @property {string} [linkedServiceName.referenceName] Reference + * LinkedService name. + * @property {object} [linkedServiceName.parameters] Arguments for * LinkedService. - * @member {object} [path] The path to storage for storing the interim data. - * Type: string (or Expression with resultType string). - * @member {object} [enableCompression] Specifies whether to use compression - * when copying data via an interim staging. Default value is false. Type: - * boolean (or Expression with resultType boolean). + * @property {object} [path] The path to storage for storing the interim + * data. Type: string (or Expression with resultType string). + * @property {object} [enableCompression] Specifies whether to use + * compression when copying data via an interim staging. Default value is + * false. Type: boolean (or Expression with resultType boolean). */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/storedProcedureParameter.js b/lib/services/datafactoryManagement/lib/models/storedProcedureParameter.js index 8ed255fe26..1d1af9ad0c 100644 --- a/lib/services/datafactoryManagement/lib/models/storedProcedureParameter.js +++ b/lib/services/datafactoryManagement/lib/models/storedProcedureParameter.js @@ -17,9 +17,9 @@ class StoredProcedureParameter { /** * Create a StoredProcedureParameter. - * @member {object} [value] Stored procedure parameter value. Type: string + * @property {object} [value] Stored procedure parameter value. Type: string * (or Expression with resultType string). - * @member {string} [type] Stored procedure parameter type. Possible values + * @property {string} [type] Stored procedure parameter type. Possible values * include: 'String', 'Int', 'Decimal', 'Guid', 'Boolean', 'Date' */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/subResource.js b/lib/services/datafactoryManagement/lib/models/subResource.js index c2aa120c1a..8f4cd06671 100644 --- a/lib/services/datafactoryManagement/lib/models/subResource.js +++ b/lib/services/datafactoryManagement/lib/models/subResource.js @@ -20,10 +20,10 @@ const models = require('./index'); class SubResource extends models['BaseResource'] { /** * Create a SubResource. - * @member {string} [id] The resource identifier. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. - * @member {string} [etag] Etag identifies change in the resource. + * @property {string} [id] The resource identifier. + * @property {string} [name] The resource name. + * @property {string} [type] The resource type. + * @property {string} [etag] Etag identifies change in the resource. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/sybaseLinkedService.js b/lib/services/datafactoryManagement/lib/models/sybaseLinkedService.js index 2328f3c040..78819d59d1 100644 --- a/lib/services/datafactoryManagement/lib/models/sybaseLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/sybaseLinkedService.js @@ -20,19 +20,19 @@ const models = require('./index'); class SybaseLinkedService extends models['LinkedService'] { /** * Create a SybaseLinkedService. - * @member {object} server Server name for connection. Type: string (or + * @property {object} server Server name for connection. Type: string (or * Expression with resultType string). - * @member {object} database Database name for connection. Type: string (or + * @property {object} database Database name for connection. Type: string (or * Expression with resultType string). - * @member {object} [schema] Schema name for connection. Type: string (or + * @property {object} [schema] Schema name for connection. Type: string (or * Expression with resultType string). - * @member {string} [authenticationType] AuthenticationType to be used for + * @property {string} [authenticationType] AuthenticationType to be used for * connection. Possible values include: 'Basic', 'Windows' - * @member {object} [username] Username for authentication. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password for authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [username] Username for authentication. Type: string + * (or Expression with resultType string). + * @property {object} [password] Password for authentication. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/tabularTranslator.js b/lib/services/datafactoryManagement/lib/models/tabularTranslator.js index 468a76db2e..f9e77380d0 100644 --- a/lib/services/datafactoryManagement/lib/models/tabularTranslator.js +++ b/lib/services/datafactoryManagement/lib/models/tabularTranslator.js @@ -20,13 +20,13 @@ const models = require('./index'); class TabularTranslator extends models['CopyTranslator'] { /** * Create a TabularTranslator. - * @member {object} [columnMappings] Column mappings. Example: "UserId: + * @property {object} [columnMappings] Column mappings. Example: "UserId: * MyUserId, Group: MyGroup, Name: MyName" Type: string (or Expression with * resultType string). - * @member {object} [schemaMapping] The schema mapping to map between tabular - * data and hierarchical data. Example: {"Column1": "$.Column1", "Column2": - * "$.Column2.Property1", "Column3": "$.Column2.Property2"}. Type: object (or - * Expression with resultType object). + * @property {object} [schemaMapping] The schema mapping to map between + * tabular data and hierarchical data. Example: {"Column1": "$.Column1", + * "Column2": "$.Column2.Property1", "Column3": "$.Column2.Property2"}. Type: + * object (or Expression with resultType object). */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/teradataLinkedService.js b/lib/services/datafactoryManagement/lib/models/teradataLinkedService.js index cbf57161a4..9533ae2082 100644 --- a/lib/services/datafactoryManagement/lib/models/teradataLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/teradataLinkedService.js @@ -20,15 +20,15 @@ const models = require('./index'); class TeradataLinkedService extends models['LinkedService'] { /** * Create a TeradataLinkedService. - * @member {object} server Server name for connection. Type: string (or + * @property {object} server Server name for connection. Type: string (or * Expression with resultType string). - * @member {string} [authenticationType] AuthenticationType to be used for + * @property {string} [authenticationType] AuthenticationType to be used for * connection. Possible values include: 'Basic', 'Windows' - * @member {object} [username] Username for authentication. Type: string (or - * Expression with resultType string). - * @member {object} [password] Password for authentication. - * @member {string} [password.type] Polymorphic Discriminator - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [username] Username for authentication. Type: string + * (or Expression with resultType string). + * @property {object} [password] Password for authentication. + * @property {string} [password.type] Polymorphic Discriminator + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/textFormat.js b/lib/services/datafactoryManagement/lib/models/textFormat.js index 4d04418829..9d40374b3d 100644 --- a/lib/services/datafactoryManagement/lib/models/textFormat.js +++ b/lib/services/datafactoryManagement/lib/models/textFormat.js @@ -20,29 +20,29 @@ const models = require('./index'); class TextFormat extends models['DatasetStorageFormat'] { /** * Create a TextFormat. - * @member {object} [columnDelimiter] The column delimiter. Type: string (or - * Expression with resultType string). - * @member {object} [rowDelimiter] The row delimiter. Type: string (or + * @property {object} [columnDelimiter] The column delimiter. Type: string + * (or Expression with resultType string). + * @property {object} [rowDelimiter] The row delimiter. Type: string (or * Expression with resultType string). - * @member {object} [escapeChar] The escape character. Type: string (or + * @property {object} [escapeChar] The escape character. Type: string (or * Expression with resultType string). - * @member {object} [quoteChar] The quote character. Type: string (or + * @property {object} [quoteChar] The quote character. Type: string (or * Expression with resultType string). - * @member {object} [nullValue] The null value string. Type: string (or + * @property {object} [nullValue] The null value string. Type: string (or * Expression with resultType string). - * @member {object} [encodingName] The code page name of the preferred + * @property {object} [encodingName] The code page name of the preferred * encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes * another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in * the following link to set supported values: * https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string * (or Expression with resultType string). - * @member {object} [treatEmptyAsNull] Treat empty column values in the text - * file as null. The default value is true. Type: boolean (or Expression with - * resultType boolean). - * @member {object} [skipLineCount] The number of lines/rows to be skipped + * @property {object} [treatEmptyAsNull] Treat empty column values in the + * text file as null. The default value is true. Type: boolean (or Expression + * with resultType boolean). + * @property {object} [skipLineCount] The number of lines/rows to be skipped * when parsing text files. The default value is 0. Type: integer (or * Expression with resultType integer). - * @member {object} [firstRowAsHeader] When used as input, treat the first + * @property {object} [firstRowAsHeader] When used as input, treat the first * row of data as headers. When used as output,write the headers into the * output as the first row of data. The default value is false. Type: boolean * (or Expression with resultType boolean). diff --git a/lib/services/datafactoryManagement/lib/models/trigger.js b/lib/services/datafactoryManagement/lib/models/trigger.js index 2e67b58d0d..db8504dbb8 100644 --- a/lib/services/datafactoryManagement/lib/models/trigger.js +++ b/lib/services/datafactoryManagement/lib/models/trigger.js @@ -18,11 +18,11 @@ class Trigger { /** * Create a Trigger. - * @member {string} [description] Trigger description. - * @member {string} [runtimeState] Indicates if trigger is running or not. + * @property {string} [description] Trigger description. + * @property {string} [runtimeState] Indicates if trigger is running or not. * Updated when Start/Stop APIs are called on the Trigger. Possible values * include: 'Started', 'Stopped', 'Disabled' - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/triggerDependencyReference.js b/lib/services/datafactoryManagement/lib/models/triggerDependencyReference.js index 70f99c5352..66f61d67b9 100644 --- a/lib/services/datafactoryManagement/lib/models/triggerDependencyReference.js +++ b/lib/services/datafactoryManagement/lib/models/triggerDependencyReference.js @@ -20,8 +20,9 @@ const models = require('./index'); class TriggerDependencyReference extends models['DependencyReference'] { /** * Create a TriggerDependencyReference. - * @member {object} referenceTrigger Referenced trigger. - * @member {string} [referenceTrigger.referenceName] Reference trigger name. + * @property {object} referenceTrigger Referenced trigger. + * @property {string} [referenceTrigger.referenceName] Reference trigger + * name. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/triggerListResponse.js b/lib/services/datafactoryManagement/lib/models/triggerListResponse.js index 40afc24add..127573b507 100644 --- a/lib/services/datafactoryManagement/lib/models/triggerListResponse.js +++ b/lib/services/datafactoryManagement/lib/models/triggerListResponse.js @@ -16,7 +16,7 @@ class TriggerListResponse extends Array { /** * Create a TriggerListResponse. - * @member {string} [nextLink] The link to the next page of results, if any + * @property {string} [nextLink] The link to the next page of results, if any * remaining results exist. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/triggerPipelineReference.js b/lib/services/datafactoryManagement/lib/models/triggerPipelineReference.js index 1859d0502d..16fdb3b53a 100644 --- a/lib/services/datafactoryManagement/lib/models/triggerPipelineReference.js +++ b/lib/services/datafactoryManagement/lib/models/triggerPipelineReference.js @@ -17,11 +17,11 @@ class TriggerPipelineReference { /** * Create a TriggerPipelineReference. - * @member {object} [pipelineReference] Pipeline reference. - * @member {string} [pipelineReference.referenceName] Reference pipeline + * @property {object} [pipelineReference] Pipeline reference. + * @property {string} [pipelineReference.referenceName] Reference pipeline * name. - * @member {string} [pipelineReference.name] Reference name. - * @member {object} [parameters] Pipeline parameters. + * @property {string} [pipelineReference.name] Reference name. + * @property {object} [parameters] Pipeline parameters. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/triggerReference.js b/lib/services/datafactoryManagement/lib/models/triggerReference.js index 5e97d00217..0887988a67 100644 --- a/lib/services/datafactoryManagement/lib/models/triggerReference.js +++ b/lib/services/datafactoryManagement/lib/models/triggerReference.js @@ -17,7 +17,7 @@ class TriggerReference { /** * Create a TriggerReference. - * @member {string} referenceName Reference trigger name. + * @property {string} referenceName Reference trigger name. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/triggerResource.js b/lib/services/datafactoryManagement/lib/models/triggerResource.js index 3bc301bee9..9e240db299 100644 --- a/lib/services/datafactoryManagement/lib/models/triggerResource.js +++ b/lib/services/datafactoryManagement/lib/models/triggerResource.js @@ -20,12 +20,12 @@ const models = require('./index'); class TriggerResource extends models['SubResource'] { /** * Create a TriggerResource. - * @member {object} properties Properties of the trigger. - * @member {string} [properties.description] Trigger description. - * @member {string} [properties.runtimeState] Indicates if trigger is running - * or not. Updated when Start/Stop APIs are called on the Trigger. Possible - * values include: 'Started', 'Stopped', 'Disabled' - * @member {string} [properties.type] Polymorphic Discriminator + * @property {object} properties Properties of the trigger. + * @property {string} [properties.description] Trigger description. + * @property {string} [properties.runtimeState] Indicates if trigger is + * running or not. Updated when Start/Stop APIs are called on the Trigger. + * Possible values include: 'Started', 'Stopped', 'Disabled' + * @property {string} [properties.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/triggerRun.js b/lib/services/datafactoryManagement/lib/models/triggerRun.js index 6bd623442b..6548be6091 100644 --- a/lib/services/datafactoryManagement/lib/models/triggerRun.js +++ b/lib/services/datafactoryManagement/lib/models/triggerRun.js @@ -17,16 +17,16 @@ class TriggerRun { /** * Create a TriggerRun. - * @member {string} [triggerRunId] Trigger run id. - * @member {string} [triggerName] Trigger name. - * @member {string} [triggerType] Trigger type. - * @member {date} [triggerRunTimestamp] Trigger run start time. - * @member {string} [status] Trigger run status. Possible values include: + * @property {string} [triggerRunId] Trigger run id. + * @property {string} [triggerName] Trigger name. + * @property {string} [triggerType] Trigger type. + * @property {date} [triggerRunTimestamp] Trigger run start time. + * @property {string} [status] Trigger run status. Possible values include: * 'Succeeded', 'Failed', 'Inprogress' - * @member {string} [message] Trigger error message. - * @member {object} [properties] List of property name and value related to + * @property {string} [message] Trigger error message. + * @property {object} [properties] List of property name and value related to * trigger run. Name, value pair depends on type of trigger. - * @member {object} [triggeredPipelines] List of pipeline name and run Id + * @property {object} [triggeredPipelines] List of pipeline name and run Id * triggered by the trigger run. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/triggerRunsQueryResponse.js b/lib/services/datafactoryManagement/lib/models/triggerRunsQueryResponse.js index 133ef162a0..8d2ebf0944 100644 --- a/lib/services/datafactoryManagement/lib/models/triggerRunsQueryResponse.js +++ b/lib/services/datafactoryManagement/lib/models/triggerRunsQueryResponse.js @@ -17,8 +17,8 @@ class TriggerRunsQueryResponse { /** * Create a TriggerRunsQueryResponse. - * @member {array} value List of trigger runs. - * @member {string} [continuationToken] The continuation token for getting + * @property {array} value List of trigger runs. + * @property {string} [continuationToken] The continuation token for getting * the next page of results, if any remaining results exist, null otherwise. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/tumblingWindowTrigger.js b/lib/services/datafactoryManagement/lib/models/tumblingWindowTrigger.js index 77afa6b703..038372dc76 100644 --- a/lib/services/datafactoryManagement/lib/models/tumblingWindowTrigger.js +++ b/lib/services/datafactoryManagement/lib/models/tumblingWindowTrigger.js @@ -22,37 +22,39 @@ const models = require('./index'); class TumblingWindowTrigger extends models['Trigger'] { /** * Create a TumblingWindowTrigger. - * @member {object} pipelineProperty Pipeline for which runs are created when - * an event is fired for trigger window that is ready. - * @member {object} [pipelineProperty.pipelineReference] Pipeline reference. - * @member {string} [pipelineProperty.pipelineReference.referenceName] + * @property {object} pipelineProperty Pipeline for which runs are created + * when an event is fired for trigger window that is ready. + * @property {object} [pipelineProperty.pipelineReference] Pipeline + * reference. + * @property {string} [pipelineProperty.pipelineReference.referenceName] * Reference pipeline name. - * @member {string} [pipelineProperty.pipelineReference.name] Reference name. - * @member {object} [pipelineProperty.parameters] Pipeline parameters. - * @member {string} frequency The frequency of the time windows. Possible + * @property {string} [pipelineProperty.pipelineReference.name] Reference + * name. + * @property {object} [pipelineProperty.parameters] Pipeline parameters. + * @property {string} frequency The frequency of the time windows. Possible * values include: 'Minute', 'Hour' - * @member {number} interval The interval of the time windows. The minimum + * @property {number} interval The interval of the time windows. The minimum * interval allowed is 15 Minutes. - * @member {date} startTime The start time for the time period for the + * @property {date} startTime The start time for the time period for the * trigger during which events are fired for windows that are ready. Only UTC * time is currently supported. - * @member {date} [endTime] The end time for the time period for the trigger - * during which events are fired for windows that are ready. Only UTC time is - * currently supported. - * @member {object} [delay] Specifies how long the trigger waits past due + * @property {date} [endTime] The end time for the time period for the + * trigger during which events are fired for windows that are ready. Only UTC + * time is currently supported. + * @property {object} [delay] Specifies how long the trigger waits past due * time before triggering new run. It doesn't alter window start and end * time. The default is 0. Type: string (or Expression with resultType * string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {number} maxConcurrency The max number of parallel time windows + * @property {number} maxConcurrency The max number of parallel time windows * (ready for execution) for which a new run is triggered. - * @member {object} [retryPolicy] Retry policy that will be applied for + * @property {object} [retryPolicy] Retry policy that will be applied for * failed pipeline runs. - * @member {object} [retryPolicy.count] Maximum ordinary retry attempts. + * @property {object} [retryPolicy.count] Maximum ordinary retry attempts. * Default is 0. Type: integer (or Expression with resultType integer), * minimum: 0. - * @member {number} [retryPolicy.intervalInSeconds] Interval between retries - * in seconds. Default is 30. - * @member {array} [dependsOn] Triggers that this trigger depends on. Only + * @property {number} [retryPolicy.intervalInSeconds] Interval between + * retries in seconds. Default is 30. + * @property {array} [dependsOn] Triggers that this trigger depends on. Only * tumbling window triggers are supported. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/tumblingWindowTriggerDependencyReference.js b/lib/services/datafactoryManagement/lib/models/tumblingWindowTriggerDependencyReference.js index d876c212ee..d9486df039 100644 --- a/lib/services/datafactoryManagement/lib/models/tumblingWindowTriggerDependencyReference.js +++ b/lib/services/datafactoryManagement/lib/models/tumblingWindowTriggerDependencyReference.js @@ -20,9 +20,9 @@ const models = require('./index'); class TumblingWindowTriggerDependencyReference extends models['TriggerDependencyReference'] { /** * Create a TumblingWindowTriggerDependencyReference. - * @member {string} [offset] Timespan applied to the start time of a tumbling - * window when evaluating dependency. - * @member {string} [size] The size of the window when evaluating the + * @property {string} [offset] Timespan applied to the start time of a + * tumbling window when evaluating dependency. + * @property {string} [size] The size of the window when evaluating the * dependency. If undefined the frequency of the tumbling window will be * used. */ diff --git a/lib/services/datafactoryManagement/lib/models/untilActivity.js b/lib/services/datafactoryManagement/lib/models/untilActivity.js index 3f7bb59cbd..e2a937a354 100644 --- a/lib/services/datafactoryManagement/lib/models/untilActivity.js +++ b/lib/services/datafactoryManagement/lib/models/untilActivity.js @@ -21,16 +21,17 @@ const models = require('./index'); class UntilActivity extends models['ControlActivity'] { /** * Create a UntilActivity. - * @member {object} expression An expression that would evaluate to Boolean. - * The loop will continue until this expression evaluates to true - * @member {string} [expression.value] Expression value. - * @member {object} [timeout] Specifies the timeout for the activity to run. - * If there is no value specified, it takes the value of TimeSpan.FromDays(7) - * which is 1 week as default. Type: string (or Expression with resultType - * string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * Type: string (or Expression with resultType string), pattern: + * @property {object} expression An expression that would evaluate to + * Boolean. The loop will continue until this expression evaluates to true + * @property {string} [expression.value] Expression value. + * @property {object} [timeout] Specifies the timeout for the activity to + * run. If there is no value specified, it takes the value of + * TimeSpan.FromDays(7) which is 1 week as default. Type: string (or + * Expression with resultType string), pattern: + * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or + * Expression with resultType string), pattern: * ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). - * @member {array} activities List of activities to execute. + * @property {array} activities List of activities to execute. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/updateIntegrationRuntimeNodeRequest.js b/lib/services/datafactoryManagement/lib/models/updateIntegrationRuntimeNodeRequest.js index 93fc260ce9..a7cb996866 100644 --- a/lib/services/datafactoryManagement/lib/models/updateIntegrationRuntimeNodeRequest.js +++ b/lib/services/datafactoryManagement/lib/models/updateIntegrationRuntimeNodeRequest.js @@ -17,7 +17,7 @@ class UpdateIntegrationRuntimeNodeRequest { /** * Create a UpdateIntegrationRuntimeNodeRequest. - * @member {number} [concurrentJobsLimit] The number of concurrent jobs + * @property {number} [concurrentJobsLimit] The number of concurrent jobs * permitted to run on the integration runtime node. Values between 1 and * maxConcurrentJobs(inclusive) are allowed. */ diff --git a/lib/services/datafactoryManagement/lib/models/updateIntegrationRuntimeRequest.js b/lib/services/datafactoryManagement/lib/models/updateIntegrationRuntimeRequest.js index 79e67a30a8..ef295c6bf9 100644 --- a/lib/services/datafactoryManagement/lib/models/updateIntegrationRuntimeRequest.js +++ b/lib/services/datafactoryManagement/lib/models/updateIntegrationRuntimeRequest.js @@ -17,11 +17,11 @@ class UpdateIntegrationRuntimeRequest { /** * Create a UpdateIntegrationRuntimeRequest. - * @member {string} [autoUpdate] Enables or disables the auto-update feature - * of the self-hosted integration runtime. See + * @property {string} [autoUpdate] Enables or disables the auto-update + * feature of the self-hosted integration runtime. See * https://go.microsoft.com/fwlink/?linkid=854189. Possible values include: * 'On', 'Off' - * @member {string} [updateDelayOffset] The time offset (in hours) in the + * @property {string} [updateDelayOffset] The time offset (in hours) in the * day, e.g., PT03H is 3 hours. The integration runtime auto update will * happen on that time. */ diff --git a/lib/services/datafactoryManagement/lib/models/userAccessPolicy.js b/lib/services/datafactoryManagement/lib/models/userAccessPolicy.js new file mode 100644 index 0000000000..9efe49c746 --- /dev/null +++ b/lib/services/datafactoryManagement/lib/models/userAccessPolicy.js @@ -0,0 +1,92 @@ +/* + * 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'; + +/** + * Get Data Plane read only token request definition. + * + */ +class UserAccessPolicy { + /** + * Create a UserAccessPolicy. + * @property {string} [permissions] The string with permissions for Data + * Plane access. Currently only 'r' is supported which grants read only + * access. + * @property {string} [accessResourcePath] The resource path to get access + * relative to factory. Currently only empty string is supported which + * corresponds to the factory resource. + * @property {string} [profileName] The name of the profile. Currently only + * the default is supported. The default value is DefaultProfile. + * @property {string} [startTime] Start time for the token. If not specified + * the current time will be used. + * @property {string} [expireTime] Expiration time for the token. Maximum + * duration for the token is eight hours and by default the token will expire + * in eight hours. + */ + constructor() { + } + + /** + * Defines the metadata of UserAccessPolicy + * + * @returns {object} metadata of UserAccessPolicy + * + */ + mapper() { + return { + required: false, + serializedName: 'UserAccessPolicy', + type: { + name: 'Composite', + className: 'UserAccessPolicy', + modelProperties: { + permissions: { + required: false, + serializedName: 'permissions', + type: { + name: 'String' + } + }, + accessResourcePath: { + required: false, + serializedName: 'accessResourcePath', + type: { + name: 'String' + } + }, + profileName: { + required: false, + serializedName: 'profileName', + type: { + name: 'String' + } + }, + startTime: { + required: false, + serializedName: 'startTime', + type: { + name: 'String' + } + }, + expireTime: { + required: false, + serializedName: 'expireTime', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = UserAccessPolicy; diff --git a/lib/services/datafactoryManagement/lib/models/userProperty.js b/lib/services/datafactoryManagement/lib/models/userProperty.js index b9344f64b5..b96d4cf5f9 100644 --- a/lib/services/datafactoryManagement/lib/models/userProperty.js +++ b/lib/services/datafactoryManagement/lib/models/userProperty.js @@ -17,8 +17,8 @@ class UserProperty { /** * Create a UserProperty. - * @member {string} name User proprety name. - * @member {object} value User proprety value. Type: string (or Expression + * @property {string} name User proprety name. + * @property {object} value User proprety value. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/variableSpecification.js b/lib/services/datafactoryManagement/lib/models/variableSpecification.js index 6916456ad9..09bbd13962 100644 --- a/lib/services/datafactoryManagement/lib/models/variableSpecification.js +++ b/lib/services/datafactoryManagement/lib/models/variableSpecification.js @@ -17,9 +17,9 @@ class VariableSpecification { /** * Create a VariableSpecification. - * @member {string} type Variable type. Possible values include: 'String', + * @property {string} type Variable type. Possible values include: 'String', * 'Bool', 'Array' - * @member {object} [defaultValue] Default value of variable. + * @property {object} [defaultValue] Default value of variable. */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/verticaLinkedService.js b/lib/services/datafactoryManagement/lib/models/verticaLinkedService.js index 6099917707..a8107b3d71 100644 --- a/lib/services/datafactoryManagement/lib/models/verticaLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/verticaLinkedService.js @@ -20,19 +20,20 @@ const models = require('./index'); class VerticaLinkedService extends models['LinkedService'] { /** * Create a VerticaLinkedService. - * @member {object} [connectionString] An ODBC connection string. Type: + * @property {object} [connectionString] An ODBC connection string. Type: * string, SecureString or AzureKeyVaultSecretReference. - * @member {object} [pwd] The Azure key vault secret reference of password in - * connection string. - * @member {object} [pwd.store] The Azure Key Vault linked service reference. - * @member {string} [pwd.store.referenceName] Reference LinkedService name. - * @member {object} [pwd.store.parameters] Arguments for LinkedService. - * @member {object} [pwd.secretName] The name of the secret in Azure Key + * @property {object} [pwd] The Azure key vault secret reference of password + * in connection string. + * @property {object} [pwd.store] The Azure Key Vault linked service + * reference. + * @property {string} [pwd.store.referenceName] Reference LinkedService name. + * @property {object} [pwd.store.parameters] Arguments for LinkedService. + * @property {object} [pwd.secretName] The name of the secret in Azure Key * Vault. Type: string (or Expression with resultType string). - * @member {object} [pwd.secretVersion] The version of the secret in Azure + * @property {object} [pwd.secretVersion] The version of the secret in Azure * Key Vault. The default value is the latest version of the secret. Type: * string (or Expression with resultType string). - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/verticaSource.js b/lib/services/datafactoryManagement/lib/models/verticaSource.js index 919aa3a877..c24e9066c9 100644 --- a/lib/services/datafactoryManagement/lib/models/verticaSource.js +++ b/lib/services/datafactoryManagement/lib/models/verticaSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class VerticaSource extends models['CopySource'] { /** * Create a VerticaSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/verticaTableDataset.js b/lib/services/datafactoryManagement/lib/models/verticaTableDataset.js index 2157740761..10e47dd79e 100644 --- a/lib/services/datafactoryManagement/lib/models/verticaTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/verticaTableDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class VerticaTableDataset extends models['Dataset'] { /** * Create a VerticaTableDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/waitActivity.js b/lib/services/datafactoryManagement/lib/models/waitActivity.js index 4f8ea0ad89..0d972f9574 100644 --- a/lib/services/datafactoryManagement/lib/models/waitActivity.js +++ b/lib/services/datafactoryManagement/lib/models/waitActivity.js @@ -20,7 +20,7 @@ const models = require('./index'); class WaitActivity extends models['ControlActivity'] { /** * Create a WaitActivity. - * @member {number} waitTimeInSeconds Duration in seconds. + * @property {number} waitTimeInSeconds Duration in seconds. */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/webActivity.js b/lib/services/datafactoryManagement/lib/models/webActivity.js index 602ac68fa7..e41a4c144b 100644 --- a/lib/services/datafactoryManagement/lib/models/webActivity.js +++ b/lib/services/datafactoryManagement/lib/models/webActivity.js @@ -20,33 +20,33 @@ const models = require('./index'); class WebActivity extends models['ExecutionActivity'] { /** * Create a WebActivity. - * @member {string} method Rest API method for target endpoint. Possible + * @property {string} method Rest API method for target endpoint. Possible * values include: 'GET', 'POST', 'PUT', 'DELETE' - * @member {object} url Web activity target endpoint and path. Type: string + * @property {object} url Web activity target endpoint and path. Type: string * (or Expression with resultType string). - * @member {object} [headers] Represents the headers that will be sent to the - * request. For example, to set the language and type on a request: "headers" - * : { "Accept-Language": "en-us", "Content-Type": "application/json" }. - * Type: string (or Expression with resultType string). - * @member {object} [body] Represents the payload that will be sent to the + * @property {object} [headers] Represents the headers that will be sent to + * the request. For example, to set the language and type on a request: + * "headers" : { "Accept-Language": "en-us", "Content-Type": + * "application/json" }. Type: string (or Expression with resultType string). + * @property {object} [body] Represents the payload that will be sent to the * endpoint. Required for POST/PUT method, not allowed for GET method Type: * string (or Expression with resultType string). - * @member {object} [authentication] Authentication method used for calling + * @property {object} [authentication] Authentication method used for calling * the endpoint. - * @member {string} [authentication.type] Web activity authentication + * @property {string} [authentication.type] Web activity authentication * (Basic/ClientCertificate/MSI) - * @member {object} [authentication.pfx] Base64-encoded contents of a PFX + * @property {object} [authentication.pfx] Base64-encoded contents of a PFX * file. - * @member {string} [authentication.pfx.value] Value of secure string. - * @member {string} [authentication.username] Web activity authentication + * @property {string} [authentication.pfx.value] Value of secure string. + * @property {string} [authentication.username] Web activity authentication * user name for basic authentication. - * @member {object} [authentication.password] Password for the PFX file or + * @property {object} [authentication.password] Password for the PFX file or * basic authentication. - * @member {string} [authentication.password.value] Value of secure string. - * @member {string} [authentication.resource] Resource for which Azure Auth + * @property {string} [authentication.password.value] Value of secure string. + * @property {string} [authentication.resource] Resource for which Azure Auth * token will be requested when using MSI Authentication. - * @member {array} [datasets] List of datasets passed to web endpoint. - * @member {array} [linkedServices] List of linked services passed to web + * @property {array} [datasets] List of datasets passed to web endpoint. + * @property {array} [linkedServices] List of linked services passed to web * endpoint. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/webActivityAuthentication.js b/lib/services/datafactoryManagement/lib/models/webActivityAuthentication.js index 111bce21c5..c4a2bb13e3 100644 --- a/lib/services/datafactoryManagement/lib/models/webActivityAuthentication.js +++ b/lib/services/datafactoryManagement/lib/models/webActivityAuthentication.js @@ -17,16 +17,16 @@ class WebActivityAuthentication { /** * Create a WebActivityAuthentication. - * @member {string} type Web activity authentication + * @property {string} type Web activity authentication * (Basic/ClientCertificate/MSI) - * @member {object} [pfx] Base64-encoded contents of a PFX file. - * @member {string} [pfx.value] Value of secure string. - * @member {string} [username] Web activity authentication user name for + * @property {object} [pfx] Base64-encoded contents of a PFX file. + * @property {string} [pfx.value] Value of secure string. + * @property {string} [username] Web activity authentication user name for * basic authentication. - * @member {object} [password] Password for the PFX file or basic + * @property {object} [password] Password for the PFX file or basic * authentication. - * @member {string} [password.value] Value of secure string. - * @member {string} [resource] Resource for which Azure Auth token will be + * @property {string} [password.value] Value of secure string. + * @property {string} [resource] Resource for which Azure Auth token will be * requested when using MSI Authentication. */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/webBasicAuthentication.js b/lib/services/datafactoryManagement/lib/models/webBasicAuthentication.js index cf7cee3e0d..ea08298f2b 100644 --- a/lib/services/datafactoryManagement/lib/models/webBasicAuthentication.js +++ b/lib/services/datafactoryManagement/lib/models/webBasicAuthentication.js @@ -21,10 +21,10 @@ const models = require('./index'); class WebBasicAuthentication extends models['WebLinkedServiceTypeProperties'] { /** * Create a WebBasicAuthentication. - * @member {object} username User name for Basic authentication. Type: string - * (or Expression with resultType string). - * @member {object} password The password for Basic authentication. - * @member {string} [password.type] Polymorphic Discriminator + * @property {object} username User name for Basic authentication. Type: + * string (or Expression with resultType string). + * @property {object} password The password for Basic authentication. + * @property {string} [password.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/webClientCertificateAuthentication.js b/lib/services/datafactoryManagement/lib/models/webClientCertificateAuthentication.js index ec0223fd03..a8fe7a785a 100644 --- a/lib/services/datafactoryManagement/lib/models/webClientCertificateAuthentication.js +++ b/lib/services/datafactoryManagement/lib/models/webClientCertificateAuthentication.js @@ -23,10 +23,10 @@ const models = require('./index'); class WebClientCertificateAuthentication extends models['WebLinkedServiceTypeProperties'] { /** * Create a WebClientCertificateAuthentication. - * @member {object} pfx Base64-encoded contents of a PFX file. - * @member {string} [pfx.type] Polymorphic Discriminator - * @member {object} password Password for the PFX file. - * @member {string} [password.type] Polymorphic Discriminator + * @property {object} pfx Base64-encoded contents of a PFX file. + * @property {string} [pfx.type] Polymorphic Discriminator + * @property {object} password Password for the PFX file. + * @property {string} [password.type] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/datafactoryManagement/lib/models/webLinkedService.js b/lib/services/datafactoryManagement/lib/models/webLinkedService.js index d98aa7028e..31bfd7b542 100644 --- a/lib/services/datafactoryManagement/lib/models/webLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/webLinkedService.js @@ -20,11 +20,11 @@ const models = require('./index'); class WebLinkedService extends models['LinkedService'] { /** * Create a WebLinkedService. - * @member {object} typeProperties Web linked service properties. - * @member {object} [typeProperties.url] The URL of the web service endpoint, - * e.g. http://www.microsoft.com . Type: string (or Expression with + * @property {object} typeProperties Web linked service properties. + * @property {object} [typeProperties.url] The URL of the web service + * endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with * resultType string). - * @member {string} [typeProperties.authenticationType] Polymorphic + * @property {string} [typeProperties.authenticationType] Polymorphic * Discriminator */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/webLinkedServiceTypeProperties.js b/lib/services/datafactoryManagement/lib/models/webLinkedServiceTypeProperties.js index 47b3e5580f..fda1c8c474 100644 --- a/lib/services/datafactoryManagement/lib/models/webLinkedServiceTypeProperties.js +++ b/lib/services/datafactoryManagement/lib/models/webLinkedServiceTypeProperties.js @@ -18,10 +18,10 @@ class WebLinkedServiceTypeProperties { /** * Create a WebLinkedServiceTypeProperties. - * @member {object} url The URL of the web service endpoint, e.g. + * @property {object} url The URL of the web service endpoint, e.g. * http://www.microsoft.com . Type: string (or Expression with resultType * string). - * @member {string} authenticationType Polymorphic Discriminator + * @property {string} authenticationType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/datafactoryManagement/lib/models/webTableDataset.js b/lib/services/datafactoryManagement/lib/models/webTableDataset.js index 1aa9663ca0..216e1773ae 100644 --- a/lib/services/datafactoryManagement/lib/models/webTableDataset.js +++ b/lib/services/datafactoryManagement/lib/models/webTableDataset.js @@ -20,9 +20,9 @@ const models = require('./index'); class WebTableDataset extends models['Dataset'] { /** * Create a WebTableDataset. - * @member {object} index The zero-based index of the table in the web page. - * Type: integer (or Expression with resultType integer), minimum: 0. - * @member {object} [path] The relative URL to the web page from the linked + * @property {object} index The zero-based index of the table in the web + * page. Type: integer (or Expression with resultType integer), minimum: 0. + * @property {object} [path] The relative URL to the web page from the linked * service URL. Type: string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/xeroLinkedService.js b/lib/services/datafactoryManagement/lib/models/xeroLinkedService.js index 0a14519d85..51219ca1fc 100644 --- a/lib/services/datafactoryManagement/lib/models/xeroLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/xeroLinkedService.js @@ -13,31 +13,32 @@ const models = require('./index'); /** - * Xero Serivce linked service. + * Xero Service linked service. * * @extends models['LinkedService'] */ class XeroLinkedService extends models['LinkedService'] { /** * Create a XeroLinkedService. - * @member {object} host The endpoint of the Xero server. (i.e. api.xero.com) - * @member {object} [consumerKey] The consumer key associated with the Xero + * @property {object} host The endpoint of the Xero server. (i.e. + * api.xero.com) + * @property {object} [consumerKey] The consumer key associated with the Xero * application. - * @member {string} [consumerKey.type] Polymorphic Discriminator - * @member {object} [privateKey] The private key from the .pem file that was - * generated for your Xero private application. You must include all the text - * from the .pem file, including the Unix line endings( + * @property {string} [consumerKey.type] Polymorphic Discriminator + * @property {object} [privateKey] The private key from the .pem file that + * was generated for your Xero private application. You must include all the + * text from the .pem file, including the Unix line endings( * ). - * @member {string} [privateKey.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {string} [privateKey.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/xeroObjectDataset.js b/lib/services/datafactoryManagement/lib/models/xeroObjectDataset.js index 386b982a0d..263ec00f27 100644 --- a/lib/services/datafactoryManagement/lib/models/xeroObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/xeroObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class XeroObjectDataset extends models['Dataset'] { /** * Create a XeroObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/xeroSource.js b/lib/services/datafactoryManagement/lib/models/xeroSource.js index 7967e58eaa..d370bb8233 100644 --- a/lib/services/datafactoryManagement/lib/models/xeroSource.js +++ b/lib/services/datafactoryManagement/lib/models/xeroSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class XeroSource extends models['CopySource'] { /** * Create a XeroSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/zohoLinkedService.js b/lib/services/datafactoryManagement/lib/models/zohoLinkedService.js index c41cbb75d1..8770045539 100644 --- a/lib/services/datafactoryManagement/lib/models/zohoLinkedService.js +++ b/lib/services/datafactoryManagement/lib/models/zohoLinkedService.js @@ -20,19 +20,19 @@ const models = require('./index'); class ZohoLinkedService extends models['LinkedService'] { /** * Create a ZohoLinkedService. - * @member {object} endpoint The endpoint of the Zoho server. (i.e. + * @property {object} endpoint The endpoint of the Zoho server. (i.e. * crm.zoho.com/crm/private) - * @member {object} [accessToken] The access token for Zoho authentication. - * @member {string} [accessToken.type] Polymorphic Discriminator - * @member {object} [useEncryptedEndpoints] Specifies whether the data source - * endpoints are encrypted using HTTPS. The default value is true. - * @member {object} [useHostVerification] Specifies whether to require the + * @property {object} [accessToken] The access token for Zoho authentication. + * @property {string} [accessToken.type] Polymorphic Discriminator + * @property {object} [useEncryptedEndpoints] Specifies whether the data + * source endpoints are encrypted using HTTPS. The default value is true. + * @property {object} [useHostVerification] Specifies whether to require the * host name in the server's certificate to match the host name of the server * when connecting over SSL. The default value is true. - * @member {object} [usePeerVerification] Specifies whether to verify the + * @property {object} [usePeerVerification] Specifies whether to verify the * identity of the server when connecting over SSL. The default value is * true. - * @member {object} [encryptedCredential] The encrypted credential used for + * @property {object} [encryptedCredential] The encrypted credential used for * authentication. Credentials are encrypted using the integration runtime * credential manager. Type: string (or Expression with resultType string). */ diff --git a/lib/services/datafactoryManagement/lib/models/zohoObjectDataset.js b/lib/services/datafactoryManagement/lib/models/zohoObjectDataset.js index 1e0a78249b..a60a66e2e7 100644 --- a/lib/services/datafactoryManagement/lib/models/zohoObjectDataset.js +++ b/lib/services/datafactoryManagement/lib/models/zohoObjectDataset.js @@ -20,7 +20,7 @@ const models = require('./index'); class ZohoObjectDataset extends models['Dataset'] { /** * Create a ZohoObjectDataset. - * @member {object} [tableName] The table name. Type: string (or Expression + * @property {object} [tableName] The table name. Type: string (or Expression * with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/models/zohoSource.js b/lib/services/datafactoryManagement/lib/models/zohoSource.js index b38d724450..febe7a9530 100644 --- a/lib/services/datafactoryManagement/lib/models/zohoSource.js +++ b/lib/services/datafactoryManagement/lib/models/zohoSource.js @@ -20,7 +20,7 @@ const models = require('./index'); class ZohoSource extends models['CopySource'] { /** * Create a ZohoSource. - * @member {object} [query] A query to retrieve data from source. Type: + * @property {object} [query] A query to retrieve data from source. Type: * string (or Expression with resultType string). */ constructor() { diff --git a/lib/services/datafactoryManagement/lib/operations/factories.js b/lib/services/datafactoryManagement/lib/operations/factories.js index 059cd277d8..579a2fd892 100644 --- a/lib/services/datafactoryManagement/lib/operations/factories.js +++ b/lib/services/datafactoryManagement/lib/operations/factories.js @@ -1454,6 +1454,215 @@ function _getGitHubAccessToken(resourceGroupName, factoryName, gitHubAccessToken }); } +/** + * Get Data Plane access. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} factoryName The factory name. + * + * @param {object} policy Data Plane user access policy definition. + * + * @param {string} [policy.permissions] The string with permissions for Data + * Plane access. Currently only 'r' is supported which grants read only access. + * + * @param {string} [policy.accessResourcePath] The resource path to get access + * relative to factory. Currently only empty string is supported which + * corresponds to the factory resource. + * + * @param {string} [policy.profileName] The name of the profile. Currently only + * the default is supported. The default value is DefaultProfile. + * + * @param {string} [policy.startTime] Start time for the token. If not + * specified the current time will be used. + * + * @param {string} [policy.expireTime] Expiration time for the token. Maximum + * duration for the token is eight hours and by default the token will expire + * in eight hours. + * + * @param {object} [options] Optional Parameters. + * + * @param {object} [options.customHeaders] Headers that will be added to the + * request + * + * @param {function} callback - The callback. + * + * @returns {function} callback(err, result, request, response) + * + * {Error} err - The Error object if an error occurred, null otherwise. + * + * {object} [result] - The deserialized result object if an error did not occur. + * See {@link AccessPolicyResponse} for more information. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ +function _getDataPlaneAccess(resourceGroupName, factoryName, policy, options, callback) { + /* jshint validthis: true */ + let client = this.client; + if(!callback && typeof options === 'function') { + callback = options; + options = null; + } + if (!callback) { + throw new Error('callback cannot be null.'); + } + // Validate + try { + if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { + throw new Error('this.client.subscriptionId cannot be null or undefined and it must be of type string.'); + } + if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { + throw new Error('resourceGroupName cannot be null or undefined and it must be of type string.'); + } + if (resourceGroupName !== null && resourceGroupName !== undefined) { + if (resourceGroupName.length > 90) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MaxLength": 90'); + } + if (resourceGroupName.length < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + if (resourceGroupName.match(/^[-\w\._\(\)]+$/) === null) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "Pattern": /^[-\w\._\(\)]+$/'); + } + } + if (factoryName === null || factoryName === undefined || typeof factoryName.valueOf() !== 'string') { + throw new Error('factoryName cannot be null or undefined and it must be of type string.'); + } + if (factoryName !== null && factoryName !== undefined) { + if (factoryName.length > 63) + { + throw new Error('"factoryName" should satisfy the constraint - "MaxLength": 63'); + } + if (factoryName.length < 3) + { + throw new Error('"factoryName" should satisfy the constraint - "MinLength": 3'); + } + if (factoryName.match(/^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$/) === null) + { + throw new Error('"factoryName" should satisfy the constraint - "Pattern": /^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$/'); + } + } + if (this.client.apiVersion === null || this.client.apiVersion === undefined || typeof this.client.apiVersion.valueOf() !== 'string') { + throw new Error('this.client.apiVersion cannot be null or undefined and it must be of type string.'); + } + if (policy === null || policy === undefined) { + throw new Error('policy cannot be null or undefined.'); + } + if (this.client.acceptLanguage !== null && this.client.acceptLanguage !== undefined && typeof this.client.acceptLanguage.valueOf() !== 'string') { + throw new Error('this.client.acceptLanguage must be of type string.'); + } + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{factoryName}', encodeURIComponent(factoryName)); + let queryParameters = []; + queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); + if (queryParameters.length > 0) { + requestUrl += '?' + queryParameters.join('&'); + } + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'POST'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + if (this.client.generateClientRequestId) { + httpRequest.headers['x-ms-client-request-id'] = msRestAzure.generateUuid(); + } + if (this.client.acceptLanguage !== undefined && this.client.acceptLanguage !== null) { + httpRequest.headers['accept-language'] = this.client.acceptLanguage; + } + if(options) { + for(let headerName in options['customHeaders']) { + if (options['customHeaders'].hasOwnProperty(headerName)) { + httpRequest.headers[headerName] = options['customHeaders'][headerName]; + } + } + } + // Serialize Request + let requestContent = null; + let requestModel = null; + try { + if (policy !== null && policy !== undefined) { + let requestModelMapper = new client.models['UserAccessPolicy']().mapper(); + requestModel = client.serialize(requestModelMapper, policy, 'policy'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(policy, null, 2)}.`); + return callback(serializationError); + } + httpRequest.body = requestContent; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 200) { + let error = new Error(responseBody); + error.statusCode = response.statusCode; + error.request = msRest.stripRequest(httpRequest); + error.response = msRest.stripResponse(response); + if (responseBody === '') responseBody = null; + let parsedErrorResponse; + try { + parsedErrorResponse = JSON.parse(responseBody); + if (parsedErrorResponse) { + if (parsedErrorResponse.error) parsedErrorResponse = parsedErrorResponse.error; + if (parsedErrorResponse.code) error.code = parsedErrorResponse.code; + if (parsedErrorResponse.message) error.message = parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['CloudError']().mapper(); + error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); + } + } catch (defaultError) { + error.message = `Error "${defaultError.message}" occurred in deserializing the responseBody ` + + `- "${responseBody}" for the default response.`; + return callback(error); + } + return callback(error); + } + // Create Result + let result = null; + if (responseBody === '') responseBody = null; + // Deserialize Response + if (statusCode === 200) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['AccessPolicyResponse']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError.request = msRest.stripRequest(httpRequest); + deserializationError.response = msRest.stripResponse(response); + return callback(deserializationError); + } + } + + return callback(null, result, httpRequest, response); + }); +} + /** * Lists factories under the specified subscription. * @@ -1724,6 +1933,7 @@ class Factories { this._get = _get; this._deleteMethod = _deleteMethod; this._getGitHubAccessToken = _getGitHubAccessToken; + this._getDataPlaneAccess = _getDataPlaneAccess; this._listNext = _listNext; this._listByResourceGroupNext = _listByResourceGroupNext; } @@ -2554,6 +2764,130 @@ class Factories { } } + /** + * Get Data Plane access. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} factoryName The factory name. + * + * @param {object} policy Data Plane user access policy definition. + * + * @param {string} [policy.permissions] The string with permissions for Data + * Plane access. Currently only 'r' is supported which grants read only access. + * + * @param {string} [policy.accessResourcePath] The resource path to get access + * relative to factory. Currently only empty string is supported which + * corresponds to the factory resource. + * + * @param {string} [policy.profileName] The name of the profile. Currently only + * the default is supported. The default value is DefaultProfile. + * + * @param {string} [policy.startTime] Start time for the token. If not + * specified the current time will be used. + * + * @param {string} [policy.expireTime] Expiration time for the token. Maximum + * duration for the token is eight hours and by default the token will expire + * in eight hours. + * + * @param {object} [options] Optional Parameters. + * + * @param {object} [options.customHeaders] Headers that will be added to the + * request + * + * @returns {Promise} A promise is returned + * + * @resolve {HttpOperationResponse} - The deserialized result object. + * + * @reject {Error} - The error object. + */ + getDataPlaneAccessWithHttpOperationResponse(resourceGroupName, factoryName, policy, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._getDataPlaneAccess(resourceGroupName, factoryName, policy, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Get Data Plane access. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} factoryName The factory name. + * + * @param {object} policy Data Plane user access policy definition. + * + * @param {string} [policy.permissions] The string with permissions for Data + * Plane access. Currently only 'r' is supported which grants read only access. + * + * @param {string} [policy.accessResourcePath] The resource path to get access + * relative to factory. Currently only empty string is supported which + * corresponds to the factory resource. + * + * @param {string} [policy.profileName] The name of the profile. Currently only + * the default is supported. The default value is DefaultProfile. + * + * @param {string} [policy.startTime] Start time for the token. If not + * specified the current time will be used. + * + * @param {string} [policy.expireTime] Expiration time for the token. Maximum + * duration for the token is eight hours and by default the token will expire + * in eight hours. + * + * @param {object} [options] Optional Parameters. + * + * @param {object} [options.customHeaders] Headers that will be added to the + * request + * + * @param {function} [optionalCallback] - The optional callback. + * + * @returns {function|Promise} If a callback was passed as the last parameter + * then it returns the callback else returns a Promise. + * + * {Promise} A promise is returned + * + * @resolve {AccessPolicyResponse} - The deserialized result object. + * + * @reject {Error} - The error object. + * + * {function} optionalCallback(err, result, request, response) + * + * {Error} err - The Error object if an error occurred, null otherwise. + * + * {object} [result] - The deserialized result object if an error did not occur. + * See {@link AccessPolicyResponse} for more information. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + getDataPlaneAccess(resourceGroupName, factoryName, policy, options, optionalCallback) { + let client = this.client; + let self = this; + if (!optionalCallback && typeof options === 'function') { + optionalCallback = options; + options = null; + } + if (!optionalCallback) { + return new Promise((resolve, reject) => { + self._getDataPlaneAccess(resourceGroupName, factoryName, policy, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._getDataPlaneAccess(resourceGroupName, factoryName, policy, options, optionalCallback); + } + } + /** * Lists factories under the specified subscription. * diff --git a/lib/services/datafactoryManagement/lib/operations/index.d.ts b/lib/services/datafactoryManagement/lib/operations/index.d.ts index a9be609c1b..f0fbd33acc 100644 --- a/lib/services/datafactoryManagement/lib/operations/index.d.ts +++ b/lib/services/datafactoryManagement/lib/operations/index.d.ts @@ -748,6 +748,103 @@ export interface Factories { getGitHubAccessToken(resourceGroupName: string, factoryName: string, gitHubAccessTokenRequest: models.GitHubAccessTokenRequest, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + /** + * Get Data Plane access. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} factoryName The factory name. + * + * @param {object} policy Data Plane user access policy definition. + * + * @param {string} [policy.permissions] The string with permissions for Data + * Plane access. Currently only 'r' is supported which grants read only access. + * + * @param {string} [policy.accessResourcePath] The resource path to get access + * relative to factory. Currently only empty string is supported which + * corresponds to the factory resource. + * + * @param {string} [policy.profileName] The name of the profile. Currently only + * the default is supported. The default value is DefaultProfile. + * + * @param {string} [policy.startTime] Start time for the token. If not + * specified the current time will be used. + * + * @param {string} [policy.expireTime] Expiration time for the token. Maximum + * duration for the token is eight hours and by default the token will expire + * in eight hours. + * + * @param {object} [options] Optional Parameters. + * + * @param {object} [options.customHeaders] Headers that will be added to the + * request + * + * @returns {Promise} A promise is returned + * + * @resolve {HttpOperationResponse} - The deserialized result object. + * + * @reject {Error|ServiceError} - The error object. + */ + getDataPlaneAccessWithHttpOperationResponse(resourceGroupName: string, factoryName: string, policy: models.UserAccessPolicy, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Get Data Plane access. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} factoryName The factory name. + * + * @param {object} policy Data Plane user access policy definition. + * + * @param {string} [policy.permissions] The string with permissions for Data + * Plane access. Currently only 'r' is supported which grants read only access. + * + * @param {string} [policy.accessResourcePath] The resource path to get access + * relative to factory. Currently only empty string is supported which + * corresponds to the factory resource. + * + * @param {string} [policy.profileName] The name of the profile. Currently only + * the default is supported. The default value is DefaultProfile. + * + * @param {string} [policy.startTime] Start time for the token. If not + * specified the current time will be used. + * + * @param {string} [policy.expireTime] Expiration time for the token. Maximum + * duration for the token is eight hours and by default the token will expire + * in eight hours. + * + * @param {object} [options] Optional Parameters. + * + * @param {object} [options.customHeaders] Headers that will be added to the + * request + * + * @param {ServiceCallback} [optionalCallback] - The optional callback. + * + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. + * + * {Promise} A promise is returned. + * + * @resolve {AccessPolicyResponse} - The deserialized result object. + * + * @reject {Error|ServiceError} - The error object. + * + * {ServiceCallback} optionalCallback(err, result, request, response) + * + * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. + * + * {AccessPolicyResponse} [result] - The deserialized result object if an error did not occur. + * See {@link AccessPolicyResponse} for more information. + * + * {WebResource} [request] - The HTTP Request object if an error did not occur. + * + * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. + */ + getDataPlaneAccess(resourceGroupName: string, factoryName: string, policy: models.UserAccessPolicy, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + getDataPlaneAccess(resourceGroupName: string, factoryName: string, policy: models.UserAccessPolicy, callback: ServiceCallback): void; + getDataPlaneAccess(resourceGroupName: string, factoryName: string, policy: models.UserAccessPolicy, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + /** * Lists factories under the specified subscription. *