diff --git a/.azure-pipelines/client.test.yml b/.azure-pipelines/client.test.yml new file mode 100644 index 0000000000..8b73878283 --- /dev/null +++ b/.azure-pipelines/client.test.yml @@ -0,0 +1,46 @@ +parameters: + name: '' + vmImage: '' + +jobs: + - job: ${{ format('Test_{0}', parameters.name) }} + dependsOn: + - 'Publish' + + pool: + vmImage: ${{ parameters.vmImage }} + + strategy: + matrix: + Node6: + node.version: '6.x' + Node8: + node.version: '8.x' + Node10: + node.version: '10.x' + Node11: + node.version: '11.x' + + steps: + - task: NodeTool@0 + inputs: + versionSpec: '$(node.version)' + displayName: 'Install Node.js $(node.version)' + + - task: Npm@1 + inputs: + command: 'install' + displayName: 'npm install' + + - task: Npm@1 + inputs: + command: 'custom' + customCommand: 'run mocha -- $(test.path) --reporter mocha-junit-reporter' + displayName: 'npm run mocha' + + - task: PublishTestResults@2 + inputs: + testResultsFiles: '**/test-results.xml' + testRunTitle: ${{ format('{0} Node $(node.version)', parameters.name) }} + condition: succeededOrFailed() + displayName: 'Publish test results' diff --git a/.azure-pipelines/client.yml b/.azure-pipelines/client.yml new file mode 100644 index 0000000000..32ef5f7584 --- /dev/null +++ b/.azure-pipelines/client.yml @@ -0,0 +1,78 @@ +trigger: + - master + +variables: + node.version: '10.x' + +jobs: + - job: 'Publish' + + pool: + vmImage: 'ubuntu-16.04' + + steps: + - task: NodeTool@0 + inputs: + versionSpec: '$(node.version)' + displayName: 'Install Node.js $(node.version)' + + - task: Npm@1 + inputs: + command: 'install' + workingDir: '$(source.path)' + displayName: 'npm install' + + - task: Npm@1 + inputs: + command: 'custom' + customCommand: 'pack' + workingDir: '$(source.path)' + displayName: 'npm pack' + + - task: CopyFiles@2 + inputs: + sourceFolder: '$(source.path)' + contents: '*.tgz' + targetFolder: $(Build.ArtifactStagingDirectory) + displayName: 'Copy Package' + + - task: PublishBuildArtifacts@1 + displayName: 'Publish Package' + + - job: 'Audit' + + pool: + vmImage: 'ubuntu-16.04' + + steps: + - task: NodeTool@0 + inputs: + versionSpec: '$(node.version)' + displayName: 'Install Node.js $(node.version)' + + - task: Npm@1 + inputs: + command: 'custom' + customCommand: 'i --package-lock-only' + workingDir: '$(source.path)' + displayName: 'npm i --package-lock-only' + + - powershell: "npm audit --json | ConvertFrom-Json | Select-Object -expandProperty 'metadata' | select-object -expandproperty 'vulnerabilities' | %{ if ($_.low + $_.moderate + $_.high + $_.critical -ne 0) { write-error 'FAILED! Your package has vulnerabilities. Check npm audit' }}" + workingDirectory: '$(source.path)' + displayName: 'npm audit' + + - template: client.test.yml + parameters: + name: Linux + vmImage: 'ubuntu-16.04' + + - template: client.test.yml + parameters: + name: macOS + vmImage: 'macOS-10.13' + + - template: client.test.yml + parameters: + name: Windows + vmImage: 'vs2017-win2016' + diff --git a/.gitignore b/.gitignore index 7b45e47f78..37e0f7715b 100644 --- a/.gitignore +++ b/.gitignore @@ -55,4 +55,10 @@ packages # Coverage report coverage -.nyc_output \ No newline at end of file +.nyc_output + +# Output of 'npm pack' +*.tgz + +# Test Results +test-results.xml diff --git a/README.md b/README.md index 2884ad1779..adf68dfb62 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Azure SDK for Node.js -[![NPM version](https://badge.fury.io/js/azure.png)](https://badge.fury.io/js/azure) [![Build Status](https://travis-ci.org/Azure/azure-sdk-for-node.png?branch=master)](https://travis-ci.org/Azure/azure-sdk-for-node) +| Component | Build Status | +| --------- | ------ | +| Management Libraries | [![Build Status](https://travis-ci.org/Azure/azure-sdk-for-node.png?branch=master)](https://travis-ci.org/Azure/azure-sdk-for-node) | +| Client Libraries | [![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/azure-sdk-for-node.client)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=33) | This project provides Node.js packages that makes it easy to consume and manage Microsoft Azure Services. diff --git a/lib/services/dataLake.Store/LICENSE.txt b/lib/services/cognitiveServicesQnAMaker/LICENSE.txt similarity index 96% rename from lib/services/dataLake.Store/LICENSE.txt rename to lib/services/cognitiveServicesQnAMaker/LICENSE.txt index 0313a903d7..a70e8cf660 100644 --- a/lib/services/dataLake.Store/LICENSE.txt +++ b/lib/services/cognitiveServicesQnAMaker/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2017 Microsoft +Copyright (c) 2018 Microsoft Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +SOFTWARE. diff --git a/lib/services/cognitiveServicesQnAMaker/README.md b/lib/services/cognitiveServicesQnAMaker/README.md new file mode 100644 index 0000000000..6376500ce0 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/README.md @@ -0,0 +1,44 @@ +--- +uid: azure-cognitiveservices-qnamaker +summary: *content + +--- +**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 - QnAMakerClient + +This project provides a Node.js package for accessing Azure. Right now it supports: +- **Node.js version 6.x.x or higher** + +### Features + + +### How to Install + +```bash +npm install azure-cognitiveservices-qnamaker +``` + +### How to use + +#### Authentication, client creation, and getKeys endpointKeys as an example. + +```javascript +const msRest = require("ms-rest"); +const QnAMakerClient = require("azure-cognitiveservices-qnamaker"); +const token = ""; +const creds = new msRest.TokenCredentials(token); +const subscriptionId = ""; +const client = new QnAMakerClient(creds, subscriptionId); + +client.endpointKeys.getKeys().then((result) => { + console.log("The result is:"); + console.log(result); +}).catch((err) => { + console.log('An error occurred:'); + console.dir(err, {depth: null, colors: true}); +}); +``` + +### Related projects + +- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/alterationsDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/alterationsDTO.js new file mode 100644 index 0000000000..dc52b0836d --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/alterationsDTO.js @@ -0,0 +1,59 @@ +/* + * 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'; + +/** + * Collection of words that are synonyms. + * + */ +class AlterationsDTO { + /** + * Create a AlterationsDTO. + * @property {array} alterations Words that are synonymous with each other. + */ + constructor() { + } + + /** + * Defines the metadata of AlterationsDTO + * + * @returns {object} metadata of AlterationsDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'AlterationsDTO', + type: { + name: 'Composite', + className: 'AlterationsDTO', + modelProperties: { + alterations: { + required: true, + serializedName: 'alterations', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = AlterationsDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/createKbDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/createKbDTO.js new file mode 100644 index 0000000000..eafdb34120 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/createKbDTO.js @@ -0,0 +1,104 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Post body schema for CreateKb operation. + * + */ +class CreateKbDTO { + /** + * Create a CreateKbDTO. + * @property {string} name Friendly name for the knowledgebase. + * @property {array} [qnaList] List of Q-A (QnADTO) to be added to the + * knowledgebase. Q-A Ids are assigned by the service and should be omitted. + * @property {array} [urls] List of URLs to be used for extracting Q-A. + * @property {array} [files] List of files from which to Extract Q-A. + */ + constructor() { + } + + /** + * Defines the metadata of CreateKbDTO + * + * @returns {object} metadata of CreateKbDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'CreateKbDTO', + type: { + name: 'Composite', + className: 'CreateKbDTO', + modelProperties: { + name: { + required: true, + serializedName: 'name', + constraints: { + MaxLength: 100, + MinLength: 1 + }, + type: { + name: 'String' + } + }, + qnaList: { + required: false, + serializedName: 'qnaList', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'QnADTOElementType', + type: { + name: 'Composite', + className: 'QnADTO' + } + } + } + }, + urls: { + required: false, + serializedName: 'urls', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + files: { + required: false, + serializedName: 'files', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'FileDTOElementType', + type: { + name: 'Composite', + className: 'FileDTO' + } + } + } + } + } + } + }; + } +} + +module.exports = CreateKbDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/createKbInputDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/createKbInputDTO.js new file mode 100644 index 0000000000..5dea34b93a --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/createKbInputDTO.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'; + +/** + * Input to create KB. + * + */ +class CreateKbInputDTO { + /** + * Create a CreateKbInputDTO. + * @property {array} [qnaList] List of QNA to be added to the index. Ids are + * generated by the service and should be omitted. + * @property {array} [urls] List of URLs to be added to knowledgebase. + * @property {array} [files] List of files to be added to knowledgebase. + */ + constructor() { + } + + /** + * Defines the metadata of CreateKbInputDTO + * + * @returns {object} metadata of CreateKbInputDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'CreateKbInputDTO', + type: { + name: 'Composite', + className: 'CreateKbInputDTO', + modelProperties: { + qnaList: { + required: false, + serializedName: 'qnaList', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'QnADTOElementType', + type: { + name: 'Composite', + className: 'QnADTO' + } + } + } + }, + urls: { + required: false, + serializedName: 'urls', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + files: { + required: false, + serializedName: 'files', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'FileDTOElementType', + type: { + name: 'Composite', + className: 'FileDTO' + } + } + } + } + } + } + }; + } +} + +module.exports = CreateKbInputDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/deleteKbContentsDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/deleteKbContentsDTO.js new file mode 100644 index 0000000000..768bb3463e --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/deleteKbContentsDTO.js @@ -0,0 +1,75 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * PATCH body schema of Delete Operation in UpdateKb + * + */ +class DeleteKbContentsDTO { + /** + * Create a DeleteKbContentsDTO. + * @property {array} [ids] List of Qna Ids to be deleted + * @property {array} [sources] List of sources to be deleted from + * knowledgebase. + */ + constructor() { + } + + /** + * Defines the metadata of DeleteKbContentsDTO + * + * @returns {object} metadata of DeleteKbContentsDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'DeleteKbContentsDTO', + type: { + name: 'Composite', + className: 'DeleteKbContentsDTO', + modelProperties: { + ids: { + required: false, + serializedName: 'ids', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'NumberElementType', + type: { + name: 'Number' + } + } + } + }, + sources: { + required: false, + serializedName: 'sources', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = DeleteKbContentsDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/endpointKeysDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/endpointKeysDTO.js new file mode 100644 index 0000000000..f38f76c070 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/endpointKeysDTO.js @@ -0,0 +1,76 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Schema for EndpointKeys generate/refresh operations. + * + */ +class EndpointKeysDTO { + /** + * Create a EndpointKeysDTO. + * @property {string} [primaryEndpointKey] Primary Access Key. + * @property {string} [secondaryEndpointKey] Secondary Access Key. + * @property {string} [installedVersion] Current version of runtime. + * @property {string} [lastStableVersion] Latest version of runtime. + */ + constructor() { + } + + /** + * Defines the metadata of EndpointKeysDTO + * + * @returns {object} metadata of EndpointKeysDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'EndpointKeysDTO', + type: { + name: 'Composite', + className: 'EndpointKeysDTO', + modelProperties: { + primaryEndpointKey: { + required: false, + serializedName: 'primaryEndpointKey', + type: { + name: 'String' + } + }, + secondaryEndpointKey: { + required: false, + serializedName: 'secondaryEndpointKey', + type: { + name: 'String' + } + }, + installedVersion: { + required: false, + serializedName: 'installedVersion', + type: { + name: 'String' + } + }, + lastStableVersion: { + required: false, + serializedName: 'lastStableVersion', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = EndpointKeysDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/errorModel.js b/lib/services/cognitiveServicesQnAMaker/lib/models/errorModel.js new file mode 100644 index 0000000000..e35537d227 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/errorModel.js @@ -0,0 +1,105 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The error object. As per Microsoft One API guidelines - + * https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + * + */ +class ErrorModel { + /** + * Create a ErrorModel. + * @property {string} code One of a server-defined set of error codes. + * Possible values include: 'BadArgument', 'Forbidden', 'NotFound', + * 'KbNotFound', 'Unauthorized', 'Unspecified', 'EndpointKeysError', + * 'QuotaExceeded', 'QnaRuntimeError', 'SKULimitExceeded', + * 'OperationNotFound', 'ServiceError', 'ValidationFailure', + * 'ExtractionFailure' + * @property {string} [message] A human-readable representation of the error. + * @property {string} [target] The target of the error. + * @property {array} [details] An array of details about specific errors that + * led to this reported error. + * @property {object} [innerError] An object containing more specific + * information than the current object about the error. + * @property {string} [innerError.code] A more specific error code than was + * provided by the containing error. + * @property {object} [innerError.innerError] An object containing more + * specific information than the current object about the error. + */ + constructor() { + } + + /** + * Defines the metadata of ErrorModel + * + * @returns {object} metadata of ErrorModel + * + */ + mapper() { + return { + required: false, + serializedName: 'Error', + type: { + name: 'Composite', + className: 'ErrorModel', + modelProperties: { + code: { + required: true, + serializedName: 'code', + type: { + name: 'String' + } + }, + message: { + required: false, + serializedName: 'message', + type: { + name: 'String' + } + }, + target: { + required: false, + serializedName: 'target', + type: { + name: 'String' + } + }, + details: { + required: false, + serializedName: 'details', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'ErrorModelElementType', + type: { + name: 'Composite', + className: 'ErrorModel' + } + } + } + }, + innerError: { + required: false, + serializedName: 'innerError', + type: { + name: 'Composite', + className: 'InnerErrorModel' + } + } + } + } + }; + } +} + +module.exports = ErrorModel; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/errorResponse.js b/lib/services/cognitiveServicesQnAMaker/lib/models/errorResponse.js new file mode 100644 index 0000000000..1b381d0ddc --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/errorResponse.js @@ -0,0 +1,54 @@ +/* + * 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'; + +/** + * Error response. As per Microsoft One API guidelines - + * https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + * + */ +class ErrorResponse { + /** + * Create a ErrorResponse. + * @property {object} [error] The error object. + */ + constructor() { + } + + /** + * Defines the metadata of ErrorResponse + * + * @returns {object} metadata of ErrorResponse + * + */ + mapper() { + return { + required: false, + serializedName: 'ErrorResponse', + type: { + name: 'Composite', + className: 'ErrorResponse', + modelProperties: { + error: { + required: false, + serializedName: 'error', + type: { + name: 'Composite', + className: 'ErrorResponseError' + } + } + } + } + }; + } +} + +module.exports = ErrorResponse; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/errorResponseError.js b/lib/services/cognitiveServicesQnAMaker/lib/models/errorResponseError.js new file mode 100644 index 0000000000..16f5f8146f --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/errorResponseError.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'; + +const models = require('./index'); + +/** + * The error object. + * + * @extends models['ErrorModel'] + */ +class ErrorResponseError extends models['ErrorModel'] { + /** + * Create a ErrorResponseError. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ErrorResponseError + * + * @returns {object} metadata of ErrorResponseError + * + */ + mapper() { + return { + required: false, + serializedName: 'ErrorResponse_error', + type: { + name: 'Composite', + className: 'ErrorResponseError', + modelProperties: { + code: { + required: true, + serializedName: 'code', + type: { + name: 'String' + } + }, + message: { + required: false, + serializedName: 'message', + type: { + name: 'String' + } + }, + target: { + required: false, + serializedName: 'target', + type: { + name: 'String' + } + }, + details: { + required: false, + serializedName: 'details', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'ErrorModelElementType', + type: { + name: 'Composite', + className: 'ErrorModel' + } + } + } + }, + innerError: { + required: false, + serializedName: 'innerError', + type: { + name: 'Composite', + className: 'InnerErrorModel' + } + } + } + } + }; + } +} + +module.exports = ErrorResponseError; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/fileDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/fileDTO.js new file mode 100644 index 0000000000..3e188d7629 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/fileDTO.js @@ -0,0 +1,65 @@ +/* + * 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'; + +/** + * DTO to hold details of uploaded files. + * + */ +class FileDTO { + /** + * Create a FileDTO. + * @property {string} fileName File name. Supported file types are ".tsv", + * ".pdf", ".txt", ".docx", ".xlsx". + * @property {string} fileUri Public URI of the file. + */ + constructor() { + } + + /** + * Defines the metadata of FileDTO + * + * @returns {object} metadata of FileDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'FileDTO', + type: { + name: 'Composite', + className: 'FileDTO', + modelProperties: { + fileName: { + required: true, + serializedName: 'fileName', + constraints: { + MaxLength: 200, + MinLength: 1 + }, + type: { + name: 'String' + } + }, + fileUri: { + required: true, + serializedName: 'fileUri', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = FileDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/index.d.ts b/lib/services/cognitiveServicesQnAMaker/lib/models/index.d.ts new file mode 100644 index 0000000000..c96b063985 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/index.d.ts @@ -0,0 +1,452 @@ +/* + * 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. + */ + +import * as moment from "moment"; + +/** + * Input to create KB. + */ +export interface CreateKbInputDTO { + /** + * List of QNA to be added to the index. Ids are generated by the service and should be omitted. + */ + qnaList?: QnADTO[]; + /** + * List of URLs to be added to knowledgebase. + */ + urls?: string[]; + /** + * List of files to be added to knowledgebase. + */ + files?: FileDTO[]; +} + +/** + * An instance of CreateKbInputDTO for add operation + */ +export interface UpdateKbOperationDTOAdd extends CreateKbInputDTO { +} + +/** + * PATCH body schema of Delete Operation in UpdateKb + */ +export interface DeleteKbContentsDTO { + /** + * List of Qna Ids to be deleted + */ + ids?: number[]; + /** + * List of sources to be deleted from knowledgebase. + */ + sources?: string[]; +} + +/** + * An instance of DeleteKbContentsDTO for delete Operation + */ +export interface UpdateKbOperationDTODelete extends DeleteKbContentsDTO { +} + +/** + * PATCH body schema for Update operation in Update Kb + */ +export interface UpdateKbContentsDTO { + /** + * Friendly name for the knowledgebase. + */ + name?: string; + /** + * List of Q-A (UpdateQnaDTO) to be added to the knowledgebase. + */ + qnaList?: UpdateQnaDTO[]; + /** + * List of existing URLs to be refreshed. The content will be extracted again and re-indexed. + */ + urls?: string[]; +} + +/** + * An instance of UpdateKbContentsDTO for Update Operation + */ +export interface UpdateKbOperationDTOUpdate extends UpdateKbContentsDTO { +} + +/** + * Contains list of QnAs to be updated + */ +export interface UpdateKbOperationDTO { + /** + * An instance of CreateKbInputDTO for add operation + */ + add?: UpdateKbOperationDTOAdd; + /** + * An instance of DeleteKbContentsDTO for delete Operation + */ + deleteProperty?: UpdateKbOperationDTODelete; + /** + * An instance of UpdateKbContentsDTO for Update Operation + */ + update?: UpdateKbOperationDTOUpdate; +} + +/** + * PATCH Body schema for Update Kb which contains list of questions to be added and deleted + */ +export interface UpdateQuestionsDTO { + /** + * List of questions to be added + */ + add?: string[]; + /** + * List of questions to be deleted. + */ + deleteProperty?: string[]; +} + +/** + * List of questions associated with the answer. + */ +export interface UpdateQnaDTOQuestions extends UpdateQuestionsDTO { +} + +/** + * PATCH Body schema to represent list of Metadata to be updated + */ +export interface UpdateMetadataDTO { + /** + * List of Metadata associated with answer to be deleted + */ + deleteProperty?: MetadataDTO[]; + /** + * List of metadata associated with answer to be added + */ + add?: MetadataDTO[]; +} + +/** + * List of metadata associated with the answer to be updated + */ +export interface UpdateQnaDTOMetadata extends UpdateMetadataDTO { +} + +/** + * PATCH Body schema for Update Qna List + */ +export interface UpdateQnaDTO { + /** + * Unique id for the Q-A + */ + id?: number; + /** + * Answer text + */ + answer?: string; + /** + * Source from which Q-A was indexed. eg. + * https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs + */ + source?: string; + /** + * List of questions associated with the answer. + */ + questions?: UpdateQnaDTOQuestions; + /** + * List of metadata associated with the answer to be updated + */ + metadata?: UpdateQnaDTOMetadata; +} + +/** + * Name - value pair of metadata. + */ +export interface MetadataDTO { + /** + * Metadata name. + */ + name: string; + /** + * Metadata value. + */ + value: string; +} + +/** + * Q-A object. + */ +export interface QnADTO { + /** + * Unique id for the Q-A. + */ + id?: number; + /** + * Answer text + */ + answer: string; + /** + * Source from which Q-A was indexed. eg. + * https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs + */ + source?: string; + /** + * List of questions associated with the answer. + */ + questions: string[]; + /** + * List of metadata associated with the answer. + */ + metadata?: MetadataDTO[]; +} + +/** + * DTO to hold details of uploaded files. + */ +export interface FileDTO { + /** + * File name. Supported file types are ".tsv", ".pdf", ".txt", ".docx", ".xlsx". + */ + fileName: string; + /** + * Public URI of the file. + */ + fileUri: string; +} + +/** + * List of QnADTO + */ +export interface QnADocumentsDTO { + /** + * List of answers. + */ + qnaDocuments?: QnADTO[]; +} + +/** + * Post body schema for CreateKb operation. + */ +export interface CreateKbDTO { + /** + * Friendly name for the knowledgebase. + */ + name: string; + /** + * List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and + * should be omitted. + */ + qnaList?: QnADTO[]; + /** + * List of URLs to be used for extracting Q-A. + */ + urls?: string[]; + /** + * List of files from which to Extract Q-A. + */ + files?: FileDTO[]; +} + +/** + * Post body schema for Replace KB operation. + */ +export interface ReplaceKbDTO { + /** + * List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and + * should be omitted. + */ + qnAList: QnADTO[]; +} + +/** + * The error object. As per Microsoft One API guidelines - + * https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + */ +export interface ErrorModel { + /** + * One of a server-defined set of error codes. Possible values include: 'BadArgument', + * 'Forbidden', 'NotFound', 'KbNotFound', 'Unauthorized', 'Unspecified', 'EndpointKeysError', + * 'QuotaExceeded', 'QnaRuntimeError', 'SKULimitExceeded', 'OperationNotFound', 'ServiceError', + * 'ValidationFailure', 'ExtractionFailure' + */ + code: string; + /** + * A human-readable representation of the error. + */ + message?: string; + /** + * The target of the error. + */ + target?: string; + /** + * An array of details about specific errors that led to this reported error. + */ + details?: ErrorModel[]; + /** + * An object containing more specific information than the current object about the error. + */ + innerError?: InnerErrorModel; +} + +/** + * The error object. + */ +export interface ErrorResponseError extends ErrorModel { +} + +/** + * Error response. As per Microsoft One API guidelines - + * https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + */ +export interface ErrorResponse { + /** + * The error object. + */ + error?: ErrorResponseError; +} + +/** + * An object containing more specific information about the error. As per Microsoft One API + * guidelines - + * https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + */ +export interface InnerErrorModel { + /** + * A more specific error code than was provided by the containing error. + */ + code?: string; + /** + * An object containing more specific information than the current object about the error. + */ + innerError?: InnerErrorModel; +} + +/** + * Record to track long running operation. + */ +export interface Operation { + /** + * Operation state. Possible values include: 'Failed', 'NotStarted', 'Running', 'Succeeded' + */ + operationState?: string; + /** + * Timestamp when the operation was created. + */ + createdTimestamp?: string; + /** + * Timestamp when the current state was entered. + */ + lastActionTimestamp?: string; + /** + * Relative URI to the target resource location for completed resources. + */ + resourceLocation?: string; + /** + * User Id + */ + userId?: string; + /** + * Operation Id. + */ + operationId?: string; + /** + * Error details in case of failures. + */ + errorResponse?: ErrorResponse; +} + +/** + * Response schema for CreateKb operation. + */ +export interface KnowledgebaseDTO { + /** + * Unique id that identifies a knowledgebase. + */ + id?: string; + /** + * URL host name at which the knowledgebase is hosted. + */ + hostName?: string; + /** + * Time stamp at which the knowledgebase was last accessed (UTC). + */ + lastAccessedTimestamp?: string; + /** + * Time stamp at which the knowledgebase was last modified (UTC). + */ + lastChangedTimestamp?: string; + /** + * Time stamp at which the knowledgebase was last published (UTC). + */ + lastPublishedTimestamp?: string; + /** + * Friendly name of the knowledgebase. + */ + name?: string; + /** + * User who created / owns the knowledgebase. + */ + userId?: string; + /** + * URL sources from which Q-A were extracted and added to the knowledgebase. + */ + urls?: string[]; + /** + * Custom sources from which Q-A were extracted or explicitly added to the knowledgebase. + */ + sources?: string[]; +} + +/** + * Collection of knowledgebases owned by a user. + */ +export interface KnowledgebasesDTO { + /** + * Collection of knowledgebase records. + */ + knowledgebases?: KnowledgebaseDTO[]; +} + +/** + * Collection of words that are synonyms. + */ +export interface AlterationsDTO { + /** + * Words that are synonymous with each other. + */ + alterations: string[]; +} + +/** + * Collection of word alterations. + */ +export interface WordAlterationsDTO { + /** + * Collection of word alterations. + */ + wordAlterations: AlterationsDTO[]; +} + +/** + * Schema for EndpointKeys generate/refresh operations. + */ +export interface EndpointKeysDTO { + /** + * Primary Access Key. + */ + primaryEndpointKey?: string; + /** + * Secondary Access Key. + */ + secondaryEndpointKey?: string; + /** + * Current version of runtime. + */ + installedVersion?: string; + /** + * Latest version of runtime. + */ + lastStableVersion?: string; +} diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/index.js b/lib/services/cognitiveServicesQnAMaker/lib/models/index.js new file mode 100644 index 0000000000..8c3f801c29 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/index.js @@ -0,0 +1,44 @@ +/* + * 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. + */ + +/* jshint latedef:false */ +/* jshint forin:false */ +/* jshint noempty:false */ + +'use strict'; + +exports.CreateKbInputDTO = require('./createKbInputDTO'); +exports.UpdateKbOperationDTOAdd = require('./updateKbOperationDTOAdd'); +exports.DeleteKbContentsDTO = require('./deleteKbContentsDTO'); +exports.UpdateKbOperationDTODelete = require('./updateKbOperationDTODelete'); +exports.UpdateKbContentsDTO = require('./updateKbContentsDTO'); +exports.UpdateKbOperationDTOUpdate = require('./updateKbOperationDTOUpdate'); +exports.UpdateKbOperationDTO = require('./updateKbOperationDTO'); +exports.UpdateQuestionsDTO = require('./updateQuestionsDTO'); +exports.UpdateQnaDTOQuestions = require('./updateQnaDTOQuestions'); +exports.UpdateMetadataDTO = require('./updateMetadataDTO'); +exports.UpdateQnaDTOMetadata = require('./updateQnaDTOMetadata'); +exports.UpdateQnaDTO = require('./updateQnaDTO'); +exports.MetadataDTO = require('./metadataDTO'); +exports.QnADTO = require('./qnADTO'); +exports.FileDTO = require('./fileDTO'); +exports.QnADocumentsDTO = require('./qnADocumentsDTO'); +exports.CreateKbDTO = require('./createKbDTO'); +exports.ReplaceKbDTO = require('./replaceKbDTO'); +exports.ErrorModel = require('./errorModel'); +exports.ErrorResponseError = require('./errorResponseError'); +exports.ErrorResponse = require('./errorResponse'); +exports.InnerErrorModel = require('./innerErrorModel'); +exports.Operation = require('./operation'); +exports.KnowledgebaseDTO = require('./knowledgebaseDTO'); +exports.KnowledgebasesDTO = require('./knowledgebasesDTO'); +exports.AlterationsDTO = require('./alterationsDTO'); +exports.WordAlterationsDTO = require('./wordAlterationsDTO'); +exports.EndpointKeysDTO = require('./endpointKeysDTO'); diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/innerErrorModel.js b/lib/services/cognitiveServicesQnAMaker/lib/models/innerErrorModel.js new file mode 100644 index 0000000000..03f3d857a4 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/innerErrorModel.js @@ -0,0 +1,65 @@ +/* + * 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'; + +/** + * An object containing more specific information about the error. As per + * Microsoft One API guidelines - + * https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + * + */ +class InnerErrorModel { + /** + * Create a InnerErrorModel. + * @property {string} [code] A more specific error code than was provided by + * the containing error. + * @property {object} [innerError] An object containing more specific + * information than the current object about the error. + */ + constructor() { + } + + /** + * Defines the metadata of InnerErrorModel + * + * @returns {object} metadata of InnerErrorModel + * + */ + mapper() { + return { + required: false, + serializedName: 'InnerErrorModel', + type: { + name: 'Composite', + className: 'InnerErrorModel', + modelProperties: { + code: { + required: false, + serializedName: 'code', + type: { + name: 'String' + } + }, + innerError: { + required: false, + serializedName: 'innerError', + type: { + name: 'Composite', + className: 'InnerErrorModel' + } + } + } + } + }; + } +} + +module.exports = InnerErrorModel; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/knowledgebaseDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/knowledgebaseDTO.js new file mode 100644 index 0000000000..7a512c8dbf --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/knowledgebaseDTO.js @@ -0,0 +1,136 @@ +/* + * 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'; + +/** + * Response schema for CreateKb operation. + * + */ +class KnowledgebaseDTO { + /** + * Create a KnowledgebaseDTO. + * @property {string} [id] Unique id that identifies a knowledgebase. + * @property {string} [hostName] URL host name at which the knowledgebase is + * hosted. + * @property {string} [lastAccessedTimestamp] Time stamp at which the + * knowledgebase was last accessed (UTC). + * @property {string} [lastChangedTimestamp] Time stamp at which the + * knowledgebase was last modified (UTC). + * @property {string} [lastPublishedTimestamp] Time stamp at which the + * knowledgebase was last published (UTC). + * @property {string} [name] Friendly name of the knowledgebase. + * @property {string} [userId] User who created / owns the knowledgebase. + * @property {array} [urls] URL sources from which Q-A were extracted and + * added to the knowledgebase. + * @property {array} [sources] Custom sources from which Q-A were extracted + * or explicitly added to the knowledgebase. + */ + constructor() { + } + + /** + * Defines the metadata of KnowledgebaseDTO + * + * @returns {object} metadata of KnowledgebaseDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'KnowledgebaseDTO', + type: { + name: 'Composite', + className: 'KnowledgebaseDTO', + modelProperties: { + id: { + required: false, + serializedName: 'id', + type: { + name: 'String' + } + }, + hostName: { + required: false, + serializedName: 'hostName', + type: { + name: 'String' + } + }, + lastAccessedTimestamp: { + required: false, + serializedName: 'lastAccessedTimestamp', + type: { + name: 'String' + } + }, + lastChangedTimestamp: { + required: false, + serializedName: 'lastChangedTimestamp', + type: { + name: 'String' + } + }, + lastPublishedTimestamp: { + required: false, + serializedName: 'lastPublishedTimestamp', + type: { + name: 'String' + } + }, + name: { + required: false, + serializedName: 'name', + type: { + name: 'String' + } + }, + userId: { + required: false, + serializedName: 'userId', + type: { + name: 'String' + } + }, + urls: { + required: false, + serializedName: 'urls', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + sources: { + required: false, + serializedName: 'sources', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = KnowledgebaseDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/knowledgebasesDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/knowledgebasesDTO.js new file mode 100644 index 0000000000..4af86e2074 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/knowledgebasesDTO.js @@ -0,0 +1,60 @@ +/* + * 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'; + +/** + * Collection of knowledgebases owned by a user. + * + */ +class KnowledgebasesDTO { + /** + * Create a KnowledgebasesDTO. + * @property {array} [knowledgebases] Collection of knowledgebase records. + */ + constructor() { + } + + /** + * Defines the metadata of KnowledgebasesDTO + * + * @returns {object} metadata of KnowledgebasesDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'KnowledgebasesDTO', + type: { + name: 'Composite', + className: 'KnowledgebasesDTO', + modelProperties: { + knowledgebases: { + required: false, + serializedName: 'knowledgebases', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'KnowledgebaseDTOElementType', + type: { + name: 'Composite', + className: 'KnowledgebaseDTO' + } + } + } + } + } + } + }; + } +} + +module.exports = KnowledgebasesDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/metadataDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/metadataDTO.js new file mode 100644 index 0000000000..60864ce8b9 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/metadataDTO.js @@ -0,0 +1,68 @@ +/* + * 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'; + +/** + * Name - value pair of metadata. + * + */ +class MetadataDTO { + /** + * Create a MetadataDTO. + * @property {string} name Metadata name. + * @property {string} value Metadata value. + */ + constructor() { + } + + /** + * Defines the metadata of MetadataDTO + * + * @returns {object} metadata of MetadataDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'MetadataDTO', + type: { + name: 'Composite', + className: 'MetadataDTO', + modelProperties: { + name: { + required: true, + serializedName: 'name', + constraints: { + MaxLength: 100, + MinLength: 1 + }, + type: { + name: 'String' + } + }, + value: { + required: true, + serializedName: 'value', + constraints: { + MaxLength: 500, + MinLength: 1 + }, + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = MetadataDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/operation.js b/lib/services/cognitiveServicesQnAMaker/lib/models/operation.js new file mode 100644 index 0000000000..4651196d68 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/operation.js @@ -0,0 +1,106 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Record to track long running operation. + * + */ +class Operation { + /** + * Create a Operation. + * @property {string} [operationState] Operation state. Possible values + * include: 'Failed', 'NotStarted', 'Running', 'Succeeded' + * @property {string} [createdTimestamp] Timestamp when the operation was + * created. + * @property {string} [lastActionTimestamp] Timestamp when the current state + * was entered. + * @property {string} [resourceLocation] Relative URI to the target resource + * location for completed resources. + * @property {string} [userId] User Id + * @property {string} [operationId] Operation Id. + * @property {object} [errorResponse] Error details in case of failures. + * @property {object} [errorResponse.error] The error object. + */ + constructor() { + } + + /** + * Defines the metadata of Operation + * + * @returns {object} metadata of Operation + * + */ + mapper() { + return { + required: false, + serializedName: 'Operation', + type: { + name: 'Composite', + className: 'Operation', + modelProperties: { + operationState: { + required: false, + serializedName: 'operationState', + type: { + name: 'String' + } + }, + createdTimestamp: { + required: false, + serializedName: 'createdTimestamp', + type: { + name: 'String' + } + }, + lastActionTimestamp: { + required: false, + serializedName: 'lastActionTimestamp', + type: { + name: 'String' + } + }, + resourceLocation: { + required: false, + serializedName: 'resourceLocation', + type: { + name: 'String' + } + }, + userId: { + required: false, + serializedName: 'userId', + type: { + name: 'String' + } + }, + operationId: { + required: false, + serializedName: 'operationId', + type: { + name: 'String' + } + }, + errorResponse: { + required: false, + serializedName: 'errorResponse', + type: { + name: 'Composite', + className: 'ErrorResponse' + } + } + } + } + }; + } +} + +module.exports = Operation; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/qnADTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/qnADTO.js new file mode 100644 index 0000000000..2c8e72fa9c --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/qnADTO.js @@ -0,0 +1,107 @@ +/* + * 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'; + +/** + * Q-A object. + * + */ +class QnADTO { + /** + * Create a QnADTO. + * @property {number} [id] Unique id for the Q-A. + * @property {string} answer Answer text + * @property {string} [source] Source from which Q-A was indexed. eg. + * https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs + * @property {array} questions List of questions associated with the answer. + * @property {array} [metadata] List of metadata associated with the answer. + */ + constructor() { + } + + /** + * Defines the metadata of QnADTO + * + * @returns {object} metadata of QnADTO + * + */ + mapper() { + return { + required: false, + serializedName: 'QnADTO', + type: { + name: 'Composite', + className: 'QnADTO', + modelProperties: { + id: { + required: false, + serializedName: 'id', + type: { + name: 'Number' + } + }, + answer: { + required: true, + serializedName: 'answer', + constraints: { + MaxLength: 25000, + MinLength: 1 + }, + type: { + name: 'String' + } + }, + source: { + required: false, + serializedName: 'source', + constraints: { + MaxLength: 300 + }, + type: { + name: 'String' + } + }, + questions: { + required: true, + serializedName: 'questions', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + metadata: { + required: false, + serializedName: 'metadata', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'MetadataDTOElementType', + type: { + name: 'Composite', + className: 'MetadataDTO' + } + } + } + } + } + } + }; + } +} + +module.exports = QnADTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/qnADocumentsDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/qnADocumentsDTO.js new file mode 100644 index 0000000000..e5cdd23e78 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/qnADocumentsDTO.js @@ -0,0 +1,60 @@ +/* + * 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'; + +/** + * List of QnADTO + * + */ +class QnADocumentsDTO { + /** + * Create a QnADocumentsDTO. + * @property {array} [qnaDocuments] List of answers. + */ + constructor() { + } + + /** + * Defines the metadata of QnADocumentsDTO + * + * @returns {object} metadata of QnADocumentsDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'QnADocumentsDTO', + type: { + name: 'Composite', + className: 'QnADocumentsDTO', + modelProperties: { + qnaDocuments: { + required: false, + serializedName: 'qnaDocuments', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'QnADTOElementType', + type: { + name: 'Composite', + className: 'QnADTO' + } + } + } + } + } + } + }; + } +} + +module.exports = QnADocumentsDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/replaceKbDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/replaceKbDTO.js new file mode 100644 index 0000000000..72e21815e7 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/replaceKbDTO.js @@ -0,0 +1,61 @@ +/* + * 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'; + +/** + * Post body schema for Replace KB operation. + * + */ +class ReplaceKbDTO { + /** + * Create a ReplaceKbDTO. + * @property {array} qnAList List of Q-A (QnADTO) to be added to the + * knowledgebase. Q-A Ids are assigned by the service and should be omitted. + */ + constructor() { + } + + /** + * Defines the metadata of ReplaceKbDTO + * + * @returns {object} metadata of ReplaceKbDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'ReplaceKbDTO', + type: { + name: 'Composite', + className: 'ReplaceKbDTO', + modelProperties: { + qnAList: { + required: true, + serializedName: 'qnAList', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'QnADTOElementType', + type: { + name: 'Composite', + className: 'QnADTO' + } + } + } + } + } + } + }; + } +} + +module.exports = ReplaceKbDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbContentsDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbContentsDTO.js new file mode 100644 index 0000000000..2343750ffd --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbContentsDTO.js @@ -0,0 +1,85 @@ +/* + * 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'; + +/** + * PATCH body schema for Update operation in Update Kb + * + */ +class UpdateKbContentsDTO { + /** + * Create a UpdateKbContentsDTO. + * @property {string} [name] Friendly name for the knowledgebase. + * @property {array} [qnaList] List of Q-A (UpdateQnaDTO) to be added to the + * knowledgebase. + * @property {array} [urls] List of existing URLs to be refreshed. The + * content will be extracted again and re-indexed. + */ + constructor() { + } + + /** + * Defines the metadata of UpdateKbContentsDTO + * + * @returns {object} metadata of UpdateKbContentsDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'UpdateKbContentsDTO', + type: { + name: 'Composite', + className: 'UpdateKbContentsDTO', + modelProperties: { + name: { + required: false, + serializedName: 'name', + type: { + name: 'String' + } + }, + qnaList: { + required: false, + serializedName: 'qnaList', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'UpdateQnaDTOElementType', + type: { + name: 'Composite', + className: 'UpdateQnaDTO' + } + } + } + }, + urls: { + required: false, + serializedName: 'urls', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = UpdateKbContentsDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTO.js new file mode 100644 index 0000000000..8e922a4502 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTO.js @@ -0,0 +1,73 @@ +/* + * 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'; + +/** + * Contains list of QnAs to be updated + * + */ +class UpdateKbOperationDTO { + /** + * Create a UpdateKbOperationDTO. + * @property {object} [add] An instance of CreateKbInputDTO for add operation + * @property {object} [deleteProperty] An instance of DeleteKbContentsDTO for + * delete Operation + * @property {object} [update] An instance of UpdateKbContentsDTO for Update + * Operation + */ + constructor() { + } + + /** + * Defines the metadata of UpdateKbOperationDTO + * + * @returns {object} metadata of UpdateKbOperationDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'UpdateKbOperationDTO', + type: { + name: 'Composite', + className: 'UpdateKbOperationDTO', + modelProperties: { + add: { + required: false, + serializedName: 'add', + type: { + name: 'Composite', + className: 'UpdateKbOperationDTOAdd' + } + }, + deleteProperty: { + required: false, + serializedName: 'delete', + type: { + name: 'Composite', + className: 'UpdateKbOperationDTODelete' + } + }, + update: { + required: false, + serializedName: 'update', + type: { + name: 'Composite', + className: 'UpdateKbOperationDTOUpdate' + } + } + } + } + }; + } +} + +module.exports = UpdateKbOperationDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTOAdd.js b/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTOAdd.js new file mode 100644 index 0000000000..27ed1bca98 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTOAdd.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'; + +const models = require('./index'); + +/** + * An instance of CreateKbInputDTO for add operation + * + * @extends models['CreateKbInputDTO'] + */ +class UpdateKbOperationDTOAdd extends models['CreateKbInputDTO'] { + /** + * Create a UpdateKbOperationDTOAdd. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of UpdateKbOperationDTOAdd + * + * @returns {object} metadata of UpdateKbOperationDTOAdd + * + */ + mapper() { + return { + required: false, + serializedName: 'UpdateKbOperationDTO_add', + type: { + name: 'Composite', + className: 'UpdateKbOperationDTOAdd', + modelProperties: { + qnaList: { + required: false, + serializedName: 'qnaList', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'QnADTOElementType', + type: { + name: 'Composite', + className: 'QnADTO' + } + } + } + }, + urls: { + required: false, + serializedName: 'urls', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + files: { + required: false, + serializedName: 'files', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'FileDTOElementType', + type: { + name: 'Composite', + className: 'FileDTO' + } + } + } + } + } + } + }; + } +} + +module.exports = UpdateKbOperationDTOAdd; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTODelete.js b/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTODelete.js new file mode 100644 index 0000000000..fa24b6a168 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTODelete.js @@ -0,0 +1,76 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * An instance of DeleteKbContentsDTO for delete Operation + * + * @extends models['DeleteKbContentsDTO'] + */ +class UpdateKbOperationDTODelete extends models['DeleteKbContentsDTO'] { + /** + * Create a UpdateKbOperationDTODelete. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of UpdateKbOperationDTODelete + * + * @returns {object} metadata of UpdateKbOperationDTODelete + * + */ + mapper() { + return { + required: false, + serializedName: 'UpdateKbOperationDTO_delete', + type: { + name: 'Composite', + className: 'UpdateKbOperationDTODelete', + modelProperties: { + ids: { + required: false, + serializedName: 'ids', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'NumberElementType', + type: { + name: 'Number' + } + } + } + }, + sources: { + required: false, + serializedName: 'sources', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = UpdateKbOperationDTODelete; diff --git a/lib/services/networkManagement2/lib/models/httpConfiguration.js b/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTOUpdate.js similarity index 56% rename from lib/services/networkManagement2/lib/models/httpConfiguration.js rename to lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTOUpdate.js index 1cf98671ac..6793e83e81 100644 --- a/lib/services/networkManagement2/lib/models/httpConfiguration.js +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/updateKbOperationDTOUpdate.js @@ -10,66 +10,67 @@ 'use strict'; +const models = require('./index'); + /** - * HTTP configuration of the connectivity check. + * An instance of UpdateKbContentsDTO for Update Operation * + * @extends models['UpdateKbContentsDTO'] */ -class HTTPConfiguration { +class UpdateKbOperationDTOUpdate extends models['UpdateKbContentsDTO'] { /** - * Create a HTTPConfiguration. - * @member {string} [method] HTTP method. Possible values include: 'Get' - * @member {array} [headers] List of HTTP headers. - * @member {array} [validStatusCodes] Valid status codes. + * Create a UpdateKbOperationDTOUpdate. */ constructor() { + super(); } /** - * Defines the metadata of HTTPConfiguration + * Defines the metadata of UpdateKbOperationDTOUpdate * - * @returns {object} metadata of HTTPConfiguration + * @returns {object} metadata of UpdateKbOperationDTOUpdate * */ mapper() { return { required: false, - serializedName: 'HTTPConfiguration', + serializedName: 'UpdateKbOperationDTO_update', type: { name: 'Composite', - className: 'HTTPConfiguration', + className: 'UpdateKbOperationDTOUpdate', modelProperties: { - method: { + name: { required: false, - serializedName: 'method', + serializedName: 'name', type: { name: 'String' } }, - headers: { + qnaList: { required: false, - serializedName: 'headers', + serializedName: 'qnaList', type: { name: 'Sequence', element: { required: false, - serializedName: 'HTTPHeaderElementType', + serializedName: 'UpdateQnaDTOElementType', type: { name: 'Composite', - className: 'HTTPHeader' + className: 'UpdateQnaDTO' } } } }, - validStatusCodes: { + urls: { required: false, - serializedName: 'validStatusCodes', + serializedName: 'urls', type: { name: 'Sequence', element: { required: false, - serializedName: 'NumberElementType', + serializedName: 'StringElementType', type: { - name: 'Number' + name: 'String' } } } @@ -80,4 +81,4 @@ class HTTPConfiguration { } } -module.exports = HTTPConfiguration; +module.exports = UpdateKbOperationDTOUpdate; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/updateMetadataDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/updateMetadataDTO.js new file mode 100644 index 0000000000..7228da2b8e --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/updateMetadataDTO.js @@ -0,0 +1,78 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * PATCH Body schema to represent list of Metadata to be updated + * + */ +class UpdateMetadataDTO { + /** + * Create a UpdateMetadataDTO. + * @property {array} [deleteProperty] List of Metadata associated with answer + * to be deleted + * @property {array} [add] List of metadata associated with answer to be + * added + */ + constructor() { + } + + /** + * Defines the metadata of UpdateMetadataDTO + * + * @returns {object} metadata of UpdateMetadataDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'UpdateMetadataDTO', + type: { + name: 'Composite', + className: 'UpdateMetadataDTO', + modelProperties: { + deleteProperty: { + required: false, + serializedName: 'delete', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'MetadataDTOElementType', + type: { + name: 'Composite', + className: 'MetadataDTO' + } + } + } + }, + add: { + required: false, + serializedName: 'add', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'MetadataDTOElementType', + type: { + name: 'Composite', + className: 'MetadataDTO' + } + } + } + } + } + } + }; + } +} + +module.exports = UpdateMetadataDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/updateQnaDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/updateQnaDTO.js new file mode 100644 index 0000000000..2bb5280ffe --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/updateQnaDTO.js @@ -0,0 +1,96 @@ +/* + * 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'; + +/** + * PATCH Body schema for Update Qna List + * + */ +class UpdateQnaDTO { + /** + * Create a UpdateQnaDTO. + * @property {number} [id] Unique id for the Q-A + * @property {string} [answer] Answer text + * @property {string} [source] Source from which Q-A was indexed. eg. + * https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs + * @property {object} [questions] List of questions associated with the + * answer. + * @property {object} [metadata] List of metadata associated with the answer + * to be updated + */ + constructor() { + } + + /** + * Defines the metadata of UpdateQnaDTO + * + * @returns {object} metadata of UpdateQnaDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'UpdateQnaDTO', + type: { + name: 'Composite', + className: 'UpdateQnaDTO', + modelProperties: { + id: { + required: false, + serializedName: 'id', + constraints: { + InclusiveMaximum: 2147483647, + InclusiveMinimum: 0 + }, + type: { + name: 'Number' + } + }, + answer: { + required: false, + serializedName: 'answer', + type: { + name: 'String' + } + }, + source: { + required: false, + serializedName: 'source', + constraints: { + MaxLength: 300 + }, + type: { + name: 'String' + } + }, + questions: { + required: false, + serializedName: 'questions', + type: { + name: 'Composite', + className: 'UpdateQnaDTOQuestions' + } + }, + metadata: { + required: false, + serializedName: 'metadata', + type: { + name: 'Composite', + className: 'UpdateQnaDTOMetadata' + } + } + } + } + }; + } +} + +module.exports = UpdateQnaDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/updateQnaDTOMetadata.js b/lib/services/cognitiveServicesQnAMaker/lib/models/updateQnaDTOMetadata.js new file mode 100644 index 0000000000..a66f383532 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/updateQnaDTOMetadata.js @@ -0,0 +1,78 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * List of metadata associated with the answer to be updated + * + * @extends models['UpdateMetadataDTO'] + */ +class UpdateQnaDTOMetadata extends models['UpdateMetadataDTO'] { + /** + * Create a UpdateQnaDTOMetadata. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of UpdateQnaDTOMetadata + * + * @returns {object} metadata of UpdateQnaDTOMetadata + * + */ + mapper() { + return { + required: false, + serializedName: 'UpdateQnaDTO_metadata', + type: { + name: 'Composite', + className: 'UpdateQnaDTOMetadata', + modelProperties: { + deleteProperty: { + required: false, + serializedName: 'delete', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'MetadataDTOElementType', + type: { + name: 'Composite', + className: 'MetadataDTO' + } + } + } + }, + add: { + required: false, + serializedName: 'add', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'MetadataDTOElementType', + type: { + name: 'Composite', + className: 'MetadataDTO' + } + } + } + } + } + } + }; + } +} + +module.exports = UpdateQnaDTOMetadata; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/updateQnaDTOQuestions.js b/lib/services/cognitiveServicesQnAMaker/lib/models/updateQnaDTOQuestions.js new file mode 100644 index 0000000000..588f561385 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/updateQnaDTOQuestions.js @@ -0,0 +1,76 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * List of questions associated with the answer. + * + * @extends models['UpdateQuestionsDTO'] + */ +class UpdateQnaDTOQuestions extends models['UpdateQuestionsDTO'] { + /** + * Create a UpdateQnaDTOQuestions. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of UpdateQnaDTOQuestions + * + * @returns {object} metadata of UpdateQnaDTOQuestions + * + */ + mapper() { + return { + required: false, + serializedName: 'UpdateQnaDTO_questions', + type: { + name: 'Composite', + className: 'UpdateQnaDTOQuestions', + modelProperties: { + add: { + required: false, + serializedName: 'add', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + deleteProperty: { + required: false, + serializedName: 'delete', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = UpdateQnaDTOQuestions; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/updateQuestionsDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/updateQuestionsDTO.js new file mode 100644 index 0000000000..c9ce1a7844 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/updateQuestionsDTO.js @@ -0,0 +1,75 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * PATCH Body schema for Update Kb which contains list of questions to be added + * and deleted + * + */ +class UpdateQuestionsDTO { + /** + * Create a UpdateQuestionsDTO. + * @property {array} [add] List of questions to be added + * @property {array} [deleteProperty] List of questions to be deleted. + */ + constructor() { + } + + /** + * Defines the metadata of UpdateQuestionsDTO + * + * @returns {object} metadata of UpdateQuestionsDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'UpdateQuestionsDTO', + type: { + name: 'Composite', + className: 'UpdateQuestionsDTO', + modelProperties: { + add: { + required: false, + serializedName: 'add', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + deleteProperty: { + required: false, + serializedName: 'delete', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = UpdateQuestionsDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/models/wordAlterationsDTO.js b/lib/services/cognitiveServicesQnAMaker/lib/models/wordAlterationsDTO.js new file mode 100644 index 0000000000..4cb195498b --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/models/wordAlterationsDTO.js @@ -0,0 +1,60 @@ +/* + * 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'; + +/** + * Collection of word alterations. + * + */ +class WordAlterationsDTO { + /** + * Create a WordAlterationsDTO. + * @property {array} wordAlterations Collection of word alterations. + */ + constructor() { + } + + /** + * Defines the metadata of WordAlterationsDTO + * + * @returns {object} metadata of WordAlterationsDTO + * + */ + mapper() { + return { + required: false, + serializedName: 'WordAlterationsDTO', + type: { + name: 'Composite', + className: 'WordAlterationsDTO', + modelProperties: { + wordAlterations: { + required: true, + serializedName: 'wordAlterations', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'AlterationsDTOElementType', + type: { + name: 'Composite', + className: 'AlterationsDTO' + } + } + } + } + } + } + }; + } +} + +module.exports = WordAlterationsDTO; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/operations/alterations.js b/lib/services/cognitiveServicesQnAMaker/lib/operations/alterations.js new file mode 100644 index 0000000000..1362f95c79 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/operations/alterations.js @@ -0,0 +1,433 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const WebResource = msRest.WebResource; + +/** + * @summary Download alterations from runtime. + * + * @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 WordAlterationsDTO} 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 _get(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.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); + } + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'alterations'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + if(options) { + for(let headerName in options['customHeaders']) { + if (options['customHeaders'].hasOwnProperty(headerName)) { + httpRequest.headers[headerName] = options['customHeaders'][headerName]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['WordAlterationsDTO']().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); + }); +} + +/** + * @summary Replace alterations data. + * + * @param {object} wordAlterations New alterations data. + * + * @param {array} wordAlterations.wordAlterations Collection of word + * alterations. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _replace(wordAlterations, 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.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); + } + if (wordAlterations === null || wordAlterations === undefined) { + throw new Error('wordAlterations cannot be null or undefined.'); + } + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'alterations'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'PUT'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + 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 (wordAlterations !== null && wordAlterations !== undefined) { + let requestModelMapper = new client.models['WordAlterationsDTO']().mapper(); + requestModel = client.serialize(requestModelMapper, wordAlterations, 'wordAlterations'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(wordAlterations, 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 !== 204) { + 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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; + + return callback(null, result, httpRequest, response); + }); +} + +/** Class representing a Alterations. */ +class Alterations { + /** + * Create a Alterations. + * @param {QnAMakerClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._get = _get; + this._replace = _replace; + } + + /** + * @summary Download alterations from runtime. + * + * @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. + */ + getWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._get(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * @summary Download alterations from runtime. + * + * @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 {WordAlterationsDTO} - 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 WordAlterationsDTO} 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. + */ + get(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._get(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._get(options, optionalCallback); + } + } + + /** + * @summary Replace alterations data. + * + * @param {object} wordAlterations New alterations data. + * + * @param {array} wordAlterations.wordAlterations Collection of word + * alterations. + * + * @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. + */ + replaceWithHttpOperationResponse(wordAlterations, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._replace(wordAlterations, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * @summary Replace alterations data. + * + * @param {object} wordAlterations New alterations data. + * + * @param {array} wordAlterations.wordAlterations Collection of word + * alterations. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + replace(wordAlterations, 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._replace(wordAlterations, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._replace(wordAlterations, options, optionalCallback); + } + } + +} + +module.exports = Alterations; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/operations/endpointKeys.js b/lib/services/cognitiveServicesQnAMaker/lib/operations/endpointKeys.js new file mode 100644 index 0000000000..19fac9f19a --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/operations/endpointKeys.js @@ -0,0 +1,430 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const WebResource = msRest.WebResource; + +/** + * @summary Gets endpoint keys for an endpoint + * + * @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 EndpointKeysDTO} 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 _getKeys(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.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); + } + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'endpointkeys'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + if(options) { + for(let headerName in options['customHeaders']) { + if (options['customHeaders'].hasOwnProperty(headerName)) { + httpRequest.headers[headerName] = options['customHeaders'][headerName]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['EndpointKeysDTO']().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); + }); +} + +/** + * @summary Re-generates an endpoint key. + * + * @param {string} keyType Type of Key + * + * @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 EndpointKeysDTO} 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 _refreshKeys(keyType, 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.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); + } + if (keyType === null || keyType === undefined || typeof keyType.valueOf() !== 'string') { + throw new Error('keyType cannot be null or undefined and it must be of type string.'); + } + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'endpointkeys/{keyType}'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + requestUrl = requestUrl.replace('{keyType}', encodeURIComponent(keyType)); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'PATCH'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + if(options) { + for(let headerName in options['customHeaders']) { + if (options['customHeaders'].hasOwnProperty(headerName)) { + httpRequest.headers[headerName] = options['customHeaders'][headerName]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['EndpointKeysDTO']().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); + }); +} + +/** Class representing a EndpointKeys. */ +class EndpointKeys { + /** + * Create a EndpointKeys. + * @param {QnAMakerClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._getKeys = _getKeys; + this._refreshKeys = _refreshKeys; + } + + /** + * @summary Gets endpoint keys for an endpoint + * + * @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. + */ + getKeysWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._getKeys(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * @summary Gets endpoint keys for an endpoint + * + * @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 {EndpointKeysDTO} - 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 EndpointKeysDTO} 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. + */ + getKeys(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._getKeys(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._getKeys(options, optionalCallback); + } + } + + /** + * @summary Re-generates an endpoint key. + * + * @param {string} keyType Type of Key + * + * @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. + */ + refreshKeysWithHttpOperationResponse(keyType, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._refreshKeys(keyType, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * @summary Re-generates an endpoint key. + * + * @param {string} keyType Type of Key + * + * @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 {EndpointKeysDTO} - 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 EndpointKeysDTO} 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. + */ + refreshKeys(keyType, 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._refreshKeys(keyType, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._refreshKeys(keyType, options, optionalCallback); + } + } + +} + +module.exports = EndpointKeys; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/operations/index.d.ts b/lib/services/cognitiveServicesQnAMaker/lib/operations/index.d.ts new file mode 100644 index 0000000000..34ae72e068 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/operations/index.d.ts @@ -0,0 +1,864 @@ +/* + * 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. +*/ + +import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse } from 'ms-rest'; +import * as models from '../models'; + + +/** + * @class + * EndpointKeys + * __NOTE__: An instance of this class is automatically created for an + * instance of the QnAMakerClient. + */ +export interface EndpointKeys { + + + /** + * @summary Gets endpoint keys for an endpoint + * + * @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. + */ + getKeysWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Gets endpoint keys for an endpoint + * + * @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 {EndpointKeysDTO} - 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. + * + * {EndpointKeysDTO} [result] - The deserialized result object if an error did not occur. + * See {@link EndpointKeysDTO} 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. + */ + getKeys(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + getKeys(callback: ServiceCallback): void; + getKeys(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * @summary Re-generates an endpoint key. + * + * @param {string} keyType Type of Key + * + * @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. + */ + refreshKeysWithHttpOperationResponse(keyType: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Re-generates an endpoint key. + * + * @param {string} keyType Type of Key + * + * @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 {EndpointKeysDTO} - 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. + * + * {EndpointKeysDTO} [result] - The deserialized result object if an error did not occur. + * See {@link EndpointKeysDTO} 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. + */ + refreshKeys(keyType: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + refreshKeys(keyType: string, callback: ServiceCallback): void; + refreshKeys(keyType: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * Alterations + * __NOTE__: An instance of this class is automatically created for an + * instance of the QnAMakerClient. + */ +export interface Alterations { + + + /** + * @summary Download alterations from runtime. + * + * @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. + */ + getWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Download alterations from runtime. + * + * @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 {WordAlterationsDTO} - 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. + * + * {WordAlterationsDTO} [result] - The deserialized result object if an error did not occur. + * See {@link WordAlterationsDTO} 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. + */ + get(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(callback: ServiceCallback): void; + get(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * @summary Replace alterations data. + * + * @param {object} wordAlterations New alterations data. + * + * @param {array} wordAlterations.wordAlterations Collection of word + * alterations. + * + * @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. + */ + replaceWithHttpOperationResponse(wordAlterations: models.WordAlterationsDTO, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Replace alterations data. + * + * @param {object} wordAlterations New alterations data. + * + * @param {array} wordAlterations.wordAlterations Collection of word + * alterations. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + replace(wordAlterations: models.WordAlterationsDTO, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + replace(wordAlterations: models.WordAlterationsDTO, callback: ServiceCallback): void; + replace(wordAlterations: models.WordAlterationsDTO, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * Knowledgebase + * __NOTE__: An instance of this class is automatically created for an + * instance of the QnAMakerClient. + */ +export interface Knowledgebase { + + + /** + * @summary Gets all knowledgebases for a user. + * + * @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. + */ + listAllWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Gets all knowledgebases for a user. + * + * @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 {KnowledgebasesDTO} - 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. + * + * {KnowledgebasesDTO} [result] - The deserialized result object if an error did not occur. + * See {@link KnowledgebasesDTO} 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. + */ + listAll(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listAll(callback: ServiceCallback): void; + listAll(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * @summary Gets details of a specific knowledgebase. + * + * @param {string} kbId Knowledgebase id. + * + * @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. + */ + getDetailsWithHttpOperationResponse(kbId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Gets details of a specific knowledgebase. + * + * @param {string} kbId Knowledgebase id. + * + * @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 {KnowledgebaseDTO} - 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. + * + * {KnowledgebaseDTO} [result] - The deserialized result object if an error did not occur. + * See {@link KnowledgebaseDTO} 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. + */ + getDetails(kbId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + getDetails(kbId: string, callback: ServiceCallback): void; + getDetails(kbId: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * @summary Deletes the knowledgebase and all its data. + * + * @param {string} kbId Knowledgebase id. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(kbId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Deletes the knowledgebase and all its data. + * + * @param {string} kbId Knowledgebase id. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + deleteMethod(kbId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(kbId: string, callback: ServiceCallback): void; + deleteMethod(kbId: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * @summary Publishes all changes in test index of a knowledgebase to its prod + * index. + * + * @param {string} kbId Knowledgebase id. + * + * @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. + */ + publishWithHttpOperationResponse(kbId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Publishes all changes in test index of a knowledgebase to its prod + * index. + * + * @param {string} kbId Knowledgebase id. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + publish(kbId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + publish(kbId: string, callback: ServiceCallback): void; + publish(kbId: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * @summary Replace knowledgebase contents. + * + * @param {string} kbId Knowledgebase id. + * + * @param {object} replaceKb An instance of ReplaceKbDTO which contains list of + * qnas to be uploaded + * + * @param {array} replaceKb.qnAList List of Q-A (QnADTO) to be added to the + * knowledgebase. Q-A Ids are assigned by the service and should be omitted. + * + * @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. + */ + replaceWithHttpOperationResponse(kbId: string, replaceKb: models.ReplaceKbDTO, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Replace knowledgebase contents. + * + * @param {string} kbId Knowledgebase id. + * + * @param {object} replaceKb An instance of ReplaceKbDTO which contains list of + * qnas to be uploaded + * + * @param {array} replaceKb.qnAList List of Q-A (QnADTO) to be added to the + * knowledgebase. Q-A Ids are assigned by the service and should be omitted. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + replace(kbId: string, replaceKb: models.ReplaceKbDTO, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + replace(kbId: string, replaceKb: models.ReplaceKbDTO, callback: ServiceCallback): void; + replace(kbId: string, replaceKb: models.ReplaceKbDTO, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * @summary Asynchronous operation to modify a knowledgebase. + * + * @param {string} kbId Knowledgebase id. + * + * @param {object} updateKb Post body of the request. + * + * @param {object} [updateKb.add] An instance of CreateKbInputDTO for add + * operation + * + * @param {array} [updateKb.add.qnaList] List of QNA to be added to the index. + * Ids are generated by the service and should be omitted. + * + * @param {array} [updateKb.add.urls] List of URLs to be added to + * knowledgebase. + * + * @param {array} [updateKb.add.files] List of files to be added to + * knowledgebase. + * + * @param {object} [updateKb.deleteProperty] An instance of DeleteKbContentsDTO + * for delete Operation + * + * @param {array} [updateKb.deleteProperty.ids] List of Qna Ids to be deleted + * + * @param {array} [updateKb.deleteProperty.sources] List of sources to be + * deleted from knowledgebase. + * + * @param {object} [updateKb.update] An instance of UpdateKbContentsDTO for + * Update Operation + * + * @param {string} [updateKb.update.name] Friendly name for the knowledgebase. + * + * @param {array} [updateKb.update.qnaList] List of Q-A (UpdateQnaDTO) to be + * added to the knowledgebase. + * + * @param {array} [updateKb.update.urls] List of existing URLs to be refreshed. + * The content will be extracted again and re-indexed. + * + * @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. + */ + updateWithHttpOperationResponse(kbId: string, updateKb: models.UpdateKbOperationDTO, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Asynchronous operation to modify a knowledgebase. + * + * @param {string} kbId Knowledgebase id. + * + * @param {object} updateKb Post body of the request. + * + * @param {object} [updateKb.add] An instance of CreateKbInputDTO for add + * operation + * + * @param {array} [updateKb.add.qnaList] List of QNA to be added to the index. + * Ids are generated by the service and should be omitted. + * + * @param {array} [updateKb.add.urls] List of URLs to be added to + * knowledgebase. + * + * @param {array} [updateKb.add.files] List of files to be added to + * knowledgebase. + * + * @param {object} [updateKb.deleteProperty] An instance of DeleteKbContentsDTO + * for delete Operation + * + * @param {array} [updateKb.deleteProperty.ids] List of Qna Ids to be deleted + * + * @param {array} [updateKb.deleteProperty.sources] List of sources to be + * deleted from knowledgebase. + * + * @param {object} [updateKb.update] An instance of UpdateKbContentsDTO for + * Update Operation + * + * @param {string} [updateKb.update.name] Friendly name for the knowledgebase. + * + * @param {array} [updateKb.update.qnaList] List of Q-A (UpdateQnaDTO) to be + * added to the knowledgebase. + * + * @param {array} [updateKb.update.urls] List of existing URLs to be refreshed. + * The content will be extracted again and re-indexed. + * + * @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 {Operation} - 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. + * + * {Operation} [result] - The deserialized result object if an error did not occur. + * See {@link Operation} 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. + */ + update(kbId: string, updateKb: models.UpdateKbOperationDTO, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + update(kbId: string, updateKb: models.UpdateKbOperationDTO, callback: ServiceCallback): void; + update(kbId: string, updateKb: models.UpdateKbOperationDTO, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * @summary Asynchronous operation to create a new knowledgebase. + * + * @param {object} createKbPayload Post body of the request. + * + * @param {string} createKbPayload.name Friendly name for the knowledgebase. + * + * @param {array} [createKbPayload.qnaList] List of Q-A (QnADTO) to be added to + * the knowledgebase. Q-A Ids are assigned by the service and should be + * omitted. + * + * @param {array} [createKbPayload.urls] List of URLs to be used for extracting + * Q-A. + * + * @param {array} [createKbPayload.files] List of files from which to Extract + * Q-A. + * + * @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. + */ + createWithHttpOperationResponse(createKbPayload: models.CreateKbDTO, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Asynchronous operation to create a new knowledgebase. + * + * @param {object} createKbPayload Post body of the request. + * + * @param {string} createKbPayload.name Friendly name for the knowledgebase. + * + * @param {array} [createKbPayload.qnaList] List of Q-A (QnADTO) to be added to + * the knowledgebase. Q-A Ids are assigned by the service and should be + * omitted. + * + * @param {array} [createKbPayload.urls] List of URLs to be used for extracting + * Q-A. + * + * @param {array} [createKbPayload.files] List of files from which to Extract + * Q-A. + * + * @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 {Operation} - 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. + * + * {Operation} [result] - The deserialized result object if an error did not occur. + * See {@link Operation} 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. + */ + create(createKbPayload: models.CreateKbDTO, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + create(createKbPayload: models.CreateKbDTO, callback: ServiceCallback): void; + create(createKbPayload: models.CreateKbDTO, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * @summary Download the knowledgebase. + * + * @param {string} kbId Knowledgebase id. + * + * @param {string} environment Specifies whether environment is Test or Prod. + * Possible values include: 'Prod', 'Test' + * + * @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. + */ + downloadWithHttpOperationResponse(kbId: string, environment: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Download the knowledgebase. + * + * @param {string} kbId Knowledgebase id. + * + * @param {string} environment Specifies whether environment is Test or Prod. + * Possible values include: 'Prod', 'Test' + * + * @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 {QnADocumentsDTO} - 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. + * + * {QnADocumentsDTO} [result] - The deserialized result object if an error did not occur. + * See {@link QnADocumentsDTO} 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. + */ + download(kbId: string, environment: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + download(kbId: string, environment: string, callback: ServiceCallback): void; + download(kbId: string, environment: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * Operations + * __NOTE__: An instance of this class is automatically created for an + * instance of the QnAMakerClient. + */ +export interface Operations { + + + /** + * @summary Gets details of a specific long running operation. + * + * @param {string} operationId Operation id. + * + * @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. + */ + getDetailsWithHttpOperationResponse(operationId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * @summary Gets details of a specific long running operation. + * + * @param {string} operationId Operation id. + * + * @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 {Operation} - 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. + * + * {Operation} [result] - The deserialized result object if an error did not occur. + * See {@link Operation} 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. + */ + getDetails(operationId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + getDetails(operationId: string, callback: ServiceCallback): void; + getDetails(operationId: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} diff --git a/lib/services/dataLake.Store/lib/account/operations/index.js b/lib/services/cognitiveServicesQnAMaker/lib/operations/index.js similarity index 63% rename from lib/services/dataLake.Store/lib/account/operations/index.js rename to lib/services/cognitiveServicesQnAMaker/lib/operations/index.js index e537016285..e9106ddcdd 100644 --- a/lib/services/dataLake.Store/lib/account/operations/index.js +++ b/lib/services/cognitiveServicesQnAMaker/lib/operations/index.js @@ -14,9 +14,7 @@ 'use strict'; -exports.Accounts = require('./accounts'); -exports.FirewallRules = require('./firewallRules'); -exports.VirtualNetworkRules = require('./virtualNetworkRules'); -exports.TrustedIdProviders = require('./trustedIdProviders'); +exports.EndpointKeys = require('./endpointKeys'); +exports.Alterations = require('./alterations'); +exports.Knowledgebase = require('./knowledgebase'); exports.Operations = require('./operations'); -exports.Locations = require('./locations'); diff --git a/lib/services/dataLake.Store/lib/account/operations/firewallRules.js b/lib/services/cognitiveServicesQnAMaker/lib/operations/knowledgebase.js similarity index 51% rename from lib/services/dataLake.Store/lib/account/operations/firewallRules.js rename to lib/services/cognitiveServicesQnAMaker/lib/operations/knowledgebase.js index 77a5d3988b..4aec04a4c6 100644 --- a/lib/services/dataLake.Store/lib/account/operations/firewallRules.js +++ b/lib/services/cognitiveServicesQnAMaker/lib/operations/knowledgebase.js @@ -11,16 +11,10 @@ 'use strict'; const msRest = require('ms-rest'); -const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * Lists the Data Lake Store firewall rules within the specified Data Lake - * Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. + * @summary Gets all knowledgebases for a user. * * @param {object} [options] Optional Parameters. * @@ -34,14 +28,13 @@ const WebResource = msRest.WebResource; * {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 FirewallRuleListResult} for more - * information. + * See {@link KnowledgebasesDTO} 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 _listByAccount(resourceGroupName, accountName, options, callback) { +function _listAll(options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -53,20 +46,8 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { } // 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 (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - 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 (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.'); + if (this.client.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); } } catch (error) { return callback(error); @@ -74,15 +55,8 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules'; - requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); - requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{accountName}', encodeURIComponent(accountName)); - let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); - if (queryParameters.length > 0) { - requestUrl += '?' + queryParameters.join('&'); - } + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'knowledgebases'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); // Create HTTP transport objects let httpRequest = new WebResource(); @@ -91,12 +65,6 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { 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)) { @@ -121,12 +89,13 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { 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; + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['CloudError']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -146,7 +115,7 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['FirewallRuleListResult']().mapper(); + let resultMapper = new client.models['KnowledgebasesDTO']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -162,26 +131,9 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { } /** - * Creates or updates the specified firewall rule. During update, the firewall - * rule with the specified name will be replaced with this new firewall rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} firewallRuleName The name of the firewall rule to create or - * update. + * @summary Gets details of a specific knowledgebase. * - * @param {object} parameters Parameters supplied to create or update the - * firewall rule. - * - * @param {string} parameters.startIpAddress The start IP address for the - * firewall rule. This can be either ipv4 or ipv6. Start and End should be in - * the same protocol. - * - * @param {string} parameters.endIpAddress The end IP address for the firewall - * rule. This can be either ipv4 or ipv6. Start and End should be in the same - * protocol. + * @param {string} kbId Knowledgebase id. * * @param {object} [options] Optional Parameters. * @@ -195,13 +147,13 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { * {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 FirewallRule} for more information. + * See {@link KnowledgebaseDTO} 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 _createOrUpdate(resourceGroupName, accountName, firewallRuleName, parameters, options, callback) { +function _getDetails(kbId, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -213,26 +165,11 @@ function _createOrUpdate(resourceGroupName, accountName, firewallRuleName, param } // 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 (this.client.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); } - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (firewallRuleName === null || firewallRuleName === undefined || typeof firewallRuleName.valueOf() !== 'string') { - throw new Error('firewallRuleName cannot be null or undefined and it must be of type string.'); - } - if (parameters === null || parameters === undefined) { - throw new Error('parameters cannot be null or undefined.'); - } - 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 (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.'); + if (kbId === null || kbId === undefined || typeof kbId.valueOf() !== 'string') { + throw new Error('kbId cannot be null or undefined and it must be of type string.'); } } catch (error) { return callback(error); @@ -240,30 +177,17 @@ function _createOrUpdate(resourceGroupName, accountName, firewallRuleName, param // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}'; - requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); - requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{accountName}', encodeURIComponent(accountName)); - requestUrl = requestUrl.replace('{firewallRuleName}', encodeURIComponent(firewallRuleName)); - let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); - if (queryParameters.length > 0) { - requestUrl += '?' + queryParameters.join('&'); - } + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'knowledgebases/{kbId}'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + requestUrl = requestUrl.replace('{kbId}', encodeURIComponent(kbId)); // Create HTTP transport objects let httpRequest = new WebResource(); - httpRequest.method = 'PUT'; + httpRequest.method = 'GET'; 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)) { @@ -271,21 +195,7 @@ function _createOrUpdate(resourceGroupName, accountName, firewallRuleName, param } } } - // Serialize Request - let requestContent = null; - let requestModel = null; - try { - if (parameters !== null && parameters !== undefined) { - let requestModelMapper = new client.models['CreateOrUpdateFirewallRuleParameters']().mapper(); - requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); - requestContent = JSON.stringify(requestModel); - } - } catch (error) { - let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + - `payload - ${JSON.stringify(parameters, null, 2)}.`); - return callback(serializationError); - } - httpRequest.body = requestContent; + httpRequest.body = null; // Send Request return client.pipeline(httpRequest, (err, response, responseBody) => { if (err) { @@ -302,12 +212,13 @@ function _createOrUpdate(resourceGroupName, accountName, firewallRuleName, param 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; + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['CloudError']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -327,7 +238,7 @@ function _createOrUpdate(resourceGroupName, accountName, firewallRuleName, param parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['FirewallRule']().mapper(); + let resultMapper = new client.models['KnowledgebaseDTO']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -343,13 +254,9 @@ function _createOrUpdate(resourceGroupName, accountName, firewallRuleName, param } /** - * Gets the specified Data Lake Store firewall rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. + * @summary Deletes the knowledgebase and all its data. * - * @param {string} firewallRuleName The name of the firewall rule to retrieve. + * @param {string} kbId Knowledgebase id. * * @param {object} [options] Optional Parameters. * @@ -362,14 +269,13 @@ function _createOrUpdate(resourceGroupName, accountName, firewallRuleName, param * * {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 FirewallRule} for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {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 _get(resourceGroupName, accountName, firewallRuleName, options, callback) { +function _deleteMethod(kbId, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -381,23 +287,117 @@ function _get(resourceGroupName, accountName, firewallRuleName, options, callbac } // 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 (this.client.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint 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 (kbId === null || kbId === undefined || typeof kbId.valueOf() !== 'string') { + throw new Error('kbId cannot be null or undefined and it must be of type string.'); } - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'knowledgebases/{kbId}'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + requestUrl = requestUrl.replace('{kbId}', encodeURIComponent(kbId)); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'DELETE'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + if(options) { + for(let headerName in options['customHeaders']) { + if (options['customHeaders'].hasOwnProperty(headerName)) { + httpRequest.headers[headerName] = options['customHeaders'][headerName]; + } } - if (firewallRuleName === null || firewallRuleName === undefined || typeof firewallRuleName.valueOf() !== 'string') { - throw new Error('firewallRuleName cannot be null or undefined and it must be of type string.'); + } + httpRequest.body = null; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 204) { + 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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); } - 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.'); + // Create Result + let result = null; + if (responseBody === '') responseBody = null; + + return callback(null, result, httpRequest, response); + }); +} + +/** + * @summary Publishes all changes in test index of a knowledgebase to its prod + * index. + * + * @param {string} kbId Knowledgebase id. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _publish(kbId, 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.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); } - 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.'); + if (kbId === null || kbId === undefined || typeof kbId.valueOf() !== 'string') { + throw new Error('kbId cannot be null or undefined and it must be of type string.'); } } catch (error) { return callback(error); @@ -405,30 +405,17 @@ function _get(resourceGroupName, accountName, firewallRuleName, options, callbac // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}'; - requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); - requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{accountName}', encodeURIComponent(accountName)); - requestUrl = requestUrl.replace('{firewallRuleName}', encodeURIComponent(firewallRuleName)); - let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); - if (queryParameters.length > 0) { - requestUrl += '?' + queryParameters.join('&'); - } + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'knowledgebases/{kbId}'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + requestUrl = requestUrl.replace('{kbId}', encodeURIComponent(kbId)); // Create HTTP transport objects let httpRequest = new WebResource(); - httpRequest.method = 'GET'; + 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)) { @@ -443,7 +430,7 @@ function _get(resourceGroupName, accountName, firewallRuleName, options, callbac return callback(err); } let statusCode = response.statusCode; - if (statusCode !== 200) { + if (statusCode !== 204) { let error = new Error(responseBody); error.statusCode = response.statusCode; error.request = msRest.stripRequest(httpRequest); @@ -453,12 +440,13 @@ function _get(resourceGroupName, accountName, firewallRuleName, options, callbac 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; + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['CloudError']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -471,49 +459,178 @@ function _get(resourceGroupName, accountName, firewallRuleName, options, callbac // Create Result let result = null; if (responseBody === '') responseBody = null; - // Deserialize Response - if (statusCode === 200) { - let parsedResponse = null; + + return callback(null, result, httpRequest, response); + }); +} + +/** + * @summary Replace knowledgebase contents. + * + * @param {string} kbId Knowledgebase id. + * + * @param {object} replaceKb An instance of ReplaceKbDTO which contains list of + * qnas to be uploaded + * + * @param {array} replaceKb.qnAList List of Q-A (QnADTO) to be added to the + * knowledgebase. Q-A Ids are assigned by the service and should be omitted. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _replace(kbId, replaceKb, 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.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); + } + if (kbId === null || kbId === undefined || typeof kbId.valueOf() !== 'string') { + throw new Error('kbId cannot be null or undefined and it must be of type string.'); + } + if (replaceKb === null || replaceKb === undefined) { + throw new Error('replaceKb cannot be null or undefined.'); + } + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'knowledgebases/{kbId}'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + requestUrl = requestUrl.replace('{kbId}', encodeURIComponent(kbId)); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'PUT'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + 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 (replaceKb !== null && replaceKb !== undefined) { + let requestModelMapper = new client.models['ReplaceKbDTO']().mapper(); + requestModel = client.serialize(requestModelMapper, replaceKb, 'replaceKb'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(replaceKb, 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 !== 204) { + 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 { - parsedResponse = JSON.parse(responseBody); - result = JSON.parse(responseBody); - if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['FirewallRule']().mapper(); - result = client.deserialize(resultMapper, parsedResponse, 'result'); + parsedErrorResponse = JSON.parse(responseBody); + if (parsedErrorResponse) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; } - } 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); + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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; return callback(null, result, httpRequest, response); }); } /** - * Updates the specified firewall rule. + * @summary Asynchronous operation to modify a knowledgebase. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} kbId Knowledgebase id. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {object} updateKb Post body of the request. * - * @param {string} firewallRuleName The name of the firewall rule to update. + * @param {object} [updateKb.add] An instance of CreateKbInputDTO for add + * operation * - * @param {object} [options] Optional Parameters. + * @param {array} [updateKb.add.qnaList] List of QNA to be added to the index. + * Ids are generated by the service and should be omitted. + * + * @param {array} [updateKb.add.urls] List of URLs to be added to + * knowledgebase. + * + * @param {array} [updateKb.add.files] List of files to be added to + * knowledgebase. + * + * @param {object} [updateKb.deleteProperty] An instance of DeleteKbContentsDTO + * for delete Operation + * + * @param {array} [updateKb.deleteProperty.ids] List of Qna Ids to be deleted + * + * @param {array} [updateKb.deleteProperty.sources] List of sources to be + * deleted from knowledgebase. * - * @param {object} [options.parameters] Parameters supplied to update the - * firewall rule. + * @param {object} [updateKb.update] An instance of UpdateKbContentsDTO for + * Update Operation * - * @param {string} [options.parameters.startIpAddress] The start IP address for - * the firewall rule. This can be either ipv4 or ipv6. Start and End should be - * in the same protocol. + * @param {string} [updateKb.update.name] Friendly name for the knowledgebase. * - * @param {string} [options.parameters.endIpAddress] The end IP address for the - * firewall rule. This can be either ipv4 or ipv6. Start and End should be in - * the same protocol. + * @param {array} [updateKb.update.qnaList] List of Q-A (UpdateQnaDTO) to be + * added to the knowledgebase. + * + * @param {array} [updateKb.update.urls] List of existing URLs to be refreshed. + * The content will be extracted again and re-indexed. + * + * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request @@ -525,13 +642,13 @@ function _get(resourceGroupName, accountName, firewallRuleName, options, callbac * {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 FirewallRule} for more information. + * See {@link Operation} 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 _update(resourceGroupName, accountName, firewallRuleName, options, callback) { +function _update(kbId, updateKb, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -541,26 +658,16 @@ function _update(resourceGroupName, accountName, firewallRuleName, options, call if (!callback) { throw new Error('callback cannot be null.'); } - let parameters = (options && options.parameters !== undefined) ? options.parameters : undefined; // 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 (this.client.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); } - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); + if (kbId === null || kbId === undefined || typeof kbId.valueOf() !== 'string') { + throw new Error('kbId cannot be null or undefined and it must be of type string.'); } - if (firewallRuleName === null || firewallRuleName === undefined || typeof firewallRuleName.valueOf() !== 'string') { - throw new Error('firewallRuleName cannot be null or undefined and it must be of type string.'); - } - 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 (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.'); + if (updateKb === null || updateKb === undefined) { + throw new Error('updateKb cannot be null or undefined.'); } } catch (error) { return callback(error); @@ -568,16 +675,9 @@ function _update(resourceGroupName, accountName, firewallRuleName, options, call // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}'; - requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); - requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{accountName}', encodeURIComponent(accountName)); - requestUrl = requestUrl.replace('{firewallRuleName}', encodeURIComponent(firewallRuleName)); - let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); - if (queryParameters.length > 0) { - requestUrl += '?' + queryParameters.join('&'); - } + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'knowledgebases/{kbId}'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + requestUrl = requestUrl.replace('{kbId}', encodeURIComponent(kbId)); // Create HTTP transport objects let httpRequest = new WebResource(); @@ -586,12 +686,6 @@ function _update(resourceGroupName, accountName, firewallRuleName, options, call 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)) { @@ -603,14 +697,14 @@ function _update(resourceGroupName, accountName, firewallRuleName, options, call let requestContent = null; let requestModel = null; try { - if (parameters !== null && parameters !== undefined) { - let requestModelMapper = new client.models['UpdateFirewallRuleParameters']().mapper(); - requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + if (updateKb !== null && updateKb !== undefined) { + let requestModelMapper = new client.models['UpdateKbOperationDTO']().mapper(); + requestModel = client.serialize(requestModelMapper, updateKb, 'updateKb'); requestContent = JSON.stringify(requestModel); } } catch (error) { let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + - `payload - ${JSON.stringify(parameters, null, 2)}.`); + `payload - ${JSON.stringify(updateKb, null, 2)}.`); return callback(serializationError); } httpRequest.body = requestContent; @@ -620,7 +714,7 @@ function _update(resourceGroupName, accountName, firewallRuleName, options, call return callback(err); } let statusCode = response.statusCode; - if (statusCode !== 200) { + if (statusCode !== 202) { let error = new Error(responseBody); error.statusCode = response.statusCode; error.request = msRest.stripRequest(httpRequest); @@ -630,12 +724,13 @@ function _update(resourceGroupName, accountName, firewallRuleName, options, call 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; + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['CloudError']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -649,13 +744,13 @@ function _update(resourceGroupName, accountName, firewallRuleName, options, call let result = null; if (responseBody === '') responseBody = null; // Deserialize Response - if (statusCode === 200) { + if (statusCode === 202) { let parsedResponse = null; try { parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['FirewallRule']().mapper(); + let resultMapper = new client.models['Operation']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -671,14 +766,21 @@ function _update(resourceGroupName, accountName, firewallRuleName, options, call } /** - * Deletes the specified firewall rule from the specified Data Lake Store - * account. + * @summary Asynchronous operation to create a new knowledgebase. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {object} createKbPayload Post body of the request. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} createKbPayload.name Friendly name for the knowledgebase. * - * @param {string} firewallRuleName The name of the firewall rule to delete. + * @param {array} [createKbPayload.qnaList] List of Q-A (QnADTO) to be added to + * the knowledgebase. Q-A Ids are assigned by the service and should be + * omitted. + * + * @param {array} [createKbPayload.urls] List of URLs to be used for extracting + * Q-A. + * + * @param {array} [createKbPayload.files] List of files from which to Extract + * Q-A. * * @param {object} [options] Optional Parameters. * @@ -691,13 +793,14 @@ function _update(resourceGroupName, accountName, firewallRuleName, options, call * * {Error} err - The Error object if an error occurred, null otherwise. * - * {null} [result] - The deserialized result object if an error did not occur. + * {object} [result] - The deserialized result object if an error did not occur. + * See {@link Operation} 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 _deleteMethod(resourceGroupName, accountName, firewallRuleName, options, callback) { +function _create(createKbPayload, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -709,23 +812,11 @@ function _deleteMethod(resourceGroupName, accountName, firewallRuleName, options } // 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 (this.client.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint 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 (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (firewallRuleName === null || firewallRuleName === undefined || typeof firewallRuleName.valueOf() !== 'string') { - throw new Error('firewallRuleName cannot be null or undefined and it must be of type string.'); - } - 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 (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.'); + if (createKbPayload === null || createKbPayload === undefined) { + throw new Error('createKbPayload cannot be null or undefined.'); } } catch (error) { return callback(error); @@ -733,30 +824,16 @@ function _deleteMethod(resourceGroupName, accountName, firewallRuleName, options // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}'; - requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); - requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{accountName}', encodeURIComponent(accountName)); - requestUrl = requestUrl.replace('{firewallRuleName}', encodeURIComponent(firewallRuleName)); - let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); - if (queryParameters.length > 0) { - requestUrl += '?' + queryParameters.join('&'); - } + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'knowledgebases/create'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); // Create HTTP transport objects let httpRequest = new WebResource(); - httpRequest.method = 'DELETE'; + 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)) { @@ -764,14 +841,28 @@ function _deleteMethod(resourceGroupName, accountName, firewallRuleName, options } } } - httpRequest.body = null; + // Serialize Request + let requestContent = null; + let requestModel = null; + try { + if (createKbPayload !== null && createKbPayload !== undefined) { + let requestModelMapper = new client.models['CreateKbDTO']().mapper(); + requestModel = client.serialize(requestModelMapper, createKbPayload, 'createKbPayload'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(createKbPayload, 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 && statusCode !== 204) { + if (statusCode !== 202) { let error = new Error(responseBody); error.statusCode = response.statusCode; error.request = msRest.stripRequest(httpRequest); @@ -781,12 +872,13 @@ function _deleteMethod(resourceGroupName, accountName, firewallRuleName, options 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; + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['CloudError']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -799,17 +891,35 @@ function _deleteMethod(resourceGroupName, accountName, firewallRuleName, options // Create Result let result = null; if (responseBody === '') responseBody = null; + // Deserialize Response + if (statusCode === 202) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['Operation']().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 the Data Lake Store firewall rules within the specified Data Lake - * Store account. + * @summary Download the knowledgebase. + * + * @param {string} kbId Knowledgebase id. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} environment Specifies whether environment is Test or Prod. + * Possible values include: 'Prod', 'Test' * * @param {object} [options] Optional Parameters. * @@ -823,14 +933,13 @@ function _deleteMethod(resourceGroupName, accountName, firewallRuleName, options * {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 FirewallRuleListResult} for more - * information. + * See {@link QnADocumentsDTO} 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 _listByAccountNext(nextPageLink, options, callback) { +function _download(kbId, environment, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -842,19 +951,25 @@ function _listByAccountNext(nextPageLink, options, callback) { } // Validate try { - if (nextPageLink === null || nextPageLink === undefined || typeof nextPageLink.valueOf() !== 'string') { - throw new Error('nextPageLink cannot be null or undefined and it must be of type string.'); + if (this.client.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); + } + if (kbId === null || kbId === undefined || typeof kbId.valueOf() !== 'string') { + throw new Error('kbId cannot be null or undefined and it must be of type string.'); } - 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.'); + if (environment === null || environment === undefined || typeof environment.valueOf() !== 'string') { + throw new Error('environment cannot be null or undefined and it must be of type string.'); } } catch (error) { return callback(error); } // Construct URL - let requestUrl = '{nextLink}'; - requestUrl = requestUrl.replace('{nextLink}', nextPageLink); + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'knowledgebases/{kbId}/{environment}/qna'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + requestUrl = requestUrl.replace('{kbId}', encodeURIComponent(kbId)); + requestUrl = requestUrl.replace('{environment}', encodeURIComponent(environment)); // Create HTTP transport objects let httpRequest = new WebResource(); @@ -863,12 +978,6 @@ function _listByAccountNext(nextPageLink, options, callback) { 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)) { @@ -893,12 +1002,13 @@ function _listByAccountNext(nextPageLink, options, callback) { 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; + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['CloudError']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -918,7 +1028,7 @@ function _listByAccountNext(nextPageLink, options, callback) { parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['FirewallRuleListResult']().mapper(); + let resultMapper = new client.models['QnADocumentsDTO']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -933,29 +1043,26 @@ function _listByAccountNext(nextPageLink, options, callback) { }); } -/** Class representing a FirewallRules. */ -class FirewallRules { +/** Class representing a Knowledgebase. */ +class Knowledgebase { /** - * Create a FirewallRules. - * @param {DataLakeStoreAccountManagementClient} client Reference to the service client. + * Create a Knowledgebase. + * @param {QnAMakerClient} client Reference to the service client. */ constructor(client) { this.client = client; - this._listByAccount = _listByAccount; - this._createOrUpdate = _createOrUpdate; - this._get = _get; - this._update = _update; + this._listAll = _listAll; + this._getDetails = _getDetails; this._deleteMethod = _deleteMethod; - this._listByAccountNext = _listByAccountNext; + this._publish = _publish; + this._replace = _replace; + this._update = _update; + this._create = _create; + this._download = _download; } /** - * Lists the Data Lake Store firewall rules within the specified Data Lake - * Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. + * @summary Gets all knowledgebases for a user. * * @param {object} [options] Optional Parameters. * @@ -964,15 +1071,15 @@ class FirewallRules { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - listByAccountWithHttpOperationResponse(resourceGroupName, accountName, options) { + listAllWithHttpOperationResponse(options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._listByAccount(resourceGroupName, accountName, options, (err, result, request, response) => { + self._listAll(options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -983,12 +1090,7 @@ class FirewallRules { } /** - * Lists the Data Lake Store firewall rules within the specified Data Lake - * Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. + * @summary Gets all knowledgebases for a user. * * @param {object} [options] Optional Parameters. * @@ -1002,7 +1104,7 @@ class FirewallRules { * * {Promise} A promise is returned * - * @resolve {FirewallRuleListResult} - The deserialized result object. + * @resolve {KnowledgebasesDTO} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1011,14 +1113,13 @@ class FirewallRules { * {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 FirewallRuleListResult} for more - * information. + * See {@link KnowledgebasesDTO} 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. */ - listByAccount(resourceGroupName, accountName, options, optionalCallback) { + listAll(options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1027,38 +1128,103 @@ class FirewallRules { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._listByAccount(resourceGroupName, accountName, options, (err, result, request, response) => { + self._listAll(options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._listByAccount(resourceGroupName, accountName, options, optionalCallback); + return self._listAll(options, optionalCallback); } } /** - * Creates or updates the specified firewall rule. During update, the firewall - * rule with the specified name will be replaced with this new firewall rule. + * @summary Gets details of a specific knowledgebase. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} kbId Knowledgebase id. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {object} [options] Optional Parameters. * - * @param {string} firewallRuleName The name of the firewall rule to create or - * update. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {object} parameters Parameters supplied to create or update the - * firewall rule. + * @returns {Promise} A promise is returned + * + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {string} parameters.startIpAddress The start IP address for the - * firewall rule. This can be either ipv4 or ipv6. Start and End should be in - * the same protocol. + * @reject {Error} - The error object. + */ + getDetailsWithHttpOperationResponse(kbId, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._getDetails(kbId, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * @summary Gets details of a specific knowledgebase. * - * @param {string} parameters.endIpAddress The end IP address for the firewall - * rule. This can be either ipv4 or ipv6. Start and End should be in the same - * protocol. + * @param {string} kbId Knowledgebase id. + * + * @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 {KnowledgebaseDTO} - 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 KnowledgebaseDTO} 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. + */ + getDetails(kbId, 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._getDetails(kbId, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._getDetails(kbId, options, optionalCallback); + } + } + + /** + * @summary Deletes the knowledgebase and all its data. + * + * @param {string} kbId Knowledgebase id. * * @param {object} [options] Optional Parameters. * @@ -1067,15 +1233,15 @@ class FirewallRules { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - createOrUpdateWithHttpOperationResponse(resourceGroupName, accountName, firewallRuleName, parameters, options) { + deleteMethodWithHttpOperationResponse(kbId, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._createOrUpdate(resourceGroupName, accountName, firewallRuleName, parameters, options, (err, result, request, response) => { + self._deleteMethod(kbId, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1086,26 +1252,92 @@ class FirewallRules { } /** - * Creates or updates the specified firewall rule. During update, the firewall - * rule with the specified name will be replaced with this new firewall rule. + * @summary Deletes the knowledgebase and all its data. + * + * @param {string} kbId Knowledgebase id. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + deleteMethod(kbId, 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._deleteMethod(kbId, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._deleteMethod(kbId, options, optionalCallback); + } + } + + /** + * @summary Publishes all changes in test index of a knowledgebase to its prod + * index. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} kbId Knowledgebase id. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {object} [options] Optional Parameters. * - * @param {string} firewallRuleName The name of the firewall rule to create or - * update. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {object} parameters Parameters supplied to create or update the - * firewall rule. + * @returns {Promise} A promise is returned * - * @param {string} parameters.startIpAddress The start IP address for the - * firewall rule. This can be either ipv4 or ipv6. Start and End should be in - * the same protocol. + * @resolve {HttpOperationResponse} - The deserialized result object. + * + * @reject {Error} - The error object. + */ + publishWithHttpOperationResponse(kbId, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._publish(kbId, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * @summary Publishes all changes in test index of a knowledgebase to its prod + * index. * - * @param {string} parameters.endIpAddress The end IP address for the firewall - * rule. This can be either ipv4 or ipv6. Start and End should be in the same - * protocol. + * @param {string} kbId Knowledgebase id. * * @param {object} [options] Optional Parameters. * @@ -1119,7 +1351,7 @@ class FirewallRules { * * {Promise} A promise is returned * - * @resolve {FirewallRule} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1127,14 +1359,13 @@ class FirewallRules { * * {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 FirewallRule} for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {object} [request] - The HTTP Request object if an error did not occur. * * {stream} [response] - The HTTP Response stream if an error did not occur. */ - createOrUpdate(resourceGroupName, accountName, firewallRuleName, parameters, options, optionalCallback) { + publish(kbId, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1143,25 +1374,27 @@ class FirewallRules { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._createOrUpdate(resourceGroupName, accountName, firewallRuleName, parameters, options, (err, result, request, response) => { + self._publish(kbId, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._createOrUpdate(resourceGroupName, accountName, firewallRuleName, parameters, options, optionalCallback); + return self._publish(kbId, options, optionalCallback); } } /** - * Gets the specified Data Lake Store firewall rule. + * @summary Replace knowledgebase contents. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} kbId Knowledgebase id. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {object} replaceKb An instance of ReplaceKbDTO which contains list of + * qnas to be uploaded * - * @param {string} firewallRuleName The name of the firewall rule to retrieve. + * @param {array} replaceKb.qnAList List of Q-A (QnADTO) to be added to the + * knowledgebase. Q-A Ids are assigned by the service and should be omitted. * * @param {object} [options] Optional Parameters. * @@ -1170,15 +1403,15 @@ class FirewallRules { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - getWithHttpOperationResponse(resourceGroupName, accountName, firewallRuleName, options) { + replaceWithHttpOperationResponse(kbId, replaceKb, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._get(resourceGroupName, accountName, firewallRuleName, options, (err, result, request, response) => { + self._replace(kbId, replaceKb, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1189,13 +1422,15 @@ class FirewallRules { } /** - * Gets the specified Data Lake Store firewall rule. + * @summary Replace knowledgebase contents. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} kbId Knowledgebase id. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {object} replaceKb An instance of ReplaceKbDTO which contains list of + * qnas to be uploaded * - * @param {string} firewallRuleName The name of the firewall rule to retrieve. + * @param {array} replaceKb.qnAList List of Q-A (QnADTO) to be added to the + * knowledgebase. Q-A Ids are assigned by the service and should be omitted. * * @param {object} [options] Optional Parameters. * @@ -1209,7 +1444,7 @@ class FirewallRules { * * {Promise} A promise is returned * - * @resolve {FirewallRule} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1217,14 +1452,13 @@ class FirewallRules { * * {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 FirewallRule} for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {object} [request] - The HTTP Request object if an error did not occur. * * {stream} [response] - The HTTP Response stream if an error did not occur. */ - get(resourceGroupName, accountName, firewallRuleName, options, optionalCallback) { + replace(kbId, replaceKb, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1233,53 +1467,71 @@ class FirewallRules { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._get(resourceGroupName, accountName, firewallRuleName, options, (err, result, request, response) => { + self._replace(kbId, replaceKb, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._get(resourceGroupName, accountName, firewallRuleName, options, optionalCallback); + return self._replace(kbId, replaceKb, options, optionalCallback); } } /** - * Updates the specified firewall rule. + * @summary Asynchronous operation to modify a knowledgebase. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} kbId Knowledgebase id. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {object} updateKb Post body of the request. * - * @param {string} firewallRuleName The name of the firewall rule to update. + * @param {object} [updateKb.add] An instance of CreateKbInputDTO for add + * operation * - * @param {object} [options] Optional Parameters. + * @param {array} [updateKb.add.qnaList] List of QNA to be added to the index. + * Ids are generated by the service and should be omitted. + * + * @param {array} [updateKb.add.urls] List of URLs to be added to + * knowledgebase. + * + * @param {array} [updateKb.add.files] List of files to be added to + * knowledgebase. + * + * @param {object} [updateKb.deleteProperty] An instance of DeleteKbContentsDTO + * for delete Operation + * + * @param {array} [updateKb.deleteProperty.ids] List of Qna Ids to be deleted + * + * @param {array} [updateKb.deleteProperty.sources] List of sources to be + * deleted from knowledgebase. + * + * @param {object} [updateKb.update] An instance of UpdateKbContentsDTO for + * Update Operation * - * @param {object} [options.parameters] Parameters supplied to update the - * firewall rule. + * @param {string} [updateKb.update.name] Friendly name for the knowledgebase. * - * @param {string} [options.parameters.startIpAddress] The start IP address for - * the firewall rule. This can be either ipv4 or ipv6. Start and End should be - * in the same protocol. + * @param {array} [updateKb.update.qnaList] List of Q-A (UpdateQnaDTO) to be + * added to the knowledgebase. * - * @param {string} [options.parameters.endIpAddress] The end IP address for the - * firewall rule. This can be either ipv4 or ipv6. Start and End should be in - * the same protocol. + * @param {array} [updateKb.update.urls] List of existing URLs to be refreshed. + * The content will be extracted again and re-indexed. + * + * @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. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - updateWithHttpOperationResponse(resourceGroupName, accountName, firewallRuleName, options) { + updateWithHttpOperationResponse(kbId, updateKb, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._update(resourceGroupName, accountName, firewallRuleName, options, (err, result, request, response) => { + self._update(kbId, updateKb, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1290,26 +1542,44 @@ class FirewallRules { } /** - * Updates the specified firewall rule. + * @summary Asynchronous operation to modify a knowledgebase. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} kbId Knowledgebase id. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {object} updateKb Post body of the request. * - * @param {string} firewallRuleName The name of the firewall rule to update. + * @param {object} [updateKb.add] An instance of CreateKbInputDTO for add + * operation * - * @param {object} [options] Optional Parameters. + * @param {array} [updateKb.add.qnaList] List of QNA to be added to the index. + * Ids are generated by the service and should be omitted. + * + * @param {array} [updateKb.add.urls] List of URLs to be added to + * knowledgebase. + * + * @param {array} [updateKb.add.files] List of files to be added to + * knowledgebase. + * + * @param {object} [updateKb.deleteProperty] An instance of DeleteKbContentsDTO + * for delete Operation + * + * @param {array} [updateKb.deleteProperty.ids] List of Qna Ids to be deleted * - * @param {object} [options.parameters] Parameters supplied to update the - * firewall rule. + * @param {array} [updateKb.deleteProperty.sources] List of sources to be + * deleted from knowledgebase. * - * @param {string} [options.parameters.startIpAddress] The start IP address for - * the firewall rule. This can be either ipv4 or ipv6. Start and End should be - * in the same protocol. + * @param {object} [updateKb.update] An instance of UpdateKbContentsDTO for + * Update Operation * - * @param {string} [options.parameters.endIpAddress] The end IP address for the - * firewall rule. This can be either ipv4 or ipv6. Start and End should be in - * the same protocol. + * @param {string} [updateKb.update.name] Friendly name for the knowledgebase. + * + * @param {array} [updateKb.update.qnaList] List of Q-A (UpdateQnaDTO) to be + * added to the knowledgebase. + * + * @param {array} [updateKb.update.urls] List of existing URLs to be refreshed. + * The content will be extracted again and re-indexed. + * + * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request @@ -1321,7 +1591,7 @@ class FirewallRules { * * {Promise} A promise is returned * - * @resolve {FirewallRule} - The deserialized result object. + * @resolve {Operation} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1330,13 +1600,13 @@ class FirewallRules { * {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 FirewallRule} for more information. + * See {@link Operation} 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. */ - update(resourceGroupName, accountName, firewallRuleName, options, optionalCallback) { + update(kbId, updateKb, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1345,26 +1615,33 @@ class FirewallRules { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._update(resourceGroupName, accountName, firewallRuleName, options, (err, result, request, response) => { + self._update(kbId, updateKb, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._update(resourceGroupName, accountName, firewallRuleName, options, optionalCallback); + return self._update(kbId, updateKb, options, optionalCallback); } } /** - * Deletes the specified firewall rule from the specified Data Lake Store - * account. + * @summary Asynchronous operation to create a new knowledgebase. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {object} createKbPayload Post body of the request. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} createKbPayload.name Friendly name for the knowledgebase. * - * @param {string} firewallRuleName The name of the firewall rule to delete. + * @param {array} [createKbPayload.qnaList] List of Q-A (QnADTO) to be added to + * the knowledgebase. Q-A Ids are assigned by the service and should be + * omitted. + * + * @param {array} [createKbPayload.urls] List of URLs to be used for extracting + * Q-A. + * + * @param {array} [createKbPayload.files] List of files from which to Extract + * Q-A. * * @param {object} [options] Optional Parameters. * @@ -1373,15 +1650,15 @@ class FirewallRules { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - deleteMethodWithHttpOperationResponse(resourceGroupName, accountName, firewallRuleName, options) { + createWithHttpOperationResponse(createKbPayload, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._deleteMethod(resourceGroupName, accountName, firewallRuleName, options, (err, result, request, response) => { + self._create(createKbPayload, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1392,14 +1669,21 @@ class FirewallRules { } /** - * Deletes the specified firewall rule from the specified Data Lake Store - * account. + * @summary Asynchronous operation to create a new knowledgebase. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {object} createKbPayload Post body of the request. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} createKbPayload.name Friendly name for the knowledgebase. * - * @param {string} firewallRuleName The name of the firewall rule to delete. + * @param {array} [createKbPayload.qnaList] List of Q-A (QnADTO) to be added to + * the knowledgebase. Q-A Ids are assigned by the service and should be + * omitted. + * + * @param {array} [createKbPayload.urls] List of URLs to be used for extracting + * Q-A. + * + * @param {array} [createKbPayload.files] List of files from which to Extract + * Q-A. * * @param {object} [options] Optional Parameters. * @@ -1413,7 +1697,7 @@ class FirewallRules { * * {Promise} A promise is returned * - * @resolve {null} - The deserialized result object. + * @resolve {Operation} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1421,13 +1705,14 @@ class FirewallRules { * * {Error} err - The Error object if an error occurred, null otherwise. * - * {null} [result] - The deserialized result object if an error did not occur. + * {object} [result] - The deserialized result object if an error did not occur. + * See {@link Operation} 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. */ - deleteMethod(resourceGroupName, accountName, firewallRuleName, options, optionalCallback) { + create(createKbPayload, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1436,23 +1721,24 @@ class FirewallRules { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._deleteMethod(resourceGroupName, accountName, firewallRuleName, options, (err, result, request, response) => { + self._create(createKbPayload, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._deleteMethod(resourceGroupName, accountName, firewallRuleName, options, optionalCallback); + return self._create(createKbPayload, options, optionalCallback); } } /** - * Lists the Data Lake Store firewall rules within the specified Data Lake - * Store account. + * @summary Download the knowledgebase. + * + * @param {string} kbId Knowledgebase id. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} environment Specifies whether environment is Test or Prod. + * Possible values include: 'Prod', 'Test' * * @param {object} [options] Optional Parameters. * @@ -1461,15 +1747,15 @@ class FirewallRules { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - listByAccountNextWithHttpOperationResponse(nextPageLink, options) { + downloadWithHttpOperationResponse(kbId, environment, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._listByAccountNext(nextPageLink, options, (err, result, request, response) => { + self._download(kbId, environment, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1480,11 +1766,12 @@ class FirewallRules { } /** - * Lists the Data Lake Store firewall rules within the specified Data Lake - * Store account. + * @summary Download the knowledgebase. + * + * @param {string} kbId Knowledgebase id. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} environment Specifies whether environment is Test or Prod. + * Possible values include: 'Prod', 'Test' * * @param {object} [options] Optional Parameters. * @@ -1498,7 +1785,7 @@ class FirewallRules { * * {Promise} A promise is returned * - * @resolve {FirewallRuleListResult} - The deserialized result object. + * @resolve {QnADocumentsDTO} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1507,14 +1794,13 @@ class FirewallRules { * {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 FirewallRuleListResult} for more - * information. + * See {@link QnADocumentsDTO} 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. */ - listByAccountNext(nextPageLink, options, optionalCallback) { + download(kbId, environment, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1523,17 +1809,17 @@ class FirewallRules { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._listByAccountNext(nextPageLink, options, (err, result, request, response) => { + self._download(kbId, environment, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._listByAccountNext(nextPageLink, options, optionalCallback); + return self._download(kbId, environment, options, optionalCallback); } } } -module.exports = FirewallRules; +module.exports = Knowledgebase; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/operations/operations.js b/lib/services/cognitiveServicesQnAMaker/lib/operations/operations.js new file mode 100644 index 0000000000..8e94e97361 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/operations/operations.js @@ -0,0 +1,234 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const WebResource = msRest.WebResource; + +/** + * @summary Gets details of a specific long running operation. + * + * @param {string} operationId Operation id. + * + * @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 Operation} 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 _getDetails(operationId, 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.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); + } + if (operationId === null || operationId === undefined || typeof operationId.valueOf() !== 'string') { + throw new Error('operationId cannot be null or undefined and it must be of type string.'); + } + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'operations/{operationId}'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + requestUrl = requestUrl.replace('{operationId}', encodeURIComponent(operationId)); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + if(options) { + for(let headerName in options['customHeaders']) { + if (options['customHeaders'].hasOwnProperty(headerName)) { + httpRequest.headers[headerName] = options['customHeaders'][headerName]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['Operation']().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); + }); +} + +/** Class representing a Operations. */ +class Operations { + /** + * Create a Operations. + * @param {QnAMakerClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._getDetails = _getDetails; + } + + /** + * @summary Gets details of a specific long running operation. + * + * @param {string} operationId Operation id. + * + * @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. + */ + getDetailsWithHttpOperationResponse(operationId, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._getDetails(operationId, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * @summary Gets details of a specific long running operation. + * + * @param {string} operationId Operation id. + * + * @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 {Operation} - 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 Operation} 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. + */ + getDetails(operationId, 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._getDetails(operationId, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._getDetails(operationId, options, optionalCallback); + } + } + +} + +module.exports = Operations; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/qnAMakerClient.d.ts b/lib/services/cognitiveServicesQnAMaker/lib/qnAMakerClient.d.ts new file mode 100644 index 0000000000..6822553a5d --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/qnAMakerClient.d.ts @@ -0,0 +1,48 @@ +/* + * 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. + */ + +import { ServiceClient, ServiceClientOptions, ServiceClientCredentials } from 'ms-rest'; +import * as models from "./models"; +import * as operations from "./operations"; + +export default class QnAMakerClient extends ServiceClient { + /** + * @class + * Initializes a new instance of the QnAMakerClient class. + * @constructor + * + * @param {credentials} credentials - Subscription credentials which uniquely identify client subscription. + * + * @param {string} endpoint - Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). + * + * @param {object} [options] - The parameter options + * + * @param {Array} [options.filters] - Filters to be added to the request pipeline + * + * @param {object} [options.requestOptions] - Options for the underlying request object + * {@link https://github.com/request/request#requestoptions-callback Options doc} + * + * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy + * + */ + constructor(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions); + + credentials: ServiceClientCredentials; + + endpoint: string; + + // Operation groups + endpointKeys: operations.EndpointKeys; + alterations: operations.Alterations; + knowledgebase: operations.Knowledgebase; + operations: operations.Operations; +} + +export { QnAMakerClient, models as QnAMakerModels }; diff --git a/lib/services/cognitiveServicesQnAMaker/lib/qnAMakerClient.js b/lib/services/cognitiveServicesQnAMaker/lib/qnAMakerClient.js new file mode 100644 index 0000000000..71f3f5cae4 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/lib/qnAMakerClient.js @@ -0,0 +1,67 @@ +/* + * 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. + */ + +/* jshint latedef:false */ +/* jshint forin:false */ +/* jshint noempty:false */ + +'use strict'; + +const msRest = require('ms-rest'); +const ServiceClient = msRest.ServiceClient; + +const models = require('./models'); +const operations = require('./operations'); + + +/** Class representing a QnAMakerClient. */ +class QnAMakerClient extends ServiceClient { + /** + * Create a QnAMakerClient. + * @param {credentials} credentials - Subscription credentials which uniquely identify client subscription. + * @param {string} endpoint - Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com). + * @param {object} [options] - The parameter options + * @param {Array} [options.filters] - Filters to be added to the request pipeline + * @param {object} [options.requestOptions] - Options for the underlying request object + * {@link https://github.com/request/request#requestoptions-callback Options doc} + * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy + */ + constructor(credentials, endpoint, options) { + if (credentials === null || credentials === undefined) { + throw new Error('\'credentials\' cannot be null.'); + } + if (endpoint === null || endpoint === undefined) { + throw new Error('\'endpoint\' cannot be null.'); + } + + if (!options) options = {}; + + super(credentials, options); + + this.baseUri = '{Endpoint}/qnamaker/v4.0'; + this.credentials = credentials; + this.endpoint = endpoint; + + let packageInfo = this.getPackageJsonInfo(__dirname); + this.addUserAgentInfo(`${packageInfo.name}/${packageInfo.version}`); + this.endpointKeys = new operations.EndpointKeys(this); + this.alterations = new operations.Alterations(this); + this.knowledgebase = new operations.Knowledgebase(this); + this.operations = new operations.Operations(this); + this.models = models; + msRest.addSerializationMixin(this); + } + +} + +module.exports = QnAMakerClient; +module.exports['default'] = QnAMakerClient; +module.exports.QnAMakerClient = QnAMakerClient; +module.exports.QnAMakerModels = models; diff --git a/lib/services/cognitiveServicesQnAMaker/package.json b/lib/services/cognitiveServicesQnAMaker/package.json new file mode 100644 index 0000000000..b0b41c7786 --- /dev/null +++ b/lib/services/cognitiveServicesQnAMaker/package.json @@ -0,0 +1,24 @@ +{ + "name": "azure-cognitiveservices-qnamaker", + "author": "Microsoft Corporation", + "description": "QnAMakerClient Library with typescript type definitions for node", + "version": "1.0.0", + "dependencies": { + "ms-rest": "^2.3.3" + }, + "keywords": [ + "node", + "azure" + ], + "license": "MIT", + "main": "./lib/qnAMakerClient.js", + "types": "./lib/qnAMakerClient.d.ts", + "homepage": "https://github.com/azure/azure-sdk-for-node/tree/master/lib/services/cognitiveServicesQnAMaker", + "repository": { + "type": "git", + "url": "https://github.com/azure/azure-sdk-for-node.git" + }, + "bugs": { + "url": "https://github.com/azure/azure-sdk-for-node/issues" + } +} diff --git a/lib/services/cognitiveServicesVision/package.json b/lib/services/cognitiveServicesVision/package.json index f92e502901..58e1513774 100644 --- a/lib/services/cognitiveServicesVision/package.json +++ b/lib/services/cognitiveServicesVision/package.json @@ -1,38 +1,28 @@ { "name": "azure-cognitiveservices-vision", "author": "Microsoft Corporation", - "contributors": [ - "Xu, Willie " - ], - "version": "1.1.0-preview", "description": "Microsoft Azure Cognitive Services Vision API Client Library for Node.js", - "tags": [ - "azure", - "sdk" - ], + "version": "2.0.0", + "dependencies": { + "ms-rest": "^2.3.3", + "ms-rest-azure": "^2.5.6", + "azure-cognitiveservices-face": "^2.2.0-preview", + "azure-cognitiveservices-computervision": "^3.2.0", + "azure-cognitiveservices-contentmoderator": "^4.1.0" + }, "keywords": [ "node", "azure" ], + "license": "MIT", "main": "./lib/cognitiveServicesVision.js", "types": "./lib/cognitiveServicesVision.d.ts", - "license": "MIT", - "dependencies": { - "ms-rest": "^2.2.5", - "ms-rest-azure": "^2.5.0", - "azure-cognitiveservices-face": "^1.0.0-preview", - "azure-cognitiveservices-computervision": "^1.0.0-preview", - "azure-cognitiveservices-contentmoderator": "^1.0.0-preview" - }, - "homepage": "http://github.com/Azure/azure-sdk-for-node", + "homepage": "http://github.com/Azure/azure-sdk-for-node/tree/master/lib/services/cognitiveServicesVision", "repository": { "type": "git", "url": "git@github.com:Azure/azure-sdk-for-node.git" }, "bugs": { "url": "http://github.com/Azure/azure-sdk-for-node/issues" - }, - "scripts": { - "test": "npm -s run-script jshint" } -} \ No newline at end of file +} diff --git a/lib/services/containerRegistryManagement/README.md b/lib/services/containerRegistryManagement/README.md index b977d48fb7..51a5951535 100644 --- a/lib/services/containerRegistryManagement/README.md +++ b/lib/services/containerRegistryManagement/README.md @@ -3,40 +3,43 @@ uid: azure-arm-containerregistry summary: *content --- -# Microsoft Azure SDK for Node.js - ContainerRegistryManagementClient +**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 - ContainerRegistryManagementClient + 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-containerregistry ``` -## How to use +### How to use -### Authentication, client creation and get registries as an example. +#### Authentication, client creation, and get registries as an example. ```javascript const msRestAzure = require("ms-rest-azure"); const ContainerRegistryManagementClient = require("azure-arm-containerregistry"); msRestAzure.interactiveLogin().then((creds) => { - const subscriptionId = ""; - const client = new ContainerRegistryManagementClient(creds, subscriptionId); - const resourceGroupName = "testresourceGroupName"; - const registryName = "testregistryName"; - return client.registries.get(resourceGroupName, registryName).then((result) => { - console.log("The result is:"); - console.log(result); - }); + const subscriptionId = ""; + const client = new ContainerRegistryManagementClient(creds, subscriptionId); + const resourceGroupName = "testresourceGroupName"; + const registryName = "testregistryName"; + + return client.registries.get(resourceGroupName, registryName).then((result) => { + console.log("The result is:"); + console.log(result); + }); }).catch((err) => { console.log('An error occurred:'); 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/containerRegistryManagement/lib/models/actor.js b/lib/services/containerRegistryManagement/lib/models/actor.js index 974a6fe851..59f20e9196 100644 --- a/lib/services/containerRegistryManagement/lib/models/actor.js +++ b/lib/services/containerRegistryManagement/lib/models/actor.js @@ -18,7 +18,7 @@ class Actor { /** * Create a Actor. - * @member {string} [name] The subject or username associated with the + * @property {string} [name] The subject or username associated with the * request context that generated the event. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/agentProperties.js b/lib/services/containerRegistryManagement/lib/models/agentProperties.js index 54ca08b66b..741d938bb4 100644 --- a/lib/services/containerRegistryManagement/lib/models/agentProperties.js +++ b/lib/services/containerRegistryManagement/lib/models/agentProperties.js @@ -17,7 +17,7 @@ class AgentProperties { /** * Create a AgentProperties. - * @member {number} [cpu] The CPU configuration in terms of number of cores + * @property {number} [cpu] The CPU configuration in terms of number of cores * required for the run. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/argument.js b/lib/services/containerRegistryManagement/lib/models/argument.js index 292d0d83d9..83baa771a4 100644 --- a/lib/services/containerRegistryManagement/lib/models/argument.js +++ b/lib/services/containerRegistryManagement/lib/models/argument.js @@ -17,9 +17,9 @@ class Argument { /** * Create a Argument. - * @member {string} name The name of the argument. - * @member {string} value The value of the argument. - * @member {boolean} [isSecret] Flag to indicate whether the argument + * @property {string} name The name of the argument. + * @property {string} value The value of the argument. + * @property {boolean} [isSecret] Flag to indicate whether the argument * represents a secret and want to be removed from build logs. Default value: * false . */ diff --git a/lib/services/containerRegistryManagement/lib/models/authInfo.js b/lib/services/containerRegistryManagement/lib/models/authInfo.js index 0303c4f789..3902cfcc4c 100644 --- a/lib/services/containerRegistryManagement/lib/models/authInfo.js +++ b/lib/services/containerRegistryManagement/lib/models/authInfo.js @@ -17,14 +17,15 @@ class AuthInfo { /** * Create a AuthInfo. - * @member {string} tokenType The type of Auth token. Possible values + * @property {string} tokenType The type of Auth token. Possible values * include: 'PAT', 'OAuth' - * @member {string} token The access token used to access the source control - * provider. - * @member {string} [refreshToken] The refresh token used to refresh the + * @property {string} token The access token used to access the source + * control provider. + * @property {string} [refreshToken] The refresh token used to refresh the * access token. - * @member {string} [scope] The scope of the access token. - * @member {number} [expiresIn] Time in seconds that the token remains valid + * @property {string} [scope] The scope of the access token. + * @property {number} [expiresIn] Time in seconds that the token remains + * valid */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/authInfoUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/authInfoUpdateParameters.js index df1896032b..f83a7d8c96 100644 --- a/lib/services/containerRegistryManagement/lib/models/authInfoUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/authInfoUpdateParameters.js @@ -17,14 +17,15 @@ class AuthInfoUpdateParameters { /** * Create a AuthInfoUpdateParameters. - * @member {string} [tokenType] The type of Auth token. Possible values + * @property {string} [tokenType] The type of Auth token. Possible values * include: 'PAT', 'OAuth' - * @member {string} [token] The access token used to access the source + * @property {string} [token] The access token used to access the source * control provider. - * @member {string} [refreshToken] The refresh token used to refresh the + * @property {string} [refreshToken] The refresh token used to refresh the * access token. - * @member {string} [scope] The scope of the access token. - * @member {number} [expiresIn] Time in seconds that the token remains valid + * @property {string} [scope] The scope of the access token. + * @property {number} [expiresIn] Time in seconds that the token remains + * valid */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/baseImageDependency.js b/lib/services/containerRegistryManagement/lib/models/baseImageDependency.js index 19d89b38b5..73edb03149 100644 --- a/lib/services/containerRegistryManagement/lib/models/baseImageDependency.js +++ b/lib/services/containerRegistryManagement/lib/models/baseImageDependency.js @@ -17,12 +17,12 @@ class BaseImageDependency { /** * Create a BaseImageDependency. - * @member {string} [type] The type of the base image dependency. Possible + * @property {string} [type] The type of the base image dependency. Possible * values include: 'BuildTime', 'RunTime' - * @member {string} [registry] The registry login server. - * @member {string} [repository] The repository name. - * @member {string} [tag] The tag name. - * @member {string} [digest] The sha256-based digest of the image manifest. + * @property {string} [registry] The registry login server. + * @property {string} [repository] The repository name. + * @property {string} [tag] The tag name. + * @property {string} [digest] The sha256-based digest of the image manifest. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/baseImageTrigger.js b/lib/services/containerRegistryManagement/lib/models/baseImageTrigger.js index 09741034b1..a29b738abe 100644 --- a/lib/services/containerRegistryManagement/lib/models/baseImageTrigger.js +++ b/lib/services/containerRegistryManagement/lib/models/baseImageTrigger.js @@ -17,11 +17,11 @@ class BaseImageTrigger { /** * Create a BaseImageTrigger. - * @member {string} baseImageTriggerType The type of the auto trigger for + * @property {string} baseImageTriggerType The type of the auto trigger for * base image dependency updates. Possible values include: 'All', 'Runtime' - * @member {string} [status] The current status of trigger. Possible values + * @property {string} [status] The current status of trigger. Possible values * include: 'Disabled', 'Enabled' - * @member {string} name The name of the trigger. + * @property {string} name The name of the trigger. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/baseImageTriggerUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/baseImageTriggerUpdateParameters.js index 6d1c78aab7..ab0b3c35ac 100644 --- a/lib/services/containerRegistryManagement/lib/models/baseImageTriggerUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/baseImageTriggerUpdateParameters.js @@ -17,11 +17,11 @@ class BaseImageTriggerUpdateParameters { /** * Create a BaseImageTriggerUpdateParameters. - * @member {string} [baseImageTriggerType] The type of the auto trigger for + * @property {string} [baseImageTriggerType] The type of the auto trigger for * base image dependency updates. Possible values include: 'All', 'Runtime' - * @member {string} [status] The current status of trigger. Possible values + * @property {string} [status] The current status of trigger. Possible values * include: 'Disabled', 'Enabled' - * @member {string} name The name of the trigger. + * @property {string} name The name of the trigger. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/callbackConfig.js b/lib/services/containerRegistryManagement/lib/models/callbackConfig.js index a9a193b51e..727c38704c 100644 --- a/lib/services/containerRegistryManagement/lib/models/callbackConfig.js +++ b/lib/services/containerRegistryManagement/lib/models/callbackConfig.js @@ -17,10 +17,10 @@ class CallbackConfig { /** * Create a CallbackConfig. - * @member {string} serviceUri The service URI for the webhook to post + * @property {string} serviceUri The service URI for the webhook to post * notifications. - * @member {object} [customHeaders] Custom headers that will be added to the - * webhook notifications. + * @property {object} [customHeaders] Custom headers that will be added to + * the webhook notifications. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/dockerBuildRequest.js b/lib/services/containerRegistryManagement/lib/models/dockerBuildRequest.js index 7c4e8f44f1..36ec1a8208 100644 --- a/lib/services/containerRegistryManagement/lib/models/dockerBuildRequest.js +++ b/lib/services/containerRegistryManagement/lib/models/dockerBuildRequest.js @@ -20,32 +20,32 @@ const models = require('./index'); class DockerBuildRequest extends models['RunRequest'] { /** * Create a DockerBuildRequest. - * @member {array} [imageNames] The fully qualified image names including the - * repository and tag. - * @member {boolean} [isPushEnabled] The value of this property indicates + * @property {array} [imageNames] The fully qualified image names including + * the repository and tag. + * @property {boolean} [isPushEnabled] The value of this property indicates * whether the image built should be pushed to the registry or not. Default * value: true . - * @member {boolean} [noCache] The value of this property indicates whether + * @property {boolean} [noCache] The value of this property indicates whether * the image cache is enabled or not. Default value: false . - * @member {string} dockerFilePath The Docker file path relative to the + * @property {string} dockerFilePath The Docker file path relative to the * source location. - * @member {array} [argumentsProperty] The collection of override arguments + * @property {array} [argumentsProperty] The collection of override arguments * to be used when executing the run. - * @member {number} [timeout] Run timeout in seconds. Default value: 3600 . - * @member {object} platform The platform properties against which the run + * @property {number} [timeout] Run timeout in seconds. Default value: 3600 . + * @property {object} platform The platform properties against which the run * has to happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible + * @property {string} [platform.os] The operating system type required for + * the run. Possible values include: 'Windows', 'Linux' + * @property {string} [platform.architecture] The OS architecture. Possible * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values + * @property {string} [platform.variant] Variant of the CPU. Possible values * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms + * @property {object} [agentConfiguration] The machine configuration of the + * run agent. + * @property {number} [agentConfiguration.cpu] The CPU configuration in terms * of number of cores required for the run. - * @member {string} [sourceLocation] The URL(absolute or relative) of the - * source context. It can be an URL to a tar or git repoistory. + * @property {string} [sourceLocation] The URL(absolute or relative) of the + * source context. It can be an URL to a tar or git repository. * If it is relative URL, the relative path should be obtained from calling * listBuildSourceUploadUrl API. */ diff --git a/lib/services/containerRegistryManagement/lib/models/dockerBuildStep.js b/lib/services/containerRegistryManagement/lib/models/dockerBuildStep.js index c1f77779b9..1ca836d3d5 100644 --- a/lib/services/containerRegistryManagement/lib/models/dockerBuildStep.js +++ b/lib/services/containerRegistryManagement/lib/models/dockerBuildStep.js @@ -20,16 +20,16 @@ const models = require('./index'); class DockerBuildStep extends models['TaskStepProperties'] { /** * Create a DockerBuildStep. - * @member {array} [imageNames] The fully qualified image names including the - * repository and tag. - * @member {boolean} [isPushEnabled] The value of this property indicates + * @property {array} [imageNames] The fully qualified image names including + * the repository and tag. + * @property {boolean} [isPushEnabled] The value of this property indicates * whether the image built should be pushed to the registry or not. Default * value: true . - * @member {boolean} [noCache] The value of this property indicates whether + * @property {boolean} [noCache] The value of this property indicates whether * the image cache is enabled or not. Default value: false . - * @member {string} dockerFilePath The Docker file path relative to the + * @property {string} dockerFilePath The Docker file path relative to the * source context. - * @member {array} [argumentsProperty] The collection of override arguments + * @property {array} [argumentsProperty] The collection of override arguments * to be used when executing this build step. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/dockerBuildStepUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/dockerBuildStepUpdateParameters.js index e0bcb290e8..8d9e573bc6 100644 --- a/lib/services/containerRegistryManagement/lib/models/dockerBuildStepUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/dockerBuildStepUpdateParameters.js @@ -20,15 +20,15 @@ const models = require('./index'); class DockerBuildStepUpdateParameters extends models['TaskStepUpdateParameters'] { /** * Create a DockerBuildStepUpdateParameters. - * @member {array} [imageNames] The fully qualified image names including the - * repository and tag. - * @member {boolean} [isPushEnabled] The value of this property indicates + * @property {array} [imageNames] The fully qualified image names including + * the repository and tag. + * @property {boolean} [isPushEnabled] The value of this property indicates * whether the image built should be pushed to the registry or not. - * @member {boolean} [noCache] The value of this property indicates whether + * @property {boolean} [noCache] The value of this property indicates whether * the image cache is enabled or not. - * @member {string} [dockerFilePath] The Docker file path relative to the + * @property {string} [dockerFilePath] The Docker file path relative to the * source context. - * @member {array} [argumentsProperty] The collection of override arguments + * @property {array} [argumentsProperty] The collection of override arguments * to be used when executing this build step. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/encodedTaskRunRequest.js b/lib/services/containerRegistryManagement/lib/models/encodedTaskRunRequest.js index eca48141cd..1838f046fa 100644 --- a/lib/services/containerRegistryManagement/lib/models/encodedTaskRunRequest.js +++ b/lib/services/containerRegistryManagement/lib/models/encodedTaskRunRequest.js @@ -20,27 +20,27 @@ const models = require('./index'); class EncodedTaskRunRequest extends models['RunRequest'] { /** * Create a EncodedTaskRunRequest. - * @member {string} encodedTaskContent Base64 encoded value of the + * @property {string} encodedTaskContent Base64 encoded value of the * template/definition file content. - * @member {string} [encodedValuesContent] Base64 encoded value of the + * @property {string} [encodedValuesContent] Base64 encoded value of the * parameters/values file content. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. - * @member {number} [timeout] Run timeout in seconds. Default value: 3600 . - * @member {object} platform The platform properties against which the run + * @property {array} [values] The collection of overridable values that can + * be passed when running a task. + * @property {number} [timeout] Run timeout in seconds. Default value: 3600 . + * @property {object} platform The platform properties against which the run * has to happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible + * @property {string} [platform.os] The operating system type required for + * the run. Possible values include: 'Windows', 'Linux' + * @property {string} [platform.architecture] The OS architecture. Possible * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values + * @property {string} [platform.variant] Variant of the CPU. Possible values * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms + * @property {object} [agentConfiguration] The machine configuration of the + * run agent. + * @property {number} [agentConfiguration.cpu] The CPU configuration in terms * of number of cores required for the run. - * @member {string} [sourceLocation] The URL(absolute or relative) of the - * source context. It can be an URL to a tar or git repoistory. + * @property {string} [sourceLocation] The URL(absolute or relative) of the + * source context. It can be an URL to a tar or git repository. * If it is relative URL, the relative path should be obtained from calling * listBuildSourceUploadUrl API. */ diff --git a/lib/services/containerRegistryManagement/lib/models/encodedTaskStep.js b/lib/services/containerRegistryManagement/lib/models/encodedTaskStep.js index 2e96a591fa..0e94f4f381 100644 --- a/lib/services/containerRegistryManagement/lib/models/encodedTaskStep.js +++ b/lib/services/containerRegistryManagement/lib/models/encodedTaskStep.js @@ -20,12 +20,12 @@ const models = require('./index'); class EncodedTaskStep extends models['TaskStepProperties'] { /** * Create a EncodedTaskStep. - * @member {string} encodedTaskContent Base64 encoded value of the + * @property {string} encodedTaskContent Base64 encoded value of the * template/definition file content. - * @member {string} [encodedValuesContent] Base64 encoded value of the + * @property {string} [encodedValuesContent] Base64 encoded value of the * parameters/values file content. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. + * @property {array} [values] The collection of overridable values that can + * be passed when running a task. */ constructor() { super(); diff --git a/lib/services/containerRegistryManagement/lib/models/encodedTaskStepUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/encodedTaskStepUpdateParameters.js index f12308b425..be5584f9ba 100644 --- a/lib/services/containerRegistryManagement/lib/models/encodedTaskStepUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/encodedTaskStepUpdateParameters.js @@ -20,12 +20,12 @@ const models = require('./index'); class EncodedTaskStepUpdateParameters extends models['TaskStepUpdateParameters'] { /** * Create a EncodedTaskStepUpdateParameters. - * @member {string} [encodedTaskContent] Base64 encoded value of the + * @property {string} [encodedTaskContent] Base64 encoded value of the * template/definition file content. - * @member {string} [encodedValuesContent] Base64 encoded value of the + * @property {string} [encodedValuesContent] Base64 encoded value of the * parameters/values file content. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. + * @property {array} [values] The collection of overridable values that can + * be passed when running a task. */ constructor() { super(); diff --git a/lib/services/containerRegistryManagement/lib/models/event.js b/lib/services/containerRegistryManagement/lib/models/event.js index 1ebb10b49a..6e2508c4df 100644 --- a/lib/services/containerRegistryManagement/lib/models/event.js +++ b/lib/services/containerRegistryManagement/lib/models/event.js @@ -20,76 +20,77 @@ const models = require('./index'); class Event extends models['EventInfo'] { /** * Create a Event. - * @member {object} [eventRequestMessage] The event request message sent to + * @property {object} [eventRequestMessage] The event request message sent to * the service URI. - * @member {object} [eventRequestMessage.content] The content of the event + * @property {object} [eventRequestMessage.content] The content of the event * request message. - * @member {string} [eventRequestMessage.content.id] The event ID. - * @member {date} [eventRequestMessage.content.timestamp] The time at which + * @property {string} [eventRequestMessage.content.id] The event ID. + * @property {date} [eventRequestMessage.content.timestamp] The time at which * the event occurred. - * @member {string} [eventRequestMessage.content.action] The action that + * @property {string} [eventRequestMessage.content.action] The action that * encompasses the provided event. - * @member {object} [eventRequestMessage.content.target] The target of the + * @property {object} [eventRequestMessage.content.target] The target of the * event. - * @member {string} [eventRequestMessage.content.target.mediaType] The MIME + * @property {string} [eventRequestMessage.content.target.mediaType] The MIME * type of the referenced object. - * @member {number} [eventRequestMessage.content.target.size] The number of + * @property {number} [eventRequestMessage.content.target.size] The number of * bytes of the content. Same as Length field. - * @member {string} [eventRequestMessage.content.target.digest] The digest of - * the content, as defined by the Registry V2 HTTP API Specification. - * @member {number} [eventRequestMessage.content.target.length] The number of - * bytes of the content. Same as Size field. - * @member {string} [eventRequestMessage.content.target.repository] The + * @property {string} [eventRequestMessage.content.target.digest] The digest + * of the content, as defined by the Registry V2 HTTP API Specification. + * @property {number} [eventRequestMessage.content.target.length] The number + * of bytes of the content. Same as Size field. + * @property {string} [eventRequestMessage.content.target.repository] The * repository name. - * @member {string} [eventRequestMessage.content.target.url] The direct URL + * @property {string} [eventRequestMessage.content.target.url] The direct URL * to the content. - * @member {string} [eventRequestMessage.content.target.tag] The tag name. - * @member {object} [eventRequestMessage.content.request] The request that + * @property {string} [eventRequestMessage.content.target.tag] The tag name. + * @property {object} [eventRequestMessage.content.request] The request that * generated the event. - * @member {string} [eventRequestMessage.content.request.id] The ID of the + * @property {string} [eventRequestMessage.content.request.id] The ID of the * request that initiated the event. - * @member {string} [eventRequestMessage.content.request.addr] The IP or + * @property {string} [eventRequestMessage.content.request.addr] The IP or * hostname and possibly port of the client connection that initiated the * event. This is the RemoteAddr from the standard http request. - * @member {string} [eventRequestMessage.content.request.host] The externally - * accessible hostname of the registry instance, as specified by the http - * host header on incoming requests. - * @member {string} [eventRequestMessage.content.request.method] The request - * method that generated the event. - * @member {string} [eventRequestMessage.content.request.useragent] The user - * agent header of the request. - * @member {object} [eventRequestMessage.content.actor] The agent that + * @property {string} [eventRequestMessage.content.request.host] The + * externally accessible hostname of the registry instance, as specified by + * the http host header on incoming requests. + * @property {string} [eventRequestMessage.content.request.method] The + * request method that generated the event. + * @property {string} [eventRequestMessage.content.request.useragent] The + * user agent header of the request. + * @property {object} [eventRequestMessage.content.actor] The agent that * initiated the event. For most situations, this could be from the * authorization context of the request. - * @member {string} [eventRequestMessage.content.actor.name] The subject or + * @property {string} [eventRequestMessage.content.actor.name] The subject or * username associated with the request context that generated the event. - * @member {object} [eventRequestMessage.content.source] The registry node + * @property {object} [eventRequestMessage.content.source] The registry node * that generated the event. Put differently, while the actor initiates the * event, the source generates it. - * @member {string} [eventRequestMessage.content.source.addr] The IP or + * @property {string} [eventRequestMessage.content.source.addr] The IP or * hostname and the port of the registry node that generated the event. * Generally, this will be resolved by os.Hostname() along with the running * port. - * @member {string} [eventRequestMessage.content.source.instanceID] The + * @property {string} [eventRequestMessage.content.source.instanceID] The * running instance of an application. Changes after each restart. - * @member {object} [eventRequestMessage.headers] The headers of the event + * @property {object} [eventRequestMessage.headers] The headers of the event * request message. - * @member {string} [eventRequestMessage.method] The HTTP method used to send + * @property {string} [eventRequestMessage.method] The HTTP method used to + * send the event request message. + * @property {string} [eventRequestMessage.requestUri] The URI used to send * the event request message. - * @member {string} [eventRequestMessage.requestUri] The URI used to send the - * event request message. - * @member {string} [eventRequestMessage.version] The HTTP message version. - * @member {object} [eventResponseMessage] The event response message + * @property {string} [eventRequestMessage.version] The HTTP message version. + * @property {object} [eventResponseMessage] The event response message * received from the service URI. - * @member {string} [eventResponseMessage.content] The content of the event + * @property {string} [eventResponseMessage.content] The content of the event * response message. - * @member {object} [eventResponseMessage.headers] The headers of the event + * @property {object} [eventResponseMessage.headers] The headers of the event * response message. - * @member {string} [eventResponseMessage.reasonPhrase] The reason phrase of + * @property {string} [eventResponseMessage.reasonPhrase] The reason phrase + * of the event response message. + * @property {string} [eventResponseMessage.statusCode] The status code of * the event response message. - * @member {string} [eventResponseMessage.statusCode] The status code of the - * event response message. - * @member {string} [eventResponseMessage.version] The HTTP message version. + * @property {string} [eventResponseMessage.version] The HTTP message + * version. */ constructor() { super(); diff --git a/lib/services/containerRegistryManagement/lib/models/eventContent.js b/lib/services/containerRegistryManagement/lib/models/eventContent.js index 6c21c04677..f2d1c80665 100644 --- a/lib/services/containerRegistryManagement/lib/models/eventContent.js +++ b/lib/services/containerRegistryManagement/lib/models/eventContent.js @@ -17,43 +17,46 @@ class EventContent { /** * Create a EventContent. - * @member {string} [id] The event ID. - * @member {date} [timestamp] The time at which the event occurred. - * @member {string} [action] The action that encompasses the provided event. - * @member {object} [target] The target of the event. - * @member {string} [target.mediaType] The MIME type of the referenced + * @property {string} [id] The event ID. + * @property {date} [timestamp] The time at which the event occurred. + * @property {string} [action] The action that encompasses the provided + * event. + * @property {object} [target] The target of the event. + * @property {string} [target.mediaType] The MIME type of the referenced * object. - * @member {number} [target.size] The number of bytes of the content. Same as - * Length field. - * @member {string} [target.digest] The digest of the content, as defined by - * the Registry V2 HTTP API Specification. - * @member {number} [target.length] The number of bytes of the content. Same - * as Size field. - * @member {string} [target.repository] The repository name. - * @member {string} [target.url] The direct URL to the content. - * @member {string} [target.tag] The tag name. - * @member {object} [request] The request that generated the event. - * @member {string} [request.id] The ID of the request that initiated the + * @property {number} [target.size] The number of bytes of the content. Same + * as Length field. + * @property {string} [target.digest] The digest of the content, as defined + * by the Registry V2 HTTP API Specification. + * @property {number} [target.length] The number of bytes of the content. + * Same as Size field. + * @property {string} [target.repository] The repository name. + * @property {string} [target.url] The direct URL to the content. + * @property {string} [target.tag] The tag name. + * @property {object} [request] The request that generated the event. + * @property {string} [request.id] The ID of the request that initiated the * event. - * @member {string} [request.addr] The IP or hostname and possibly port of + * @property {string} [request.addr] The IP or hostname and possibly port of * the client connection that initiated the event. This is the RemoteAddr * from the standard http request. - * @member {string} [request.host] The externally accessible hostname of the - * registry instance, as specified by the http host header on incoming + * @property {string} [request.host] The externally accessible hostname of + * the registry instance, as specified by the http host header on incoming * requests. - * @member {string} [request.method] The request method that generated the + * @property {string} [request.method] The request method that generated the * event. - * @member {string} [request.useragent] The user agent header of the request. - * @member {object} [actor] The agent that initiated the event. For most + * @property {string} [request.useragent] The user agent header of the + * request. + * @property {object} [actor] The agent that initiated the event. For most * situations, this could be from the authorization context of the request. - * @member {string} [actor.name] The subject or username associated with the - * request context that generated the event. - * @member {object} [source] The registry node that generated the event. Put - * differently, while the actor initiates the event, the source generates it. - * @member {string} [source.addr] The IP or hostname and the port of the + * @property {string} [actor.name] The subject or username associated with + * the request context that generated the event. + * @property {object} [source] The registry node that generated the event. + * Put differently, while the actor initiates the event, the source generates + * it. + * @property {string} [source.addr] The IP or hostname and the port of the * registry node that generated the event. Generally, this will be resolved * by os.Hostname() along with the running port. - * @member {string} [source.instanceID] The running instance of an + * @property {string} [source.instanceID] The running instance of an * application. Changes after each restart. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/eventInfo.js b/lib/services/containerRegistryManagement/lib/models/eventInfo.js index 188e3a4684..bf8199ddda 100644 --- a/lib/services/containerRegistryManagement/lib/models/eventInfo.js +++ b/lib/services/containerRegistryManagement/lib/models/eventInfo.js @@ -17,7 +17,7 @@ class EventInfo { /** * Create a EventInfo. - * @member {string} [id] The event ID. + * @property {string} [id] The event ID. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/eventListResult.js b/lib/services/containerRegistryManagement/lib/models/eventListResult.js index 0db0d01992..d25599494c 100644 --- a/lib/services/containerRegistryManagement/lib/models/eventListResult.js +++ b/lib/services/containerRegistryManagement/lib/models/eventListResult.js @@ -16,7 +16,7 @@ class EventListResult extends Array { /** * Create a EventListResult. - * @member {string} [nextLink] The URI that can be used to request the next + * @property {string} [nextLink] The URI that can be used to request the next * list of events. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/eventRequestMessage.js b/lib/services/containerRegistryManagement/lib/models/eventRequestMessage.js index 2cb95eb72c..b5cc1ba4a6 100644 --- a/lib/services/containerRegistryManagement/lib/models/eventRequestMessage.js +++ b/lib/services/containerRegistryManagement/lib/models/eventRequestMessage.js @@ -17,55 +17,55 @@ class EventRequestMessage { /** * Create a EventRequestMessage. - * @member {object} [content] The content of the event request message. - * @member {string} [content.id] The event ID. - * @member {date} [content.timestamp] The time at which the event occurred. - * @member {string} [content.action] The action that encompasses the provided - * event. - * @member {object} [content.target] The target of the event. - * @member {string} [content.target.mediaType] The MIME type of the + * @property {object} [content] The content of the event request message. + * @property {string} [content.id] The event ID. + * @property {date} [content.timestamp] The time at which the event occurred. + * @property {string} [content.action] The action that encompasses the + * provided event. + * @property {object} [content.target] The target of the event. + * @property {string} [content.target.mediaType] The MIME type of the * referenced object. - * @member {number} [content.target.size] The number of bytes of the content. - * Same as Length field. - * @member {string} [content.target.digest] The digest of the content, as + * @property {number} [content.target.size] The number of bytes of the + * content. Same as Length field. + * @property {string} [content.target.digest] The digest of the content, as * defined by the Registry V2 HTTP API Specification. - * @member {number} [content.target.length] The number of bytes of the + * @property {number} [content.target.length] The number of bytes of the * content. Same as Size field. - * @member {string} [content.target.repository] The repository name. - * @member {string} [content.target.url] The direct URL to the content. - * @member {string} [content.target.tag] The tag name. - * @member {object} [content.request] The request that generated the event. - * @member {string} [content.request.id] The ID of the request that initiated - * the event. - * @member {string} [content.request.addr] The IP or hostname and possibly + * @property {string} [content.target.repository] The repository name. + * @property {string} [content.target.url] The direct URL to the content. + * @property {string} [content.target.tag] The tag name. + * @property {object} [content.request] The request that generated the event. + * @property {string} [content.request.id] The ID of the request that + * initiated the event. + * @property {string} [content.request.addr] The IP or hostname and possibly * port of the client connection that initiated the event. This is the * RemoteAddr from the standard http request. - * @member {string} [content.request.host] The externally accessible hostname - * of the registry instance, as specified by the http host header on incoming - * requests. - * @member {string} [content.request.method] The request method that + * @property {string} [content.request.host] The externally accessible + * hostname of the registry instance, as specified by the http host header on + * incoming requests. + * @property {string} [content.request.method] The request method that * generated the event. - * @member {string} [content.request.useragent] The user agent header of the - * request. - * @member {object} [content.actor] The agent that initiated the event. For + * @property {string} [content.request.useragent] The user agent header of + * the request. + * @property {object} [content.actor] The agent that initiated the event. For * most situations, this could be from the authorization context of the * request. - * @member {string} [content.actor.name] The subject or username associated + * @property {string} [content.actor.name] The subject or username associated * with the request context that generated the event. - * @member {object} [content.source] The registry node that generated the + * @property {object} [content.source] The registry node that generated the * event. Put differently, while the actor initiates the event, the source * generates it. - * @member {string} [content.source.addr] The IP or hostname and the port of - * the registry node that generated the event. Generally, this will be + * @property {string} [content.source.addr] The IP or hostname and the port + * of the registry node that generated the event. Generally, this will be * resolved by os.Hostname() along with the running port. - * @member {string} [content.source.instanceID] The running instance of an + * @property {string} [content.source.instanceID] The running instance of an * application. Changes after each restart. - * @member {object} [headers] The headers of the event request message. - * @member {string} [method] The HTTP method used to send the event request + * @property {object} [headers] The headers of the event request message. + * @property {string} [method] The HTTP method used to send the event request * message. - * @member {string} [requestUri] The URI used to send the event request + * @property {string} [requestUri] The URI used to send the event request * message. - * @member {string} [version] The HTTP message version. + * @property {string} [version] The HTTP message version. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/eventResponseMessage.js b/lib/services/containerRegistryManagement/lib/models/eventResponseMessage.js index a9a47dc980..ba414438cd 100644 --- a/lib/services/containerRegistryManagement/lib/models/eventResponseMessage.js +++ b/lib/services/containerRegistryManagement/lib/models/eventResponseMessage.js @@ -17,13 +17,13 @@ class EventResponseMessage { /** * Create a EventResponseMessage. - * @member {string} [content] The content of the event response message. - * @member {object} [headers] The headers of the event response message. - * @member {string} [reasonPhrase] The reason phrase of the event response + * @property {string} [content] The content of the event response message. + * @property {object} [headers] The headers of the event response message. + * @property {string} [reasonPhrase] The reason phrase of the event response * message. - * @member {string} [statusCode] The status code of the event response + * @property {string} [statusCode] The status code of the event response * message. - * @member {string} [version] The HTTP message version. + * @property {string} [version] The HTTP message version. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/fileTaskRunRequest.js b/lib/services/containerRegistryManagement/lib/models/fileTaskRunRequest.js index dac8ec2d1a..4f91bc3c70 100644 --- a/lib/services/containerRegistryManagement/lib/models/fileTaskRunRequest.js +++ b/lib/services/containerRegistryManagement/lib/models/fileTaskRunRequest.js @@ -20,27 +20,27 @@ const models = require('./index'); class FileTaskRunRequest extends models['RunRequest'] { /** * Create a FileTaskRunRequest. - * @member {string} taskFilePath The template/definition file path relative + * @property {string} taskFilePath The template/definition file path relative * to the source. - * @member {string} [valuesFilePath] The values/parameters file path relative - * to the source. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. - * @member {number} [timeout] Run timeout in seconds. Default value: 3600 . - * @member {object} platform The platform properties against which the run + * @property {string} [valuesFilePath] The values/parameters file path + * relative to the source. + * @property {array} [values] The collection of overridable values that can + * be passed when running a task. + * @property {number} [timeout] Run timeout in seconds. Default value: 3600 . + * @property {object} platform The platform properties against which the run * has to happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible + * @property {string} [platform.os] The operating system type required for + * the run. Possible values include: 'Windows', 'Linux' + * @property {string} [platform.architecture] The OS architecture. Possible * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values + * @property {string} [platform.variant] Variant of the CPU. Possible values * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms + * @property {object} [agentConfiguration] The machine configuration of the + * run agent. + * @property {number} [agentConfiguration.cpu] The CPU configuration in terms * of number of cores required for the run. - * @member {string} [sourceLocation] The URL(absolute or relative) of the - * source context. It can be an URL to a tar or git repoistory. + * @property {string} [sourceLocation] The URL(absolute or relative) of the + * source context. It can be an URL to a tar or git repository. * If it is relative URL, the relative path should be obtained from calling * listBuildSourceUploadUrl API. */ diff --git a/lib/services/containerRegistryManagement/lib/models/fileTaskStep.js b/lib/services/containerRegistryManagement/lib/models/fileTaskStep.js index f0b7d2092b..a7cd95564c 100644 --- a/lib/services/containerRegistryManagement/lib/models/fileTaskStep.js +++ b/lib/services/containerRegistryManagement/lib/models/fileTaskStep.js @@ -20,12 +20,12 @@ const models = require('./index'); class FileTaskStep extends models['TaskStepProperties'] { /** * Create a FileTaskStep. - * @member {string} taskFilePath The task template/definition file path + * @property {string} taskFilePath The task template/definition file path * relative to the source context. - * @member {string} [valuesFilePath] The task values/parameters file path + * @property {string} [valuesFilePath] The task values/parameters file path * relative to the source context. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. + * @property {array} [values] The collection of overridable values that can + * be passed when running a task. */ constructor() { super(); diff --git a/lib/services/containerRegistryManagement/lib/models/fileTaskStepUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/fileTaskStepUpdateParameters.js index c83b5f4884..2a7c507274 100644 --- a/lib/services/containerRegistryManagement/lib/models/fileTaskStepUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/fileTaskStepUpdateParameters.js @@ -20,12 +20,12 @@ const models = require('./index'); class FileTaskStepUpdateParameters extends models['TaskStepUpdateParameters'] { /** * Create a FileTaskStepUpdateParameters. - * @member {string} [taskFilePath] The task template/definition file path + * @property {string} [taskFilePath] The task template/definition file path * relative to the source context. - * @member {string} [valuesFilePath] The values/parameters file path relative - * to the source context. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. + * @property {string} [valuesFilePath] The values/parameters file path + * relative to the source context. + * @property {array} [values] The collection of overridable values that can + * be passed when running a task. */ constructor() { super(); diff --git a/lib/services/containerRegistryManagement/lib/models/imageDescriptor.js b/lib/services/containerRegistryManagement/lib/models/imageDescriptor.js index 2b1c7f723b..88c5d574e3 100644 --- a/lib/services/containerRegistryManagement/lib/models/imageDescriptor.js +++ b/lib/services/containerRegistryManagement/lib/models/imageDescriptor.js @@ -17,10 +17,10 @@ class ImageDescriptor { /** * Create a ImageDescriptor. - * @member {string} [registry] The registry login server. - * @member {string} [repository] The repository name. - * @member {string} [tag] The tag name. - * @member {string} [digest] The sha256-based digest of the image manifest. + * @property {string} [registry] The registry login server. + * @property {string} [repository] The repository name. + * @property {string} [tag] The tag name. + * @property {string} [digest] The sha256-based digest of the image manifest. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/imageUpdateTrigger.js b/lib/services/containerRegistryManagement/lib/models/imageUpdateTrigger.js index 9301807a67..35ee9cdd1c 100644 --- a/lib/services/containerRegistryManagement/lib/models/imageUpdateTrigger.js +++ b/lib/services/containerRegistryManagement/lib/models/imageUpdateTrigger.js @@ -17,9 +17,10 @@ class ImageUpdateTrigger { /** * Create a ImageUpdateTrigger. - * @member {string} [id] The unique ID of the trigger. - * @member {date} [timestamp] The timestamp when the image update happened. - * @member {array} [images] The list of image updates that caused the build. + * @property {string} [id] The unique ID of the trigger. + * @property {date} [timestamp] The timestamp when the image update happened. + * @property {array} [images] The list of image updates that caused the + * build. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/importImageParameters.js b/lib/services/containerRegistryManagement/lib/models/importImageParameters.js index 47526cfb7e..15df147337 100644 --- a/lib/services/containerRegistryManagement/lib/models/importImageParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/importImageParameters.js @@ -16,29 +16,30 @@ class ImportImageParameters { /** * Create a ImportImageParameters. - * @member {object} source The source of the image. - * @member {string} [source.resourceId] The resource identifier of the source - * Azure Container Registry. - * @member {string} [source.registryUri] The address of the source registry + * @property {object} source The source of the image. + * @property {string} [source.resourceId] The resource identifier of the + * source Azure Container Registry. + * @property {string} [source.registryUri] The address of the source registry * (e.g. 'mcr.microsoft.com'). - * @member {object} [source.credentials] Credentials used when importing from - * a registry uri. - * @member {string} [source.credentials.username] The username to + * @property {object} [source.credentials] Credentials used when importing + * from a registry uri. + * @property {string} [source.credentials.username] The username to * authenticate with the source registry. - * @member {string} [source.credentials.password] The password used to + * @property {string} [source.credentials.password] The password used to * authenticate with the source registry. - * @member {string} [source.sourceImage] Repository name of the source image. + * @property {string} [source.sourceImage] Repository name of the source + * image. * Specify an image by repository ('hello-world'). This will use the 'latest' * tag. * Specify an image by tag ('hello-world:latest'). * Specify an image by sha256-based manifest digest * ('hello-world@sha256:abc123'). - * @member {array} [targetTags] List of strings of the form repo[:tag]. When - * tag is omitted the source will be used (or 'latest' if source tag is also - * omitted). - * @member {array} [untaggedTargetRepositories] List of strings of repository - * names to do a manifest only copy. No tag will be created. - * @member {string} [mode] When Force, any existing target tags will be + * @property {array} [targetTags] List of strings of the form repo[:tag]. + * When tag is omitted the source will be used (or 'latest' if source tag is + * also omitted). + * @property {array} [untaggedTargetRepositories] List of strings of + * repository names to do a manifest only copy. No tag will be created. + * @property {string} [mode] When Force, any existing target tags will be * overwritten. When NoForce, any existing target tags will fail the * operation before any copying begins. Possible values include: 'NoForce', * 'Force'. Default value: 'NoForce' . diff --git a/lib/services/containerRegistryManagement/lib/models/importSource.js b/lib/services/containerRegistryManagement/lib/models/importSource.js index 12dfd4899c..d04bd0611b 100644 --- a/lib/services/containerRegistryManagement/lib/models/importSource.js +++ b/lib/services/containerRegistryManagement/lib/models/importSource.js @@ -16,17 +16,17 @@ class ImportSource { /** * Create a ImportSource. - * @member {string} [resourceId] The resource identifier of the source Azure - * Container Registry. - * @member {string} [registryUri] The address of the source registry (e.g. + * @property {string} [resourceId] The resource identifier of the source + * Azure Container Registry. + * @property {string} [registryUri] The address of the source registry (e.g. * 'mcr.microsoft.com'). - * @member {object} [credentials] Credentials used when importing from a + * @property {object} [credentials] Credentials used when importing from a * registry uri. - * @member {string} [credentials.username] The username to authenticate with - * the source registry. - * @member {string} [credentials.password] The password used to authenticate + * @property {string} [credentials.username] The username to authenticate * with the source registry. - * @member {string} sourceImage Repository name of the source image. + * @property {string} [credentials.password] The password used to + * authenticate with the source registry. + * @property {string} sourceImage Repository name of the source image. * Specify an image by repository ('hello-world'). This will use the 'latest' * tag. * Specify an image by tag ('hello-world:latest'). diff --git a/lib/services/containerRegistryManagement/lib/models/importSourceCredentials.js b/lib/services/containerRegistryManagement/lib/models/importSourceCredentials.js index 1645b2d3f8..fc50eeb040 100644 --- a/lib/services/containerRegistryManagement/lib/models/importSourceCredentials.js +++ b/lib/services/containerRegistryManagement/lib/models/importSourceCredentials.js @@ -16,9 +16,9 @@ class ImportSourceCredentials { /** * Create a ImportSourceCredentials. - * @member {string} [username] The username to authenticate with the source + * @property {string} [username] The username to authenticate with the source * registry. - * @member {string} password The password used to authenticate with the + * @property {string} password The password used to authenticate with the * source registry. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/index.d.ts b/lib/services/containerRegistryManagement/lib/models/index.d.ts index f30f253a7e..a30f827423 100644 --- a/lib/services/containerRegistryManagement/lib/models/index.d.ts +++ b/lib/services/containerRegistryManagement/lib/models/index.d.ts @@ -1,2055 +1,1812 @@ /* * 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 ImportSourceCredentials class. - * @constructor - * @member {string} [username] The username to authenticate with the source - * registry. - * @member {string} password The password used to authenticate with the source - * registry. - */ export interface ImportSourceCredentials { + /** + * The username to authenticate with the source registry. + */ username?: string; + /** + * The password used to authenticate with the source registry. + */ password: string; } -/** - * @class - * Initializes a new instance of the ImportSource class. - * @constructor - * @member {string} [resourceId] The resource identifier of the source Azure - * Container Registry. - * @member {string} [registryUri] The address of the source registry (e.g. - * 'mcr.microsoft.com'). - * @member {object} [credentials] Credentials used when importing from a - * registry uri. - * @member {string} [credentials.username] The username to authenticate with - * the source registry. - * @member {string} [credentials.password] The password used to authenticate - * with the source registry. - * @member {string} sourceImage Repository name of the source image. - * Specify an image by repository ('hello-world'). This will use the 'latest' - * tag. - * Specify an image by tag ('hello-world:latest'). - * Specify an image by sha256-based manifest digest - * ('hello-world@sha256:abc123'). - */ export interface ImportSource { + /** + * The resource identifier of the source Azure Container Registry. + */ resourceId?: string; + /** + * The address of the source registry (e.g. 'mcr.microsoft.com'). + */ registryUri?: string; + /** + * Credentials used when importing from a registry uri. + */ credentials?: ImportSourceCredentials; + /** + * Repository name of the source image. + * Specify an image by repository ('hello-world'). This will use the 'latest' tag. + * Specify an image by tag ('hello-world:latest'). + * Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). + */ sourceImage: string; } -/** - * @class - * Initializes a new instance of the ImportImageParameters class. - * @constructor - * @member {object} source The source of the image. - * @member {string} [source.resourceId] The resource identifier of the source - * Azure Container Registry. - * @member {string} [source.registryUri] The address of the source registry - * (e.g. 'mcr.microsoft.com'). - * @member {object} [source.credentials] Credentials used when importing from a - * registry uri. - * @member {string} [source.credentials.username] The username to authenticate - * with the source registry. - * @member {string} [source.credentials.password] The password used to - * authenticate with the source registry. - * @member {string} [source.sourceImage] Repository name of the source image. - * Specify an image by repository ('hello-world'). This will use the 'latest' - * tag. - * Specify an image by tag ('hello-world:latest'). - * Specify an image by sha256-based manifest digest - * ('hello-world@sha256:abc123'). - * @member {array} [targetTags] List of strings of the form repo[:tag]. When - * tag is omitted the source will be used (or 'latest' if source tag is also - * omitted). - * @member {array} [untaggedTargetRepositories] List of strings of repository - * names to do a manifest only copy. No tag will be created. - * @member {string} [mode] When Force, any existing target tags will be - * overwritten. When NoForce, any existing target tags will fail the operation - * before any copying begins. Possible values include: 'NoForce', 'Force'. - * Default value: 'NoForce' . - */ export interface ImportImageParameters { + /** + * The source of the image. + */ source: ImportSource; + /** + * List of strings of the form repo[:tag]. When tag is omitted the source will be used (or + * 'latest' if source tag is also omitted). + */ targetTags?: string[]; + /** + * List of strings of repository names to do a manifest only copy. No tag will be created. + */ untaggedTargetRepositories?: string[]; + /** + * When Force, any existing target tags will be overwritten. When NoForce, any existing target + * tags will fail the operation before any copying begins. Possible values include: 'NoForce', + * 'Force' + */ mode?: string; } /** - * @class - * Initializes a new instance of the RegistryNameCheckRequest class. - * @constructor * A request to check whether a container registry name is available. - * - * @member {string} name The name of the container registry. - */ +*/ export interface RegistryNameCheckRequest { + /** + * The name of the container registry. + */ name: string; } /** - * @class - * Initializes a new instance of the RegistryNameStatus class. - * @constructor - * The result of a request to check the availability of a container registry - * name. - * - * @member {boolean} [nameAvailable] The value that indicates whether the name - * is available. - * @member {string} [reason] If any, the reason that the name is not available. - * @member {string} [message] If any, the error message that provides more - * detail for the reason that the name is not available. - */ + * The result of a request to check the availability of a container registry name. +*/ export interface RegistryNameStatus { + /** + * The value that indicates whether the name is available. + */ nameAvailable?: boolean; + /** + * If any, the reason that the name is not available. + */ reason?: string; + /** + * If any, the error message that provides more detail for the reason that the name is not + * available. + */ message?: string; } /** - * @class - * Initializes a new instance of the OperationDisplayDefinition class. - * @constructor * The display information for a container registry operation. - * - * @member {string} [provider] The resource provider name: - * Microsoft.ContainerRegistry. - * @member {string} [resource] The resource on which the operation is - * performed. - * @member {string} [operation] The operation that users can perform. - * @member {string} [description] The description for the operation. - */ +*/ export interface OperationDisplayDefinition { + /** + * The resource provider name: Microsoft.ContainerRegistry. + */ provider?: string; + /** + * The resource on which the operation is performed. + */ resource?: string; + /** + * The operation that users can perform. + */ operation?: string; + /** + * The description for the operation. + */ description?: string; } /** - * @class - * Initializes a new instance of the OperationMetricSpecificationDefinition class. - * @constructor * The definition of Azure Monitoring metric. - * - * @member {string} [name] Metric name. - * @member {string} [displayName] Metric display name. - * @member {string} [displayDescription] Metric description. - * @member {string} [unit] Metric unit. - * @member {string} [aggregationType] Metric aggregation type. - * @member {string} [internalMetricName] Internal metric name. - */ +*/ export interface OperationMetricSpecificationDefinition { + /** + * Metric name. + */ name?: string; + /** + * Metric display name. + */ displayName?: string; + /** + * Metric description. + */ displayDescription?: string; + /** + * Metric unit. + */ unit?: string; + /** + * Metric aggregation type. + */ aggregationType?: string; + /** + * Internal metric name. + */ internalMetricName?: string; } /** - * @class - * Initializes a new instance of the OperationServiceSpecificationDefinition class. - * @constructor * The definition of Azure Monitoring metrics list. - * - * @member {array} [metricSpecifications] A list of Azure Monitoring metrics - * definition. - */ +*/ export interface OperationServiceSpecificationDefinition { + /** + * A list of Azure Monitoring metrics definition. + */ metricSpecifications?: OperationMetricSpecificationDefinition[]; } /** - * @class - * Initializes a new instance of the OperationDefinition class. - * @constructor * The definition of a container registry operation. - * - * @member {string} [origin] The origin information of the container registry - * operation. - * @member {string} [name] Operation name: {provider}/{resource}/{operation}. - * @member {object} [display] The display information for the container - * registry operation. - * @member {string} [display.provider] The resource provider name: - * Microsoft.ContainerRegistry. - * @member {string} [display.resource] The resource on which the operation is - * performed. - * @member {string} [display.operation] The operation that users can perform. - * @member {string} [display.description] The description for the operation. - * @member {object} [serviceSpecification] The definition of Azure Monitoring - * service. - * @member {array} [serviceSpecification.metricSpecifications] A list of Azure - * Monitoring metrics definition. - */ +*/ export interface OperationDefinition { + /** + * The origin information of the container registry operation. + */ origin?: string; + /** + * Operation name: {provider}/{resource}/{operation}. + */ name?: string; + /** + * The display information for the container registry operation. + */ display?: OperationDisplayDefinition; + /** + * The definition of Azure Monitoring service. + */ serviceSpecification?: OperationServiceSpecificationDefinition; } /** - * @class - * Initializes a new instance of the Sku class. - * @constructor * The SKU of a container registry. - * - * @member {string} name The SKU name of the container registry. Required for - * registry creation. Possible values include: 'Classic', 'Basic', 'Standard', - * 'Premium' - * @member {string} [tier] The SKU tier based on the SKU name. Possible values - * include: 'Classic', 'Basic', 'Standard', 'Premium' - */ +*/ export interface Sku { + /** + * The SKU name of the container registry. Required for registry creation. Possible values + * include: 'Classic', 'Basic', 'Standard', 'Premium' + */ name: string; + /** + * The SKU tier based on the SKU name. Possible values include: 'Classic', 'Basic', 'Standard', + * 'Premium' + */ readonly tier?: string; } /** - * @class - * Initializes a new instance of the Status class. - * @constructor * The status of an Azure resource at the time the operation was called. - * - * @member {string} [displayStatus] The short label for the status. - * @member {string} [message] The detailed message for the status, including - * alerts and error messages. - * @member {date} [timestamp] The timestamp when the status was changed to the - * current value. - */ +*/ export interface Status { + /** + * The short label for the status. + */ readonly displayStatus?: string; + /** + * The detailed message for the status, including alerts and error messages. + */ readonly message?: string; + /** + * The timestamp when the status was changed to the current value. + */ readonly timestamp?: Date; } /** - * @class - * Initializes a new instance of the StorageAccountProperties class. - * @constructor - * The properties of a storage account for a container registry. Only - * applicable to Classic SKU. - * - * @member {string} id The resource ID of the storage account. - */ + * The properties of a storage account for a container registry. Only applicable to Classic SKU. +*/ export interface StorageAccountProperties { + /** + * The resource ID of the storage account. + */ + id: string; +} + +/** + * The virtual network rule for a container registry. +*/ +export interface VirtualNetworkRule { + /** + * Resource ID of a subnet, for example: + * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + */ id: string; } /** - * @class - * Initializes a new instance of the Resource class. - * @constructor + * The network rule set for a container registry. +*/ +export interface NetworkRuleSet { + /** + * The default action of allow or deny when no other rules match. Possible values include: + * 'Allow', 'Deny' + */ + defaultAction: string; + /** + * The virtual network rules. + */ + virtualNetworkRules?: VirtualNetworkRule[]; +} + +/** * An Azure resource. - * - * @member {string} [id] The resource ID. - * @member {string} [name] The name of the resource. - * @member {string} [type] The type of the resource. - * @member {string} location The location of the resource. This cannot be - * changed after the resource is created. - * @member {object} [tags] The tags of the resource. - */ +*/ export interface Resource extends BaseResource { + /** + * The resource ID. + */ readonly id?: string; + /** + * The name of the resource. + */ readonly name?: string; + /** + * The type of the resource. + */ readonly type?: string; + /** + * The location of the resource. This cannot be changed after the resource is created. + */ location: string; + /** + * The tags of the resource. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the Registry class. - * @constructor * An object that represents a container registry. - * - * @member {object} sku The SKU of the container registry. - * @member {string} [sku.name] The SKU name of the container registry. Required - * for registry creation. Possible values include: 'Classic', 'Basic', - * 'Standard', 'Premium' - * @member {string} [sku.tier] The SKU tier based on the SKU name. Possible - * values include: 'Classic', 'Basic', 'Standard', 'Premium' - * @member {string} [loginServer] The URL that can be used to log into the - * container registry. - * @member {date} [creationDate] The creation date of the container registry in - * ISO8601 format. - * @member {string} [provisioningState] The provisioning state of the container - * registry at the time the operation was called. Possible values include: - * 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled' - * @member {object} [status] The status of the container registry at the time - * the operation was called. - * @member {string} [status.displayStatus] The short label for the status. - * @member {string} [status.message] The detailed message for the status, - * including alerts and error messages. - * @member {date} [status.timestamp] The timestamp when the status was changed - * to the current value. - * @member {boolean} [adminUserEnabled] The value that indicates whether the - * admin user is enabled. Default value: false . - * @member {object} [storageAccount] The properties of the storage account for - * the container registry. Only applicable to Classic SKU. - * @member {string} [storageAccount.id] The resource ID of the storage account. - */ +*/ export interface Registry extends Resource { + /** + * The SKU of the container registry. + */ sku: Sku; + /** + * The URL that can be used to log into the container registry. + */ readonly loginServer?: string; + /** + * The creation date of the container registry in ISO8601 format. + */ readonly creationDate?: Date; + /** + * The provisioning state of the container registry at the time the operation was called. + * Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled' + */ readonly provisioningState?: string; + /** + * The status of the container registry at the time the operation was called. + */ readonly status?: Status; + /** + * The value that indicates whether the admin user is enabled. + */ adminUserEnabled?: boolean; + /** + * The properties of the storage account for the container registry. Only applicable to Classic + * SKU. + */ storageAccount?: StorageAccountProperties; + /** + * The network rule set for a container registry. + */ + networkRuleSet?: NetworkRuleSet; } /** - * @class - * Initializes a new instance of the RegistryUpdateParameters class. - * @constructor * The parameters for updating a container registry. - * - * @member {object} [tags] The tags for the container registry. - * @member {object} [sku] The SKU of the container registry. - * @member {string} [sku.name] The SKU name of the container registry. Required - * for registry creation. Possible values include: 'Classic', 'Basic', - * 'Standard', 'Premium' - * @member {string} [sku.tier] The SKU tier based on the SKU name. Possible - * values include: 'Classic', 'Basic', 'Standard', 'Premium' - * @member {boolean} [adminUserEnabled] The value that indicates whether the - * admin user is enabled. - * @member {object} [storageAccount] The parameters of a storage account for - * the container registry. Only applicable to Classic SKU. If specified, the - * storage account must be in the same physical location as the container - * registry. - * @member {string} [storageAccount.id] The resource ID of the storage account. - */ +*/ export interface RegistryUpdateParameters { + /** + * The tags for the container registry. + */ tags?: { [propertyName: string]: string }; + /** + * The SKU of the container registry. + */ sku?: Sku; + /** + * The value that indicates whether the admin user is enabled. + */ adminUserEnabled?: boolean; + /** + * The parameters of a storage account for the container registry. Only applicable to Classic + * SKU. If specified, the storage account must be in the same physical location as the container + * registry. + */ storageAccount?: StorageAccountProperties; + /** + * The network rule set for a container registry. + */ + networkRuleSet?: NetworkRuleSet; } /** - * @class - * Initializes a new instance of the RegistryPassword class. - * @constructor * The login password for the container registry. - * - * @member {string} [name] The password name. Possible values include: - * 'password', 'password2' - * @member {string} [value] The password value. - */ +*/ export interface RegistryPassword { + /** + * The password name. Possible values include: 'password', 'password2' + */ name?: string; + /** + * The password value. + */ value?: string; } /** - * @class - * Initializes a new instance of the RegistryListCredentialsResult class. - * @constructor * The response from the ListCredentials operation. - * - * @member {string} [username] The username for a container registry. - * @member {array} [passwords] The list of passwords for a container registry. - */ +*/ export interface RegistryListCredentialsResult { + /** + * The username for a container registry. + */ username?: string; + /** + * The list of passwords for a container registry. + */ passwords?: RegistryPassword[]; } /** - * @class - * Initializes a new instance of the RegenerateCredentialParameters class. - * @constructor * The parameters used to regenerate the login credential. - * - * @member {string} name Specifies name of the password which should be - * regenerated -- password or password2. Possible values include: 'password', - * 'password2' - */ +*/ export interface RegenerateCredentialParameters { + /** + * Specifies name of the password which should be regenerated -- password or password2. Possible + * values include: 'password', 'password2' + */ name: string; } /** - * @class - * Initializes a new instance of the RegistryUsage class. - * @constructor * The quota usage for a container registry. - * - * @member {string} [name] The name of the usage. - * @member {number} [limit] The limit of the usage. - * @member {number} [currentValue] The current value of the usage. - * @member {string} [unit] The unit of measurement. Possible values include: - * 'Count', 'Bytes' - */ +*/ export interface RegistryUsage { + /** + * The name of the usage. + */ name?: string; + /** + * The limit of the usage. + */ limit?: number; + /** + * The current value of the usage. + */ currentValue?: number; + /** + * The unit of measurement. Possible values include: 'Count', 'Bytes' + */ unit?: string; } /** - * @class - * Initializes a new instance of the RegistryUsageListResult class. - * @constructor * The result of a request to get container registry quota usages. - * - * @member {array} [value] The list of container registry quota usages. - */ +*/ export interface RegistryUsageListResult { + /** + * The list of container registry quota usages. + */ value?: RegistryUsage[]; } /** - * @class - * Initializes a new instance of the QuarantinePolicy class. - * @constructor * An object that represents quarantine policy for a container registry. - * - * @member {string} [status] The value that indicates whether the policy is - * enabled or not. Possible values include: 'enabled', 'disabled' - */ +*/ export interface QuarantinePolicy { + /** + * The value that indicates whether the policy is enabled or not. Possible values include: + * 'enabled', 'disabled' + */ status?: string; } /** - * @class - * Initializes a new instance of the TrustPolicy class. - * @constructor * An object that represents content trust policy for a container registry. - * - * @member {string} [type] The type of trust policy. Possible values include: - * 'Notary' - * @member {string} [status] The value that indicates whether the policy is - * enabled or not. Possible values include: 'enabled', 'disabled' - */ +*/ export interface TrustPolicy { + /** + * The type of trust policy. Possible values include: 'Notary' + */ type?: string; + /** + * The value that indicates whether the policy is enabled or not. Possible values include: + * 'enabled', 'disabled' + */ status?: string; } /** - * @class - * Initializes a new instance of the RegistryPolicies class. - * @constructor * An object that represents policies for a container registry. - * - * @member {object} [quarantinePolicy] An object that represents quarantine - * policy for a container registry. - * @member {string} [quarantinePolicy.status] The value that indicates whether - * the policy is enabled or not. Possible values include: 'enabled', 'disabled' - * @member {object} [trustPolicy] An object that represents content trust - * policy for a container registry. - * @member {string} [trustPolicy.type] The type of trust policy. Possible - * values include: 'Notary' - * @member {string} [trustPolicy.status] The value that indicates whether the - * policy is enabled or not. Possible values include: 'enabled', 'disabled' - */ +*/ export interface RegistryPolicies { + /** + * An object that represents quarantine policy for a container registry. + */ quarantinePolicy?: QuarantinePolicy; + /** + * An object that represents content trust policy for a container registry. + */ trustPolicy?: TrustPolicy; } /** - * @class - * Initializes a new instance of the Replication class. - * @constructor * An object that represents a replication for a container registry. - * - * @member {string} [provisioningState] The provisioning state of the - * replication at the time the operation was called. Possible values include: - * 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled' - * @member {object} [status] The status of the replication at the time the - * operation was called. - * @member {string} [status.displayStatus] The short label for the status. - * @member {string} [status.message] The detailed message for the status, - * including alerts and error messages. - * @member {date} [status.timestamp] The timestamp when the status was changed - * to the current value. - */ +*/ export interface Replication extends Resource { + /** + * The provisioning state of the replication at the time the operation was called. Possible + * values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled' + */ readonly provisioningState?: string; + /** + * The status of the replication at the time the operation was called. + */ readonly status?: Status; } /** - * @class - * Initializes a new instance of the ReplicationUpdateParameters class. - * @constructor * The parameters for updating a replication. - * - * @member {object} [tags] The tags for the replication. - */ +*/ export interface ReplicationUpdateParameters { + /** + * The tags for the replication. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the Webhook class. - * @constructor * An object that represents a webhook for a container registry. - * - * @member {string} [status] The status of the webhook at the time the - * operation was called. Possible values include: 'enabled', 'disabled' - * @member {string} [scope] The scope of repositories where the event can be - * triggered. For example, 'foo:*' means events for all tags under repository - * 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to - * 'foo:latest'. Empty means all events. - * @member {array} actions The list of actions that trigger the webhook to post - * notifications. - * @member {string} [provisioningState] The provisioning state of the webhook - * at the time the operation was called. Possible values include: 'Creating', - * 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled' - */ +*/ export interface Webhook extends Resource { + /** + * The status of the webhook at the time the operation was called. Possible values include: + * 'enabled', 'disabled' + */ status?: string; + /** + * The scope of repositories where the event can be triggered. For example, 'foo:*' means events + * for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is + * equivalent to 'foo:latest'. Empty means all events. + */ scope?: string; + /** + * The list of actions that trigger the webhook to post notifications. + */ actions: string[]; + /** + * The provisioning state of the webhook at the time the operation was called. Possible values + * include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled' + */ readonly provisioningState?: string; } /** - * @class - * Initializes a new instance of the WebhookCreateParameters class. - * @constructor * The parameters for creating a webhook. - * - * @member {object} [tags] The tags for the webhook. - * @member {string} location The location of the webhook. This cannot be - * changed after the resource is created. - * @member {string} serviceUri The service URI for the webhook to post - * notifications. - * @member {object} [customHeaders] Custom headers that will be added to the - * webhook notifications. - * @member {string} [status] The status of the webhook at the time the - * operation was called. Possible values include: 'enabled', 'disabled' - * @member {string} [scope] The scope of repositories where the event can be - * triggered. For example, 'foo:*' means events for all tags under repository - * 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to - * 'foo:latest'. Empty means all events. - * @member {array} actions The list of actions that trigger the webhook to post - * notifications. - */ +*/ export interface WebhookCreateParameters { + /** + * The tags for the webhook. + */ tags?: { [propertyName: string]: string }; + /** + * The location of the webhook. This cannot be changed after the resource is created. + */ location: string; + /** + * The service URI for the webhook to post notifications. + */ serviceUri: string; + /** + * Custom headers that will be added to the webhook notifications. + */ customHeaders?: { [propertyName: string]: string }; + /** + * The status of the webhook at the time the operation was called. Possible values include: + * 'enabled', 'disabled' + */ status?: string; + /** + * The scope of repositories where the event can be triggered. For example, 'foo:*' means events + * for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is + * equivalent to 'foo:latest'. Empty means all events. + */ scope?: string; + /** + * The list of actions that trigger the webhook to post notifications. + */ actions: string[]; } /** - * @class - * Initializes a new instance of the WebhookUpdateParameters class. - * @constructor * The parameters for updating a webhook. - * - * @member {object} [tags] The tags for the webhook. - * @member {string} [serviceUri] The service URI for the webhook to post - * notifications. - * @member {object} [customHeaders] Custom headers that will be added to the - * webhook notifications. - * @member {string} [status] The status of the webhook at the time the - * operation was called. Possible values include: 'enabled', 'disabled' - * @member {string} [scope] The scope of repositories where the event can be - * triggered. For example, 'foo:*' means events for all tags under repository - * 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to - * 'foo:latest'. Empty means all events. - * @member {array} [actions] The list of actions that trigger the webhook to - * post notifications. - */ +*/ export interface WebhookUpdateParameters { + /** + * The tags for the webhook. + */ tags?: { [propertyName: string]: string }; + /** + * The service URI for the webhook to post notifications. + */ serviceUri?: string; + /** + * Custom headers that will be added to the webhook notifications. + */ customHeaders?: { [propertyName: string]: string }; + /** + * The status of the webhook at the time the operation was called. Possible values include: + * 'enabled', 'disabled' + */ status?: string; + /** + * The scope of repositories where the event can be triggered. For example, 'foo:*' means events + * for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is + * equivalent to 'foo:latest'. Empty means all events. + */ scope?: string; + /** + * The list of actions that trigger the webhook to post notifications. + */ actions?: string[]; } /** - * @class - * Initializes a new instance of the EventInfo class. - * @constructor * The basic information of an event. - * - * @member {string} [id] The event ID. - */ +*/ export interface EventInfo { + /** + * The event ID. + */ id?: string; } /** - * @class - * Initializes a new instance of the CallbackConfig class. - * @constructor * The configuration of service URI and custom headers for the webhook. - * - * @member {string} serviceUri The service URI for the webhook to post - * notifications. - * @member {object} [customHeaders] Custom headers that will be added to the - * webhook notifications. - */ +*/ export interface CallbackConfig { + /** + * The service URI for the webhook to post notifications. + */ serviceUri: string; + /** + * Custom headers that will be added to the webhook notifications. + */ customHeaders?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the Target class. - * @constructor * The target of the event. - * - * @member {string} [mediaType] The MIME type of the referenced object. - * @member {number} [size] The number of bytes of the content. Same as Length - * field. - * @member {string} [digest] The digest of the content, as defined by the - * Registry V2 HTTP API Specification. - * @member {number} [length] The number of bytes of the content. Same as Size - * field. - * @member {string} [repository] The repository name. - * @member {string} [url] The direct URL to the content. - * @member {string} [tag] The tag name. - */ +*/ export interface Target { + /** + * The MIME type of the referenced object. + */ mediaType?: string; + /** + * The number of bytes of the content. Same as Length field. + */ size?: number; + /** + * The digest of the content, as defined by the Registry V2 HTTP API Specification. + */ digest?: string; + /** + * The number of bytes of the content. Same as Size field. + */ length?: number; + /** + * The repository name. + */ repository?: string; + /** + * The direct URL to the content. + */ url?: string; + /** + * The tag name. + */ tag?: string; } /** - * @class - * Initializes a new instance of the Request class. - * @constructor * The request that generated the event. - * - * @member {string} [id] The ID of the request that initiated the event. - * @member {string} [addr] The IP or hostname and possibly port of the client - * connection that initiated the event. This is the RemoteAddr from the - * standard http request. - * @member {string} [host] The externally accessible hostname of the registry - * instance, as specified by the http host header on incoming requests. - * @member {string} [method] The request method that generated the event. - * @member {string} [useragent] The user agent header of the request. - */ +*/ export interface Request { + /** + * The ID of the request that initiated the event. + */ id?: string; + /** + * The IP or hostname and possibly port of the client connection that initiated the event. This + * is the RemoteAddr from the standard http request. + */ addr?: string; + /** + * The externally accessible hostname of the registry instance, as specified by the http host + * header on incoming requests. + */ host?: string; + /** + * The request method that generated the event. + */ method?: string; + /** + * The user agent header of the request. + */ useragent?: string; } /** - * @class - * Initializes a new instance of the Actor class. - * @constructor - * The agent that initiated the event. For most situations, this could be from - * the authorization context of the request. - * - * @member {string} [name] The subject or username associated with the request - * context that generated the event. - */ + * The agent that initiated the event. For most situations, this could be from the authorization + * context of the request. +*/ export interface Actor { + /** + * The subject or username associated with the request context that generated the event. + */ name?: string; } /** - * @class - * Initializes a new instance of the Source class. - * @constructor - * The registry node that generated the event. Put differently, while the actor - * initiates the event, the source generates it. - * - * @member {string} [addr] The IP or hostname and the port of the registry node - * that generated the event. Generally, this will be resolved by os.Hostname() - * along with the running port. - * @member {string} [instanceID] The running instance of an application. - * Changes after each restart. - */ + * The registry node that generated the event. Put differently, while the actor initiates the + * event, the source generates it. +*/ export interface Source { + /** + * The IP or hostname and the port of the registry node that generated the event. Generally, this + * will be resolved by os.Hostname() along with the running port. + */ addr?: string; + /** + * The running instance of an application. Changes after each restart. + */ instanceID?: string; } /** - * @class - * Initializes a new instance of the EventContent class. - * @constructor * The content of the event request message. - * - * @member {string} [id] The event ID. - * @member {date} [timestamp] The time at which the event occurred. - * @member {string} [action] The action that encompasses the provided event. - * @member {object} [target] The target of the event. - * @member {string} [target.mediaType] The MIME type of the referenced object. - * @member {number} [target.size] The number of bytes of the content. Same as - * Length field. - * @member {string} [target.digest] The digest of the content, as defined by - * the Registry V2 HTTP API Specification. - * @member {number} [target.length] The number of bytes of the content. Same as - * Size field. - * @member {string} [target.repository] The repository name. - * @member {string} [target.url] The direct URL to the content. - * @member {string} [target.tag] The tag name. - * @member {object} [request] The request that generated the event. - * @member {string} [request.id] The ID of the request that initiated the - * event. - * @member {string} [request.addr] The IP or hostname and possibly port of the - * client connection that initiated the event. This is the RemoteAddr from the - * standard http request. - * @member {string} [request.host] The externally accessible hostname of the - * registry instance, as specified by the http host header on incoming - * requests. - * @member {string} [request.method] The request method that generated the - * event. - * @member {string} [request.useragent] The user agent header of the request. - * @member {object} [actor] The agent that initiated the event. For most - * situations, this could be from the authorization context of the request. - * @member {string} [actor.name] The subject or username associated with the - * request context that generated the event. - * @member {object} [source] The registry node that generated the event. Put - * differently, while the actor initiates the event, the source generates it. - * @member {string} [source.addr] The IP or hostname and the port of the - * registry node that generated the event. Generally, this will be resolved by - * os.Hostname() along with the running port. - * @member {string} [source.instanceID] The running instance of an application. - * Changes after each restart. - */ +*/ export interface EventContent { + /** + * The event ID. + */ id?: string; + /** + * The time at which the event occurred. + */ timestamp?: Date; + /** + * The action that encompasses the provided event. + */ action?: string; + /** + * The target of the event. + */ target?: Target; + /** + * The request that generated the event. + */ request?: Request; + /** + * The agent that initiated the event. For most situations, this could be from the authorization + * context of the request. + */ actor?: Actor; + /** + * The registry node that generated the event. Put differently, while the actor initiates the + * event, the source generates it. + */ source?: Source; } /** - * @class - * Initializes a new instance of the EventRequestMessage class. - * @constructor * The event request message sent to the service URI. - * - * @member {object} [content] The content of the event request message. - * @member {string} [content.id] The event ID. - * @member {date} [content.timestamp] The time at which the event occurred. - * @member {string} [content.action] The action that encompasses the provided - * event. - * @member {object} [content.target] The target of the event. - * @member {string} [content.target.mediaType] The MIME type of the referenced - * object. - * @member {number} [content.target.size] The number of bytes of the content. - * Same as Length field. - * @member {string} [content.target.digest] The digest of the content, as - * defined by the Registry V2 HTTP API Specification. - * @member {number} [content.target.length] The number of bytes of the content. - * Same as Size field. - * @member {string} [content.target.repository] The repository name. - * @member {string} [content.target.url] The direct URL to the content. - * @member {string} [content.target.tag] The tag name. - * @member {object} [content.request] The request that generated the event. - * @member {string} [content.request.id] The ID of the request that initiated - * the event. - * @member {string} [content.request.addr] The IP or hostname and possibly port - * of the client connection that initiated the event. This is the RemoteAddr - * from the standard http request. - * @member {string} [content.request.host] The externally accessible hostname - * of the registry instance, as specified by the http host header on incoming - * requests. - * @member {string} [content.request.method] The request method that generated - * the event. - * @member {string} [content.request.useragent] The user agent header of the - * request. - * @member {object} [content.actor] The agent that initiated the event. For - * most situations, this could be from the authorization context of the - * request. - * @member {string} [content.actor.name] The subject or username associated - * with the request context that generated the event. - * @member {object} [content.source] The registry node that generated the - * event. Put differently, while the actor initiates the event, the source - * generates it. - * @member {string} [content.source.addr] The IP or hostname and the port of - * the registry node that generated the event. Generally, this will be resolved - * by os.Hostname() along with the running port. - * @member {string} [content.source.instanceID] The running instance of an - * application. Changes after each restart. - * @member {object} [headers] The headers of the event request message. - * @member {string} [method] The HTTP method used to send the event request - * message. - * @member {string} [requestUri] The URI used to send the event request - * message. - * @member {string} [version] The HTTP message version. - */ +*/ export interface EventRequestMessage { + /** + * The content of the event request message. + */ content?: EventContent; + /** + * The headers of the event request message. + */ headers?: { [propertyName: string]: string }; + /** + * The HTTP method used to send the event request message. + */ method?: string; + /** + * The URI used to send the event request message. + */ requestUri?: string; + /** + * The HTTP message version. + */ version?: string; } /** - * @class - * Initializes a new instance of the EventResponseMessage class. - * @constructor * The event response message received from the service URI. - * - * @member {string} [content] The content of the event response message. - * @member {object} [headers] The headers of the event response message. - * @member {string} [reasonPhrase] The reason phrase of the event response - * message. - * @member {string} [statusCode] The status code of the event response message. - * @member {string} [version] The HTTP message version. - */ +*/ export interface EventResponseMessage { + /** + * The content of the event response message. + */ content?: string; + /** + * The headers of the event response message. + */ headers?: { [propertyName: string]: string }; + /** + * The reason phrase of the event response message. + */ reasonPhrase?: string; + /** + * The status code of the event response message. + */ statusCode?: string; + /** + * The HTTP message version. + */ version?: string; } /** - * @class - * Initializes a new instance of the Event class. - * @constructor * The event for a webhook. - * - * @member {object} [eventRequestMessage] The event request message sent to the - * service URI. - * @member {object} [eventRequestMessage.content] The content of the event - * request message. - * @member {string} [eventRequestMessage.content.id] The event ID. - * @member {date} [eventRequestMessage.content.timestamp] The time at which the - * event occurred. - * @member {string} [eventRequestMessage.content.action] The action that - * encompasses the provided event. - * @member {object} [eventRequestMessage.content.target] The target of the - * event. - * @member {string} [eventRequestMessage.content.target.mediaType] The MIME - * type of the referenced object. - * @member {number} [eventRequestMessage.content.target.size] The number of - * bytes of the content. Same as Length field. - * @member {string} [eventRequestMessage.content.target.digest] The digest of - * the content, as defined by the Registry V2 HTTP API Specification. - * @member {number} [eventRequestMessage.content.target.length] The number of - * bytes of the content. Same as Size field. - * @member {string} [eventRequestMessage.content.target.repository] The - * repository name. - * @member {string} [eventRequestMessage.content.target.url] The direct URL to - * the content. - * @member {string} [eventRequestMessage.content.target.tag] The tag name. - * @member {object} [eventRequestMessage.content.request] The request that - * generated the event. - * @member {string} [eventRequestMessage.content.request.id] The ID of the - * request that initiated the event. - * @member {string} [eventRequestMessage.content.request.addr] The IP or - * hostname and possibly port of the client connection that initiated the - * event. This is the RemoteAddr from the standard http request. - * @member {string} [eventRequestMessage.content.request.host] The externally - * accessible hostname of the registry instance, as specified by the http host - * header on incoming requests. - * @member {string} [eventRequestMessage.content.request.method] The request - * method that generated the event. - * @member {string} [eventRequestMessage.content.request.useragent] The user - * agent header of the request. - * @member {object} [eventRequestMessage.content.actor] The agent that - * initiated the event. For most situations, this could be from the - * authorization context of the request. - * @member {string} [eventRequestMessage.content.actor.name] The subject or - * username associated with the request context that generated the event. - * @member {object} [eventRequestMessage.content.source] The registry node that - * generated the event. Put differently, while the actor initiates the event, - * the source generates it. - * @member {string} [eventRequestMessage.content.source.addr] The IP or - * hostname and the port of the registry node that generated the event. - * Generally, this will be resolved by os.Hostname() along with the running - * port. - * @member {string} [eventRequestMessage.content.source.instanceID] The running - * instance of an application. Changes after each restart. - * @member {object} [eventRequestMessage.headers] The headers of the event - * request message. - * @member {string} [eventRequestMessage.method] The HTTP method used to send - * the event request message. - * @member {string} [eventRequestMessage.requestUri] The URI used to send the - * event request message. - * @member {string} [eventRequestMessage.version] The HTTP message version. - * @member {object} [eventResponseMessage] The event response message received - * from the service URI. - * @member {string} [eventResponseMessage.content] The content of the event - * response message. - * @member {object} [eventResponseMessage.headers] The headers of the event - * response message. - * @member {string} [eventResponseMessage.reasonPhrase] The reason phrase of - * the event response message. - * @member {string} [eventResponseMessage.statusCode] The status code of the - * event response message. - * @member {string} [eventResponseMessage.version] The HTTP message version. - */ +*/ export interface Event extends EventInfo { + /** + * The event request message sent to the service URI. + */ eventRequestMessage?: EventRequestMessage; + /** + * The event response message received from the service URI. + */ eventResponseMessage?: EventResponseMessage; } /** - * @class - * Initializes a new instance of the RunRequest class. - * @constructor * The request parameters for scheduling a run. - * - * @member {boolean} [isArchiveEnabled] The value that indicates whether - * archiving is enabled for the run or not. Default value: false . - * @member {string} type Polymorphic Discriminator - */ +*/ export interface RunRequest { + /** + * The value that indicates whether archiving is enabled for the run or not. + */ isArchiveEnabled?: boolean; + /** + * Polymorphic Discriminator + */ type: string; } /** - * @class - * Initializes a new instance of the ImageDescriptor class. - * @constructor * Properties for a registry image. - * - * @member {string} [registry] The registry login server. - * @member {string} [repository] The repository name. - * @member {string} [tag] The tag name. - * @member {string} [digest] The sha256-based digest of the image manifest. - */ +*/ export interface ImageDescriptor { + /** + * The registry login server. + */ registry?: string; + /** + * The repository name. + */ repository?: string; + /** + * The tag name. + */ tag?: string; + /** + * The sha256-based digest of the image manifest. + */ digest?: string; } /** - * @class - * Initializes a new instance of the ImageUpdateTrigger class. - * @constructor * The image update trigger that caused a build. - * - * @member {string} [id] The unique ID of the trigger. - * @member {date} [timestamp] The timestamp when the image update happened. - * @member {array} [images] The list of image updates that caused the build. - */ +*/ export interface ImageUpdateTrigger { + /** + * The unique ID of the trigger. + */ id?: string; + /** + * The timestamp when the image update happened. + */ timestamp?: Date; + /** + * The list of image updates that caused the build. + */ images?: ImageDescriptor[]; } /** - * @class - * Initializes a new instance of the SourceTriggerDescriptor class. - * @constructor * The source trigger that caused a run. - * - * @member {string} [id] The unique ID of the trigger. - * @member {string} [eventType] The event type of the trigger. - * @member {string} [commitId] The unique ID that identifies a commit. - * @member {string} [pullRequestId] The unique ID that identifies pull request. - * @member {string} [repositoryUrl] The repository URL. - * @member {string} [branchName] The branch name in the repository. - * @member {string} [providerType] The source control provider type. - */ +*/ export interface SourceTriggerDescriptor { + /** + * The unique ID of the trigger. + */ id?: string; + /** + * The event type of the trigger. + */ eventType?: string; + /** + * The unique ID that identifies a commit. + */ commitId?: string; + /** + * The unique ID that identifies pull request. + */ pullRequestId?: string; + /** + * The repository URL. + */ repositoryUrl?: string; + /** + * The branch name in the repository. + */ branchName?: string; + /** + * The source control provider type. + */ providerType?: string; } /** - * @class - * Initializes a new instance of the PlatformProperties class. - * @constructor * The platform properties against which the run has to happen. - * - * @member {string} os The operating system type required for the run. Possible - * values include: 'Windows', 'Linux' - * @member {string} [architecture] The OS architecture. Possible values - * include: 'amd64', 'x86', 'arm' - * @member {string} [variant] Variant of the CPU. Possible values include: - * 'v6', 'v7', 'v8' - */ +*/ export interface PlatformProperties { + /** + * The operating system type required for the run. Possible values include: 'Windows', 'Linux' + */ os: string; + /** + * The OS architecture. Possible values include: 'amd64', 'x86', 'arm' + */ architecture?: string; + /** + * Variant of the CPU. Possible values include: 'v6', 'v7', 'v8' + */ variant?: string; } /** - * @class - * Initializes a new instance of the AgentProperties class. - * @constructor * The properties that determine the run agent configuration. - * - * @member {number} [cpu] The CPU configuration in terms of number of cores - * required for the run. - */ +*/ export interface AgentProperties { + /** + * The CPU configuration in terms of number of cores required for the run. + */ cpu?: number; } /** - * @class - * Initializes a new instance of the ProxyResource class. - * @constructor - * The resource model definition for a ARM proxy resource. It will have - * everything other than required location and tags. - * - * @member {string} [id] The resource ID. - * @member {string} [name] The name of the resource. - * @member {string} [type] The type of the resource. - */ + * The resource model definition for a ARM proxy resource. It will have everything other than + * required location and tags. +*/ export interface ProxyResource extends BaseResource { + /** + * The resource ID. + */ readonly id?: string; + /** + * The name of the resource. + */ readonly name?: string; + /** + * The type of the resource. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the Run class. - * @constructor * Run resource properties - * - * @member {string} [runId] The unique identifier for the run. - * @member {string} [status] The current status of the run. Possible values - * include: 'Queued', 'Started', 'Running', 'Succeeded', 'Failed', 'Canceled', - * 'Error', 'Timeout' - * @member {date} [lastUpdatedTime] The last updated time for the run. - * @member {string} [runType] The type of run. Possible values include: - * 'QuickBuild', 'QuickRun', 'AutoBuild', 'AutoRun' - * @member {date} [createTime] The time the run was scheduled. - * @member {date} [startTime] The time the run started. - * @member {date} [finishTime] The time the run finished. - * @member {array} [outputImages] The list of all images that were generated - * from the run. This is applicable if the run generates base image - * dependencies. - * @member {string} [task] The task against which run was scheduled. - * @member {object} [imageUpdateTrigger] The image update trigger that caused - * the run. This is applicable if the task has base image trigger configured. - * @member {string} [imageUpdateTrigger.id] The unique ID of the trigger. - * @member {date} [imageUpdateTrigger.timestamp] The timestamp when the image - * update happened. - * @member {array} [imageUpdateTrigger.images] The list of image updates that - * caused the build. - * @member {object} [sourceTrigger] The source trigger that caused the run. - * @member {string} [sourceTrigger.id] The unique ID of the trigger. - * @member {string} [sourceTrigger.eventType] The event type of the trigger. - * @member {string} [sourceTrigger.commitId] The unique ID that identifies a - * commit. - * @member {string} [sourceTrigger.pullRequestId] The unique ID that identifies - * pull request. - * @member {string} [sourceTrigger.repositoryUrl] The repository URL. - * @member {string} [sourceTrigger.branchName] The branch name in the - * repository. - * @member {string} [sourceTrigger.providerType] The source control provider - * type. - * @member {boolean} [isArchiveEnabled] The value that indicates whether - * archiving is enabled or not. Default value: false . - * @member {object} [platform] The platform properties against which the run - * will happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible - * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values - * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms of - * number of cores required for the run. - * @member {string} [provisioningState] The provisioning state of a run. - * Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', - * 'Failed', 'Canceled' - */ +*/ export interface Run extends ProxyResource { + /** + * The unique identifier for the run. + */ runId?: string; + /** + * The current status of the run. Possible values include: 'Queued', 'Started', 'Running', + * 'Succeeded', 'Failed', 'Canceled', 'Error', 'Timeout' + */ status?: string; + /** + * The last updated time for the run. + */ lastUpdatedTime?: Date; + /** + * The type of run. Possible values include: 'QuickBuild', 'QuickRun', 'AutoBuild', 'AutoRun' + */ runType?: string; + /** + * The time the run was scheduled. + */ createTime?: Date; + /** + * The time the run started. + */ startTime?: Date; + /** + * The time the run finished. + */ finishTime?: Date; + /** + * The list of all images that were generated from the run. This is applicable if the run + * generates base image dependencies. + */ outputImages?: ImageDescriptor[]; + /** + * The task against which run was scheduled. + */ task?: string; + /** + * The image update trigger that caused the run. This is applicable if the task has base image + * trigger configured. + */ imageUpdateTrigger?: ImageUpdateTrigger; + /** + * The source trigger that caused the run. + */ sourceTrigger?: SourceTriggerDescriptor; + /** + * The value that indicates whether archiving is enabled or not. + */ isArchiveEnabled?: boolean; + /** + * The platform properties against which the run will happen. + */ platform?: PlatformProperties; + /** + * The machine configuration of the run agent. + */ agentConfiguration?: AgentProperties; + /** + * The provisioning state of a run. Possible values include: 'Creating', 'Updating', 'Deleting', + * 'Succeeded', 'Failed', 'Canceled' + */ provisioningState?: string; } /** - * @class - * Initializes a new instance of the SourceUploadDefinition class. - * @constructor * The properties of a response to source upload request. - * - * @member {string} [uploadUrl] The URL where the client can upload the source. - * @member {string} [relativePath] The relative path to the source. This is - * used to submit the subsequent queue build request. - */ +*/ export interface SourceUploadDefinition { + /** + * The URL where the client can upload the source. + */ uploadUrl?: string; + /** + * The relative path to the source. This is used to submit the subsequent queue build request. + */ relativePath?: string; } /** - * @class - * Initializes a new instance of the RunFilter class. - * @constructor * Properties that are enabled for Odata querying on runs. - * - * @member {string} [runId] The unique identifier for the run. - * @member {string} [runType] The type of run. Possible values include: - * 'QuickBuild', 'QuickRun', 'AutoBuild', 'AutoRun' - * @member {string} [status] The current status of the run. Possible values - * include: 'Queued', 'Started', 'Running', 'Succeeded', 'Failed', 'Canceled', - * 'Error', 'Timeout' - * @member {date} [createTime] The create time for a run. - * @member {date} [finishTime] The time the run finished. - * @member {string} [outputImageManifests] The list of comma-separated image - * manifests that were generated from the run. This is applicable if the run is - * of - * build type. - * @member {boolean} [isArchiveEnabled] The value that indicates whether - * archiving is enabled or not. - * @member {string} [taskName] The name of the task that the run corresponds - * to. - */ +*/ export interface RunFilter { + /** + * The unique identifier for the run. + */ runId?: string; + /** + * The type of run. Possible values include: 'QuickBuild', 'QuickRun', 'AutoBuild', 'AutoRun' + */ runType?: string; + /** + * The current status of the run. Possible values include: 'Queued', 'Started', 'Running', + * 'Succeeded', 'Failed', 'Canceled', 'Error', 'Timeout' + */ status?: string; + /** + * The create time for a run. + */ createTime?: Date; + /** + * The time the run finished. + */ finishTime?: Date; + /** + * The list of comma-separated image manifests that were generated from the run. This is + * applicable if the run is of + * build type. + */ outputImageManifests?: string; + /** + * The value that indicates whether archiving is enabled or not. + */ isArchiveEnabled?: boolean; + /** + * The name of the task that the run corresponds to. + */ taskName?: string; } /** - * @class - * Initializes a new instance of the RunUpdateParameters class. - * @constructor * The set of run properties that can be updated. - * - * @member {boolean} [isArchiveEnabled] The value that indicates whether - * archiving is enabled or not. - */ +*/ export interface RunUpdateParameters { + /** + * The value that indicates whether archiving is enabled or not. + */ isArchiveEnabled?: boolean; } /** - * @class - * Initializes a new instance of the RunGetLogResult class. - * @constructor * The result of get log link operation. - * - * @member {string} [logLink] The link to logs for a run on a azure container - * registry. - */ +*/ export interface RunGetLogResult { + /** + * The link to logs for a run on a azure container registry. + */ logLink?: string; } /** - * @class - * Initializes a new instance of the BaseImageDependency class. - * @constructor * Properties that describe a base image dependency. - * - * @member {string} [type] The type of the base image dependency. Possible - * values include: 'BuildTime', 'RunTime' - * @member {string} [registry] The registry login server. - * @member {string} [repository] The repository name. - * @member {string} [tag] The tag name. - * @member {string} [digest] The sha256-based digest of the image manifest. - */ +*/ export interface BaseImageDependency { + /** + * The type of the base image dependency. Possible values include: 'BuildTime', 'RunTime' + */ type?: string; + /** + * The registry login server. + */ registry?: string; + /** + * The repository name. + */ repository?: string; + /** + * The tag name. + */ tag?: string; + /** + * The sha256-based digest of the image manifest. + */ digest?: string; } /** - * @class - * Initializes a new instance of the TaskStepProperties class. - * @constructor * Base properties for any task step. - * - * @member {array} [baseImageDependencies] List of base image dependencies for - * a step. - * @member {string} [contextPath] The URL(absolute or relative) of the source - * context for the task step. - * @member {string} [contextAccessToken] The token (git PAT or SAS token of - * storage account blob) associated with the context for a step. - * @member {string} type Polymorphic Discriminator - */ +*/ export interface TaskStepProperties { + /** + * List of base image dependencies for a step. + */ readonly baseImageDependencies?: BaseImageDependency[]; + /** + * The URL(absolute or relative) of the source context for the task step. + */ contextPath?: string; + /** + * The token (git PAT or SAS token of storage account blob) associated with the context for a + * step. + */ contextAccessToken?: string; + /** + * Polymorphic Discriminator + */ type: string; } /** - * @class - * Initializes a new instance of the AuthInfo class. - * @constructor * The authorization properties for accessing the source code repository. - * - * @member {string} tokenType The type of Auth token. Possible values include: - * 'PAT', 'OAuth' - * @member {string} token The access token used to access the source control - * provider. - * @member {string} [refreshToken] The refresh token used to refresh the access - * token. - * @member {string} [scope] The scope of the access token. - * @member {number} [expiresIn] Time in seconds that the token remains valid - */ +*/ export interface AuthInfo { + /** + * The type of Auth token. Possible values include: 'PAT', 'OAuth' + */ tokenType: string; + /** + * The access token used to access the source control provider. + */ token: string; + /** + * The refresh token used to refresh the access token. + */ refreshToken?: string; + /** + * The scope of the access token. + */ scope?: string; + /** + * Time in seconds that the token remains valid + */ expiresIn?: number; } /** - * @class - * Initializes a new instance of the SourceProperties class. - * @constructor * The properties of the source code repository. - * - * @member {string} sourceControlType The type of source control service. - * Possible values include: 'Github', 'VisualStudioTeamService' - * @member {string} repositoryUrl The full URL to the source code respository - * @member {string} [branch] The branch name of the source code. - * @member {object} [sourceControlAuthProperties] The authorization properties - * for accessing the source code repository and to set up - * webhooks for notifications. - * @member {string} [sourceControlAuthProperties.tokenType] The type of Auth - * token. Possible values include: 'PAT', 'OAuth' - * @member {string} [sourceControlAuthProperties.token] The access token used - * to access the source control provider. - * @member {string} [sourceControlAuthProperties.refreshToken] The refresh - * token used to refresh the access token. - * @member {string} [sourceControlAuthProperties.scope] The scope of the access - * token. - * @member {number} [sourceControlAuthProperties.expiresIn] Time in seconds - * that the token remains valid - */ +*/ export interface SourceProperties { + /** + * The type of source control service. Possible values include: 'Github', + * 'VisualStudioTeamService' + */ sourceControlType: string; + /** + * The full URL to the source code repository + */ repositoryUrl: string; + /** + * The branch name of the source code. + */ branch?: string; + /** + * The authorization properties for accessing the source code repository and to set up + * webhooks for notifications. + */ sourceControlAuthProperties?: AuthInfo; } /** - * @class - * Initializes a new instance of the SourceTrigger class. - * @constructor * The properties of a source based trigger. - * - * @member {object} sourceRepository The properties that describes the - * source(code) for the task. - * @member {string} [sourceRepository.sourceControlType] The type of source - * control service. Possible values include: 'Github', - * 'VisualStudioTeamService' - * @member {string} [sourceRepository.repositoryUrl] The full URL to the source - * code respository - * @member {string} [sourceRepository.branch] The branch name of the source - * code. - * @member {object} [sourceRepository.sourceControlAuthProperties] The - * authorization properties for accessing the source code repository and to set - * up - * webhooks for notifications. - * @member {string} [sourceRepository.sourceControlAuthProperties.tokenType] - * The type of Auth token. Possible values include: 'PAT', 'OAuth' - * @member {string} [sourceRepository.sourceControlAuthProperties.token] The - * access token used to access the source control provider. - * @member {string} [sourceRepository.sourceControlAuthProperties.refreshToken] - * The refresh token used to refresh the access token. - * @member {string} [sourceRepository.sourceControlAuthProperties.scope] The - * scope of the access token. - * @member {number} [sourceRepository.sourceControlAuthProperties.expiresIn] - * Time in seconds that the token remains valid - * @member {array} sourceTriggerEvents The source event corresponding to the - * trigger. - * @member {string} [status] The current status of trigger. Possible values - * include: 'Disabled', 'Enabled' - * @member {string} name The name of the trigger. - */ +*/ export interface SourceTrigger { + /** + * The properties that describes the source(code) for the task. + */ sourceRepository: SourceProperties; + /** + * The source event corresponding to the trigger. + */ sourceTriggerEvents: string[]; + /** + * The current status of trigger. Possible values include: 'Disabled', 'Enabled' + */ status?: string; + /** + * The name of the trigger. + */ name: string; } /** - * @class - * Initializes a new instance of the BaseImageTrigger class. - * @constructor * The trigger based on base image dependency. - * - * @member {string} baseImageTriggerType The type of the auto trigger for base - * image dependency updates. Possible values include: 'All', 'Runtime' - * @member {string} [status] The current status of trigger. Possible values - * include: 'Disabled', 'Enabled' - * @member {string} name The name of the trigger. - */ +*/ export interface BaseImageTrigger { + /** + * The type of the auto trigger for base image dependency updates. Possible values include: + * 'All', 'Runtime' + */ baseImageTriggerType: string; + /** + * The current status of trigger. Possible values include: 'Disabled', 'Enabled' + */ status?: string; + /** + * The name of the trigger. + */ name: string; } /** - * @class - * Initializes a new instance of the TriggerProperties class. - * @constructor * The properties of a trigger. - * - * @member {array} [sourceTriggers] The collection of triggers based on source - * code repository. - * @member {object} [baseImageTrigger] The trigger based on base image - * dependencies. - * @member {string} [baseImageTrigger.baseImageTriggerType] The type of the - * auto trigger for base image dependency updates. Possible values include: - * 'All', 'Runtime' - * @member {string} [baseImageTrigger.status] The current status of trigger. - * Possible values include: 'Disabled', 'Enabled' - * @member {string} [baseImageTrigger.name] The name of the trigger. - */ +*/ export interface TriggerProperties { + /** + * The collection of triggers based on source code repository. + */ sourceTriggers?: SourceTrigger[]; + /** + * The trigger based on base image dependencies. + */ baseImageTrigger?: BaseImageTrigger; } /** - * @class - * Initializes a new instance of the Task class. - * @constructor * The task that has the ARM resource and task properties. - * The task will have all information to schedule a run against it. - * - * @member {string} [provisioningState] The provisioning state of the task. - * Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', - * 'Failed', 'Canceled' - * @member {date} [creationDate] The creation date of task. - * @member {string} [status] The current status of task. Possible values - * include: 'Disabled', 'Enabled' - * @member {object} platform The platform properties against which the run has - * to happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible - * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values - * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms of - * number of cores required for the run. - * @member {number} [timeout] Run timeout in seconds. Default value: 3600 . - * @member {object} step The properties of a task step. - * @member {array} [step.baseImageDependencies] List of base image dependencies - * for a step. - * @member {string} [step.contextPath] The URL(absolute or relative) of the - * source context for the task step. - * @member {string} [step.contextAccessToken] The token (git PAT or SAS token - * of storage account blob) associated with the context for a step. - * @member {string} [step.type] Polymorphic Discriminator - * @member {object} [trigger] The properties that describe all triggers for the - * task. - * @member {array} [trigger.sourceTriggers] The collection of triggers based on - * source code repository. - * @member {object} [trigger.baseImageTrigger] The trigger based on base image - * dependencies. - * @member {string} [trigger.baseImageTrigger.baseImageTriggerType] The type of - * the auto trigger for base image dependency updates. Possible values include: - * 'All', 'Runtime' - * @member {string} [trigger.baseImageTrigger.status] The current status of - * trigger. Possible values include: 'Disabled', 'Enabled' - * @member {string} [trigger.baseImageTrigger.name] The name of the trigger. - */ + * The task will have all information to schedule a run against it. +*/ export interface Task extends Resource { + /** + * The provisioning state of the task. Possible values include: 'Creating', 'Updating', + * 'Deleting', 'Succeeded', 'Failed', 'Canceled' + */ readonly provisioningState?: string; + /** + * The creation date of task. + */ readonly creationDate?: Date; + /** + * The current status of task. Possible values include: 'Disabled', 'Enabled' + */ status?: string; + /** + * The platform properties against which the run has to happen. + */ platform: PlatformProperties; + /** + * The machine configuration of the run agent. + */ agentConfiguration?: AgentProperties; + /** + * Run timeout in seconds. + */ timeout?: number; + /** + * The properties of a task step. + */ step: TaskStepProperties; + /** + * The properties that describe all triggers for the task. + */ trigger?: TriggerProperties; } /** - * @class - * Initializes a new instance of the PlatformUpdateParameters class. - * @constructor * The properties for updating the platform configuration. - * - * @member {string} [os] The operating system type required for the run. - * Possible values include: 'Windows', 'Linux' - * @member {string} [architecture] The OS architecture. Possible values - * include: 'amd64', 'x86', 'arm' - * @member {string} [variant] Variant of the CPU. Possible values include: - * 'v6', 'v7', 'v8' - */ +*/ export interface PlatformUpdateParameters { + /** + * The operating system type required for the run. Possible values include: 'Windows', 'Linux' + */ os?: string; + /** + * The OS architecture. Possible values include: 'amd64', 'x86', 'arm' + */ architecture?: string; + /** + * Variant of the CPU. Possible values include: 'v6', 'v7', 'v8' + */ variant?: string; } /** - * @class - * Initializes a new instance of the TaskStepUpdateParameters class. - * @constructor * Base properties for updating any task step. - * - * @member {string} [contextPath] The URL(absolute or relative) of the source - * context for the task step. - * @member {string} [contextAccessToken] The token (git PAT or SAS token of - * storage account blob) associated with the context for a step. - * @member {string} type Polymorphic Discriminator - */ +*/ export interface TaskStepUpdateParameters { + /** + * The URL(absolute or relative) of the source context for the task step. + */ contextPath?: string; + /** + * The token (git PAT or SAS token of storage account blob) associated with the context for a + * step. + */ contextAccessToken?: string; + /** + * Polymorphic Discriminator + */ type: string; } /** - * @class - * Initializes a new instance of the AuthInfoUpdateParameters class. - * @constructor * The authorization properties for accessing the source code repository. - * - * @member {string} [tokenType] The type of Auth token. Possible values - * include: 'PAT', 'OAuth' - * @member {string} [token] The access token used to access the source control - * provider. - * @member {string} [refreshToken] The refresh token used to refresh the access - * token. - * @member {string} [scope] The scope of the access token. - * @member {number} [expiresIn] Time in seconds that the token remains valid - */ +*/ export interface AuthInfoUpdateParameters { + /** + * The type of Auth token. Possible values include: 'PAT', 'OAuth' + */ tokenType?: string; + /** + * The access token used to access the source control provider. + */ token?: string; + /** + * The refresh token used to refresh the access token. + */ refreshToken?: string; + /** + * The scope of the access token. + */ scope?: string; + /** + * Time in seconds that the token remains valid + */ expiresIn?: number; } /** - * @class - * Initializes a new instance of the SourceUpdateParameters class. - * @constructor * The properties for updating the source code repository. - * - * @member {string} [sourceControlType] The type of source control service. - * Possible values include: 'Github', 'VisualStudioTeamService' - * @member {string} [repositoryUrl] The full URL to the source code respository - * @member {string} [branch] The branch name of the source code. - * @member {object} [sourceControlAuthProperties] The authorization properties - * for accessing the source code repository and to set up - * webhooks for notifications. - * @member {string} [sourceControlAuthProperties.tokenType] The type of Auth - * token. Possible values include: 'PAT', 'OAuth' - * @member {string} [sourceControlAuthProperties.token] The access token used - * to access the source control provider. - * @member {string} [sourceControlAuthProperties.refreshToken] The refresh - * token used to refresh the access token. - * @member {string} [sourceControlAuthProperties.scope] The scope of the access - * token. - * @member {number} [sourceControlAuthProperties.expiresIn] Time in seconds - * that the token remains valid - */ +*/ export interface SourceUpdateParameters { + /** + * The type of source control service. Possible values include: 'Github', + * 'VisualStudioTeamService' + */ sourceControlType?: string; + /** + * The full URL to the source code repository + */ repositoryUrl?: string; + /** + * The branch name of the source code. + */ branch?: string; + /** + * The authorization properties for accessing the source code repository and to set up + * webhooks for notifications. + */ sourceControlAuthProperties?: AuthInfoUpdateParameters; } /** - * @class - * Initializes a new instance of the SourceTriggerUpdateParameters class. - * @constructor * The properties for updating a source based trigger. - * - * @member {object} [sourceRepository] The properties that describes the - * source(code) for the task. - * @member {string} [sourceRepository.sourceControlType] The type of source - * control service. Possible values include: 'Github', - * 'VisualStudioTeamService' - * @member {string} [sourceRepository.repositoryUrl] The full URL to the source - * code respository - * @member {string} [sourceRepository.branch] The branch name of the source - * code. - * @member {object} [sourceRepository.sourceControlAuthProperties] The - * authorization properties for accessing the source code repository and to set - * up - * webhooks for notifications. - * @member {string} [sourceRepository.sourceControlAuthProperties.tokenType] - * The type of Auth token. Possible values include: 'PAT', 'OAuth' - * @member {string} [sourceRepository.sourceControlAuthProperties.token] The - * access token used to access the source control provider. - * @member {string} [sourceRepository.sourceControlAuthProperties.refreshToken] - * The refresh token used to refresh the access token. - * @member {string} [sourceRepository.sourceControlAuthProperties.scope] The - * scope of the access token. - * @member {number} [sourceRepository.sourceControlAuthProperties.expiresIn] - * Time in seconds that the token remains valid - * @member {array} [sourceTriggerEvents] The source event corresponding to the - * trigger. - * @member {string} [status] The current status of trigger. Possible values - * include: 'Disabled', 'Enabled' - * @member {string} name The name of the trigger. - */ +*/ export interface SourceTriggerUpdateParameters { + /** + * The properties that describes the source(code) for the task. + */ sourceRepository?: SourceUpdateParameters; + /** + * The source event corresponding to the trigger. + */ sourceTriggerEvents?: string[]; + /** + * The current status of trigger. Possible values include: 'Disabled', 'Enabled' + */ status?: string; + /** + * The name of the trigger. + */ name: string; } /** - * @class - * Initializes a new instance of the BaseImageTriggerUpdateParameters class. - * @constructor * The properties for updating base image dependency trigger. - * - * @member {string} [baseImageTriggerType] The type of the auto trigger for - * base image dependency updates. Possible values include: 'All', 'Runtime' - * @member {string} [status] The current status of trigger. Possible values - * include: 'Disabled', 'Enabled' - * @member {string} name The name of the trigger. - */ +*/ export interface BaseImageTriggerUpdateParameters { + /** + * The type of the auto trigger for base image dependency updates. Possible values include: + * 'All', 'Runtime' + */ baseImageTriggerType?: string; + /** + * The current status of trigger. Possible values include: 'Disabled', 'Enabled' + */ status?: string; + /** + * The name of the trigger. + */ name: string; } /** - * @class - * Initializes a new instance of the TriggerUpdateParameters class. - * @constructor * The properties for updating triggers. - * - * @member {array} [sourceTriggers] The collection of triggers based on source - * code repository. - * @member {object} [baseImageTrigger] The trigger based on base image - * dependencies. - * @member {string} [baseImageTrigger.baseImageTriggerType] The type of the - * auto trigger for base image dependency updates. Possible values include: - * 'All', 'Runtime' - * @member {string} [baseImageTrigger.status] The current status of trigger. - * Possible values include: 'Disabled', 'Enabled' - * @member {string} [baseImageTrigger.name] The name of the trigger. - */ +*/ export interface TriggerUpdateParameters { + /** + * The collection of triggers based on source code repository. + */ sourceTriggers?: SourceTriggerUpdateParameters[]; + /** + * The trigger based on base image dependencies. + */ baseImageTrigger?: BaseImageTriggerUpdateParameters; } /** - * @class - * Initializes a new instance of the TaskUpdateParameters class. - * @constructor * The parameters for updating a task. - * - * @member {string} [status] The current status of task. Possible values - * include: 'Disabled', 'Enabled' - * @member {object} [platform] The platform properties against which the run - * has to happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible - * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values - * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms of - * number of cores required for the run. - * @member {number} [timeout] Run timeout in seconds. - * @member {object} [step] The properties for updating a task step. - * @member {string} [step.contextPath] The URL(absolute or relative) of the - * source context for the task step. - * @member {string} [step.contextAccessToken] The token (git PAT or SAS token - * of storage account blob) associated with the context for a step. - * @member {string} [step.type] Polymorphic Discriminator - * @member {object} [trigger] The properties for updating trigger properties. - * @member {array} [trigger.sourceTriggers] The collection of triggers based on - * source code repository. - * @member {object} [trigger.baseImageTrigger] The trigger based on base image - * dependencies. - * @member {string} [trigger.baseImageTrigger.baseImageTriggerType] The type of - * the auto trigger for base image dependency updates. Possible values include: - * 'All', 'Runtime' - * @member {string} [trigger.baseImageTrigger.status] The current status of - * trigger. Possible values include: 'Disabled', 'Enabled' - * @member {string} [trigger.baseImageTrigger.name] The name of the trigger. - * @member {object} [tags] The ARM resource tags. - */ +*/ export interface TaskUpdateParameters { + /** + * The current status of task. Possible values include: 'Disabled', 'Enabled' + */ status?: string; + /** + * The platform properties against which the run has to happen. + */ platform?: PlatformUpdateParameters; + /** + * The machine configuration of the run agent. + */ agentConfiguration?: AgentProperties; + /** + * Run timeout in seconds. + */ timeout?: number; + /** + * The properties for updating a task step. + */ step?: TaskStepUpdateParameters; + /** + * The properties for updating trigger properties. + */ trigger?: TriggerUpdateParameters; + /** + * The ARM resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the Argument class. - * @constructor * The properties of a run argument. - * - * @member {string} name The name of the argument. - * @member {string} value The value of the argument. - * @member {boolean} [isSecret] Flag to indicate whether the argument - * represents a secret and want to be removed from build logs. Default value: - * false . - */ +*/ export interface Argument { + /** + * The name of the argument. + */ name: string; + /** + * The value of the argument. + */ value: string; + /** + * Flag to indicate whether the argument represents a secret and want to be removed from build + * logs. + */ isSecret?: boolean; } /** - * @class - * Initializes a new instance of the DockerBuildRequest class. - * @constructor * The parameters for a docker quick build. - * - * @member {array} [imageNames] The fully qualified image names including the - * repository and tag. - * @member {boolean} [isPushEnabled] The value of this property indicates - * whether the image built should be pushed to the registry or not. Default - * value: true . - * @member {boolean} [noCache] The value of this property indicates whether the - * image cache is enabled or not. Default value: false . - * @member {string} dockerFilePath The Docker file path relative to the source - * location. - * @member {array} [argumentsProperty] The collection of override arguments to - * be used when executing the run. - * @member {number} [timeout] Run timeout in seconds. Default value: 3600 . - * @member {object} platform The platform properties against which the run has - * to happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible - * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values - * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms of - * number of cores required for the run. - * @member {string} [sourceLocation] The URL(absolute or relative) of the - * source context. It can be an URL to a tar or git repoistory. - * If it is relative URL, the relative path should be obtained from calling - * listBuildSourceUploadUrl API. - */ +*/ export interface DockerBuildRequest extends RunRequest { + /** + * The fully qualified image names including the repository and tag. + */ imageNames?: string[]; + /** + * The value of this property indicates whether the image built should be pushed to the registry + * or not. + */ isPushEnabled?: boolean; + /** + * The value of this property indicates whether the image cache is enabled or not. + */ noCache?: boolean; + /** + * The Docker file path relative to the source location. + */ dockerFilePath: string; + /** + * The collection of override arguments to be used when executing the run. + */ argumentsProperty?: Argument[]; + /** + * Run timeout in seconds. + */ timeout?: number; + /** + * The platform properties against which the run has to happen. + */ platform: PlatformProperties; + /** + * The machine configuration of the run agent. + */ agentConfiguration?: AgentProperties; + /** + * The URL(absolute or relative) of the source context. It can be an URL to a tar or git + * repository. + * If it is relative URL, the relative path should be obtained from calling + * listBuildSourceUploadUrl API. + */ sourceLocation?: string; } /** - * @class - * Initializes a new instance of the SetValue class. - * @constructor * The properties of a overridable value that can be passed to a task template. - * - * @member {string} name The name of the overridable value. - * @member {string} value The overridable value. - * @member {boolean} [isSecret] Flag to indicate whether the value represents a - * secret or not. Default value: false . - */ +*/ export interface SetValue { + /** + * The name of the overridable value. + */ name: string; + /** + * The overridable value. + */ value: string; + /** + * Flag to indicate whether the value represents a secret or not. + */ isSecret?: boolean; } /** - * @class - * Initializes a new instance of the FileTaskRunRequest class. - * @constructor * The request parameters for a scheduling run against a task file. - * - * @member {string} taskFilePath The template/definition file path relative to - * the source. - * @member {string} [valuesFilePath] The values/parameters file path relative - * to the source. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. - * @member {number} [timeout] Run timeout in seconds. Default value: 3600 . - * @member {object} platform The platform properties against which the run has - * to happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible - * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values - * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms of - * number of cores required for the run. - * @member {string} [sourceLocation] The URL(absolute or relative) of the - * source context. It can be an URL to a tar or git repoistory. - * If it is relative URL, the relative path should be obtained from calling - * listBuildSourceUploadUrl API. - */ +*/ export interface FileTaskRunRequest extends RunRequest { + /** + * The template/definition file path relative to the source. + */ taskFilePath: string; + /** + * The values/parameters file path relative to the source. + */ valuesFilePath?: string; + /** + * The collection of overridable values that can be passed when running a task. + */ values?: SetValue[]; + /** + * Run timeout in seconds. + */ timeout?: number; + /** + * The platform properties against which the run has to happen. + */ platform: PlatformProperties; + /** + * The machine configuration of the run agent. + */ agentConfiguration?: AgentProperties; + /** + * The URL(absolute or relative) of the source context. It can be an URL to a tar or git + * repository. + * If it is relative URL, the relative path should be obtained from calling + * listBuildSourceUploadUrl API. + */ sourceLocation?: string; } /** - * @class - * Initializes a new instance of the TaskRunRequest class. - * @constructor * The parameters for a task run request. - * - * @member {string} taskName The name of task against which run has to be - * queued. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. - */ +*/ export interface TaskRunRequest extends RunRequest { + /** + * The name of task against which run has to be queued. + */ taskName: string; + /** + * The collection of overridable values that can be passed when running a task. + */ values?: SetValue[]; } /** - * @class - * Initializes a new instance of the EncodedTaskRunRequest class. - * @constructor * The parameters for a quick task run request. - * - * @member {string} encodedTaskContent Base64 encoded value of the - * template/definition file content. - * @member {string} [encodedValuesContent] Base64 encoded value of the - * parameters/values file content. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. - * @member {number} [timeout] Run timeout in seconds. Default value: 3600 . - * @member {object} platform The platform properties against which the run has - * to happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible - * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values - * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms of - * number of cores required for the run. - * @member {string} [sourceLocation] The URL(absolute or relative) of the - * source context. It can be an URL to a tar or git repoistory. - * If it is relative URL, the relative path should be obtained from calling - * listBuildSourceUploadUrl API. - */ +*/ export interface EncodedTaskRunRequest extends RunRequest { + /** + * Base64 encoded value of the template/definition file content. + */ encodedTaskContent: string; + /** + * Base64 encoded value of the parameters/values file content. + */ encodedValuesContent?: string; + /** + * The collection of overridable values that can be passed when running a task. + */ values?: SetValue[]; + /** + * Run timeout in seconds. + */ timeout?: number; + /** + * The platform properties against which the run has to happen. + */ platform: PlatformProperties; + /** + * The machine configuration of the run agent. + */ agentConfiguration?: AgentProperties; + /** + * The URL(absolute or relative) of the source context. It can be an URL to a tar or git + * repository. + * If it is relative URL, the relative path should be obtained from calling + * listBuildSourceUploadUrl API. + */ sourceLocation?: string; } /** - * @class - * Initializes a new instance of the DockerBuildStep class. - * @constructor * The Docker build step. - * - * @member {array} [imageNames] The fully qualified image names including the - * repository and tag. - * @member {boolean} [isPushEnabled] The value of this property indicates - * whether the image built should be pushed to the registry or not. Default - * value: true . - * @member {boolean} [noCache] The value of this property indicates whether the - * image cache is enabled or not. Default value: false . - * @member {string} dockerFilePath The Docker file path relative to the source - * context. - * @member {array} [argumentsProperty] The collection of override arguments to - * be used when executing this build step. - */ +*/ export interface DockerBuildStep extends TaskStepProperties { + /** + * The fully qualified image names including the repository and tag. + */ imageNames?: string[]; + /** + * The value of this property indicates whether the image built should be pushed to the registry + * or not. + */ isPushEnabled?: boolean; + /** + * The value of this property indicates whether the image cache is enabled or not. + */ noCache?: boolean; + /** + * The Docker file path relative to the source context. + */ dockerFilePath: string; + /** + * The collection of override arguments to be used when executing this build step. + */ argumentsProperty?: Argument[]; } /** - * @class - * Initializes a new instance of the FileTaskStep class. - * @constructor * The properties of a task step. - * - * @member {string} taskFilePath The task template/definition file path - * relative to the source context. - * @member {string} [valuesFilePath] The task values/parameters file path - * relative to the source context. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. - */ +*/ export interface FileTaskStep extends TaskStepProperties { + /** + * The task template/definition file path relative to the source context. + */ taskFilePath: string; + /** + * The task values/parameters file path relative to the source context. + */ valuesFilePath?: string; + /** + * The collection of overridable values that can be passed when running a task. + */ values?: SetValue[]; } /** - * @class - * Initializes a new instance of the EncodedTaskStep class. - * @constructor * The properties of a encoded task step. - * - * @member {string} encodedTaskContent Base64 encoded value of the - * template/definition file content. - * @member {string} [encodedValuesContent] Base64 encoded value of the - * parameters/values file content. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. - */ +*/ export interface EncodedTaskStep extends TaskStepProperties { + /** + * Base64 encoded value of the template/definition file content. + */ encodedTaskContent: string; + /** + * Base64 encoded value of the parameters/values file content. + */ encodedValuesContent?: string; + /** + * The collection of overridable values that can be passed when running a task. + */ values?: SetValue[]; } /** - * @class - * Initializes a new instance of the DockerBuildStepUpdateParameters class. - * @constructor * The properties for updating a docker build step. - * - * @member {array} [imageNames] The fully qualified image names including the - * repository and tag. - * @member {boolean} [isPushEnabled] The value of this property indicates - * whether the image built should be pushed to the registry or not. - * @member {boolean} [noCache] The value of this property indicates whether the - * image cache is enabled or not. - * @member {string} [dockerFilePath] The Docker file path relative to the - * source context. - * @member {array} [argumentsProperty] The collection of override arguments to - * be used when executing this build step. - */ +*/ export interface DockerBuildStepUpdateParameters extends TaskStepUpdateParameters { + /** + * The fully qualified image names including the repository and tag. + */ imageNames?: string[]; + /** + * The value of this property indicates whether the image built should be pushed to the registry + * or not. + */ isPushEnabled?: boolean; + /** + * The value of this property indicates whether the image cache is enabled or not. + */ noCache?: boolean; + /** + * The Docker file path relative to the source context. + */ dockerFilePath?: string; + /** + * The collection of override arguments to be used when executing this build step. + */ argumentsProperty?: Argument[]; } /** - * @class - * Initializes a new instance of the FileTaskStepUpdateParameters class. - * @constructor * The properties of updating a task step. - * - * @member {string} [taskFilePath] The task template/definition file path - * relative to the source context. - * @member {string} [valuesFilePath] The values/parameters file path relative - * to the source context. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. - */ +*/ export interface FileTaskStepUpdateParameters extends TaskStepUpdateParameters { + /** + * The task template/definition file path relative to the source context. + */ taskFilePath?: string; + /** + * The values/parameters file path relative to the source context. + */ valuesFilePath?: string; + /** + * The collection of overridable values that can be passed when running a task. + */ values?: SetValue[]; } /** - * @class - * Initializes a new instance of the EncodedTaskStepUpdateParameters class. - * @constructor * The properties for updating encoded task step. - * - * @member {string} [encodedTaskContent] Base64 encoded value of the - * template/definition file content. - * @member {string} [encodedValuesContent] Base64 encoded value of the - * parameters/values file content. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. - */ +*/ export interface EncodedTaskStepUpdateParameters extends TaskStepUpdateParameters { + /** + * Base64 encoded value of the template/definition file content. + */ encodedTaskContent?: string; + /** + * Base64 encoded value of the parameters/values file content. + */ encodedValuesContent?: string; + /** + * The collection of overridable values that can be passed when running a task. + */ values?: SetValue[]; } - /** - * @class - * Initializes a new instance of the RegistryListResult class. - * @constructor * The result of a request to list container registries. - * - * @member {string} [nextLink] The URI that can be used to request the next - * list of container registries. - */ +*/ export interface RegistryListResult extends Array { + /** + * The URI that can be used to request the next list of container registries. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the OperationListResult class. - * @constructor * The result of a request to list container registry operations. - * - * @member {string} [nextLink] The URI that can be used to request the next - * list of container registry operations. - */ +*/ export interface OperationListResult extends Array { + /** + * The URI that can be used to request the next list of container registry operations. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ReplicationListResult class. - * @constructor * The result of a request to list replications for a container registry. - * - * @member {string} [nextLink] The URI that can be used to request the next - * list of replications. - */ +*/ export interface ReplicationListResult extends Array { + /** + * The URI that can be used to request the next list of replications. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the WebhookListResult class. - * @constructor * The result of a request to list webhooks for a container registry. - * - * @member {string} [nextLink] The URI that can be used to request the next - * list of webhooks. - */ +*/ export interface WebhookListResult extends Array { + /** + * The URI that can be used to request the next list of webhooks. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the EventListResult class. - * @constructor * The result of a request to list events for a webhook. - * - * @member {string} [nextLink] The URI that can be used to request the next - * list of events. - */ +*/ export interface EventListResult extends Array { + /** + * The URI that can be used to request the next list of events. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RunListResult class. - * @constructor * Collection of runs. - * - * @member {string} [nextLink] The URI that can be used to request the next set - * of paged results. - */ +*/ export interface RunListResult extends Array { + /** + * The URI that can be used to request the next set of paged results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the TaskListResult class. - * @constructor * The collection of tasks. - * - * @member {string} [nextLink] The URI that can be used to request the next set - * of paged results. - */ +*/ export interface TaskListResult extends Array { + /** + * The URI that can be used to request the next set of paged results. + */ nextLink?: string; } diff --git a/lib/services/containerRegistryManagement/lib/models/index.js b/lib/services/containerRegistryManagement/lib/models/index.js index 5b0f4c8e2b..3cfb4545a7 100644 --- a/lib/services/containerRegistryManagement/lib/models/index.js +++ b/lib/services/containerRegistryManagement/lib/models/index.js @@ -30,6 +30,8 @@ exports.OperationDefinition = require('./operationDefinition'); exports.Sku = require('./sku'); exports.Status = require('./status'); exports.StorageAccountProperties = require('./storageAccountProperties'); +exports.VirtualNetworkRule = require('./virtualNetworkRule'); +exports.NetworkRuleSet = require('./networkRuleSet'); exports.Resource = require('./resource'); exports.Registry = require('./registry'); exports.RegistryUpdateParameters = require('./registryUpdateParameters'); diff --git a/lib/services/containerRegistryManagement/lib/models/networkRuleSet.js b/lib/services/containerRegistryManagement/lib/models/networkRuleSet.js new file mode 100644 index 0000000000..e857a6c438 --- /dev/null +++ b/lib/services/containerRegistryManagement/lib/models/networkRuleSet.js @@ -0,0 +1,71 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The network rule set for a container registry. + * + */ +class NetworkRuleSet { + /** + * Create a NetworkRuleSet. + * @property {string} defaultAction The default action of allow or deny when + * no other rules match. Possible values include: 'Allow', 'Deny'. Default + * value: 'Allow' . + * @property {array} [virtualNetworkRules] The virtual network rules. + */ + constructor() { + } + + /** + * Defines the metadata of NetworkRuleSet + * + * @returns {object} metadata of NetworkRuleSet + * + */ + mapper() { + return { + required: false, + serializedName: 'NetworkRuleSet', + type: { + name: 'Composite', + className: 'NetworkRuleSet', + modelProperties: { + defaultAction: { + required: true, + serializedName: 'defaultAction', + defaultValue: 'Allow', + type: { + name: 'String' + } + }, + virtualNetworkRules: { + required: false, + serializedName: 'virtualNetworkRules', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'VirtualNetworkRuleElementType', + type: { + name: 'Composite', + className: 'VirtualNetworkRule' + } + } + } + } + } + } + }; + } +} + +module.exports = NetworkRuleSet; diff --git a/lib/services/containerRegistryManagement/lib/models/operationDefinition.js b/lib/services/containerRegistryManagement/lib/models/operationDefinition.js index e41849d0d2..94ca0ad21a 100644 --- a/lib/services/containerRegistryManagement/lib/models/operationDefinition.js +++ b/lib/services/containerRegistryManagement/lib/models/operationDefinition.js @@ -17,20 +17,23 @@ class OperationDefinition { /** * Create a OperationDefinition. - * @member {string} [origin] The origin information of the container registry - * operation. - * @member {string} [name] Operation name: {provider}/{resource}/{operation}. - * @member {object} [display] The display information for the container + * @property {string} [origin] The origin information of the container + * registry operation. + * @property {string} [name] Operation name: + * {provider}/{resource}/{operation}. + * @property {object} [display] The display information for the container * registry operation. - * @member {string} [display.provider] The resource provider name: + * @property {string} [display.provider] The resource provider name: * Microsoft.ContainerRegistry. - * @member {string} [display.resource] The resource on which the operation is - * performed. - * @member {string} [display.operation] The operation that users can perform. - * @member {string} [display.description] The description for the operation. - * @member {object} [serviceSpecification] The definition of Azure Monitoring - * service. - * @member {array} [serviceSpecification.metricSpecifications] A list of + * @property {string} [display.resource] The resource on which the operation + * is performed. + * @property {string} [display.operation] The operation that users can + * perform. + * @property {string} [display.description] The description for the + * operation. + * @property {object} [serviceSpecification] The definition of Azure + * Monitoring service. + * @property {array} [serviceSpecification.metricSpecifications] A list of * Azure Monitoring metrics definition. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/operationDisplayDefinition.js b/lib/services/containerRegistryManagement/lib/models/operationDisplayDefinition.js index 2d31fa5146..fdd7d8f07e 100644 --- a/lib/services/containerRegistryManagement/lib/models/operationDisplayDefinition.js +++ b/lib/services/containerRegistryManagement/lib/models/operationDisplayDefinition.js @@ -17,12 +17,12 @@ class OperationDisplayDefinition { /** * Create a OperationDisplayDefinition. - * @member {string} [provider] The resource provider name: + * @property {string} [provider] The resource provider name: * Microsoft.ContainerRegistry. - * @member {string} [resource] The resource on which the operation is + * @property {string} [resource] The resource on which the operation is * performed. - * @member {string} [operation] The operation that users can perform. - * @member {string} [description] The description for the operation. + * @property {string} [operation] The operation that users can perform. + * @property {string} [description] The description for the operation. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/operationListResult.js b/lib/services/containerRegistryManagement/lib/models/operationListResult.js index e0abee0a71..58bd1c5ff7 100644 --- a/lib/services/containerRegistryManagement/lib/models/operationListResult.js +++ b/lib/services/containerRegistryManagement/lib/models/operationListResult.js @@ -16,7 +16,7 @@ class OperationListResult extends Array { /** * Create a OperationListResult. - * @member {string} [nextLink] The URI that can be used to request the next + * @property {string} [nextLink] The URI that can be used to request the next * list of container registry operations. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/operationMetricSpecificationDefinition.js b/lib/services/containerRegistryManagement/lib/models/operationMetricSpecificationDefinition.js index 7b071e928f..dc4d9d4451 100644 --- a/lib/services/containerRegistryManagement/lib/models/operationMetricSpecificationDefinition.js +++ b/lib/services/containerRegistryManagement/lib/models/operationMetricSpecificationDefinition.js @@ -17,12 +17,12 @@ class OperationMetricSpecificationDefinition { /** * Create a OperationMetricSpecificationDefinition. - * @member {string} [name] Metric name. - * @member {string} [displayName] Metric display name. - * @member {string} [displayDescription] Metric description. - * @member {string} [unit] Metric unit. - * @member {string} [aggregationType] Metric aggregation type. - * @member {string} [internalMetricName] Internal metric name. + * @property {string} [name] Metric name. + * @property {string} [displayName] Metric display name. + * @property {string} [displayDescription] Metric description. + * @property {string} [unit] Metric unit. + * @property {string} [aggregationType] Metric aggregation type. + * @property {string} [internalMetricName] Internal metric name. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/operationServiceSpecificationDefinition.js b/lib/services/containerRegistryManagement/lib/models/operationServiceSpecificationDefinition.js index 0474a63311..eadf42c396 100644 --- a/lib/services/containerRegistryManagement/lib/models/operationServiceSpecificationDefinition.js +++ b/lib/services/containerRegistryManagement/lib/models/operationServiceSpecificationDefinition.js @@ -17,8 +17,8 @@ class OperationServiceSpecificationDefinition { /** * Create a OperationServiceSpecificationDefinition. - * @member {array} [metricSpecifications] A list of Azure Monitoring metrics - * definition. + * @property {array} [metricSpecifications] A list of Azure Monitoring + * metrics definition. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/platformProperties.js b/lib/services/containerRegistryManagement/lib/models/platformProperties.js index a3c90aba84..5ba2aa4687 100644 --- a/lib/services/containerRegistryManagement/lib/models/platformProperties.js +++ b/lib/services/containerRegistryManagement/lib/models/platformProperties.js @@ -17,11 +17,11 @@ class PlatformProperties { /** * Create a PlatformProperties. - * @member {string} os The operating system type required for the run. + * @property {string} os The operating system type required for the run. * Possible values include: 'Windows', 'Linux' - * @member {string} [architecture] The OS architecture. Possible values + * @property {string} [architecture] The OS architecture. Possible values * include: 'amd64', 'x86', 'arm' - * @member {string} [variant] Variant of the CPU. Possible values include: + * @property {string} [variant] Variant of the CPU. Possible values include: * 'v6', 'v7', 'v8' */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/platformUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/platformUpdateParameters.js index df811ebf64..4f0812a6d5 100644 --- a/lib/services/containerRegistryManagement/lib/models/platformUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/platformUpdateParameters.js @@ -17,11 +17,11 @@ class PlatformUpdateParameters { /** * Create a PlatformUpdateParameters. - * @member {string} [os] The operating system type required for the run. + * @property {string} [os] The operating system type required for the run. * Possible values include: 'Windows', 'Linux' - * @member {string} [architecture] The OS architecture. Possible values + * @property {string} [architecture] The OS architecture. Possible values * include: 'amd64', 'x86', 'arm' - * @member {string} [variant] Variant of the CPU. Possible values include: + * @property {string} [variant] Variant of the CPU. Possible values include: * 'v6', 'v7', 'v8' */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/proxyResource.js b/lib/services/containerRegistryManagement/lib/models/proxyResource.js index 6bc01330b6..9cbfbab186 100644 --- a/lib/services/containerRegistryManagement/lib/models/proxyResource.js +++ b/lib/services/containerRegistryManagement/lib/models/proxyResource.js @@ -21,9 +21,9 @@ const models = require('./index'); class ProxyResource extends models['BaseResource'] { /** * Create a ProxyResource. - * @member {string} [id] The resource ID. - * @member {string} [name] The name of the resource. - * @member {string} [type] The type of the resource. + * @property {string} [id] The resource ID. + * @property {string} [name] The name of the resource. + * @property {string} [type] The type of the resource. */ constructor() { super(); diff --git a/lib/services/containerRegistryManagement/lib/models/quarantinePolicy.js b/lib/services/containerRegistryManagement/lib/models/quarantinePolicy.js index 1157c77a09..52775a8e3a 100644 --- a/lib/services/containerRegistryManagement/lib/models/quarantinePolicy.js +++ b/lib/services/containerRegistryManagement/lib/models/quarantinePolicy.js @@ -17,7 +17,7 @@ class QuarantinePolicy { /** * Create a QuarantinePolicy. - * @member {string} [status] The value that indicates whether the policy is + * @property {string} [status] The value that indicates whether the policy is * enabled or not. Possible values include: 'enabled', 'disabled' */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/regenerateCredentialParameters.js b/lib/services/containerRegistryManagement/lib/models/regenerateCredentialParameters.js index 1c774358fb..d054b7c8c8 100644 --- a/lib/services/containerRegistryManagement/lib/models/regenerateCredentialParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/regenerateCredentialParameters.js @@ -17,7 +17,7 @@ class RegenerateCredentialParameters { /** * Create a RegenerateCredentialParameters. - * @member {string} name Specifies name of the password which should be + * @property {string} name Specifies name of the password which should be * regenerated -- password or password2. Possible values include: 'password', * 'password2' */ diff --git a/lib/services/containerRegistryManagement/lib/models/registry.js b/lib/services/containerRegistryManagement/lib/models/registry.js index 5cc411d10d..735d479846 100644 --- a/lib/services/containerRegistryManagement/lib/models/registry.js +++ b/lib/services/containerRegistryManagement/lib/models/registry.js @@ -20,33 +20,40 @@ const models = require('./index'); class Registry extends models['Resource'] { /** * Create a Registry. - * @member {object} sku The SKU of the container registry. - * @member {string} [sku.name] The SKU name of the container registry. + * @property {object} sku The SKU of the container registry. + * @property {string} [sku.name] The SKU name of the container registry. * Required for registry creation. Possible values include: 'Classic', * 'Basic', 'Standard', 'Premium' - * @member {string} [sku.tier] The SKU tier based on the SKU name. Possible + * @property {string} [sku.tier] The SKU tier based on the SKU name. Possible * values include: 'Classic', 'Basic', 'Standard', 'Premium' - * @member {string} [loginServer] The URL that can be used to log into the + * @property {string} [loginServer] The URL that can be used to log into the * container registry. - * @member {date} [creationDate] The creation date of the container registry - * in ISO8601 format. - * @member {string} [provisioningState] The provisioning state of the + * @property {date} [creationDate] The creation date of the container + * registry in ISO8601 format. + * @property {string} [provisioningState] The provisioning state of the * container registry at the time the operation was called. Possible values * include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', * 'Canceled' - * @member {object} [status] The status of the container registry at the time - * the operation was called. - * @member {string} [status.displayStatus] The short label for the status. - * @member {string} [status.message] The detailed message for the status, + * @property {object} [status] The status of the container registry at the + * time the operation was called. + * @property {string} [status.displayStatus] The short label for the status. + * @property {string} [status.message] The detailed message for the status, * including alerts and error messages. - * @member {date} [status.timestamp] The timestamp when the status was + * @property {date} [status.timestamp] The timestamp when the status was * changed to the current value. - * @member {boolean} [adminUserEnabled] The value that indicates whether the - * admin user is enabled. Default value: false . - * @member {object} [storageAccount] The properties of the storage account + * @property {boolean} [adminUserEnabled] The value that indicates whether + * the admin user is enabled. Default value: false . + * @property {object} [storageAccount] The properties of the storage account * for the container registry. Only applicable to Classic SKU. - * @member {string} [storageAccount.id] The resource ID of the storage + * @property {string} [storageAccount.id] The resource ID of the storage * account. + * @property {object} [networkRuleSet] The network rule set for a container + * registry. + * @property {string} [networkRuleSet.defaultAction] The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * @property {array} [networkRuleSet.virtualNetworkRules] The virtual network + * rules. */ constructor() { super(); @@ -167,6 +174,14 @@ class Registry extends models['Resource'] { name: 'Composite', className: 'StorageAccountProperties' } + }, + networkRuleSet: { + required: false, + serializedName: 'properties.networkRuleSet', + type: { + name: 'Composite', + className: 'NetworkRuleSet' + } } } } diff --git a/lib/services/containerRegistryManagement/lib/models/registryListCredentialsResult.js b/lib/services/containerRegistryManagement/lib/models/registryListCredentialsResult.js index efc57692b8..b2ac6db70d 100644 --- a/lib/services/containerRegistryManagement/lib/models/registryListCredentialsResult.js +++ b/lib/services/containerRegistryManagement/lib/models/registryListCredentialsResult.js @@ -17,8 +17,8 @@ class RegistryListCredentialsResult { /** * Create a RegistryListCredentialsResult. - * @member {string} [username] The username for a container registry. - * @member {array} [passwords] The list of passwords for a container + * @property {string} [username] The username for a container registry. + * @property {array} [passwords] The list of passwords for a container * registry. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/registryListResult.js b/lib/services/containerRegistryManagement/lib/models/registryListResult.js index 8c8cbb710e..5228659cf6 100644 --- a/lib/services/containerRegistryManagement/lib/models/registryListResult.js +++ b/lib/services/containerRegistryManagement/lib/models/registryListResult.js @@ -16,7 +16,7 @@ class RegistryListResult extends Array { /** * Create a RegistryListResult. - * @member {string} [nextLink] The URI that can be used to request the next + * @property {string} [nextLink] The URI that can be used to request the next * list of container registries. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/registryNameCheckRequest.js b/lib/services/containerRegistryManagement/lib/models/registryNameCheckRequest.js index 043ebb19e1..2caeb8990f 100644 --- a/lib/services/containerRegistryManagement/lib/models/registryNameCheckRequest.js +++ b/lib/services/containerRegistryManagement/lib/models/registryNameCheckRequest.js @@ -17,7 +17,7 @@ class RegistryNameCheckRequest { /** * Create a RegistryNameCheckRequest. - * @member {string} name The name of the container registry. + * @property {string} name The name of the container registry. */ constructor() { } @@ -42,7 +42,7 @@ class RegistryNameCheckRequest { constraints: { MaxLength: 50, MinLength: 5, - Pattern: '^[a-zA-Z0-9]*$' + Pattern: /^[a-zA-Z0-9]*$/ }, type: { name: 'String' diff --git a/lib/services/containerRegistryManagement/lib/models/registryNameStatus.js b/lib/services/containerRegistryManagement/lib/models/registryNameStatus.js index 2b02ca7c49..317cc4dff2 100644 --- a/lib/services/containerRegistryManagement/lib/models/registryNameStatus.js +++ b/lib/services/containerRegistryManagement/lib/models/registryNameStatus.js @@ -18,11 +18,11 @@ class RegistryNameStatus { /** * Create a RegistryNameStatus. - * @member {boolean} [nameAvailable] The value that indicates whether the + * @property {boolean} [nameAvailable] The value that indicates whether the * name is available. - * @member {string} [reason] If any, the reason that the name is not + * @property {string} [reason] If any, the reason that the name is not * available. - * @member {string} [message] If any, the error message that provides more + * @property {string} [message] If any, the error message that provides more * detail for the reason that the name is not available. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/registryPassword.js b/lib/services/containerRegistryManagement/lib/models/registryPassword.js index 4b999036f4..ee94f9371e 100644 --- a/lib/services/containerRegistryManagement/lib/models/registryPassword.js +++ b/lib/services/containerRegistryManagement/lib/models/registryPassword.js @@ -17,9 +17,9 @@ class RegistryPassword { /** * Create a RegistryPassword. - * @member {string} [name] The password name. Possible values include: + * @property {string} [name] The password name. Possible values include: * 'password', 'password2' - * @member {string} [value] The password value. + * @property {string} [value] The password value. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/registryPolicies.js b/lib/services/containerRegistryManagement/lib/models/registryPolicies.js index 5ad2aaa411..ab4ba6f9c0 100644 --- a/lib/services/containerRegistryManagement/lib/models/registryPolicies.js +++ b/lib/services/containerRegistryManagement/lib/models/registryPolicies.js @@ -17,17 +17,18 @@ class RegistryPolicies { /** * Create a RegistryPolicies. - * @member {object} [quarantinePolicy] An object that represents quarantine + * @property {object} [quarantinePolicy] An object that represents quarantine * policy for a container registry. - * @member {string} [quarantinePolicy.status] The value that indicates + * @property {string} [quarantinePolicy.status] The value that indicates * whether the policy is enabled or not. Possible values include: 'enabled', * 'disabled' - * @member {object} [trustPolicy] An object that represents content trust + * @property {object} [trustPolicy] An object that represents content trust * policy for a container registry. - * @member {string} [trustPolicy.type] The type of trust policy. Possible + * @property {string} [trustPolicy.type] The type of trust policy. Possible * values include: 'Notary' - * @member {string} [trustPolicy.status] The value that indicates whether the - * policy is enabled or not. Possible values include: 'enabled', 'disabled' + * @property {string} [trustPolicy.status] The value that indicates whether + * the policy is enabled or not. Possible values include: 'enabled', + * 'disabled' */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/registryUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/registryUpdateParameters.js index 1b5b26a0e9..ce63b0530c 100644 --- a/lib/services/containerRegistryManagement/lib/models/registryUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/registryUpdateParameters.js @@ -17,21 +17,28 @@ class RegistryUpdateParameters { /** * Create a RegistryUpdateParameters. - * @member {object} [tags] The tags for the container registry. - * @member {object} [sku] The SKU of the container registry. - * @member {string} [sku.name] The SKU name of the container registry. + * @property {object} [tags] The tags for the container registry. + * @property {object} [sku] The SKU of the container registry. + * @property {string} [sku.name] The SKU name of the container registry. * Required for registry creation. Possible values include: 'Classic', * 'Basic', 'Standard', 'Premium' - * @member {string} [sku.tier] The SKU tier based on the SKU name. Possible + * @property {string} [sku.tier] The SKU tier based on the SKU name. Possible * values include: 'Classic', 'Basic', 'Standard', 'Premium' - * @member {boolean} [adminUserEnabled] The value that indicates whether the - * admin user is enabled. - * @member {object} [storageAccount] The parameters of a storage account for - * the container registry. Only applicable to Classic SKU. If specified, the - * storage account must be in the same physical location as the container + * @property {boolean} [adminUserEnabled] The value that indicates whether + * the admin user is enabled. + * @property {object} [storageAccount] The parameters of a storage account + * for the container registry. Only applicable to Classic SKU. If specified, + * the storage account must be in the same physical location as the container * registry. - * @member {string} [storageAccount.id] The resource ID of the storage + * @property {string} [storageAccount.id] The resource ID of the storage * account. + * @property {object} [networkRuleSet] The network rule set for a container + * registry. + * @property {string} [networkRuleSet.defaultAction] The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * @property {array} [networkRuleSet.virtualNetworkRules] The virtual network + * rules. */ constructor() { } @@ -86,6 +93,14 @@ class RegistryUpdateParameters { name: 'Composite', className: 'StorageAccountProperties' } + }, + networkRuleSet: { + required: false, + serializedName: 'properties.networkRuleSet', + type: { + name: 'Composite', + className: 'NetworkRuleSet' + } } } } diff --git a/lib/services/containerRegistryManagement/lib/models/registryUsage.js b/lib/services/containerRegistryManagement/lib/models/registryUsage.js index 5b4172726f..4825aedd8b 100644 --- a/lib/services/containerRegistryManagement/lib/models/registryUsage.js +++ b/lib/services/containerRegistryManagement/lib/models/registryUsage.js @@ -17,11 +17,11 @@ class RegistryUsage { /** * Create a RegistryUsage. - * @member {string} [name] The name of the usage. - * @member {number} [limit] The limit of the usage. - * @member {number} [currentValue] The current value of the usage. - * @member {string} [unit] The unit of measurement. Possible values include: - * 'Count', 'Bytes' + * @property {string} [name] The name of the usage. + * @property {number} [limit] The limit of the usage. + * @property {number} [currentValue] The current value of the usage. + * @property {string} [unit] The unit of measurement. Possible values + * include: 'Count', 'Bytes' */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/registryUsageListResult.js b/lib/services/containerRegistryManagement/lib/models/registryUsageListResult.js index 7f8c8f829f..08a54960c9 100644 --- a/lib/services/containerRegistryManagement/lib/models/registryUsageListResult.js +++ b/lib/services/containerRegistryManagement/lib/models/registryUsageListResult.js @@ -17,7 +17,7 @@ class RegistryUsageListResult { /** * Create a RegistryUsageListResult. - * @member {array} [value] The list of container registry quota usages. + * @property {array} [value] The list of container registry quota usages. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/replication.js b/lib/services/containerRegistryManagement/lib/models/replication.js index be21b08fa7..5f81ca8169 100644 --- a/lib/services/containerRegistryManagement/lib/models/replication.js +++ b/lib/services/containerRegistryManagement/lib/models/replication.js @@ -20,15 +20,15 @@ const models = require('./index'); class Replication extends models['Resource'] { /** * Create a Replication. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * replication at the time the operation was called. Possible values include: * 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled' - * @member {object} [status] The status of the replication at the time the + * @property {object} [status] The status of the replication at the time the * operation was called. - * @member {string} [status.displayStatus] The short label for the status. - * @member {string} [status.message] The detailed message for the status, + * @property {string} [status.displayStatus] The short label for the status. + * @property {string} [status.message] The detailed message for the status, * including alerts and error messages. - * @member {date} [status.timestamp] The timestamp when the status was + * @property {date} [status.timestamp] The timestamp when the status was * changed to the current value. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/replicationListResult.js b/lib/services/containerRegistryManagement/lib/models/replicationListResult.js index 49209165ec..d06675dc54 100644 --- a/lib/services/containerRegistryManagement/lib/models/replicationListResult.js +++ b/lib/services/containerRegistryManagement/lib/models/replicationListResult.js @@ -16,7 +16,7 @@ class ReplicationListResult extends Array { /** * Create a ReplicationListResult. - * @member {string} [nextLink] The URI that can be used to request the next + * @property {string} [nextLink] The URI that can be used to request the next * list of replications. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/replicationUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/replicationUpdateParameters.js index ebc76e0dab..72ad5048f6 100644 --- a/lib/services/containerRegistryManagement/lib/models/replicationUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/replicationUpdateParameters.js @@ -17,7 +17,7 @@ class ReplicationUpdateParameters { /** * Create a ReplicationUpdateParameters. - * @member {object} [tags] The tags for the replication. + * @property {object} [tags] The tags for the replication. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/request.js b/lib/services/containerRegistryManagement/lib/models/request.js index 0563d31203..db0c49e8e2 100644 --- a/lib/services/containerRegistryManagement/lib/models/request.js +++ b/lib/services/containerRegistryManagement/lib/models/request.js @@ -17,14 +17,15 @@ class Request { /** * Create a Request. - * @member {string} [id] The ID of the request that initiated the event. - * @member {string} [addr] The IP or hostname and possibly port of the client - * connection that initiated the event. This is the RemoteAddr from the - * standard http request. - * @member {string} [host] The externally accessible hostname of the registry - * instance, as specified by the http host header on incoming requests. - * @member {string} [method] The request method that generated the event. - * @member {string} [useragent] The user agent header of the request. + * @property {string} [id] The ID of the request that initiated the event. + * @property {string} [addr] The IP or hostname and possibly port of the + * client connection that initiated the event. This is the RemoteAddr from + * the standard http request. + * @property {string} [host] The externally accessible hostname of the + * registry instance, as specified by the http host header on incoming + * requests. + * @property {string} [method] The request method that generated the event. + * @property {string} [useragent] The user agent header of the request. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/resource.js b/lib/services/containerRegistryManagement/lib/models/resource.js index a8735b8e52..d76fa1783d 100644 --- a/lib/services/containerRegistryManagement/lib/models/resource.js +++ b/lib/services/containerRegistryManagement/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 ID. - * @member {string} [name] The name of the resource. - * @member {string} [type] The type of the resource. - * @member {string} location The location of the resource. This cannot be + * @property {string} [id] The resource ID. + * @property {string} [name] The name of the resource. + * @property {string} [type] The type of the resource. + * @property {string} location The location of the resource. This cannot be * changed after the resource is created. - * @member {object} [tags] The tags of the resource. + * @property {object} [tags] The tags of the resource. */ constructor() { super(); diff --git a/lib/services/containerRegistryManagement/lib/models/run.js b/lib/services/containerRegistryManagement/lib/models/run.js index 8b8ad0f373..5fc4f78fa7 100644 --- a/lib/services/containerRegistryManagement/lib/models/run.js +++ b/lib/services/containerRegistryManagement/lib/models/run.js @@ -20,54 +20,56 @@ const models = require('./index'); class Run extends models['ProxyResource'] { /** * Create a Run. - * @member {string} [runId] The unique identifier for the run. - * @member {string} [status] The current status of the run. Possible values + * @property {string} [runId] The unique identifier for the run. + * @property {string} [status] The current status of the run. Possible values * include: 'Queued', 'Started', 'Running', 'Succeeded', 'Failed', * 'Canceled', 'Error', 'Timeout' - * @member {date} [lastUpdatedTime] The last updated time for the run. - * @member {string} [runType] The type of run. Possible values include: + * @property {date} [lastUpdatedTime] The last updated time for the run. + * @property {string} [runType] The type of run. Possible values include: * 'QuickBuild', 'QuickRun', 'AutoBuild', 'AutoRun' - * @member {date} [createTime] The time the run was scheduled. - * @member {date} [startTime] The time the run started. - * @member {date} [finishTime] The time the run finished. - * @member {array} [outputImages] The list of all images that were generated - * from the run. This is applicable if the run generates base image + * @property {date} [createTime] The time the run was scheduled. + * @property {date} [startTime] The time the run started. + * @property {date} [finishTime] The time the run finished. + * @property {array} [outputImages] The list of all images that were + * generated from the run. This is applicable if the run generates base image * dependencies. - * @member {string} [task] The task against which run was scheduled. - * @member {object} [imageUpdateTrigger] The image update trigger that caused - * the run. This is applicable if the task has base image trigger configured. - * @member {string} [imageUpdateTrigger.id] The unique ID of the trigger. - * @member {date} [imageUpdateTrigger.timestamp] The timestamp when the image - * update happened. - * @member {array} [imageUpdateTrigger.images] The list of image updates that - * caused the build. - * @member {object} [sourceTrigger] The source trigger that caused the run. - * @member {string} [sourceTrigger.id] The unique ID of the trigger. - * @member {string} [sourceTrigger.eventType] The event type of the trigger. - * @member {string} [sourceTrigger.commitId] The unique ID that identifies a - * commit. - * @member {string} [sourceTrigger.pullRequestId] The unique ID that + * @property {string} [task] The task against which run was scheduled. + * @property {object} [imageUpdateTrigger] The image update trigger that + * caused the run. This is applicable if the task has base image trigger + * configured. + * @property {string} [imageUpdateTrigger.id] The unique ID of the trigger. + * @property {date} [imageUpdateTrigger.timestamp] The timestamp when the + * image update happened. + * @property {array} [imageUpdateTrigger.images] The list of image updates + * that caused the build. + * @property {object} [sourceTrigger] The source trigger that caused the run. + * @property {string} [sourceTrigger.id] The unique ID of the trigger. + * @property {string} [sourceTrigger.eventType] The event type of the + * trigger. + * @property {string} [sourceTrigger.commitId] The unique ID that identifies + * a commit. + * @property {string} [sourceTrigger.pullRequestId] The unique ID that * identifies pull request. - * @member {string} [sourceTrigger.repositoryUrl] The repository URL. - * @member {string} [sourceTrigger.branchName] The branch name in the + * @property {string} [sourceTrigger.repositoryUrl] The repository URL. + * @property {string} [sourceTrigger.branchName] The branch name in the * repository. - * @member {string} [sourceTrigger.providerType] The source control provider - * type. - * @member {boolean} [isArchiveEnabled] The value that indicates whether + * @property {string} [sourceTrigger.providerType] The source control + * provider type. + * @property {boolean} [isArchiveEnabled] The value that indicates whether * archiving is enabled or not. Default value: false . - * @member {object} [platform] The platform properties against which the run - * will happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible + * @property {object} [platform] The platform properties against which the + * run will happen. + * @property {string} [platform.os] The operating system type required for + * the run. Possible values include: 'Windows', 'Linux' + * @property {string} [platform.architecture] The OS architecture. Possible * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values + * @property {string} [platform.variant] Variant of the CPU. Possible values * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms + * @property {object} [agentConfiguration] The machine configuration of the + * run agent. + * @property {number} [agentConfiguration.cpu] The CPU configuration in terms * of number of cores required for the run. - * @member {string} [provisioningState] The provisioning state of a run. + * @property {string} [provisioningState] The provisioning state of a run. * Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', * 'Failed', 'Canceled' */ diff --git a/lib/services/containerRegistryManagement/lib/models/runFilter.js b/lib/services/containerRegistryManagement/lib/models/runFilter.js index 83b6528ccf..e69c4b02fc 100644 --- a/lib/services/containerRegistryManagement/lib/models/runFilter.js +++ b/lib/services/containerRegistryManagement/lib/models/runFilter.js @@ -17,22 +17,22 @@ class RunFilter { /** * Create a RunFilter. - * @member {string} [runId] The unique identifier for the run. - * @member {string} [runType] The type of run. Possible values include: + * @property {string} [runId] The unique identifier for the run. + * @property {string} [runType] The type of run. Possible values include: * 'QuickBuild', 'QuickRun', 'AutoBuild', 'AutoRun' - * @member {string} [status] The current status of the run. Possible values + * @property {string} [status] The current status of the run. Possible values * include: 'Queued', 'Started', 'Running', 'Succeeded', 'Failed', * 'Canceled', 'Error', 'Timeout' - * @member {date} [createTime] The create time for a run. - * @member {date} [finishTime] The time the run finished. - * @member {string} [outputImageManifests] The list of comma-separated image - * manifests that were generated from the run. This is applicable if the run - * is of + * @property {date} [createTime] The create time for a run. + * @property {date} [finishTime] The time the run finished. + * @property {string} [outputImageManifests] The list of comma-separated + * image manifests that were generated from the run. This is applicable if + * the run is of * build type. - * @member {boolean} [isArchiveEnabled] The value that indicates whether + * @property {boolean} [isArchiveEnabled] The value that indicates whether * archiving is enabled or not. - * @member {string} [taskName] The name of the task that the run corresponds - * to. + * @property {string} [taskName] The name of the task that the run + * corresponds to. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/runGetLogResult.js b/lib/services/containerRegistryManagement/lib/models/runGetLogResult.js index afe8df834e..f013546843 100644 --- a/lib/services/containerRegistryManagement/lib/models/runGetLogResult.js +++ b/lib/services/containerRegistryManagement/lib/models/runGetLogResult.js @@ -17,8 +17,8 @@ class RunGetLogResult { /** * Create a RunGetLogResult. - * @member {string} [logLink] The link to logs for a run on a azure container - * registry. + * @property {string} [logLink] The link to logs for a run on a azure + * container registry. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/runListResult.js b/lib/services/containerRegistryManagement/lib/models/runListResult.js index 6052c64db3..781b926ade 100644 --- a/lib/services/containerRegistryManagement/lib/models/runListResult.js +++ b/lib/services/containerRegistryManagement/lib/models/runListResult.js @@ -16,7 +16,7 @@ class RunListResult extends Array { /** * Create a RunListResult. - * @member {string} [nextLink] The URI that can be used to request the next + * @property {string} [nextLink] The URI that can be used to request the next * set of paged results. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/runRequest.js b/lib/services/containerRegistryManagement/lib/models/runRequest.js index c5cb76253c..ba2f62395f 100644 --- a/lib/services/containerRegistryManagement/lib/models/runRequest.js +++ b/lib/services/containerRegistryManagement/lib/models/runRequest.js @@ -17,9 +17,9 @@ class RunRequest { /** * Create a RunRequest. - * @member {boolean} [isArchiveEnabled] The value that indicates whether + * @property {boolean} [isArchiveEnabled] The value that indicates whether * archiving is enabled for the run or not. Default value: false . - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/runUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/runUpdateParameters.js index 1ebbe3fff1..07c71bddac 100644 --- a/lib/services/containerRegistryManagement/lib/models/runUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/runUpdateParameters.js @@ -17,7 +17,7 @@ class RunUpdateParameters { /** * Create a RunUpdateParameters. - * @member {boolean} [isArchiveEnabled] The value that indicates whether + * @property {boolean} [isArchiveEnabled] The value that indicates whether * archiving is enabled or not. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/setValue.js b/lib/services/containerRegistryManagement/lib/models/setValue.js index c0937b1aea..1d9ef87ccb 100644 --- a/lib/services/containerRegistryManagement/lib/models/setValue.js +++ b/lib/services/containerRegistryManagement/lib/models/setValue.js @@ -17,10 +17,10 @@ class SetValue { /** * Create a SetValue. - * @member {string} name The name of the overridable value. - * @member {string} value The overridable value. - * @member {boolean} [isSecret] Flag to indicate whether the value represents - * a secret or not. Default value: false . + * @property {string} name The name of the overridable value. + * @property {string} value The overridable value. + * @property {boolean} [isSecret] Flag to indicate whether the value + * represents a secret or not. Default value: false . */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/sku.js b/lib/services/containerRegistryManagement/lib/models/sku.js index f3568e3ee1..a4cbe142f6 100644 --- a/lib/services/containerRegistryManagement/lib/models/sku.js +++ b/lib/services/containerRegistryManagement/lib/models/sku.js @@ -17,10 +17,10 @@ class Sku { /** * Create a Sku. - * @member {string} name The SKU name of the container registry. Required for - * registry creation. Possible values include: 'Classic', 'Basic', + * @property {string} name The SKU name of the container registry. Required + * for registry creation. Possible values include: 'Classic', 'Basic', * 'Standard', 'Premium' - * @member {string} [tier] The SKU tier based on the SKU name. Possible + * @property {string} [tier] The SKU tier based on the SKU name. Possible * values include: 'Classic', 'Basic', 'Standard', 'Premium' */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/source.js b/lib/services/containerRegistryManagement/lib/models/source.js index fdb3521d8b..f4f9b3c13b 100644 --- a/lib/services/containerRegistryManagement/lib/models/source.js +++ b/lib/services/containerRegistryManagement/lib/models/source.js @@ -18,10 +18,10 @@ class Source { /** * Create a Source. - * @member {string} [addr] The IP or hostname and the port of the registry + * @property {string} [addr] The IP or hostname and the port of the registry * node that generated the event. Generally, this will be resolved by * os.Hostname() along with the running port. - * @member {string} [instanceID] The running instance of an application. + * @property {string} [instanceID] The running instance of an application. * Changes after each restart. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/sourceProperties.js b/lib/services/containerRegistryManagement/lib/models/sourceProperties.js index c78fcf34aa..d8e90cbbf3 100644 --- a/lib/services/containerRegistryManagement/lib/models/sourceProperties.js +++ b/lib/services/containerRegistryManagement/lib/models/sourceProperties.js @@ -17,22 +17,23 @@ class SourceProperties { /** * Create a SourceProperties. - * @member {string} sourceControlType The type of source control service. + * @property {string} sourceControlType The type of source control service. * Possible values include: 'Github', 'VisualStudioTeamService' - * @member {string} repositoryUrl The full URL to the source code respository - * @member {string} [branch] The branch name of the source code. - * @member {object} [sourceControlAuthProperties] The authorization + * @property {string} repositoryUrl The full URL to the source code + * repository + * @property {string} [branch] The branch name of the source code. + * @property {object} [sourceControlAuthProperties] The authorization * properties for accessing the source code repository and to set up * webhooks for notifications. - * @member {string} [sourceControlAuthProperties.tokenType] The type of Auth - * token. Possible values include: 'PAT', 'OAuth' - * @member {string} [sourceControlAuthProperties.token] The access token used - * to access the source control provider. - * @member {string} [sourceControlAuthProperties.refreshToken] The refresh + * @property {string} [sourceControlAuthProperties.tokenType] The type of + * Auth token. Possible values include: 'PAT', 'OAuth' + * @property {string} [sourceControlAuthProperties.token] The access token + * used to access the source control provider. + * @property {string} [sourceControlAuthProperties.refreshToken] The refresh * token used to refresh the access token. - * @member {string} [sourceControlAuthProperties.scope] The scope of the + * @property {string} [sourceControlAuthProperties.scope] The scope of the * access token. - * @member {number} [sourceControlAuthProperties.expiresIn] Time in seconds + * @property {number} [sourceControlAuthProperties.expiresIn] Time in seconds * that the token remains valid */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/sourceTrigger.js b/lib/services/containerRegistryManagement/lib/models/sourceTrigger.js index 1c7f8c9d0f..425b3134da 100644 --- a/lib/services/containerRegistryManagement/lib/models/sourceTrigger.js +++ b/lib/services/containerRegistryManagement/lib/models/sourceTrigger.js @@ -17,35 +17,37 @@ class SourceTrigger { /** * Create a SourceTrigger. - * @member {object} sourceRepository The properties that describes the + * @property {object} sourceRepository The properties that describes the * source(code) for the task. - * @member {string} [sourceRepository.sourceControlType] The type of source + * @property {string} [sourceRepository.sourceControlType] The type of source * control service. Possible values include: 'Github', * 'VisualStudioTeamService' - * @member {string} [sourceRepository.repositoryUrl] The full URL to the - * source code respository - * @member {string} [sourceRepository.branch] The branch name of the source + * @property {string} [sourceRepository.repositoryUrl] The full URL to the + * source code repository + * @property {string} [sourceRepository.branch] The branch name of the source * code. - * @member {object} [sourceRepository.sourceControlAuthProperties] The + * @property {object} [sourceRepository.sourceControlAuthProperties] The * authorization properties for accessing the source code repository and to * set up * webhooks for notifications. - * @member {string} [sourceRepository.sourceControlAuthProperties.tokenType] - * The type of Auth token. Possible values include: 'PAT', 'OAuth' - * @member {string} [sourceRepository.sourceControlAuthProperties.token] The - * access token used to access the source control provider. - * @member {string} + * @property {string} + * [sourceRepository.sourceControlAuthProperties.tokenType] The type of Auth + * token. Possible values include: 'PAT', 'OAuth' + * @property {string} [sourceRepository.sourceControlAuthProperties.token] + * The access token used to access the source control provider. + * @property {string} * [sourceRepository.sourceControlAuthProperties.refreshToken] The refresh * token used to refresh the access token. - * @member {string} [sourceRepository.sourceControlAuthProperties.scope] The - * scope of the access token. - * @member {number} [sourceRepository.sourceControlAuthProperties.expiresIn] - * Time in seconds that the token remains valid - * @member {array} sourceTriggerEvents The source event corresponding to the - * trigger. - * @member {string} [status] The current status of trigger. Possible values + * @property {string} [sourceRepository.sourceControlAuthProperties.scope] + * The scope of the access token. + * @property {number} + * [sourceRepository.sourceControlAuthProperties.expiresIn] Time in seconds + * that the token remains valid + * @property {array} sourceTriggerEvents The source event corresponding to + * the trigger. + * @property {string} [status] The current status of trigger. Possible values * include: 'Disabled', 'Enabled' - * @member {string} name The name of the trigger. + * @property {string} name The name of the trigger. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/sourceTriggerDescriptor.js b/lib/services/containerRegistryManagement/lib/models/sourceTriggerDescriptor.js index 6bf83c3d08..7cf83f3c50 100644 --- a/lib/services/containerRegistryManagement/lib/models/sourceTriggerDescriptor.js +++ b/lib/services/containerRegistryManagement/lib/models/sourceTriggerDescriptor.js @@ -17,14 +17,14 @@ class SourceTriggerDescriptor { /** * Create a SourceTriggerDescriptor. - * @member {string} [id] The unique ID of the trigger. - * @member {string} [eventType] The event type of the trigger. - * @member {string} [commitId] The unique ID that identifies a commit. - * @member {string} [pullRequestId] The unique ID that identifies pull + * @property {string} [id] The unique ID of the trigger. + * @property {string} [eventType] The event type of the trigger. + * @property {string} [commitId] The unique ID that identifies a commit. + * @property {string} [pullRequestId] The unique ID that identifies pull * request. - * @member {string} [repositoryUrl] The repository URL. - * @member {string} [branchName] The branch name in the repository. - * @member {string} [providerType] The source control provider type. + * @property {string} [repositoryUrl] The repository URL. + * @property {string} [branchName] The branch name in the repository. + * @property {string} [providerType] The source control provider type. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/sourceTriggerUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/sourceTriggerUpdateParameters.js index b7bb10a97c..a50ef920e6 100644 --- a/lib/services/containerRegistryManagement/lib/models/sourceTriggerUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/sourceTriggerUpdateParameters.js @@ -17,35 +17,37 @@ class SourceTriggerUpdateParameters { /** * Create a SourceTriggerUpdateParameters. - * @member {object} [sourceRepository] The properties that describes the + * @property {object} [sourceRepository] The properties that describes the * source(code) for the task. - * @member {string} [sourceRepository.sourceControlType] The type of source + * @property {string} [sourceRepository.sourceControlType] The type of source * control service. Possible values include: 'Github', * 'VisualStudioTeamService' - * @member {string} [sourceRepository.repositoryUrl] The full URL to the - * source code respository - * @member {string} [sourceRepository.branch] The branch name of the source + * @property {string} [sourceRepository.repositoryUrl] The full URL to the + * source code repository + * @property {string} [sourceRepository.branch] The branch name of the source * code. - * @member {object} [sourceRepository.sourceControlAuthProperties] The + * @property {object} [sourceRepository.sourceControlAuthProperties] The * authorization properties for accessing the source code repository and to * set up * webhooks for notifications. - * @member {string} [sourceRepository.sourceControlAuthProperties.tokenType] - * The type of Auth token. Possible values include: 'PAT', 'OAuth' - * @member {string} [sourceRepository.sourceControlAuthProperties.token] The - * access token used to access the source control provider. - * @member {string} + * @property {string} + * [sourceRepository.sourceControlAuthProperties.tokenType] The type of Auth + * token. Possible values include: 'PAT', 'OAuth' + * @property {string} [sourceRepository.sourceControlAuthProperties.token] + * The access token used to access the source control provider. + * @property {string} * [sourceRepository.sourceControlAuthProperties.refreshToken] The refresh * token used to refresh the access token. - * @member {string} [sourceRepository.sourceControlAuthProperties.scope] The - * scope of the access token. - * @member {number} [sourceRepository.sourceControlAuthProperties.expiresIn] - * Time in seconds that the token remains valid - * @member {array} [sourceTriggerEvents] The source event corresponding to + * @property {string} [sourceRepository.sourceControlAuthProperties.scope] + * The scope of the access token. + * @property {number} + * [sourceRepository.sourceControlAuthProperties.expiresIn] Time in seconds + * that the token remains valid + * @property {array} [sourceTriggerEvents] The source event corresponding to * the trigger. - * @member {string} [status] The current status of trigger. Possible values + * @property {string} [status] The current status of trigger. Possible values * include: 'Disabled', 'Enabled' - * @member {string} name The name of the trigger. + * @property {string} name The name of the trigger. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/sourceUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/sourceUpdateParameters.js index 3c748030e1..7fa1ca0567 100644 --- a/lib/services/containerRegistryManagement/lib/models/sourceUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/sourceUpdateParameters.js @@ -17,23 +17,23 @@ class SourceUpdateParameters { /** * Create a SourceUpdateParameters. - * @member {string} [sourceControlType] The type of source control service. + * @property {string} [sourceControlType] The type of source control service. * Possible values include: 'Github', 'VisualStudioTeamService' - * @member {string} [repositoryUrl] The full URL to the source code - * respository - * @member {string} [branch] The branch name of the source code. - * @member {object} [sourceControlAuthProperties] The authorization + * @property {string} [repositoryUrl] The full URL to the source code + * repository + * @property {string} [branch] The branch name of the source code. + * @property {object} [sourceControlAuthProperties] The authorization * properties for accessing the source code repository and to set up * webhooks for notifications. - * @member {string} [sourceControlAuthProperties.tokenType] The type of Auth - * token. Possible values include: 'PAT', 'OAuth' - * @member {string} [sourceControlAuthProperties.token] The access token used - * to access the source control provider. - * @member {string} [sourceControlAuthProperties.refreshToken] The refresh + * @property {string} [sourceControlAuthProperties.tokenType] The type of + * Auth token. Possible values include: 'PAT', 'OAuth' + * @property {string} [sourceControlAuthProperties.token] The access token + * used to access the source control provider. + * @property {string} [sourceControlAuthProperties.refreshToken] The refresh * token used to refresh the access token. - * @member {string} [sourceControlAuthProperties.scope] The scope of the + * @property {string} [sourceControlAuthProperties.scope] The scope of the * access token. - * @member {number} [sourceControlAuthProperties.expiresIn] Time in seconds + * @property {number} [sourceControlAuthProperties.expiresIn] Time in seconds * that the token remains valid */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/sourceUploadDefinition.js b/lib/services/containerRegistryManagement/lib/models/sourceUploadDefinition.js index 8d802bc172..2bb3e0e627 100644 --- a/lib/services/containerRegistryManagement/lib/models/sourceUploadDefinition.js +++ b/lib/services/containerRegistryManagement/lib/models/sourceUploadDefinition.js @@ -17,9 +17,9 @@ class SourceUploadDefinition { /** * Create a SourceUploadDefinition. - * @member {string} [uploadUrl] The URL where the client can upload the + * @property {string} [uploadUrl] The URL where the client can upload the * source. - * @member {string} [relativePath] The relative path to the source. This is + * @property {string} [relativePath] The relative path to the source. This is * used to submit the subsequent queue build request. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/status.js b/lib/services/containerRegistryManagement/lib/models/status.js index 1d98fafb26..6697ccbf7b 100644 --- a/lib/services/containerRegistryManagement/lib/models/status.js +++ b/lib/services/containerRegistryManagement/lib/models/status.js @@ -17,10 +17,10 @@ class Status { /** * Create a Status. - * @member {string} [displayStatus] The short label for the status. - * @member {string} [message] The detailed message for the status, including - * alerts and error messages. - * @member {date} [timestamp] The timestamp when the status was changed to + * @property {string} [displayStatus] The short label for the status. + * @property {string} [message] The detailed message for the status, + * including alerts and error messages. + * @property {date} [timestamp] The timestamp when the status was changed to * the current value. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/storageAccountProperties.js b/lib/services/containerRegistryManagement/lib/models/storageAccountProperties.js index b1cb9dde69..e00b7697a2 100644 --- a/lib/services/containerRegistryManagement/lib/models/storageAccountProperties.js +++ b/lib/services/containerRegistryManagement/lib/models/storageAccountProperties.js @@ -18,7 +18,7 @@ class StorageAccountProperties { /** * Create a StorageAccountProperties. - * @member {string} id The resource ID of the storage account. + * @property {string} id The resource ID of the storage account. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/target.js b/lib/services/containerRegistryManagement/lib/models/target.js index 7ffed4f85a..f666425388 100644 --- a/lib/services/containerRegistryManagement/lib/models/target.js +++ b/lib/services/containerRegistryManagement/lib/models/target.js @@ -17,16 +17,16 @@ class Target { /** * Create a Target. - * @member {string} [mediaType] The MIME type of the referenced object. - * @member {number} [size] The number of bytes of the content. Same as Length - * field. - * @member {string} [digest] The digest of the content, as defined by the + * @property {string} [mediaType] The MIME type of the referenced object. + * @property {number} [size] The number of bytes of the content. Same as + * Length field. + * @property {string} [digest] The digest of the content, as defined by the * Registry V2 HTTP API Specification. - * @member {number} [length] The number of bytes of the content. Same as Size - * field. - * @member {string} [repository] The repository name. - * @member {string} [url] The direct URL to the content. - * @member {string} [tag] The tag name. + * @property {number} [length] The number of bytes of the content. Same as + * Size field. + * @property {string} [repository] The repository name. + * @property {string} [url] The direct URL to the content. + * @property {string} [tag] The tag name. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/task.js b/lib/services/containerRegistryManagement/lib/models/task.js index b1046d27bc..8e2af15744 100644 --- a/lib/services/containerRegistryManagement/lib/models/task.js +++ b/lib/services/containerRegistryManagement/lib/models/task.js @@ -14,52 +14,53 @@ const models = require('./index'); /** * The task that has the ARM resource and task properties. - * The task will have all information to schedule a run against it. + * The task will have all information to schedule a run against it. * * @extends models['Resource'] */ class Task extends models['Resource'] { /** * Create a Task. - * @member {string} [provisioningState] The provisioning state of the task. + * @property {string} [provisioningState] The provisioning state of the task. * Possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', * 'Failed', 'Canceled' - * @member {date} [creationDate] The creation date of task. - * @member {string} [status] The current status of task. Possible values + * @property {date} [creationDate] The creation date of task. + * @property {string} [status] The current status of task. Possible values * include: 'Disabled', 'Enabled' - * @member {object} platform The platform properties against which the run + * @property {object} platform The platform properties against which the run * has to happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible + * @property {string} [platform.os] The operating system type required for + * the run. Possible values include: 'Windows', 'Linux' + * @property {string} [platform.architecture] The OS architecture. Possible * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values + * @property {string} [platform.variant] Variant of the CPU. Possible values * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms + * @property {object} [agentConfiguration] The machine configuration of the + * run agent. + * @property {number} [agentConfiguration.cpu] The CPU configuration in terms * of number of cores required for the run. - * @member {number} [timeout] Run timeout in seconds. Default value: 3600 . - * @member {object} step The properties of a task step. - * @member {array} [step.baseImageDependencies] List of base image + * @property {number} [timeout] Run timeout in seconds. Default value: 3600 . + * @property {object} step The properties of a task step. + * @property {array} [step.baseImageDependencies] List of base image * dependencies for a step. - * @member {string} [step.contextPath] The URL(absolute or relative) of the + * @property {string} [step.contextPath] The URL(absolute or relative) of the * source context for the task step. - * @member {string} [step.contextAccessToken] The token (git PAT or SAS token - * of storage account blob) associated with the context for a step. - * @member {string} [step.type] Polymorphic Discriminator - * @member {object} [trigger] The properties that describe all triggers for + * @property {string} [step.contextAccessToken] The token (git PAT or SAS + * token of storage account blob) associated with the context for a step. + * @property {string} [step.type] Polymorphic Discriminator + * @property {object} [trigger] The properties that describe all triggers for * the task. - * @member {array} [trigger.sourceTriggers] The collection of triggers based - * on source code repository. - * @member {object} [trigger.baseImageTrigger] The trigger based on base + * @property {array} [trigger.sourceTriggers] The collection of triggers + * based on source code repository. + * @property {object} [trigger.baseImageTrigger] The trigger based on base * image dependencies. - * @member {string} [trigger.baseImageTrigger.baseImageTriggerType] The type - * of the auto trigger for base image dependency updates. Possible values - * include: 'All', 'Runtime' - * @member {string} [trigger.baseImageTrigger.status] The current status of + * @property {string} [trigger.baseImageTrigger.baseImageTriggerType] The + * type of the auto trigger for base image dependency updates. Possible + * values include: 'All', 'Runtime' + * @property {string} [trigger.baseImageTrigger.status] The current status of * trigger. Possible values include: 'Disabled', 'Enabled' - * @member {string} [trigger.baseImageTrigger.name] The name of the trigger. + * @property {string} [trigger.baseImageTrigger.name] The name of the + * trigger. */ constructor() { super(); diff --git a/lib/services/containerRegistryManagement/lib/models/taskListResult.js b/lib/services/containerRegistryManagement/lib/models/taskListResult.js index 3b5f4ac383..e05b2f2077 100644 --- a/lib/services/containerRegistryManagement/lib/models/taskListResult.js +++ b/lib/services/containerRegistryManagement/lib/models/taskListResult.js @@ -16,7 +16,7 @@ class TaskListResult extends Array { /** * Create a TaskListResult. - * @member {string} [nextLink] The URI that can be used to request the next + * @property {string} [nextLink] The URI that can be used to request the next * set of paged results. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/taskRunRequest.js b/lib/services/containerRegistryManagement/lib/models/taskRunRequest.js index 0d65fa1d5f..fcb72dd48c 100644 --- a/lib/services/containerRegistryManagement/lib/models/taskRunRequest.js +++ b/lib/services/containerRegistryManagement/lib/models/taskRunRequest.js @@ -20,10 +20,10 @@ const models = require('./index'); class TaskRunRequest extends models['RunRequest'] { /** * Create a TaskRunRequest. - * @member {string} taskName The name of task against which run has to be + * @property {string} taskName The name of task against which run has to be * queued. - * @member {array} [values] The collection of overridable values that can be - * passed when running a task. + * @property {array} [values] The collection of overridable values that can + * be passed when running a task. */ constructor() { super(); diff --git a/lib/services/containerRegistryManagement/lib/models/taskStepProperties.js b/lib/services/containerRegistryManagement/lib/models/taskStepProperties.js index 7b735a06db..86d6ce7151 100644 --- a/lib/services/containerRegistryManagement/lib/models/taskStepProperties.js +++ b/lib/services/containerRegistryManagement/lib/models/taskStepProperties.js @@ -17,13 +17,13 @@ class TaskStepProperties { /** * Create a TaskStepProperties. - * @member {array} [baseImageDependencies] List of base image dependencies + * @property {array} [baseImageDependencies] List of base image dependencies * for a step. - * @member {string} [contextPath] The URL(absolute or relative) of the source - * context for the task step. - * @member {string} [contextAccessToken] The token (git PAT or SAS token of + * @property {string} [contextPath] The URL(absolute or relative) of the + * source context for the task step. + * @property {string} [contextAccessToken] The token (git PAT or SAS token of * storage account blob) associated with the context for a step. - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/taskStepUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/taskStepUpdateParameters.js index 9f65840c63..eae77591ea 100644 --- a/lib/services/containerRegistryManagement/lib/models/taskStepUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/taskStepUpdateParameters.js @@ -17,11 +17,11 @@ class TaskStepUpdateParameters { /** * Create a TaskStepUpdateParameters. - * @member {string} [contextPath] The URL(absolute or relative) of the source - * context for the task step. - * @member {string} [contextAccessToken] The token (git PAT or SAS token of + * @property {string} [contextPath] The URL(absolute or relative) of the + * source context for the task step. + * @property {string} [contextAccessToken] The token (git PAT or SAS token of * storage account blob) associated with the context for a step. - * @member {string} type Polymorphic Discriminator + * @property {string} type Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/taskUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/taskUpdateParameters.js index ceca37cbb6..489b049d90 100644 --- a/lib/services/containerRegistryManagement/lib/models/taskUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/taskUpdateParameters.js @@ -17,39 +17,41 @@ class TaskUpdateParameters { /** * Create a TaskUpdateParameters. - * @member {string} [status] The current status of task. Possible values + * @property {string} [status] The current status of task. Possible values * include: 'Disabled', 'Enabled' - * @member {object} [platform] The platform properties against which the run - * has to happen. - * @member {string} [platform.os] The operating system type required for the - * run. Possible values include: 'Windows', 'Linux' - * @member {string} [platform.architecture] The OS architecture. Possible + * @property {object} [platform] The platform properties against which the + * run has to happen. + * @property {string} [platform.os] The operating system type required for + * the run. Possible values include: 'Windows', 'Linux' + * @property {string} [platform.architecture] The OS architecture. Possible * values include: 'amd64', 'x86', 'arm' - * @member {string} [platform.variant] Variant of the CPU. Possible values + * @property {string} [platform.variant] Variant of the CPU. Possible values * include: 'v6', 'v7', 'v8' - * @member {object} [agentConfiguration] The machine configuration of the run - * agent. - * @member {number} [agentConfiguration.cpu] The CPU configuration in terms + * @property {object} [agentConfiguration] The machine configuration of the + * run agent. + * @property {number} [agentConfiguration.cpu] The CPU configuration in terms * of number of cores required for the run. - * @member {number} [timeout] Run timeout in seconds. - * @member {object} [step] The properties for updating a task step. - * @member {string} [step.contextPath] The URL(absolute or relative) of the + * @property {number} [timeout] Run timeout in seconds. + * @property {object} [step] The properties for updating a task step. + * @property {string} [step.contextPath] The URL(absolute or relative) of the * source context for the task step. - * @member {string} [step.contextAccessToken] The token (git PAT or SAS token - * of storage account blob) associated with the context for a step. - * @member {string} [step.type] Polymorphic Discriminator - * @member {object} [trigger] The properties for updating trigger properties. - * @member {array} [trigger.sourceTriggers] The collection of triggers based - * on source code repository. - * @member {object} [trigger.baseImageTrigger] The trigger based on base + * @property {string} [step.contextAccessToken] The token (git PAT or SAS + * token of storage account blob) associated with the context for a step. + * @property {string} [step.type] Polymorphic Discriminator + * @property {object} [trigger] The properties for updating trigger + * properties. + * @property {array} [trigger.sourceTriggers] The collection of triggers + * based on source code repository. + * @property {object} [trigger.baseImageTrigger] The trigger based on base * image dependencies. - * @member {string} [trigger.baseImageTrigger.baseImageTriggerType] The type - * of the auto trigger for base image dependency updates. Possible values - * include: 'All', 'Runtime' - * @member {string} [trigger.baseImageTrigger.status] The current status of + * @property {string} [trigger.baseImageTrigger.baseImageTriggerType] The + * type of the auto trigger for base image dependency updates. Possible + * values include: 'All', 'Runtime' + * @property {string} [trigger.baseImageTrigger.status] The current status of * trigger. Possible values include: 'Disabled', 'Enabled' - * @member {string} [trigger.baseImageTrigger.name] The name of the trigger. - * @member {object} [tags] The ARM resource tags. + * @property {string} [trigger.baseImageTrigger.name] The name of the + * trigger. + * @property {object} [tags] The ARM resource tags. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/triggerProperties.js b/lib/services/containerRegistryManagement/lib/models/triggerProperties.js index 2753642f60..b7dd943a99 100644 --- a/lib/services/containerRegistryManagement/lib/models/triggerProperties.js +++ b/lib/services/containerRegistryManagement/lib/models/triggerProperties.js @@ -17,16 +17,16 @@ class TriggerProperties { /** * Create a TriggerProperties. - * @member {array} [sourceTriggers] The collection of triggers based on + * @property {array} [sourceTriggers] The collection of triggers based on * source code repository. - * @member {object} [baseImageTrigger] The trigger based on base image + * @property {object} [baseImageTrigger] The trigger based on base image * dependencies. - * @member {string} [baseImageTrigger.baseImageTriggerType] The type of the + * @property {string} [baseImageTrigger.baseImageTriggerType] The type of the * auto trigger for base image dependency updates. Possible values include: * 'All', 'Runtime' - * @member {string} [baseImageTrigger.status] The current status of trigger. - * Possible values include: 'Disabled', 'Enabled' - * @member {string} [baseImageTrigger.name] The name of the trigger. + * @property {string} [baseImageTrigger.status] The current status of + * trigger. Possible values include: 'Disabled', 'Enabled' + * @property {string} [baseImageTrigger.name] The name of the trigger. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/triggerUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/triggerUpdateParameters.js index f8d3b6e5b6..59a03ea3ac 100644 --- a/lib/services/containerRegistryManagement/lib/models/triggerUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/triggerUpdateParameters.js @@ -17,16 +17,16 @@ class TriggerUpdateParameters { /** * Create a TriggerUpdateParameters. - * @member {array} [sourceTriggers] The collection of triggers based on + * @property {array} [sourceTriggers] The collection of triggers based on * source code repository. - * @member {object} [baseImageTrigger] The trigger based on base image + * @property {object} [baseImageTrigger] The trigger based on base image * dependencies. - * @member {string} [baseImageTrigger.baseImageTriggerType] The type of the + * @property {string} [baseImageTrigger.baseImageTriggerType] The type of the * auto trigger for base image dependency updates. Possible values include: * 'All', 'Runtime' - * @member {string} [baseImageTrigger.status] The current status of trigger. - * Possible values include: 'Disabled', 'Enabled' - * @member {string} [baseImageTrigger.name] The name of the trigger. + * @property {string} [baseImageTrigger.status] The current status of + * trigger. Possible values include: 'Disabled', 'Enabled' + * @property {string} [baseImageTrigger.name] The name of the trigger. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/models/trustPolicy.js b/lib/services/containerRegistryManagement/lib/models/trustPolicy.js index ceeff24eab..9af6dca7b0 100644 --- a/lib/services/containerRegistryManagement/lib/models/trustPolicy.js +++ b/lib/services/containerRegistryManagement/lib/models/trustPolicy.js @@ -17,9 +17,9 @@ class TrustPolicy { /** * Create a TrustPolicy. - * @member {string} [type] The type of trust policy. Possible values include: - * 'Notary' - * @member {string} [status] The value that indicates whether the policy is + * @property {string} [type] The type of trust policy. Possible values + * include: 'Notary' + * @property {string} [status] The value that indicates whether the policy is * enabled or not. Possible values include: 'enabled', 'disabled' */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/virtualNetworkRule.js b/lib/services/containerRegistryManagement/lib/models/virtualNetworkRule.js new file mode 100644 index 0000000000..d3b25400f0 --- /dev/null +++ b/lib/services/containerRegistryManagement/lib/models/virtualNetworkRule.js @@ -0,0 +1,53 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The virtual network rule for a container registry. + * + */ +class VirtualNetworkRule { + /** + * Create a VirtualNetworkRule. + * @property {string} id Resource ID of a subnet, for example: + * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + */ + constructor() { + } + + /** + * Defines the metadata of VirtualNetworkRule + * + * @returns {object} metadata of VirtualNetworkRule + * + */ + mapper() { + return { + required: false, + serializedName: 'VirtualNetworkRule', + type: { + name: 'Composite', + className: 'VirtualNetworkRule', + modelProperties: { + id: { + required: true, + serializedName: 'id', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = VirtualNetworkRule; diff --git a/lib/services/containerRegistryManagement/lib/models/webhook.js b/lib/services/containerRegistryManagement/lib/models/webhook.js index c1b8c0801f..1d3a8dea2c 100644 --- a/lib/services/containerRegistryManagement/lib/models/webhook.js +++ b/lib/services/containerRegistryManagement/lib/models/webhook.js @@ -20,17 +20,17 @@ const models = require('./index'); class Webhook extends models['Resource'] { /** * Create a Webhook. - * @member {string} [status] The status of the webhook at the time the + * @property {string} [status] The status of the webhook at the time the * operation was called. Possible values include: 'enabled', 'disabled' - * @member {string} [scope] The scope of repositories where the event can be - * triggered. For example, 'foo:*' means events for all tags under repository - * 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to - * 'foo:latest'. Empty means all events. - * @member {array} actions The list of actions that trigger the webhook to + * @property {string} [scope] The scope of repositories where the event can + * be triggered. For example, 'foo:*' means events for all tags under + * repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is + * equivalent to 'foo:latest'. Empty means all events. + * @property {array} actions The list of actions that trigger the webhook to * post notifications. - * @member {string} [provisioningState] The provisioning state of the webhook - * at the time the operation was called. Possible values include: 'Creating', - * 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled' + * @property {string} [provisioningState] The provisioning state of the + * webhook at the time the operation was called. Possible values include: + * 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled' */ constructor() { super(); diff --git a/lib/services/containerRegistryManagement/lib/models/webhookCreateParameters.js b/lib/services/containerRegistryManagement/lib/models/webhookCreateParameters.js index 3e161be847..36ff466fa2 100644 --- a/lib/services/containerRegistryManagement/lib/models/webhookCreateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/webhookCreateParameters.js @@ -17,20 +17,20 @@ class WebhookCreateParameters { /** * Create a WebhookCreateParameters. - * @member {object} [tags] The tags for the webhook. - * @member {string} location The location of the webhook. This cannot be + * @property {object} [tags] The tags for the webhook. + * @property {string} location The location of the webhook. This cannot be * changed after the resource is created. - * @member {string} serviceUri The service URI for the webhook to post + * @property {string} serviceUri The service URI for the webhook to post * notifications. - * @member {object} [customHeaders] Custom headers that will be added to the - * webhook notifications. - * @member {string} [status] The status of the webhook at the time the + * @property {object} [customHeaders] Custom headers that will be added to + * the webhook notifications. + * @property {string} [status] The status of the webhook at the time the * operation was called. Possible values include: 'enabled', 'disabled' - * @member {string} [scope] The scope of repositories where the event can be - * triggered. For example, 'foo:*' means events for all tags under repository - * 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to - * 'foo:latest'. Empty means all events. - * @member {array} actions The list of actions that trigger the webhook to + * @property {string} [scope] The scope of repositories where the event can + * be triggered. For example, 'foo:*' means events for all tags under + * repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is + * equivalent to 'foo:latest'. Empty means all events. + * @property {array} actions The list of actions that trigger the webhook to * post notifications. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/webhookListResult.js b/lib/services/containerRegistryManagement/lib/models/webhookListResult.js index f45a5b9863..20e51d5c1e 100644 --- a/lib/services/containerRegistryManagement/lib/models/webhookListResult.js +++ b/lib/services/containerRegistryManagement/lib/models/webhookListResult.js @@ -16,7 +16,7 @@ class WebhookListResult extends Array { /** * Create a WebhookListResult. - * @member {string} [nextLink] The URI that can be used to request the next + * @property {string} [nextLink] The URI that can be used to request the next * list of webhooks. */ constructor() { diff --git a/lib/services/containerRegistryManagement/lib/models/webhookUpdateParameters.js b/lib/services/containerRegistryManagement/lib/models/webhookUpdateParameters.js index 577ae2a0b0..db47c6fae3 100644 --- a/lib/services/containerRegistryManagement/lib/models/webhookUpdateParameters.js +++ b/lib/services/containerRegistryManagement/lib/models/webhookUpdateParameters.js @@ -17,19 +17,19 @@ class WebhookUpdateParameters { /** * Create a WebhookUpdateParameters. - * @member {object} [tags] The tags for the webhook. - * @member {string} [serviceUri] The service URI for the webhook to post + * @property {object} [tags] The tags for the webhook. + * @property {string} [serviceUri] The service URI for the webhook to post * notifications. - * @member {object} [customHeaders] Custom headers that will be added to the - * webhook notifications. - * @member {string} [status] The status of the webhook at the time the + * @property {object} [customHeaders] Custom headers that will be added to + * the webhook notifications. + * @property {string} [status] The status of the webhook at the time the * operation was called. Possible values include: 'enabled', 'disabled' - * @member {string} [scope] The scope of repositories where the event can be - * triggered. For example, 'foo:*' means events for all tags under repository - * 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to - * 'foo:latest'. Empty means all events. - * @member {array} [actions] The list of actions that trigger the webhook to - * post notifications. + * @property {string} [scope] The scope of repositories where the event can + * be triggered. For example, 'foo:*' means events for all tags under + * repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is + * equivalent to 'foo:latest'. Empty means all events. + * @property {array} [actions] The list of actions that trigger the webhook + * to post notifications. */ constructor() { } diff --git a/lib/services/containerRegistryManagement/lib/operations/index.d.ts b/lib/services/containerRegistryManagement/lib/operations/index.d.ts index 199e1d387b..1decc4ffef 100644 --- a/lib/services/containerRegistryManagement/lib/operations/index.d.ts +++ b/lib/services/containerRegistryManagement/lib/operations/index.d.ts @@ -316,6 +316,16 @@ export interface Registries { * @param {string} registry.storageAccount.id The resource ID of the storage * account. * + * @param {object} [registry.networkRuleSet] The network rule set for a + * container registry. + * + * @param {string} registry.networkRuleSet.defaultAction The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * + * @param {array} [registry.networkRuleSet.virtualNetworkRules] The virtual + * network rules. + * * @param {string} registry.location The location of the resource. This cannot * be changed after the resource is created. * @@ -359,6 +369,16 @@ export interface Registries { * @param {string} registry.storageAccount.id The resource ID of the storage * account. * + * @param {object} [registry.networkRuleSet] The network rule set for a + * container registry. + * + * @param {string} registry.networkRuleSet.defaultAction The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * + * @param {array} [registry.networkRuleSet.virtualNetworkRules] The virtual + * network rules. + * * @param {string} registry.location The location of the resource. This cannot * be changed after the resource is created. * @@ -488,6 +508,16 @@ export interface Registries { * @param {string} registryUpdateParameters.storageAccount.id The resource ID * of the storage account. * + * @param {object} [registryUpdateParameters.networkRuleSet] The network rule + * set for a container registry. + * + * @param {string} registryUpdateParameters.networkRuleSet.defaultAction The + * default action of allow or deny when no other rules match. Possible values + * include: 'Allow', 'Deny' + * + * @param {array} [registryUpdateParameters.networkRuleSet.virtualNetworkRules] + * The virtual network rules. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -533,6 +563,16 @@ export interface Registries { * @param {string} registryUpdateParameters.storageAccount.id The resource ID * of the storage account. * + * @param {object} [registryUpdateParameters.networkRuleSet] The network rule + * set for a container registry. + * + * @param {string} registryUpdateParameters.networkRuleSet.defaultAction The + * default action of allow or deny when no other rules match. Possible values + * include: 'Allow', 'Deny' + * + * @param {array} [registryUpdateParameters.networkRuleSet.virtualNetworkRules] + * The virtual network rules. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -1343,6 +1383,16 @@ export interface Registries { * @param {string} registry.storageAccount.id The resource ID of the storage * account. * + * @param {object} [registry.networkRuleSet] The network rule set for a + * container registry. + * + * @param {string} registry.networkRuleSet.defaultAction The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * + * @param {array} [registry.networkRuleSet.virtualNetworkRules] The virtual + * network rules. + * * @param {string} registry.location The location of the resource. This cannot * be changed after the resource is created. * @@ -1386,6 +1436,16 @@ export interface Registries { * @param {string} registry.storageAccount.id The resource ID of the storage * account. * + * @param {object} [registry.networkRuleSet] The network rule set for a + * container registry. + * + * @param {string} registry.networkRuleSet.defaultAction The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * + * @param {array} [registry.networkRuleSet.virtualNetworkRules] The virtual + * network rules. + * * @param {string} registry.location The location of the resource. This cannot * be changed after the resource is created. * @@ -1515,6 +1575,16 @@ export interface Registries { * @param {string} registryUpdateParameters.storageAccount.id The resource ID * of the storage account. * + * @param {object} [registryUpdateParameters.networkRuleSet] The network rule + * set for a container registry. + * + * @param {string} registryUpdateParameters.networkRuleSet.defaultAction The + * default action of allow or deny when no other rules match. Possible values + * include: 'Allow', 'Deny' + * + * @param {array} [registryUpdateParameters.networkRuleSet.virtualNetworkRules] + * The virtual network rules. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -1560,6 +1630,16 @@ export interface Registries { * @param {string} registryUpdateParameters.storageAccount.id The resource ID * of the storage account. * + * @param {object} [registryUpdateParameters.networkRuleSet] The network rule + * set for a container registry. + * + * @param {string} registryUpdateParameters.networkRuleSet.defaultAction The + * default action of allow or deny when no other rules match. Possible values + * include: 'Allow', 'Deny' + * + * @param {array} [registryUpdateParameters.networkRuleSet.virtualNetworkRules] + * The virtual network rules. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the diff --git a/lib/services/containerRegistryManagement/lib/operations/registries.js b/lib/services/containerRegistryManagement/lib/operations/registries.js index 1bf3f83810..149d097a6e 100644 --- a/lib/services/containerRegistryManagement/lib/operations/registries.js +++ b/lib/services/containerRegistryManagement/lib/operations/registries.js @@ -324,6 +324,12 @@ function _get(resourceGroupName, registryName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -463,6 +469,16 @@ function _get(resourceGroupName, registryName, options, callback) { * @param {string} registry.storageAccount.id The resource ID of the storage * account. * + * @param {object} [registry.networkRuleSet] The network rule set for a + * container registry. + * + * @param {string} registry.networkRuleSet.defaultAction The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * + * @param {array} [registry.networkRuleSet.virtualNetworkRules] The virtual + * network rules. + * * @param {string} registry.location The location of the resource. This cannot * be changed after the resource is created. * @@ -635,6 +651,16 @@ function _deleteMethod(resourceGroupName, registryName, options, callback) { * @param {string} registryUpdateParameters.storageAccount.id The resource ID * of the storage account. * + * @param {object} [registryUpdateParameters.networkRuleSet] The network rule + * set for a container registry. + * + * @param {string} registryUpdateParameters.networkRuleSet.defaultAction The + * default action of allow or deny when no other rules match. Possible values + * include: 'Allow', 'Deny' + * + * @param {array} [registryUpdateParameters.networkRuleSet.virtualNetworkRules] + * The virtual network rules. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -748,6 +774,12 @@ function _listByResourceGroup(resourceGroupName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } 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.'); } @@ -1020,6 +1052,12 @@ function _listCredentials(resourceGroupName, registryName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1187,6 +1225,12 @@ function _regenerateCredential(resourceGroupName, registryName, regenerateCreden 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1363,6 +1407,12 @@ function _listUsages(resourceGroupName, registryName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1521,6 +1571,12 @@ function _listPolicies(resourceGroupName, registryName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1866,6 +1922,12 @@ function _getBuildSourceUploadUrl(resourceGroupName, registryName, options, call 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -2064,6 +2126,12 @@ function _beginImportImage(resourceGroupName, registryName, parameters, options, 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -2202,6 +2270,16 @@ function _beginImportImage(resourceGroupName, registryName, parameters, options, * @param {string} registry.storageAccount.id The resource ID of the storage * account. * + * @param {object} [registry.networkRuleSet] The network rule set for a + * container registry. + * + * @param {string} registry.networkRuleSet.defaultAction The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * + * @param {array} [registry.networkRuleSet.virtualNetworkRules] The virtual + * network rules. + * * @param {string} registry.location The location of the resource. This cannot * be changed after the resource is created. * @@ -2244,6 +2322,12 @@ function _beginCreate(resourceGroupName, registryName, registry, options, callba 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -2435,6 +2519,12 @@ function _beginDeleteMethod(resourceGroupName, registryName, options, callback) 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -2563,6 +2653,16 @@ function _beginDeleteMethod(resourceGroupName, registryName, options, callback) * @param {string} registryUpdateParameters.storageAccount.id The resource ID * of the storage account. * + * @param {object} [registryUpdateParameters.networkRuleSet] The network rule + * set for a container registry. + * + * @param {string} registryUpdateParameters.networkRuleSet.defaultAction The + * default action of allow or deny when no other rules match. Possible values + * include: 'Allow', 'Deny' + * + * @param {array} [registryUpdateParameters.networkRuleSet.virtualNetworkRules] + * The virtual network rules. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -2600,6 +2700,12 @@ function _beginUpdate(resourceGroupName, registryName, registryUpdateParameters, 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -2812,6 +2918,12 @@ function _beginUpdatePolicies(resourceGroupName, registryName, registryPoliciesU 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -2995,6 +3107,12 @@ function _beginScheduleRun(resourceGroupName, registryName, runRequest, options, 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -3788,6 +3906,16 @@ class Registries { * @param {string} registry.storageAccount.id The resource ID of the storage * account. * + * @param {object} [registry.networkRuleSet] The network rule set for a + * container registry. + * + * @param {string} registry.networkRuleSet.defaultAction The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * + * @param {array} [registry.networkRuleSet.virtualNetworkRules] The virtual + * network rules. + * * @param {string} registry.location The location of the resource. This cannot * be changed after the resource is created. * @@ -3843,6 +3971,16 @@ class Registries { * @param {string} registry.storageAccount.id The resource ID of the storage * account. * + * @param {object} [registry.networkRuleSet] The network rule set for a + * container registry. + * + * @param {string} registry.networkRuleSet.defaultAction The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * + * @param {array} [registry.networkRuleSet.virtualNetworkRules] The virtual + * network rules. + * * @param {string} registry.location The location of the resource. This cannot * be changed after the resource is created. * @@ -4014,6 +4152,16 @@ class Registries { * @param {string} registryUpdateParameters.storageAccount.id The resource ID * of the storage account. * + * @param {object} [registryUpdateParameters.networkRuleSet] The network rule + * set for a container registry. + * + * @param {string} registryUpdateParameters.networkRuleSet.defaultAction The + * default action of allow or deny when no other rules match. Possible values + * include: 'Allow', 'Deny' + * + * @param {array} [registryUpdateParameters.networkRuleSet.virtualNetworkRules] + * The virtual network rules. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -4071,6 +4219,16 @@ class Registries { * @param {string} registryUpdateParameters.storageAccount.id The resource ID * of the storage account. * + * @param {object} [registryUpdateParameters.networkRuleSet] The network rule + * set for a container registry. + * + * @param {string} registryUpdateParameters.networkRuleSet.defaultAction The + * default action of allow or deny when no other rules match. Possible values + * include: 'Allow', 'Deny' + * + * @param {array} [registryUpdateParameters.networkRuleSet.virtualNetworkRules] + * The virtual network rules. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -5166,6 +5324,16 @@ class Registries { * @param {string} registry.storageAccount.id The resource ID of the storage * account. * + * @param {object} [registry.networkRuleSet] The network rule set for a + * container registry. + * + * @param {string} registry.networkRuleSet.defaultAction The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * + * @param {array} [registry.networkRuleSet.virtualNetworkRules] The virtual + * network rules. + * * @param {string} registry.location The location of the resource. This cannot * be changed after the resource is created. * @@ -5221,6 +5389,16 @@ class Registries { * @param {string} registry.storageAccount.id The resource ID of the storage * account. * + * @param {object} [registry.networkRuleSet] The network rule set for a + * container registry. + * + * @param {string} registry.networkRuleSet.defaultAction The default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny' + * + * @param {array} [registry.networkRuleSet.virtualNetworkRules] The virtual + * network rules. + * * @param {string} registry.location The location of the resource. This cannot * be changed after the resource is created. * @@ -5392,6 +5570,16 @@ class Registries { * @param {string} registryUpdateParameters.storageAccount.id The resource ID * of the storage account. * + * @param {object} [registryUpdateParameters.networkRuleSet] The network rule + * set for a container registry. + * + * @param {string} registryUpdateParameters.networkRuleSet.defaultAction The + * default action of allow or deny when no other rules match. Possible values + * include: 'Allow', 'Deny' + * + * @param {array} [registryUpdateParameters.networkRuleSet.virtualNetworkRules] + * The virtual network rules. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -5449,6 +5637,16 @@ class Registries { * @param {string} registryUpdateParameters.storageAccount.id The resource ID * of the storage account. * + * @param {object} [registryUpdateParameters.networkRuleSet] The network rule + * set for a container registry. + * + * @param {string} registryUpdateParameters.networkRuleSet.defaultAction The + * default action of allow or deny when no other rules match. Possible values + * include: 'Allow', 'Deny' + * + * @param {array} [registryUpdateParameters.networkRuleSet.virtualNetworkRules] + * The virtual network rules. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the diff --git a/lib/services/containerRegistryManagement/lib/operations/replications.js b/lib/services/containerRegistryManagement/lib/operations/replications.js index 691f1b4b09..43b53cf6b2 100644 --- a/lib/services/containerRegistryManagement/lib/operations/replications.js +++ b/lib/services/containerRegistryManagement/lib/operations/replications.js @@ -61,6 +61,12 @@ function _get(resourceGroupName, registryName, replicationName, options, callbac 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -480,6 +486,12 @@ function _list(resourceGroupName, registryName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -648,6 +660,12 @@ function _beginCreate(resourceGroupName, registryName, replicationName, replicat 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -859,6 +877,12 @@ function _beginDeleteMethod(resourceGroupName, registryName, replicationName, op 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1027,6 +1051,12 @@ function _beginUpdate(resourceGroupName, registryName, replicationName, replicat 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } diff --git a/lib/services/containerRegistryManagement/lib/operations/runs.js b/lib/services/containerRegistryManagement/lib/operations/runs.js index 0175450ea5..a8ee5cf813 100644 --- a/lib/services/containerRegistryManagement/lib/operations/runs.js +++ b/lib/services/containerRegistryManagement/lib/operations/runs.js @@ -68,6 +68,12 @@ function _list(resourceGroupName, registryName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -240,6 +246,12 @@ function _get(resourceGroupName, registryName, runId, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -490,6 +502,12 @@ function _getLogSasUrl(resourceGroupName, registryName, runId, options, callback 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -725,6 +743,12 @@ function _beginUpdate(resourceGroupName, registryName, runId, runUpdateParameter 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -922,6 +946,12 @@ function _beginCancel(resourceGroupName, registryName, runId, options, callback) 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } diff --git a/lib/services/containerRegistryManagement/lib/operations/tasks.js b/lib/services/containerRegistryManagement/lib/operations/tasks.js index 8f98b6030e..96ec812f24 100644 --- a/lib/services/containerRegistryManagement/lib/operations/tasks.js +++ b/lib/services/containerRegistryManagement/lib/operations/tasks.js @@ -59,6 +59,12 @@ function _list(resourceGroupName, registryName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -219,6 +225,12 @@ function _get(resourceGroupName, registryName, taskName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -745,6 +757,12 @@ function _getDetails(resourceGroupName, registryName, taskName, options, callbac 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -984,6 +1002,12 @@ function _beginCreate(resourceGroupName, registryName, taskName, taskCreateParam 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1195,6 +1219,12 @@ function _beginDeleteMethod(resourceGroupName, registryName, taskName, options, 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1415,6 +1445,12 @@ function _beginUpdate(resourceGroupName, registryName, taskName, taskUpdateParam 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } diff --git a/lib/services/containerRegistryManagement/lib/operations/webhooks.js b/lib/services/containerRegistryManagement/lib/operations/webhooks.js index 1def15c336..da6d9e7c6a 100644 --- a/lib/services/containerRegistryManagement/lib/operations/webhooks.js +++ b/lib/services/containerRegistryManagement/lib/operations/webhooks.js @@ -61,6 +61,12 @@ function _get(resourceGroupName, registryName, webhookName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -514,6 +520,12 @@ function _list(resourceGroupName, registryName, options, callback) { 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -674,6 +686,12 @@ function _ping(resourceGroupName, registryName, webhookName, options, callback) 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -852,6 +870,12 @@ function _getCallbackConfig(resourceGroupName, registryName, webhookName, option 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1030,6 +1054,12 @@ function _listEvents(resourceGroupName, registryName, webhookName, options, call 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1234,6 +1264,12 @@ function _beginCreate(resourceGroupName, registryName, webhookName, webhookCreat 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1445,6 +1481,12 @@ function _beginDeleteMethod(resourceGroupName, registryName, webhookName, option 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } @@ -1629,6 +1671,12 @@ function _beginUpdate(resourceGroupName, registryName, webhookName, webhookUpdat 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 < 1) + { + throw new Error('"resourceGroupName" should satisfy the constraint - "MinLength": 1'); + } + } if (registryName === null || registryName === undefined || typeof registryName.valueOf() !== 'string') { throw new Error('registryName cannot be null or undefined and it must be of type string.'); } diff --git a/lib/services/containerRegistryManagement/package.json b/lib/services/containerRegistryManagement/package.json index d58352f46d..5a4fbf9af1 100644 --- a/lib/services/containerRegistryManagement/package.json +++ b/lib/services/containerRegistryManagement/package.json @@ -2,7 +2,7 @@ "name": "azure-arm-containerregistry", "author": "Microsoft Corporation", "description": "ContainerRegistryManagementClient Library with typescript type definitions for node", - "version": "4.2.0", + "version": "4.3.0", "dependencies": { "ms-rest": "^2.3.3", "ms-rest-azure": "^2.5.5" @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +} diff --git a/lib/services/dataLake.Store/README.md b/lib/services/dataLake.Store/README.md deleted file mode 100644 index c176700aa6..0000000000 --- a/lib/services/dataLake.Store/README.md +++ /dev/null @@ -1,115 +0,0 @@ -# Microsoft Azure SDK for Node.js - Data Lake Store - -This project provides a Node.js package that makes it easy to manage Azure Data Lake Store accounts. - -Right now it supports: - - * **Node.js version: 6.x.x or higher** - -## Features - -- Account management: create, get, list, update, and delete. -- File system management: create, get, upload, append, download, read, delete, list. - -## How to Install - -```bash -npm install azure-arm-datalake-store -``` - -## How to Use - -### Authentication, account and filesystem client creation and listing file status as an example - - ```javascript - var msRestAzure = require('ms-rest-azure'); - var adlsManagement = require("azure-arm-datalake-store"); - - // Interactive Login - // It provides a url and code that needs to be copied and pasted in a browser and authenticated over there. If successful, - // the user will get a DeviceTokenCredentials object. - msRestAzure.interactiveLogin(function(err, credentials) { - var accountName = 'testadlsacct'; - var pathToEnumerate = '/myfolder'; - var acccountClient = new adlsManagement.DataLakeStoreAccountClient(credentials, 'your-subscription-id'); - var filesystemClient = new adlsManagement.DataLakeStoreFileSystemClient(credentials, 'azuredatalakestore.net'); - filesystemClient.fileSystem.listFileStatus(accountName, pathToEnumerate, function(err, result, request, response) { - if (err) console.log(err); - console.log(result); - }); - }); - ``` - -### Create a Data Lake Store Account -```javascript -var util = require('util'); -var resourceGroupName = 'testrg'; -var accountName = 'testadlsacct'; -var location = 'eastus2'; - -// account object to create -var accountToCreate = { - tags: { - testtag1: 'testvalue1', - testtag2: 'testvalue2' - }, - location: location -}; - -client.account.create(resourceGroupName, accountName, accountToCreate, function (err, result, request, response) { - if (err) { - console.log(err); - /*err has reference to the actual request and response, so you can see what was sent and received on the wire. - The structure of err looks like this: - err: { - code: 'Error Code', - message: 'Error Message', - body: 'The response body if any', - request: reference to a stripped version of http request - response: reference to a stripped version of the response - } - */ - } else { - console.log('result is: ' + util.inspect(result, {depth: null})); - } -}); -``` - -### Create a file with content -```javascript -var util = require('util'); -var accountName = 'testadlsacct'; -var fileToCreate = '/myfolder/myfile.txt'; -var options = { - streamContents: new Buffer('some string content') -} - -filesystemClient.fileSystem.listFileStatus(accountName, fileToCreate, options, function (err, result, request, response) { - if (err) { - console.log(err); - } else { - // no result is returned, only a 201 response for success. - console.log('response is: ' + util.inspect(response, {depth: null})); - } -}); -``` - -### Get a list of files and folders - -```javascript -var util = require('util'); -var accountName = 'testadlsacct'; -var pathToEnumerate = '/myfolder'; -filesystemClient.fileSystem.listFileStatus(accountName, pathToEnumerate, function (err, result, request, response) { - if (err) { - console.log(err); - } else { - console.log('result is: ' + util.inspect(result, {depth: null})); - } -}); -``` - -## Related projects - -- [Microsoft Azure SDK for Node.js](https://github.com/azure/azure-sdk-for-node) -- [Microsoft Azure SDK for Node.js - Data Lake Analytics Management](https://github.com/Azure/azure-sdk-for-node/tree/autorest/lib/services/dataLake.Store) diff --git a/lib/services/dataLake.Store/lib/account/models/dataLakeStoreAccount.js b/lib/services/dataLake.Store/lib/account/models/dataLakeStoreAccount.js deleted file mode 100644 index cac3fd0983..0000000000 --- a/lib/services/dataLake.Store/lib/account/models/dataLakeStoreAccount.js +++ /dev/null @@ -1,346 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * Data Lake Store account information. - * - * @extends models['Resource'] - */ -class DataLakeStoreAccount extends models['Resource'] { - /** - * Create a DataLakeStoreAccount. - * @property {object} [identity] The Key Vault encryption identity, if any. - * @property {uuid} [identity.principalId] The principal identifier - * associated with the encryption. - * @property {uuid} [identity.tenantId] The tenant identifier associated with - * the encryption. - * @property {uuid} [accountId] The unique identifier associated with this - * Data Lake Store account. - * @property {string} [provisioningState] The provisioning status of the Data - * Lake Store account. Possible values include: 'Failed', 'Creating', - * 'Running', 'Succeeded', 'Patching', 'Suspending', 'Resuming', 'Deleting', - * 'Deleted', 'Undeleting', 'Canceled' - * @property {string} [state] The state of the Data Lake Store account. - * Possible values include: 'Active', 'Suspended' - * @property {date} [creationTime] The account creation time. - * @property {date} [lastModifiedTime] The account last modified time. - * @property {string} [endpoint] The full CName endpoint for this account. - * @property {string} [defaultGroup] The default owner group for all new - * folders and files created in the Data Lake Store account. - * @property {object} [encryptionConfig] The Key Vault encryption - * configuration. - * @property {string} [encryptionConfig.type] The type of encryption - * configuration being used. Currently the only supported types are - * 'UserManaged' and 'ServiceManaged'. Possible values include: - * 'UserManaged', 'ServiceManaged' - * @property {object} [encryptionConfig.keyVaultMetaInfo] The Key Vault - * information for connecting to user managed encryption keys. - * @property {string} [encryptionConfig.keyVaultMetaInfo.keyVaultResourceId] - * The resource identifier for the user managed Key Vault being used to - * encrypt. - * @property {string} [encryptionConfig.keyVaultMetaInfo.encryptionKeyName] - * The name of the user managed encryption key. - * @property {string} - * [encryptionConfig.keyVaultMetaInfo.encryptionKeyVersion] The version of - * the user managed encryption key. - * @property {string} [encryptionState] The current state of encryption for - * this Data Lake Store account. Possible values include: 'Enabled', - * 'Disabled' - * @property {string} [encryptionProvisioningState] The current state of - * encryption provisioning for this Data Lake Store account. Possible values - * include: 'Creating', 'Succeeded' - * @property {array} [firewallRules] The list of firewall rules associated - * with this Data Lake Store account. - * @property {array} [virtualNetworkRules] The list of virtual network rules - * associated with this Data Lake Store account. - * @property {string} [firewallState] The current state of the IP address - * firewall for this Data Lake Store account. Possible values include: - * 'Enabled', 'Disabled' - * @property {string} [firewallAllowAzureIps] The current state of allowing - * or disallowing IPs originating within Azure through the firewall. If the - * firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - * @property {array} [trustedIdProviders] The list of trusted identity - * providers associated with this Data Lake Store account. - * @property {string} [trustedIdProviderState] The current state of the - * trusted identity provider feature for this Data Lake Store account. - * Possible values include: 'Enabled', 'Disabled' - * @property {string} [newTier] The commitment tier to use for next month. - * Possible values include: 'Consumption', 'Commitment_1TB', - * 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', - * 'Commitment_1PB', 'Commitment_5PB' - * @property {string} [currentTier] The commitment tier in use for the - * current month. Possible values include: 'Consumption', 'Commitment_1TB', - * 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', - * 'Commitment_1PB', 'Commitment_5PB' - */ - constructor() { - super(); - } - - /** - * Defines the metadata of DataLakeStoreAccount - * - * @returns {object} metadata of DataLakeStoreAccount - * - */ - mapper() { - return { - required: false, - serializedName: 'DataLakeStoreAccount', - type: { - name: 'Composite', - className: 'DataLakeStoreAccount', - modelProperties: { - id: { - required: false, - readOnly: true, - serializedName: 'id', - type: { - name: 'String' - } - }, - name: { - required: false, - readOnly: true, - serializedName: 'name', - type: { - name: 'String' - } - }, - type: { - required: false, - readOnly: true, - serializedName: 'type', - type: { - name: 'String' - } - }, - location: { - required: false, - readOnly: true, - serializedName: 'location', - type: { - name: 'String' - } - }, - tags: { - required: false, - readOnly: true, - serializedName: 'tags', - type: { - name: 'Dictionary', - value: { - required: false, - serializedName: 'StringElementType', - type: { - name: 'String' - } - } - } - }, - identity: { - required: false, - readOnly: true, - serializedName: 'identity', - type: { - name: 'Composite', - className: 'EncryptionIdentity' - } - }, - accountId: { - required: false, - readOnly: true, - serializedName: 'properties.accountId', - type: { - name: 'String' - } - }, - provisioningState: { - required: false, - readOnly: true, - serializedName: 'properties.provisioningState', - type: { - name: 'Enum', - allowedValues: [ 'Failed', 'Creating', 'Running', 'Succeeded', 'Patching', 'Suspending', 'Resuming', 'Deleting', 'Deleted', 'Undeleting', 'Canceled' ] - } - }, - state: { - required: false, - readOnly: true, - serializedName: 'properties.state', - type: { - name: 'Enum', - allowedValues: [ 'Active', 'Suspended' ] - } - }, - creationTime: { - required: false, - readOnly: true, - serializedName: 'properties.creationTime', - type: { - name: 'DateTime' - } - }, - lastModifiedTime: { - required: false, - readOnly: true, - serializedName: 'properties.lastModifiedTime', - type: { - name: 'DateTime' - } - }, - endpoint: { - required: false, - readOnly: true, - serializedName: 'properties.endpoint', - type: { - name: 'String' - } - }, - defaultGroup: { - required: false, - readOnly: true, - serializedName: 'properties.defaultGroup', - type: { - name: 'String' - } - }, - encryptionConfig: { - required: false, - readOnly: true, - serializedName: 'properties.encryptionConfig', - type: { - name: 'Composite', - className: 'EncryptionConfig' - } - }, - encryptionState: { - required: false, - readOnly: true, - serializedName: 'properties.encryptionState', - type: { - name: 'Enum', - allowedValues: [ 'Enabled', 'Disabled' ] - } - }, - encryptionProvisioningState: { - required: false, - readOnly: true, - serializedName: 'properties.encryptionProvisioningState', - type: { - name: 'Enum', - allowedValues: [ 'Creating', 'Succeeded' ] - } - }, - firewallRules: { - required: false, - readOnly: true, - serializedName: 'properties.firewallRules', - type: { - name: 'Sequence', - element: { - required: false, - serializedName: 'FirewallRuleElementType', - type: { - name: 'Composite', - className: 'FirewallRule' - } - } - } - }, - virtualNetworkRules: { - required: false, - readOnly: true, - serializedName: 'properties.virtualNetworkRules', - type: { - name: 'Sequence', - element: { - required: false, - serializedName: 'VirtualNetworkRuleElementType', - type: { - name: 'Composite', - className: 'VirtualNetworkRule' - } - } - } - }, - firewallState: { - required: false, - readOnly: true, - serializedName: 'properties.firewallState', - type: { - name: 'Enum', - allowedValues: [ 'Enabled', 'Disabled' ] - } - }, - firewallAllowAzureIps: { - required: false, - readOnly: true, - serializedName: 'properties.firewallAllowAzureIps', - type: { - name: 'Enum', - allowedValues: [ 'Enabled', 'Disabled' ] - } - }, - trustedIdProviders: { - required: false, - readOnly: true, - serializedName: 'properties.trustedIdProviders', - type: { - name: 'Sequence', - element: { - required: false, - serializedName: 'TrustedIdProviderElementType', - type: { - name: 'Composite', - className: 'TrustedIdProvider' - } - } - } - }, - trustedIdProviderState: { - required: false, - readOnly: true, - serializedName: 'properties.trustedIdProviderState', - type: { - name: 'Enum', - allowedValues: [ 'Enabled', 'Disabled' ] - } - }, - newTier: { - required: false, - readOnly: true, - serializedName: 'properties.newTier', - type: { - name: 'Enum', - allowedValues: [ 'Consumption', 'Commitment_1TB', 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', 'Commitment_5PB' ] - } - }, - currentTier: { - required: false, - readOnly: true, - serializedName: 'properties.currentTier', - type: { - name: 'Enum', - allowedValues: [ 'Consumption', 'Commitment_1TB', 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', 'Commitment_5PB' ] - } - } - } - } - }; - } -} - -module.exports = DataLakeStoreAccount; diff --git a/lib/services/dataLake.Store/lib/account/models/encryptionConfig.js b/lib/services/dataLake.Store/lib/account/models/encryptionConfig.js deleted file mode 100644 index 5c853d8d45..0000000000 --- a/lib/services/dataLake.Store/lib/account/models/encryptionConfig.js +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -/** - * The encryption configuration for the account. - * - */ -class EncryptionConfig { - /** - * Create a EncryptionConfig. - * @property {string} type The type of encryption configuration being used. - * Currently the only supported types are 'UserManaged' and 'ServiceManaged'. - * Possible values include: 'UserManaged', 'ServiceManaged' - * @property {object} [keyVaultMetaInfo] The Key Vault information for - * connecting to user managed encryption keys. - * @property {string} [keyVaultMetaInfo.keyVaultResourceId] The resource - * identifier for the user managed Key Vault being used to encrypt. - * @property {string} [keyVaultMetaInfo.encryptionKeyName] The name of the - * user managed encryption key. - * @property {string} [keyVaultMetaInfo.encryptionKeyVersion] The version of - * the user managed encryption key. - */ - constructor() { - } - - /** - * Defines the metadata of EncryptionConfig - * - * @returns {object} metadata of EncryptionConfig - * - */ - mapper() { - return { - required: false, - serializedName: 'EncryptionConfig', - type: { - name: 'Composite', - className: 'EncryptionConfig', - modelProperties: { - type: { - required: true, - serializedName: 'type', - type: { - name: 'Enum', - allowedValues: [ 'UserManaged', 'ServiceManaged' ] - } - }, - keyVaultMetaInfo: { - required: false, - serializedName: 'keyVaultMetaInfo', - type: { - name: 'Composite', - className: 'KeyVaultMetaInfo' - } - } - } - } - }; - } -} - -module.exports = EncryptionConfig; diff --git a/lib/services/dataLake.Store/lib/account/models/index.d.ts b/lib/services/dataLake.Store/lib/account/models/index.d.ts deleted file mode 100644 index b843bfd5b5..0000000000 --- a/lib/services/dataLake.Store/lib/account/models/index.d.ts +++ /dev/null @@ -1,730 +0,0 @@ -/* - * 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. - */ - -import { BaseResource, CloudError } from "ms-rest-azure"; -import * as moment from "moment"; - -export { - - BaseResource, - CloudError -}; - -/** - * The resource model definition. - */ -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. - */ - readonly location?: string; - /** - * The resource tags. - */ - readonly tags?: { [propertyName: string]: string }; -} - -/** - * The resource model definition for a nested resource. - */ -export interface SubResource extends BaseResource { - /** - * The resource identifier. - */ - readonly id?: string; - /** - * The resource name. - */ - readonly name?: string; - /** - * The resource type. - */ - readonly type?: string; -} - -/** - * The encryption identity properties. - */ -export interface EncryptionIdentity { - /** - * The principal identifier associated with the encryption. - */ - readonly principalId?: string; - /** - * The tenant identifier associated with the encryption. - */ - readonly tenantId?: string; -} - -/** - * Metadata information used by account encryption. - */ -export interface KeyVaultMetaInfo { - /** - * The resource identifier for the user managed Key Vault being used to encrypt. - */ - keyVaultResourceId: string; - /** - * The name of the user managed encryption key. - */ - encryptionKeyName: string; - /** - * The version of the user managed encryption key. - */ - encryptionKeyVersion: string; -} - -/** - * The encryption configuration for the account. - */ -export interface EncryptionConfig { - /** - * The type of encryption configuration being used. Currently the only supported types are - * 'UserManaged' and 'ServiceManaged'. Possible values include: 'UserManaged', 'ServiceManaged' - */ - type: string; - /** - * The Key Vault information for connecting to user managed encryption keys. - */ - keyVaultMetaInfo?: KeyVaultMetaInfo; -} - -/** - * Data Lake Store firewall rule information. - */ -export interface FirewallRule extends SubResource { - /** - * The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End - * should be in the same protocol. - */ - readonly startIpAddress?: string; - /** - * The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End - * should be in the same protocol. - */ - readonly endIpAddress?: string; -} - -/** - * Data Lake Store virtual network rule information. - */ -export interface VirtualNetworkRule extends SubResource { - /** - * The resource identifier for the subnet. - */ - readonly subnetId?: string; -} - -/** - * Data Lake Store trusted identity provider information. - */ -export interface TrustedIdProvider extends SubResource { - /** - * The URL of this trusted identity provider. - */ - readonly idProvider?: string; -} - -/** - * Data Lake Store account information. - */ -export interface DataLakeStoreAccount extends Resource { - /** - * The Key Vault encryption identity, if any. - */ - readonly identity?: EncryptionIdentity; - /** - * The unique identifier associated with this Data Lake Store account. - */ - readonly accountId?: string; - /** - * The provisioning status of the Data Lake Store account. Possible values include: 'Failed', - * 'Creating', 'Running', 'Succeeded', 'Patching', 'Suspending', 'Resuming', 'Deleting', - * 'Deleted', 'Undeleting', 'Canceled' - */ - readonly provisioningState?: string; - /** - * The state of the Data Lake Store account. Possible values include: 'Active', 'Suspended' - */ - readonly state?: string; - /** - * The account creation time. - */ - readonly creationTime?: Date; - /** - * The account last modified time. - */ - readonly lastModifiedTime?: Date; - /** - * The full CName endpoint for this account. - */ - readonly endpoint?: string; - /** - * The default owner group for all new folders and files created in the Data Lake Store account. - */ - readonly defaultGroup?: string; - /** - * The Key Vault encryption configuration. - */ - readonly encryptionConfig?: EncryptionConfig; - /** - * The current state of encryption for this Data Lake Store account. Possible values include: - * 'Enabled', 'Disabled' - */ - readonly encryptionState?: string; - /** - * The current state of encryption provisioning for this Data Lake Store account. Possible values - * include: 'Creating', 'Succeeded' - */ - readonly encryptionProvisioningState?: string; - /** - * The list of firewall rules associated with this Data Lake Store account. - */ - readonly firewallRules?: FirewallRule[]; - /** - * The list of virtual network rules associated with this Data Lake Store account. - */ - readonly virtualNetworkRules?: VirtualNetworkRule[]; - /** - * The current state of the IP address firewall for this Data Lake Store account. Possible values - * include: 'Enabled', 'Disabled' - */ - readonly firewallState?: string; - /** - * The current state of allowing or disallowing IPs originating within Azure through the - * firewall. If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - */ - readonly firewallAllowAzureIps?: string; - /** - * The list of trusted identity providers associated with this Data Lake Store account. - */ - readonly trustedIdProviders?: TrustedIdProvider[]; - /** - * The current state of the trusted identity provider feature for this Data Lake Store account. - * Possible values include: 'Enabled', 'Disabled' - */ - readonly trustedIdProviderState?: string; - /** - * The commitment tier to use for next month. Possible values include: 'Consumption', - * 'Commitment_1TB', 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - */ - readonly newTier?: string; - /** - * The commitment tier in use for the current month. Possible values include: 'Consumption', - * 'Commitment_1TB', 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - */ - readonly currentTier?: string; -} - -/** - * Basic Data Lake Store account information, returned on list calls. - */ -export interface DataLakeStoreAccountBasic extends Resource { - /** - * The unique identifier associated with this Data Lake Store account. - */ - readonly accountId?: string; - /** - * The provisioning status of the Data Lake Store account. Possible values include: 'Failed', - * 'Creating', 'Running', 'Succeeded', 'Patching', 'Suspending', 'Resuming', 'Deleting', - * 'Deleted', 'Undeleting', 'Canceled' - */ - readonly provisioningState?: string; - /** - * The state of the Data Lake Store account. Possible values include: 'Active', 'Suspended' - */ - readonly state?: string; - /** - * The account creation time. - */ - readonly creationTime?: Date; - /** - * The account last modified time. - */ - readonly lastModifiedTime?: Date; - /** - * The full CName endpoint for this account. - */ - readonly endpoint?: string; -} - -/** - * The display information for a particular operation. - */ -export interface OperationDisplay { - /** - * The resource provider of the operation. - */ - readonly provider?: string; - /** - * The resource type of the operation. - */ - readonly resource?: string; - /** - * A friendly name of the operation. - */ - readonly operation?: string; - /** - * A friendly description of the operation. - */ - readonly description?: string; -} - -/** - * An available operation for Data Lake Store. - */ -export interface Operation { - /** - * The name of the operation. - */ - readonly name?: string; - /** - * The display information for the operation. - */ - display?: OperationDisplay; - /** - * The intended executor of the operation. Possible values include: 'user', 'system', - * 'user,system' - */ - readonly origin?: string; -} - -/** - * The list of available operations for Data Lake Store. - */ -export interface OperationListResult { - /** - * The results of the list operation. - */ - readonly value?: Operation[]; - /** - * The link (url) to the next page of results. - */ - readonly nextLink?: string; -} - -/** - * Subscription-level properties and limits for Data Lake Store. - */ -export interface CapabilityInformation { - /** - * The subscription credentials that uniquely identifies the subscription. - */ - readonly subscriptionId?: string; - /** - * The subscription state. Possible values include: 'Registered', 'Suspended', 'Deleted', - * 'Unregistered', 'Warned' - */ - readonly state?: string; - /** - * The maximum supported number of accounts under this subscription. - */ - readonly maxAccountCount?: number; - /** - * The current number of accounts under this subscription. - */ - readonly accountCount?: number; - /** - * The Boolean value of true or false to indicate the maintenance state. - */ - readonly migrationState?: boolean; -} - -/** - * Data Lake Store account name availability result information. - */ -export interface NameAvailabilityInformation { - /** - * The Boolean value of true or false to indicate whether the Data Lake Store account name is - * available or not. - */ - readonly nameAvailable?: boolean; - /** - * The reason why the Data Lake Store account name is not available, if nameAvailable is false. - */ - readonly reason?: string; - /** - * The message describing why the Data Lake Store account name is not available, if nameAvailable - * is false. - */ - readonly message?: string; -} - -/** - * The parameters used to create a new firewall rule while creating a new Data Lake Store account. - */ -export interface CreateFirewallRuleWithAccountParameters { - /** - * The unique name of the firewall rule to create. - */ - name: string; - /** - * The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End - * should be in the same protocol. - */ - startIpAddress: string; - /** - * The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End - * should be in the same protocol. - */ - endIpAddress: string; -} - -/** - * The parameters used to create a new virtual network rule while creating a new Data Lake Store - * account. - */ -export interface CreateVirtualNetworkRuleWithAccountParameters { - /** - * The unique name of the virtual network rule to create. - */ - name: string; - /** - * The resource identifier for the subnet. - */ - subnetId: string; -} - -/** - * The parameters used to create a new trusted identity provider while creating a new Data Lake - * Store account. - */ -export interface CreateTrustedIdProviderWithAccountParameters { - /** - * The unique name of the trusted identity provider to create. - */ - name: string; - /** - * The URL of this trusted identity provider. - */ - idProvider: string; -} - -export interface CreateDataLakeStoreAccountParameters { - /** - * The resource location. - */ - location: string; - /** - * The resource tags. - */ - tags?: { [propertyName: string]: string }; - /** - * The Key Vault encryption identity, if any. - */ - identity?: EncryptionIdentity; - /** - * The default owner group for all new folders and files created in the Data Lake Store account. - */ - defaultGroup?: string; - /** - * The Key Vault encryption configuration. - */ - encryptionConfig?: EncryptionConfig; - /** - * The current state of encryption for this Data Lake Store account. Possible values include: - * 'Enabled', 'Disabled' - */ - encryptionState?: string; - /** - * The list of firewall rules associated with this Data Lake Store account. - */ - firewallRules?: CreateFirewallRuleWithAccountParameters[]; - /** - * The list of virtual network rules associated with this Data Lake Store account. - */ - virtualNetworkRules?: CreateVirtualNetworkRuleWithAccountParameters[]; - /** - * The current state of the IP address firewall for this Data Lake Store account. Possible values - * include: 'Enabled', 'Disabled' - */ - firewallState?: string; - /** - * The current state of allowing or disallowing IPs originating within Azure through the - * firewall. If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - */ - firewallAllowAzureIps?: string; - /** - * The list of trusted identity providers associated with this Data Lake Store account. - */ - trustedIdProviders?: CreateTrustedIdProviderWithAccountParameters[]; - /** - * The current state of the trusted identity provider feature for this Data Lake Store account. - * Possible values include: 'Enabled', 'Disabled' - */ - trustedIdProviderState?: string; - /** - * The commitment tier to use for next month. Possible values include: 'Consumption', - * 'Commitment_1TB', 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - */ - newTier?: string; -} - -/** - * The Key Vault update information used for user managed key rotation. -*/ -export interface UpdateKeyVaultMetaInfo { - /** - * The version of the user managed encryption key to update through a key rotation. - */ - encryptionKeyVersion?: string; -} - -/** - * The encryption configuration used to update a user managed Key Vault key. -*/ -export interface UpdateEncryptionConfig { - /** - * The updated Key Vault key to use in user managed key rotation. - */ - keyVaultMetaInfo?: UpdateKeyVaultMetaInfo; -} - -/** - * The parameters used to update a firewall rule while updating a Data Lake Store account. -*/ -export interface UpdateFirewallRuleWithAccountParameters { - /** - * The unique name of the firewall rule to update. - */ - name: string; - /** - * The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End - * should be in the same protocol. - */ - startIpAddress?: string; - /** - * The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End - * should be in the same protocol. - */ - endIpAddress?: string; -} - -/** - * The parameters used to update a virtual network rule while updating a Data Lake Store account. -*/ -export interface UpdateVirtualNetworkRuleWithAccountParameters { - /** - * The unique name of the virtual network rule to update. - */ - name: string; - /** - * The resource identifier for the subnet. - */ - subnetId?: string; -} - -/** - * The parameters used to update a trusted identity provider while updating a Data Lake Store - * account. -*/ -export interface UpdateTrustedIdProviderWithAccountParameters { - /** - * The unique name of the trusted identity provider to update. - */ - name: string; - /** - * The URL of this trusted identity provider. - */ - idProvider?: string; -} - -/** - * Data Lake Store account information to update. -*/ -export interface UpdateDataLakeStoreAccountParameters { - /** - * Resource tags - */ - tags?: { [propertyName: string]: string }; - /** - * The default owner group for all new folders and files created in the Data Lake Store account. - */ - defaultGroup?: string; - /** - * Used for rotation of user managed Key Vault keys. Can only be used to rotate a user managed - * encryption Key Vault key. - */ - encryptionConfig?: UpdateEncryptionConfig; - /** - * The list of firewall rules associated with this Data Lake Store account. - */ - firewallRules?: UpdateFirewallRuleWithAccountParameters[]; - /** - * The list of virtual network rules associated with this Data Lake Store account. - */ - virtualNetworkRules?: UpdateVirtualNetworkRuleWithAccountParameters[]; - /** - * The current state of the IP address firewall for this Data Lake Store account. Disabling the - * firewall does not remove existing rules, they will just be ignored until the firewall is - * re-enabled. Possible values include: 'Enabled', 'Disabled' - */ - firewallState?: string; - /** - * The current state of allowing or disallowing IPs originating within Azure through the - * firewall. If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - */ - firewallAllowAzureIps?: string; - /** - * The list of trusted identity providers associated with this Data Lake Store account. - */ - trustedIdProviders?: UpdateTrustedIdProviderWithAccountParameters[]; - /** - * The current state of the trusted identity provider feature for this Data Lake Store account. - * Disabling trusted identity provider functionality does not remove the providers, they will - * just be ignored until this feature is re-enabled. Possible values include: 'Enabled', - * 'Disabled' - */ - trustedIdProviderState?: string; - /** - * The commitment tier to use for next month. Possible values include: 'Consumption', - * 'Commitment_1TB', 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - */ - newTier?: string; -} - -/** - * The parameters used to create a new firewall rule. -*/ -export interface CreateOrUpdateFirewallRuleParameters { - /** - * The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End - * should be in the same protocol. - */ - startIpAddress: string; - /** - * The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End - * should be in the same protocol. - */ - endIpAddress: string; -} - -/** - * The parameters used to update a firewall rule. -*/ -export interface UpdateFirewallRuleParameters { - /** - * The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End - * should be in the same protocol. - */ - startIpAddress?: string; - /** - * The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End - * should be in the same protocol. - */ - endIpAddress?: string; -} - -/** - * The parameters used to create a new virtual network rule. -*/ -export interface CreateOrUpdateVirtualNetworkRuleParameters { - /** - * The resource identifier for the subnet. - */ - subnetId: string; -} - -/** - * The parameters used to update a virtual network rule. -*/ -export interface UpdateVirtualNetworkRuleParameters { - /** - * The resource identifier for the subnet. - */ - subnetId?: string; -} - -/** - * The parameters used to create a new trusted identity provider. -*/ -export interface CreateOrUpdateTrustedIdProviderParameters { - /** - * The URL of this trusted identity provider. - */ - idProvider: string; -} - -/** - * The parameters used to update a trusted identity provider. -*/ -export interface UpdateTrustedIdProviderParameters { - /** - * The URL of this trusted identity provider. - */ - idProvider?: string; -} - -/** - * Data Lake Store account name availability check parameters. -*/ -export interface CheckNameAvailabilityParameters { - /** - * The Data Lake Store name to check availability for. - */ - name: string; -} - -/** - * Data Lake Store account list information response. -*/ -export interface DataLakeStoreAccountListResult extends Array { - /** - * The link (url) to the next page of results. - */ - readonly nextLink?: string; -} - -/** - * Data Lake Store firewall rule list information. -*/ -export interface FirewallRuleListResult extends Array { - /** - * The link (url) to the next page of results. - */ - readonly nextLink?: string; -} - -/** - * Data Lake Store virtual network rule list information. -*/ -export interface VirtualNetworkRuleListResult extends Array { - /** - * The link (url) to the next page of results. - */ - readonly nextLink?: string; -} - -/** - * Data Lake Store trusted identity provider list information. -*/ -export interface TrustedIdProviderListResult extends Array { - /** - * The link (url) to the next page of results. - */ - readonly nextLink?: string; -} diff --git a/lib/services/dataLake.Store/lib/account/models/index.js b/lib/services/dataLake.Store/lib/account/models/index.js deleted file mode 100644 index 41fe88ad1d..0000000000 --- a/lib/services/dataLake.Store/lib/account/models/index.js +++ /dev/null @@ -1,56 +0,0 @@ -/* - * 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. - */ - -/* jshint latedef:false */ -/* jshint forin:false */ -/* jshint noempty:false */ - -'use strict'; - -var msRestAzure = require('ms-rest-azure'); - -exports.BaseResource = msRestAzure.BaseResource; -exports.CloudError = msRestAzure.CloudError; -exports.Resource = require('./resource'); -exports.SubResource = require('./subResource'); -exports.EncryptionIdentity = require('./encryptionIdentity'); -exports.KeyVaultMetaInfo = require('./keyVaultMetaInfo'); -exports.EncryptionConfig = require('./encryptionConfig'); -exports.FirewallRule = require('./firewallRule'); -exports.VirtualNetworkRule = require('./virtualNetworkRule'); -exports.TrustedIdProvider = require('./trustedIdProvider'); -exports.DataLakeStoreAccount = require('./dataLakeStoreAccount'); -exports.DataLakeStoreAccountBasic = require('./dataLakeStoreAccountBasic'); -exports.OperationDisplay = require('./operationDisplay'); -exports.Operation = require('./operation'); -exports.OperationListResult = require('./operationListResult'); -exports.CapabilityInformation = require('./capabilityInformation'); -exports.NameAvailabilityInformation = require('./nameAvailabilityInformation'); -exports.CreateFirewallRuleWithAccountParameters = require('./createFirewallRuleWithAccountParameters'); -exports.CreateVirtualNetworkRuleWithAccountParameters = require('./createVirtualNetworkRuleWithAccountParameters'); -exports.CreateTrustedIdProviderWithAccountParameters = require('./createTrustedIdProviderWithAccountParameters'); -exports.CreateDataLakeStoreAccountParameters = require('./createDataLakeStoreAccountParameters'); -exports.UpdateKeyVaultMetaInfo = require('./updateKeyVaultMetaInfo'); -exports.UpdateEncryptionConfig = require('./updateEncryptionConfig'); -exports.UpdateFirewallRuleWithAccountParameters = require('./updateFirewallRuleWithAccountParameters'); -exports.UpdateVirtualNetworkRuleWithAccountParameters = require('./updateVirtualNetworkRuleWithAccountParameters'); -exports.UpdateTrustedIdProviderWithAccountParameters = require('./updateTrustedIdProviderWithAccountParameters'); -exports.UpdateDataLakeStoreAccountParameters = require('./updateDataLakeStoreAccountParameters'); -exports.CreateOrUpdateFirewallRuleParameters = require('./createOrUpdateFirewallRuleParameters'); -exports.UpdateFirewallRuleParameters = require('./updateFirewallRuleParameters'); -exports.CreateOrUpdateVirtualNetworkRuleParameters = require('./createOrUpdateVirtualNetworkRuleParameters'); -exports.UpdateVirtualNetworkRuleParameters = require('./updateVirtualNetworkRuleParameters'); -exports.CreateOrUpdateTrustedIdProviderParameters = require('./createOrUpdateTrustedIdProviderParameters'); -exports.UpdateTrustedIdProviderParameters = require('./updateTrustedIdProviderParameters'); -exports.CheckNameAvailabilityParameters = require('./checkNameAvailabilityParameters'); -exports.DataLakeStoreAccountListResult = require('./dataLakeStoreAccountListResult'); -exports.FirewallRuleListResult = require('./firewallRuleListResult'); -exports.VirtualNetworkRuleListResult = require('./virtualNetworkRuleListResult'); -exports.TrustedIdProviderListResult = require('./trustedIdProviderListResult'); diff --git a/lib/services/dataLake.Store/lib/account/models/keyVaultMetaInfo.js b/lib/services/dataLake.Store/lib/account/models/keyVaultMetaInfo.js deleted file mode 100644 index b7ef991b1b..0000000000 --- a/lib/services/dataLake.Store/lib/account/models/keyVaultMetaInfo.js +++ /dev/null @@ -1,71 +0,0 @@ -/* - * 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'; - -/** - * Metadata information used by account encryption. - * - */ -class KeyVaultMetaInfo { - /** - * Create a KeyVaultMetaInfo. - * @property {string} keyVaultResourceId The resource identifier for the user - * managed Key Vault being used to encrypt. - * @property {string} encryptionKeyName The name of the user managed - * encryption key. - * @property {string} encryptionKeyVersion The version of the user managed - * encryption key. - */ - constructor() { - } - - /** - * Defines the metadata of KeyVaultMetaInfo - * - * @returns {object} metadata of KeyVaultMetaInfo - * - */ - mapper() { - return { - required: false, - serializedName: 'KeyVaultMetaInfo', - type: { - name: 'Composite', - className: 'KeyVaultMetaInfo', - modelProperties: { - keyVaultResourceId: { - required: true, - serializedName: 'keyVaultResourceId', - type: { - name: 'String' - } - }, - encryptionKeyName: { - required: true, - serializedName: 'encryptionKeyName', - type: { - name: 'String' - } - }, - encryptionKeyVersion: { - required: true, - serializedName: 'encryptionKeyVersion', - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = KeyVaultMetaInfo; diff --git a/lib/services/dataLake.Store/lib/account/models/updateEncryptionConfig.js b/lib/services/dataLake.Store/lib/account/models/updateEncryptionConfig.js deleted file mode 100644 index 2611688583..0000000000 --- a/lib/services/dataLake.Store/lib/account/models/updateEncryptionConfig.js +++ /dev/null @@ -1,56 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -/** - * The encryption configuration used to update a user managed Key Vault key. - * - */ -class UpdateEncryptionConfig { - /** - * Create a UpdateEncryptionConfig. - * @property {object} [keyVaultMetaInfo] The updated Key Vault key to use in - * user managed key rotation. - * @property {string} [keyVaultMetaInfo.encryptionKeyVersion] The version of - * the user managed encryption key to update through a key rotation. - */ - constructor() { - } - - /** - * Defines the metadata of UpdateEncryptionConfig - * - * @returns {object} metadata of UpdateEncryptionConfig - * - */ - mapper() { - return { - required: false, - serializedName: 'UpdateEncryptionConfig', - type: { - name: 'Composite', - className: 'UpdateEncryptionConfig', - modelProperties: { - keyVaultMetaInfo: { - required: false, - serializedName: 'keyVaultMetaInfo', - type: { - name: 'Composite', - className: 'UpdateKeyVaultMetaInfo' - } - } - } - } - }; - } -} - -module.exports = UpdateEncryptionConfig; diff --git a/lib/services/dataLake.Store/lib/account/models/updateFirewallRuleParameters.js b/lib/services/dataLake.Store/lib/account/models/updateFirewallRuleParameters.js deleted file mode 100644 index 343233da2e..0000000000 --- a/lib/services/dataLake.Store/lib/account/models/updateFirewallRuleParameters.js +++ /dev/null @@ -1,64 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -/** - * The parameters used to update a firewall rule. - * - */ -class UpdateFirewallRuleParameters { - /** - * Create a UpdateFirewallRuleParameters. - * @property {string} [startIpAddress] The start IP address for the firewall - * rule. This can be either ipv4 or ipv6. Start and End should be in the same - * protocol. - * @property {string} [endIpAddress] The end IP address for the firewall - * rule. This can be either ipv4 or ipv6. Start and End should be in the same - * protocol. - */ - constructor() { - } - - /** - * Defines the metadata of UpdateFirewallRuleParameters - * - * @returns {object} metadata of UpdateFirewallRuleParameters - * - */ - mapper() { - return { - required: false, - serializedName: 'UpdateFirewallRuleParameters', - type: { - name: 'Composite', - className: 'UpdateFirewallRuleParameters', - modelProperties: { - startIpAddress: { - required: false, - serializedName: 'properties.startIpAddress', - type: { - name: 'String' - } - }, - endIpAddress: { - required: false, - serializedName: 'properties.endIpAddress', - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = UpdateFirewallRuleParameters; diff --git a/lib/services/dataLake.Store/lib/account/operations/index.d.ts b/lib/services/dataLake.Store/lib/account/operations/index.d.ts deleted file mode 100644 index 57b4ebb2e8..0000000000 --- a/lib/services/dataLake.Store/lib/account/operations/index.d.ts +++ /dev/null @@ -1,2733 +0,0 @@ -/* - * 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. -*/ - -import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse } from 'ms-rest'; -import * as models from '../models'; - - -/** - * @class - * Accounts - * __NOTE__: An instance of this class is automatically created for an - * instance of the DataLakeStoreAccountManagementClient. - */ -export interface Accounts { - - - /** - * Lists the Data Lake Store accounts within the subscription. The response - * includes a link to the next page of results, if any. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.filter] OData filter. Optional. - * - * @param {number} [options.top] The number of items to return. Optional. - * - * @param {number} [options.skip] The number of items to skip over before - * returning elements. Optional. - * - * @param {string} [options.select] OData Select statement. Limits the - * properties on each entry to just those requested, e.g. - * Categories?$select=CategoryName,Description. Optional. - * - * @param {string} [options.orderby] OrderBy clause. One or more - * comma-separated expressions with an optional "asc" (the default) or "desc" - * depending on the order you'd like the values sorted, e.g. - * Categories?$orderby=CategoryName desc. Optional. - * - * @param {boolean} [options.count] The Boolean value of true or false to - * request a count of the matching resources included with the resources in the - * response, e.g. Categories?$count=true. Optional. - * - * @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. - */ - listWithHttpOperationResponse(options?: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists the Data Lake Store accounts within the subscription. The response - * includes a link to the next page of results, if any. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.filter] OData filter. Optional. - * - * @param {number} [options.top] The number of items to return. Optional. - * - * @param {number} [options.skip] The number of items to skip over before - * returning elements. Optional. - * - * @param {string} [options.select] OData Select statement. Limits the - * properties on each entry to just those requested, e.g. - * Categories?$select=CategoryName,Description. Optional. - * - * @param {string} [options.orderby] OrderBy clause. One or more - * comma-separated expressions with an optional "asc" (the default) or "desc" - * depending on the order you'd like the values sorted, e.g. - * Categories?$orderby=CategoryName desc. Optional. - * - * @param {boolean} [options.count] The Boolean value of true or false to - * request a count of the matching resources included with the resources in the - * response, e.g. Categories?$count=true. Optional. - * - * @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 {DataLakeStoreAccountListResult} - 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. - * - * {DataLakeStoreAccountListResult} [result] - The deserialized result object if an error did not occur. - * See {@link DataLakeStoreAccountListResult} 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. - */ - list(options?: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise; - list(callback: ServiceCallback): void; - list(options: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Lists the Data Lake Store accounts within a specific resource group. The - * response includes a link to the next page of results, if any. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.filter] OData filter. Optional. - * - * @param {number} [options.top] The number of items to return. Optional. - * - * @param {number} [options.skip] The number of items to skip over before - * returning elements. Optional. - * - * @param {string} [options.select] OData Select statement. Limits the - * properties on each entry to just those requested, e.g. - * Categories?$select=CategoryName,Description. Optional. - * - * @param {string} [options.orderby] OrderBy clause. One or more - * comma-separated expressions with an optional "asc" (the default) or "desc" - * depending on the order you'd like the values sorted, e.g. - * Categories?$orderby=CategoryName desc. Optional. - * - * @param {boolean} [options.count] A Boolean value of true or false to request - * a count of the matching resources included with the resources in the - * response, e.g. Categories?$count=true. Optional. - * - * @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. - */ - listByResourceGroupWithHttpOperationResponse(resourceGroupName: string, options?: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists the Data Lake Store accounts within a specific resource group. The - * response includes a link to the next page of results, if any. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.filter] OData filter. Optional. - * - * @param {number} [options.top] The number of items to return. Optional. - * - * @param {number} [options.skip] The number of items to skip over before - * returning elements. Optional. - * - * @param {string} [options.select] OData Select statement. Limits the - * properties on each entry to just those requested, e.g. - * Categories?$select=CategoryName,Description. Optional. - * - * @param {string} [options.orderby] OrderBy clause. One or more - * comma-separated expressions with an optional "asc" (the default) or "desc" - * depending on the order you'd like the values sorted, e.g. - * Categories?$orderby=CategoryName desc. Optional. - * - * @param {boolean} [options.count] A Boolean value of true or false to request - * a count of the matching resources included with the resources in the - * response, e.g. Categories?$count=true. Optional. - * - * @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 {DataLakeStoreAccountListResult} - 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. - * - * {DataLakeStoreAccountListResult} [result] - The deserialized result object if an error did not occur. - * See {@link DataLakeStoreAccountListResult} 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. - */ - listByResourceGroup(resourceGroupName: string, options?: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise; - listByResourceGroup(resourceGroupName: string, callback: ServiceCallback): void; - listByResourceGroup(resourceGroupName: string, options: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Creates the specified Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {object} parameters Parameters supplied to create the Data Lake Store - * account. - * - * @param {string} parameters.location The resource location. - * - * @param {object} [parameters.tags] The resource tags. - * - * @param {object} [parameters.identity] The Key Vault encryption identity, if - * any. - * - * @param {string} [parameters.defaultGroup] The default owner group for all - * new folders and files created in the Data Lake Store account. - * - * @param {object} [parameters.encryptionConfig] The Key Vault encryption - * configuration. - * - * @param {string} parameters.encryptionConfig.type The type of encryption - * configuration being used. Currently the only supported types are - * 'UserManaged' and 'ServiceManaged'. Possible values include: 'UserManaged', - * 'ServiceManaged' - * - * @param {object} [parameters.encryptionConfig.keyVaultMetaInfo] The Key Vault - * information for connecting to user managed encryption keys. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.keyVaultResourceId The resource - * identifier for the user managed Key Vault being used to encrypt. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyName The name of - * the user managed encryption key. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyVersion The - * version of the user managed encryption key. - * - * @param {string} [parameters.encryptionState] The current state of encryption - * for this Data Lake Store account. Possible values include: 'Enabled', - * 'Disabled' - * - * @param {array} [parameters.firewallRules] The list of firewall rules - * associated with this Data Lake Store account. - * - * @param {array} [parameters.virtualNetworkRules] The list of virtual network - * rules associated with this Data Lake Store account. - * - * @param {string} [parameters.firewallState] The current state of the IP - * address firewall for this Data Lake Store account. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {string} [parameters.firewallAllowAzureIps] The current state of - * allowing or disallowing IPs originating within Azure through the firewall. - * If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {array} [parameters.trustedIdProviders] The list of trusted identity - * providers associated with this Data Lake Store account. - * - * @param {string} [parameters.trustedIdProviderState] The current state of the - * trusted identity provider feature for this Data Lake Store account. Possible - * values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.newTier] The commitment tier to use for next - * month. Possible values include: 'Consumption', 'Commitment_1TB', - * 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - * - * @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. - */ - createWithHttpOperationResponse(resourceGroupName: string, accountName: string, parameters: models.CreateDataLakeStoreAccountParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Creates the specified Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {object} parameters Parameters supplied to create the Data Lake Store - * account. - * - * @param {string} parameters.location The resource location. - * - * @param {object} [parameters.tags] The resource tags. - * - * @param {object} [parameters.identity] The Key Vault encryption identity, if - * any. - * - * @param {string} [parameters.defaultGroup] The default owner group for all - * new folders and files created in the Data Lake Store account. - * - * @param {object} [parameters.encryptionConfig] The Key Vault encryption - * configuration. - * - * @param {string} parameters.encryptionConfig.type The type of encryption - * configuration being used. Currently the only supported types are - * 'UserManaged' and 'ServiceManaged'. Possible values include: 'UserManaged', - * 'ServiceManaged' - * - * @param {object} [parameters.encryptionConfig.keyVaultMetaInfo] The Key Vault - * information for connecting to user managed encryption keys. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.keyVaultResourceId The resource - * identifier for the user managed Key Vault being used to encrypt. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyName The name of - * the user managed encryption key. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyVersion The - * version of the user managed encryption key. - * - * @param {string} [parameters.encryptionState] The current state of encryption - * for this Data Lake Store account. Possible values include: 'Enabled', - * 'Disabled' - * - * @param {array} [parameters.firewallRules] The list of firewall rules - * associated with this Data Lake Store account. - * - * @param {array} [parameters.virtualNetworkRules] The list of virtual network - * rules associated with this Data Lake Store account. - * - * @param {string} [parameters.firewallState] The current state of the IP - * address firewall for this Data Lake Store account. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {string} [parameters.firewallAllowAzureIps] The current state of - * allowing or disallowing IPs originating within Azure through the firewall. - * If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {array} [parameters.trustedIdProviders] The list of trusted identity - * providers associated with this Data Lake Store account. - * - * @param {string} [parameters.trustedIdProviderState] The current state of the - * trusted identity provider feature for this Data Lake Store account. Possible - * values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.newTier] The commitment tier to use for next - * month. Possible values include: 'Consumption', 'Commitment_1TB', - * 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - * - * @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 {DataLakeStoreAccount} - 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. - * - * {DataLakeStoreAccount} [result] - The deserialized result object if an error did not occur. - * See {@link DataLakeStoreAccount} 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. - */ - create(resourceGroupName: string, accountName: string, parameters: models.CreateDataLakeStoreAccountParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - create(resourceGroupName: string, accountName: string, parameters: models.CreateDataLakeStoreAccountParameters, callback: ServiceCallback): void; - create(resourceGroupName: string, accountName: string, parameters: models.CreateDataLakeStoreAccountParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets the specified Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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. - */ - getWithHttpOperationResponse(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets the specified Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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 {DataLakeStoreAccount} - 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. - * - * {DataLakeStoreAccount} [result] - The deserialized result object if an error did not occur. - * See {@link DataLakeStoreAccount} 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. - */ - get(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - get(resourceGroupName: string, accountName: string, callback: ServiceCallback): void; - get(resourceGroupName: string, accountName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Updates the specified Data Lake Store account information. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {object} parameters Parameters supplied to update the Data Lake Store - * account. - * - * @param {object} [parameters.tags] Resource tags - * - * @param {string} [parameters.defaultGroup] The default owner group for all - * new folders and files created in the Data Lake Store account. - * - * @param {object} [parameters.encryptionConfig] Used for rotation of user - * managed Key Vault keys. Can only be used to rotate a user managed encryption - * Key Vault key. - * - * @param {object} [parameters.encryptionConfig.keyVaultMetaInfo] The updated - * Key Vault key to use in user managed key rotation. - * - * @param {string} - * [parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyVersion] The - * version of the user managed encryption key to update through a key rotation. - * - * @param {array} [parameters.firewallRules] The list of firewall rules - * associated with this Data Lake Store account. - * - * @param {array} [parameters.virtualNetworkRules] The list of virtual network - * rules associated with this Data Lake Store account. - * - * @param {string} [parameters.firewallState] The current state of the IP - * address firewall for this Data Lake Store account. Disabling the firewall - * does not remove existing rules, they will just be ignored until the firewall - * is re-enabled. Possible values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.firewallAllowAzureIps] The current state of - * allowing or disallowing IPs originating within Azure through the firewall. - * If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {array} [parameters.trustedIdProviders] The list of trusted identity - * providers associated with this Data Lake Store account. - * - * @param {string} [parameters.trustedIdProviderState] The current state of the - * trusted identity provider feature for this Data Lake Store account. - * Disabling trusted identity provider functionality does not remove the - * providers, they will just be ignored until this feature is re-enabled. - * Possible values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.newTier] The commitment tier to use for next - * month. Possible values include: 'Consumption', 'Commitment_1TB', - * 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - * - * @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. - */ - updateWithHttpOperationResponse(resourceGroupName: string, accountName: string, parameters: models.UpdateDataLakeStoreAccountParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Updates the specified Data Lake Store account information. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {object} parameters Parameters supplied to update the Data Lake Store - * account. - * - * @param {object} [parameters.tags] Resource tags - * - * @param {string} [parameters.defaultGroup] The default owner group for all - * new folders and files created in the Data Lake Store account. - * - * @param {object} [parameters.encryptionConfig] Used for rotation of user - * managed Key Vault keys. Can only be used to rotate a user managed encryption - * Key Vault key. - * - * @param {object} [parameters.encryptionConfig.keyVaultMetaInfo] The updated - * Key Vault key to use in user managed key rotation. - * - * @param {string} - * [parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyVersion] The - * version of the user managed encryption key to update through a key rotation. - * - * @param {array} [parameters.firewallRules] The list of firewall rules - * associated with this Data Lake Store account. - * - * @param {array} [parameters.virtualNetworkRules] The list of virtual network - * rules associated with this Data Lake Store account. - * - * @param {string} [parameters.firewallState] The current state of the IP - * address firewall for this Data Lake Store account. Disabling the firewall - * does not remove existing rules, they will just be ignored until the firewall - * is re-enabled. Possible values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.firewallAllowAzureIps] The current state of - * allowing or disallowing IPs originating within Azure through the firewall. - * If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {array} [parameters.trustedIdProviders] The list of trusted identity - * providers associated with this Data Lake Store account. - * - * @param {string} [parameters.trustedIdProviderState] The current state of the - * trusted identity provider feature for this Data Lake Store account. - * Disabling trusted identity provider functionality does not remove the - * providers, they will just be ignored until this feature is re-enabled. - * Possible values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.newTier] The commitment tier to use for next - * month. Possible values include: 'Consumption', 'Commitment_1TB', - * 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - * - * @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 {DataLakeStoreAccount} - 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. - * - * {DataLakeStoreAccount} [result] - The deserialized result object if an error did not occur. - * See {@link DataLakeStoreAccount} 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. - */ - update(resourceGroupName: string, accountName: string, parameters: models.UpdateDataLakeStoreAccountParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - update(resourceGroupName: string, accountName: string, parameters: models.UpdateDataLakeStoreAccountParameters, callback: ServiceCallback): void; - update(resourceGroupName: string, accountName: string, parameters: models.UpdateDataLakeStoreAccountParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Deletes the specified Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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. - */ - deleteMethodWithHttpOperationResponse(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Deletes the specified Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - deleteMethod(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - deleteMethod(resourceGroupName: string, accountName: string, callback: ServiceCallback): void; - deleteMethod(resourceGroupName: string, accountName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Attempts to enable a user managed Key Vault for encryption of the specified - * Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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. - */ - enableKeyVaultWithHttpOperationResponse(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Attempts to enable a user managed Key Vault for encryption of the specified - * Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - enableKeyVault(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - enableKeyVault(resourceGroupName: string, accountName: string, callback: ServiceCallback): void; - enableKeyVault(resourceGroupName: string, accountName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Checks whether the specified account name is available or taken. - * - * @param {string} location The resource location without whitespace. - * - * @param {object} parameters Parameters supplied to check the Data Lake Store - * account name availability. - * - * @param {string} parameters.name The Data Lake Store name to check - * availability for. - * - * @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. - */ - checkNameAvailabilityWithHttpOperationResponse(location: string, parameters: models.CheckNameAvailabilityParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Checks whether the specified account name is available or taken. - * - * @param {string} location The resource location without whitespace. - * - * @param {object} parameters Parameters supplied to check the Data Lake Store - * account name availability. - * - * @param {string} parameters.name The Data Lake Store name to check - * availability for. - * - * @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 {NameAvailabilityInformation} - 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. - * - * {NameAvailabilityInformation} [result] - The deserialized result object if an error did not occur. - * See {@link NameAvailabilityInformation} 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. - */ - checkNameAvailability(location: string, parameters: models.CheckNameAvailabilityParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - checkNameAvailability(location: string, parameters: models.CheckNameAvailabilityParameters, callback: ServiceCallback): void; - checkNameAvailability(location: string, parameters: models.CheckNameAvailabilityParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Creates the specified Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {object} parameters Parameters supplied to create the Data Lake Store - * account. - * - * @param {string} parameters.location The resource location. - * - * @param {object} [parameters.tags] The resource tags. - * - * @param {object} [parameters.identity] The Key Vault encryption identity, if - * any. - * - * @param {string} [parameters.defaultGroup] The default owner group for all - * new folders and files created in the Data Lake Store account. - * - * @param {object} [parameters.encryptionConfig] The Key Vault encryption - * configuration. - * - * @param {string} parameters.encryptionConfig.type The type of encryption - * configuration being used. Currently the only supported types are - * 'UserManaged' and 'ServiceManaged'. Possible values include: 'UserManaged', - * 'ServiceManaged' - * - * @param {object} [parameters.encryptionConfig.keyVaultMetaInfo] The Key Vault - * information for connecting to user managed encryption keys. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.keyVaultResourceId The resource - * identifier for the user managed Key Vault being used to encrypt. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyName The name of - * the user managed encryption key. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyVersion The - * version of the user managed encryption key. - * - * @param {string} [parameters.encryptionState] The current state of encryption - * for this Data Lake Store account. Possible values include: 'Enabled', - * 'Disabled' - * - * @param {array} [parameters.firewallRules] The list of firewall rules - * associated with this Data Lake Store account. - * - * @param {array} [parameters.virtualNetworkRules] The list of virtual network - * rules associated with this Data Lake Store account. - * - * @param {string} [parameters.firewallState] The current state of the IP - * address firewall for this Data Lake Store account. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {string} [parameters.firewallAllowAzureIps] The current state of - * allowing or disallowing IPs originating within Azure through the firewall. - * If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {array} [parameters.trustedIdProviders] The list of trusted identity - * providers associated with this Data Lake Store account. - * - * @param {string} [parameters.trustedIdProviderState] The current state of the - * trusted identity provider feature for this Data Lake Store account. Possible - * values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.newTier] The commitment tier to use for next - * month. Possible values include: 'Consumption', 'Commitment_1TB', - * 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - * - * @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. - */ - beginCreateWithHttpOperationResponse(resourceGroupName: string, accountName: string, parameters: models.CreateDataLakeStoreAccountParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Creates the specified Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {object} parameters Parameters supplied to create the Data Lake Store - * account. - * - * @param {string} parameters.location The resource location. - * - * @param {object} [parameters.tags] The resource tags. - * - * @param {object} [parameters.identity] The Key Vault encryption identity, if - * any. - * - * @param {string} [parameters.defaultGroup] The default owner group for all - * new folders and files created in the Data Lake Store account. - * - * @param {object} [parameters.encryptionConfig] The Key Vault encryption - * configuration. - * - * @param {string} parameters.encryptionConfig.type The type of encryption - * configuration being used. Currently the only supported types are - * 'UserManaged' and 'ServiceManaged'. Possible values include: 'UserManaged', - * 'ServiceManaged' - * - * @param {object} [parameters.encryptionConfig.keyVaultMetaInfo] The Key Vault - * information for connecting to user managed encryption keys. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.keyVaultResourceId The resource - * identifier for the user managed Key Vault being used to encrypt. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyName The name of - * the user managed encryption key. - * - * @param {string} - * parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyVersion The - * version of the user managed encryption key. - * - * @param {string} [parameters.encryptionState] The current state of encryption - * for this Data Lake Store account. Possible values include: 'Enabled', - * 'Disabled' - * - * @param {array} [parameters.firewallRules] The list of firewall rules - * associated with this Data Lake Store account. - * - * @param {array} [parameters.virtualNetworkRules] The list of virtual network - * rules associated with this Data Lake Store account. - * - * @param {string} [parameters.firewallState] The current state of the IP - * address firewall for this Data Lake Store account. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {string} [parameters.firewallAllowAzureIps] The current state of - * allowing or disallowing IPs originating within Azure through the firewall. - * If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {array} [parameters.trustedIdProviders] The list of trusted identity - * providers associated with this Data Lake Store account. - * - * @param {string} [parameters.trustedIdProviderState] The current state of the - * trusted identity provider feature for this Data Lake Store account. Possible - * values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.newTier] The commitment tier to use for next - * month. Possible values include: 'Consumption', 'Commitment_1TB', - * 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - * - * @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 {DataLakeStoreAccount} - 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. - * - * {DataLakeStoreAccount} [result] - The deserialized result object if an error did not occur. - * See {@link DataLakeStoreAccount} 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. - */ - beginCreate(resourceGroupName: string, accountName: string, parameters: models.CreateDataLakeStoreAccountParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginCreate(resourceGroupName: string, accountName: string, parameters: models.CreateDataLakeStoreAccountParameters, callback: ServiceCallback): void; - beginCreate(resourceGroupName: string, accountName: string, parameters: models.CreateDataLakeStoreAccountParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Updates the specified Data Lake Store account information. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {object} parameters Parameters supplied to update the Data Lake Store - * account. - * - * @param {object} [parameters.tags] Resource tags - * - * @param {string} [parameters.defaultGroup] The default owner group for all - * new folders and files created in the Data Lake Store account. - * - * @param {object} [parameters.encryptionConfig] Used for rotation of user - * managed Key Vault keys. Can only be used to rotate a user managed encryption - * Key Vault key. - * - * @param {object} [parameters.encryptionConfig.keyVaultMetaInfo] The updated - * Key Vault key to use in user managed key rotation. - * - * @param {string} - * [parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyVersion] The - * version of the user managed encryption key to update through a key rotation. - * - * @param {array} [parameters.firewallRules] The list of firewall rules - * associated with this Data Lake Store account. - * - * @param {array} [parameters.virtualNetworkRules] The list of virtual network - * rules associated with this Data Lake Store account. - * - * @param {string} [parameters.firewallState] The current state of the IP - * address firewall for this Data Lake Store account. Disabling the firewall - * does not remove existing rules, they will just be ignored until the firewall - * is re-enabled. Possible values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.firewallAllowAzureIps] The current state of - * allowing or disallowing IPs originating within Azure through the firewall. - * If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {array} [parameters.trustedIdProviders] The list of trusted identity - * providers associated with this Data Lake Store account. - * - * @param {string} [parameters.trustedIdProviderState] The current state of the - * trusted identity provider feature for this Data Lake Store account. - * Disabling trusted identity provider functionality does not remove the - * providers, they will just be ignored until this feature is re-enabled. - * Possible values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.newTier] The commitment tier to use for next - * month. Possible values include: 'Consumption', 'Commitment_1TB', - * 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - * - * @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. - */ - beginUpdateWithHttpOperationResponse(resourceGroupName: string, accountName: string, parameters: models.UpdateDataLakeStoreAccountParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Updates the specified Data Lake Store account information. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {object} parameters Parameters supplied to update the Data Lake Store - * account. - * - * @param {object} [parameters.tags] Resource tags - * - * @param {string} [parameters.defaultGroup] The default owner group for all - * new folders and files created in the Data Lake Store account. - * - * @param {object} [parameters.encryptionConfig] Used for rotation of user - * managed Key Vault keys. Can only be used to rotate a user managed encryption - * Key Vault key. - * - * @param {object} [parameters.encryptionConfig.keyVaultMetaInfo] The updated - * Key Vault key to use in user managed key rotation. - * - * @param {string} - * [parameters.encryptionConfig.keyVaultMetaInfo.encryptionKeyVersion] The - * version of the user managed encryption key to update through a key rotation. - * - * @param {array} [parameters.firewallRules] The list of firewall rules - * associated with this Data Lake Store account. - * - * @param {array} [parameters.virtualNetworkRules] The list of virtual network - * rules associated with this Data Lake Store account. - * - * @param {string} [parameters.firewallState] The current state of the IP - * address firewall for this Data Lake Store account. Disabling the firewall - * does not remove existing rules, they will just be ignored until the firewall - * is re-enabled. Possible values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.firewallAllowAzureIps] The current state of - * allowing or disallowing IPs originating within Azure through the firewall. - * If the firewall is disabled, this is not enforced. Possible values include: - * 'Enabled', 'Disabled' - * - * @param {array} [parameters.trustedIdProviders] The list of trusted identity - * providers associated with this Data Lake Store account. - * - * @param {string} [parameters.trustedIdProviderState] The current state of the - * trusted identity provider feature for this Data Lake Store account. - * Disabling trusted identity provider functionality does not remove the - * providers, they will just be ignored until this feature is re-enabled. - * Possible values include: 'Enabled', 'Disabled' - * - * @param {string} [parameters.newTier] The commitment tier to use for next - * month. Possible values include: 'Consumption', 'Commitment_1TB', - * 'Commitment_10TB', 'Commitment_100TB', 'Commitment_500TB', 'Commitment_1PB', - * 'Commitment_5PB' - * - * @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 {DataLakeStoreAccount} - 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. - * - * {DataLakeStoreAccount} [result] - The deserialized result object if an error did not occur. - * See {@link DataLakeStoreAccount} 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. - */ - beginUpdate(resourceGroupName: string, accountName: string, parameters: models.UpdateDataLakeStoreAccountParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginUpdate(resourceGroupName: string, accountName: string, parameters: models.UpdateDataLakeStoreAccountParameters, callback: ServiceCallback): void; - beginUpdate(resourceGroupName: string, accountName: string, parameters: models.UpdateDataLakeStoreAccountParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Deletes the specified Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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. - */ - beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Deletes the specified Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - beginDeleteMethod(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginDeleteMethod(resourceGroupName: string, accountName: string, callback: ServiceCallback): void; - beginDeleteMethod(resourceGroupName: string, accountName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Lists the Data Lake Store accounts within the subscription. The response - * includes a link to the next page of results, if any. - * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. - * - * @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. - */ - listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists the Data Lake Store accounts within the subscription. The response - * includes a link to the next page of results, if any. - * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. - * - * @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 {DataLakeStoreAccountListResult} - 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. - * - * {DataLakeStoreAccountListResult} [result] - The deserialized result object if an error did not occur. - * See {@link DataLakeStoreAccountListResult} 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. - */ - listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listNext(nextPageLink: string, callback: ServiceCallback): void; - listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Lists the Data Lake Store accounts within a specific resource group. The - * response includes a link to the next page of results, if any. - * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. - * - * @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. - */ - listByResourceGroupNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists the Data Lake Store accounts within a specific resource group. The - * response includes a link to the next page of results, if any. - * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. - * - * @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 {DataLakeStoreAccountListResult} - 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. - * - * {DataLakeStoreAccountListResult} [result] - The deserialized result object if an error did not occur. - * See {@link DataLakeStoreAccountListResult} 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. - */ - listByResourceGroupNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback): void; - listByResourceGroupNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; -} - -/** - * @class - * FirewallRules - * __NOTE__: An instance of this class is automatically created for an - * instance of the DataLakeStoreAccountManagementClient. - */ -export interface FirewallRules { - - - /** - * Lists the Data Lake Store firewall rules within the specified Data Lake - * Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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. - */ - listByAccountWithHttpOperationResponse(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists the Data Lake Store firewall rules within the specified Data Lake - * Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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 {FirewallRuleListResult} - 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. - * - * {FirewallRuleListResult} [result] - The deserialized result object if an error did not occur. - * See {@link FirewallRuleListResult} 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. - */ - listByAccount(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listByAccount(resourceGroupName: string, accountName: string, callback: ServiceCallback): void; - listByAccount(resourceGroupName: string, accountName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Creates or updates the specified firewall rule. During update, the firewall - * rule with the specified name will be replaced with this new firewall rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} firewallRuleName The name of the firewall rule to create or - * update. - * - * @param {object} parameters Parameters supplied to create or update the - * firewall rule. - * - * @param {string} parameters.startIpAddress The start IP address for the - * firewall rule. This can be either ipv4 or ipv6. Start and End should be in - * the same protocol. - * - * @param {string} parameters.endIpAddress The end IP address for the firewall - * rule. This can be either ipv4 or ipv6. Start and End should be in the same - * protocol. - * - * @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. - */ - createOrUpdateWithHttpOperationResponse(resourceGroupName: string, accountName: string, firewallRuleName: string, parameters: models.CreateOrUpdateFirewallRuleParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Creates or updates the specified firewall rule. During update, the firewall - * rule with the specified name will be replaced with this new firewall rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} firewallRuleName The name of the firewall rule to create or - * update. - * - * @param {object} parameters Parameters supplied to create or update the - * firewall rule. - * - * @param {string} parameters.startIpAddress The start IP address for the - * firewall rule. This can be either ipv4 or ipv6. Start and End should be in - * the same protocol. - * - * @param {string} parameters.endIpAddress The end IP address for the firewall - * rule. This can be either ipv4 or ipv6. Start and End should be in the same - * protocol. - * - * @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 {FirewallRule} - 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. - * - * {FirewallRule} [result] - The deserialized result object if an error did not occur. - * See {@link FirewallRule} 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. - */ - createOrUpdate(resourceGroupName: string, accountName: string, firewallRuleName: string, parameters: models.CreateOrUpdateFirewallRuleParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - createOrUpdate(resourceGroupName: string, accountName: string, firewallRuleName: string, parameters: models.CreateOrUpdateFirewallRuleParameters, callback: ServiceCallback): void; - createOrUpdate(resourceGroupName: string, accountName: string, firewallRuleName: string, parameters: models.CreateOrUpdateFirewallRuleParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets the specified Data Lake Store firewall rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} firewallRuleName The name of the firewall rule to retrieve. - * - * @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. - */ - getWithHttpOperationResponse(resourceGroupName: string, accountName: string, firewallRuleName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets the specified Data Lake Store firewall rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} firewallRuleName The name of the firewall rule to retrieve. - * - * @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 {FirewallRule} - 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. - * - * {FirewallRule} [result] - The deserialized result object if an error did not occur. - * See {@link FirewallRule} 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. - */ - get(resourceGroupName: string, accountName: string, firewallRuleName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - get(resourceGroupName: string, accountName: string, firewallRuleName: string, callback: ServiceCallback): void; - get(resourceGroupName: string, accountName: string, firewallRuleName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Updates the specified firewall rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} firewallRuleName The name of the firewall rule to update. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.parameters] Parameters supplied to update the - * firewall rule. - * - * @param {string} [options.parameters.startIpAddress] The start IP address for - * the firewall rule. This can be either ipv4 or ipv6. Start and End should be - * in the same protocol. - * - * @param {string} [options.parameters.endIpAddress] The end IP address for the - * firewall rule. This can be either ipv4 or ipv6. Start and End should be in - * the same protocol. - * - * @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. - */ - updateWithHttpOperationResponse(resourceGroupName: string, accountName: string, firewallRuleName: string, options?: { parameters? : models.UpdateFirewallRuleParameters, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Updates the specified firewall rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} firewallRuleName The name of the firewall rule to update. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.parameters] Parameters supplied to update the - * firewall rule. - * - * @param {string} [options.parameters.startIpAddress] The start IP address for - * the firewall rule. This can be either ipv4 or ipv6. Start and End should be - * in the same protocol. - * - * @param {string} [options.parameters.endIpAddress] The end IP address for the - * firewall rule. This can be either ipv4 or ipv6. Start and End should be in - * the same protocol. - * - * @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 {FirewallRule} - 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. - * - * {FirewallRule} [result] - The deserialized result object if an error did not occur. - * See {@link FirewallRule} 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. - */ - update(resourceGroupName: string, accountName: string, firewallRuleName: string, options?: { parameters? : models.UpdateFirewallRuleParameters, customHeaders? : { [headerName: string]: string; } }): Promise; - update(resourceGroupName: string, accountName: string, firewallRuleName: string, callback: ServiceCallback): void; - update(resourceGroupName: string, accountName: string, firewallRuleName: string, options: { parameters? : models.UpdateFirewallRuleParameters, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Deletes the specified firewall rule from the specified Data Lake Store - * account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} firewallRuleName The name of the firewall rule to delete. - * - * @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. - */ - deleteMethodWithHttpOperationResponse(resourceGroupName: string, accountName: string, firewallRuleName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Deletes the specified firewall rule from the specified Data Lake Store - * account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} firewallRuleName The name of the firewall rule to delete. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - deleteMethod(resourceGroupName: string, accountName: string, firewallRuleName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - deleteMethod(resourceGroupName: string, accountName: string, firewallRuleName: string, callback: ServiceCallback): void; - deleteMethod(resourceGroupName: string, accountName: string, firewallRuleName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Lists the Data Lake Store firewall rules within the specified Data Lake - * Store account. - * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. - * - * @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. - */ - listByAccountNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists the Data Lake Store firewall rules within the specified Data Lake - * Store account. - * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. - * - * @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 {FirewallRuleListResult} - 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. - * - * {FirewallRuleListResult} [result] - The deserialized result object if an error did not occur. - * See {@link FirewallRuleListResult} 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. - */ - listByAccountNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listByAccountNext(nextPageLink: string, callback: ServiceCallback): void; - listByAccountNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; -} - -/** - * @class - * VirtualNetworkRules - * __NOTE__: An instance of this class is automatically created for an - * instance of the DataLakeStoreAccountManagementClient. - */ -export interface VirtualNetworkRules { - - - /** - * Lists the Data Lake Store virtual network rules within the specified Data - * Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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. - */ - listByAccountWithHttpOperationResponse(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists the Data Lake Store virtual network rules within the specified Data - * Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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 {VirtualNetworkRuleListResult} - 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. - * - * {VirtualNetworkRuleListResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkRuleListResult} 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. - */ - listByAccount(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listByAccount(resourceGroupName: string, accountName: string, callback: ServiceCallback): void; - listByAccount(resourceGroupName: string, accountName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Creates or updates the specified virtual network rule. During update, the - * virtual network rule with the specified name will be replaced with this new - * virtual network rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} virtualNetworkRuleName The name of the virtual network rule - * to create or update. - * - * @param {object} parameters Parameters supplied to create or update the - * virtual network rule. - * - * @param {string} parameters.subnetId The resource identifier for the subnet. - * - * @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. - */ - createOrUpdateWithHttpOperationResponse(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, parameters: models.CreateOrUpdateVirtualNetworkRuleParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Creates or updates the specified virtual network rule. During update, the - * virtual network rule with the specified name will be replaced with this new - * virtual network rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} virtualNetworkRuleName The name of the virtual network rule - * to create or update. - * - * @param {object} parameters Parameters supplied to create or update the - * virtual network rule. - * - * @param {string} parameters.subnetId The resource identifier for the subnet. - * - * @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 {VirtualNetworkRule} - 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. - * - * {VirtualNetworkRule} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkRule} 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. - */ - createOrUpdate(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, parameters: models.CreateOrUpdateVirtualNetworkRuleParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - createOrUpdate(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, parameters: models.CreateOrUpdateVirtualNetworkRuleParameters, callback: ServiceCallback): void; - createOrUpdate(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, parameters: models.CreateOrUpdateVirtualNetworkRuleParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets the specified Data Lake Store virtual network rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} virtualNetworkRuleName The name of the virtual network rule - * to retrieve. - * - * @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. - */ - getWithHttpOperationResponse(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets the specified Data Lake Store virtual network rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} virtualNetworkRuleName The name of the virtual network rule - * to retrieve. - * - * @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 {VirtualNetworkRule} - 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. - * - * {VirtualNetworkRule} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkRule} 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. - */ - get(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - get(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, callback: ServiceCallback): void; - get(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Updates the specified virtual network rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} virtualNetworkRuleName The name of the virtual network rule - * to update. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.parameters] Parameters supplied to update the - * virtual network rule. - * - * @param {string} [options.parameters.subnetId] The resource identifier for - * the subnet. - * - * @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. - */ - updateWithHttpOperationResponse(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, options?: { parameters? : models.UpdateVirtualNetworkRuleParameters, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Updates the specified virtual network rule. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} virtualNetworkRuleName The name of the virtual network rule - * to update. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.parameters] Parameters supplied to update the - * virtual network rule. - * - * @param {string} [options.parameters.subnetId] The resource identifier for - * the subnet. - * - * @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 {VirtualNetworkRule} - 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. - * - * {VirtualNetworkRule} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkRule} 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. - */ - update(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, options?: { parameters? : models.UpdateVirtualNetworkRuleParameters, customHeaders? : { [headerName: string]: string; } }): Promise; - update(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, callback: ServiceCallback): void; - update(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, options: { parameters? : models.UpdateVirtualNetworkRuleParameters, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Deletes the specified virtual network rule from the specified Data Lake - * Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} virtualNetworkRuleName The name of the virtual network rule - * to delete. - * - * @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. - */ - deleteMethodWithHttpOperationResponse(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Deletes the specified virtual network rule from the specified Data Lake - * Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} virtualNetworkRuleName The name of the virtual network rule - * to delete. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - deleteMethod(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - deleteMethod(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, callback: ServiceCallback): void; - deleteMethod(resourceGroupName: string, accountName: string, virtualNetworkRuleName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Lists the Data Lake Store virtual network rules within the specified Data - * Lake Store account. - * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. - * - * @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. - */ - listByAccountNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists the Data Lake Store virtual network rules within the specified Data - * Lake Store account. - * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. - * - * @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 {VirtualNetworkRuleListResult} - 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. - * - * {VirtualNetworkRuleListResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkRuleListResult} 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. - */ - listByAccountNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listByAccountNext(nextPageLink: string, callback: ServiceCallback): void; - listByAccountNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; -} - -/** - * @class - * TrustedIdProviders - * __NOTE__: An instance of this class is automatically created for an - * instance of the DataLakeStoreAccountManagementClient. - */ -export interface TrustedIdProviders { - - - /** - * Lists the Data Lake Store trusted identity providers within the specified - * Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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. - */ - listByAccountWithHttpOperationResponse(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists the Data Lake Store trusted identity providers within the specified - * Data Lake Store account. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @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 {TrustedIdProviderListResult} - 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. - * - * {TrustedIdProviderListResult} [result] - The deserialized result object if an error did not occur. - * See {@link TrustedIdProviderListResult} 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. - */ - listByAccount(resourceGroupName: string, accountName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listByAccount(resourceGroupName: string, accountName: string, callback: ServiceCallback): void; - listByAccount(resourceGroupName: string, accountName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Creates or updates the specified trusted identity provider. During update, - * the trusted identity provider with the specified name will be replaced with - * this new provider - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider. This is used for differentiation of providers in the account. - * - * @param {object} parameters Parameters supplied to create or replace the - * trusted identity provider. - * - * @param {string} parameters.idProvider The URL of this trusted identity - * provider. - * - * @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. - */ - createOrUpdateWithHttpOperationResponse(resourceGroupName: string, accountName: string, trustedIdProviderName: string, parameters: models.CreateOrUpdateTrustedIdProviderParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Creates or updates the specified trusted identity provider. During update, - * the trusted identity provider with the specified name will be replaced with - * this new provider - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider. This is used for differentiation of providers in the account. - * - * @param {object} parameters Parameters supplied to create or replace the - * trusted identity provider. - * - * @param {string} parameters.idProvider The URL of this trusted identity - * provider. - * - * @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 {TrustedIdProvider} - 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. - * - * {TrustedIdProvider} [result] - The deserialized result object if an error did not occur. - * See {@link TrustedIdProvider} 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. - */ - createOrUpdate(resourceGroupName: string, accountName: string, trustedIdProviderName: string, parameters: models.CreateOrUpdateTrustedIdProviderParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - createOrUpdate(resourceGroupName: string, accountName: string, trustedIdProviderName: string, parameters: models.CreateOrUpdateTrustedIdProviderParameters, callback: ServiceCallback): void; - createOrUpdate(resourceGroupName: string, accountName: string, trustedIdProviderName: string, parameters: models.CreateOrUpdateTrustedIdProviderParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets the specified Data Lake Store trusted identity provider. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider to retrieve. - * - * @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. - */ - getWithHttpOperationResponse(resourceGroupName: string, accountName: string, trustedIdProviderName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets the specified Data Lake Store trusted identity provider. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider to retrieve. - * - * @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 {TrustedIdProvider} - 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. - * - * {TrustedIdProvider} [result] - The deserialized result object if an error did not occur. - * See {@link TrustedIdProvider} 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. - */ - get(resourceGroupName: string, accountName: string, trustedIdProviderName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - get(resourceGroupName: string, accountName: string, trustedIdProviderName: string, callback: ServiceCallback): void; - get(resourceGroupName: string, accountName: string, trustedIdProviderName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Updates the specified trusted identity provider. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider. This is used for differentiation of providers in the account. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.parameters] Parameters supplied to update the - * trusted identity provider. - * - * @param {string} [options.parameters.idProvider] The URL of this trusted - * identity provider. - * - * @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. - */ - updateWithHttpOperationResponse(resourceGroupName: string, accountName: string, trustedIdProviderName: string, options?: { parameters? : models.UpdateTrustedIdProviderParameters, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Updates the specified trusted identity provider. - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider. This is used for differentiation of providers in the account. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.parameters] Parameters supplied to update the - * trusted identity provider. - * - * @param {string} [options.parameters.idProvider] The URL of this trusted - * identity provider. - * - * @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 {TrustedIdProvider} - 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. - * - * {TrustedIdProvider} [result] - The deserialized result object if an error did not occur. - * See {@link TrustedIdProvider} 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. - */ - update(resourceGroupName: string, accountName: string, trustedIdProviderName: string, options?: { parameters? : models.UpdateTrustedIdProviderParameters, customHeaders? : { [headerName: string]: string; } }): Promise; - update(resourceGroupName: string, accountName: string, trustedIdProviderName: string, callback: ServiceCallback): void; - update(resourceGroupName: string, accountName: string, trustedIdProviderName: string, options: { parameters? : models.UpdateTrustedIdProviderParameters, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Deletes the specified trusted identity provider from the specified Data Lake - * Store account - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider to delete. - * - * @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. - */ - deleteMethodWithHttpOperationResponse(resourceGroupName: string, accountName: string, trustedIdProviderName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Deletes the specified trusted identity provider from the specified Data Lake - * Store account - * - * @param {string} resourceGroupName The name of the Azure resource group. - * - * @param {string} accountName The name of the Data Lake Store account. - * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider to delete. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - deleteMethod(resourceGroupName: string, accountName: string, trustedIdProviderName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - deleteMethod(resourceGroupName: string, accountName: string, trustedIdProviderName: string, callback: ServiceCallback): void; - deleteMethod(resourceGroupName: string, accountName: string, trustedIdProviderName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Lists the Data Lake Store trusted identity providers within the specified - * Data Lake Store account. - * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. - * - * @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. - */ - listByAccountNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists the Data Lake Store trusted identity providers within the specified - * Data Lake Store account. - * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. - * - * @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 {TrustedIdProviderListResult} - 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. - * - * {TrustedIdProviderListResult} [result] - The deserialized result object if an error did not occur. - * See {@link TrustedIdProviderListResult} 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. - */ - listByAccountNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listByAccountNext(nextPageLink: string, callback: ServiceCallback): void; - listByAccountNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; -} - -/** - * @class - * Operations - * __NOTE__: An instance of this class is automatically created for an - * instance of the DataLakeStoreAccountManagementClient. - */ -export interface Operations { - - - /** - * Lists all of the available Data Lake Store REST API operations. - * - * @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. - */ - listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Lists all of the available Data Lake Store REST API operations. - * - * @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 {OperationListResult} - 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. - * - * {OperationListResult} [result] - The deserialized result object if an error did not occur. - * See {@link OperationListResult} 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. - */ - list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - list(callback: ServiceCallback): void; - list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; -} - -/** - * @class - * Locations - * __NOTE__: An instance of this class is automatically created for an - * instance of the DataLakeStoreAccountManagementClient. - */ -export interface Locations { - - - /** - * Gets subscription-level properties and limits for Data Lake Store specified - * by resource location. - * - * @param {string} location The resource location without whitespace. - * - * @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. - */ - getCapabilityWithHttpOperationResponse(location: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets subscription-level properties and limits for Data Lake Store specified - * by resource location. - * - * @param {string} location The resource location without whitespace. - * - * @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 {CapabilityInformation} - 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. - * - * {CapabilityInformation} [result] - The deserialized result object if an error did not occur. - * See {@link CapabilityInformation} 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. - */ - getCapability(location: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - getCapability(location: string, callback: ServiceCallback): void; - getCapability(location: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; -} diff --git a/lib/services/dataLake.Store/lib/filesystem/models/aclStatus.js b/lib/services/dataLake.Store/lib/filesystem/models/aclStatus.js deleted file mode 100644 index 5c33de6971..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/aclStatus.js +++ /dev/null @@ -1,95 +0,0 @@ -/* - * 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'; - -/** - * Data Lake Store file or directory Access Control List information. - * - */ -class AclStatus { - /** - * Create a AclStatus. - * @property {array} [entries] the list of ACLSpec entries on a file or - * directory. - * @property {string} [group] the group owner, an AAD Object ID. - * @property {string} [owner] the user owner, an AAD Object ID. - * @property {string} [permission] The octal representation of the unnamed - * user, mask and other permissions. - * @property {boolean} [stickyBit] the indicator of whether the sticky bit is - * on or off. - */ - constructor() { - } - - /** - * Defines the metadata of AclStatus - * - * @returns {object} metadata of AclStatus - * - */ - mapper() { - return { - required: false, - serializedName: 'AclStatus', - type: { - name: 'Composite', - className: 'AclStatus', - modelProperties: { - entries: { - required: false, - serializedName: 'entries', - type: { - name: 'Sequence', - element: { - required: false, - serializedName: 'StringElementType', - type: { - name: 'String' - } - } - } - }, - group: { - required: false, - serializedName: 'group', - type: { - name: 'String' - } - }, - owner: { - required: false, - serializedName: 'owner', - type: { - name: 'String' - } - }, - permission: { - required: false, - serializedName: 'permission', - type: { - name: 'String' - } - }, - stickyBit: { - required: false, - readOnly: true, - serializedName: 'stickyBit', - type: { - name: 'Boolean' - } - } - } - } - }; - } -} - -module.exports = AclStatus; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/aclStatusResult.js b/lib/services/dataLake.Store/lib/filesystem/models/aclStatusResult.js deleted file mode 100644 index 45076aa4ab..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/aclStatusResult.js +++ /dev/null @@ -1,62 +0,0 @@ -/* - * 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'; - -/** - * Data Lake Store file or directory Access Control List information. - * - */ -class AclStatusResult { - /** - * Create a AclStatusResult. - * @property {object} [aclStatus] the AclStatus object for a given file or - * directory. - * @property {array} [aclStatus.entries] the list of ACLSpec entries on a - * file or directory. - * @property {string} [aclStatus.group] the group owner, an AAD Object ID. - * @property {string} [aclStatus.owner] the user owner, an AAD Object ID. - * @property {string} [aclStatus.permission] The octal representation of the - * unnamed user, mask and other permissions. - * @property {boolean} [aclStatus.stickyBit] the indicator of whether the - * sticky bit is on or off. - */ - constructor() { - } - - /** - * Defines the metadata of AclStatusResult - * - * @returns {object} metadata of AclStatusResult - * - */ - mapper() { - return { - required: false, - serializedName: 'AclStatusResult', - type: { - name: 'Composite', - className: 'AclStatusResult', - modelProperties: { - aclStatus: { - required: false, - serializedName: 'aclStatus', - type: { - name: 'Composite', - className: 'AclStatus' - } - } - } - } - }; - } -} - -module.exports = AclStatusResult; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsAccessControlException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsAccessControlException.js deleted file mode 100644 index bd8dfb50b9..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsAccessControlException.js +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * A WebHDFS exception thrown indicating that access is denied due to - * insufficient permissions. Thrown when a 403 error response code is returned - * (forbidden). - * - * @extends models['AdlsRemoteException'] - */ -class AdlsAccessControlException extends models['AdlsRemoteException'] { - /** - * Create a AdlsAccessControlException. - */ - constructor() { - super(); - } - - /** - * Defines the metadata of AdlsAccessControlException - * - * @returns {object} metadata of AdlsAccessControlException - * - */ - mapper() { - return { - required: false, - serializedName: 'AccessControlException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsAccessControlException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsAccessControlException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsBadOffsetException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsBadOffsetException.js deleted file mode 100644 index b37a11a3bb..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsBadOffsetException.js +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * A WebHDFS exception thrown indicating the append or read is from a bad - * offset. Thrown when a 400 error response code is returned for append and - * open operations (Bad request). - * - * @extends models['AdlsRemoteException'] - */ -class AdlsBadOffsetException extends models['AdlsRemoteException'] { - /** - * Create a AdlsBadOffsetException. - */ - constructor() { - super(); - } - - /** - * Defines the metadata of AdlsBadOffsetException - * - * @returns {object} metadata of AdlsBadOffsetException - * - */ - mapper() { - return { - required: false, - serializedName: 'BadOffsetException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsBadOffsetException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsBadOffsetException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsError.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsError.js deleted file mode 100644 index afee6cdaca..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsError.js +++ /dev/null @@ -1,67 +0,0 @@ -/* - * 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'; - -/** - * Data Lake Store filesystem error containing a specific WebHDFS exception. - * - */ -class AdlsError { - /** - * Create a AdlsError. - * @property {object} [remoteException] the object representing the actual - * WebHDFS exception being returned. - * @property {string} [remoteException.javaClassName] the full class package - * name for the exception thrown, such as - * 'java.lang.IllegalArgumentException'. - * @property {string} [remoteException.message] the message associated with - * the exception that was thrown, such as 'Invalid value for webhdfs - * parameter "permission":...'. - * @property {string} [remoteException.exception] Polymorphic Discriminator - */ - constructor() { - } - - /** - * Defines the metadata of AdlsError - * - * @returns {object} metadata of AdlsError - * - */ - mapper() { - return { - required: false, - serializedName: 'AdlsError', - type: { - name: 'Composite', - className: 'AdlsError', - modelProperties: { - remoteException: { - required: false, - readOnly: true, - serializedName: 'remoteException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsRemoteException' - } - } - } - } - }; - } -} - -module.exports = AdlsError; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsFileAlreadyExistsException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsFileAlreadyExistsException.js deleted file mode 100644 index 322a120690..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsFileAlreadyExistsException.js +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * A WebHDFS exception thrown indicating the file or folder already exists. - * Thrown when a 403 error response code is returned (forbidden). - * - * @extends models['AdlsRemoteException'] - */ -class AdlsFileAlreadyExistsException extends models['AdlsRemoteException'] { - /** - * Create a AdlsFileAlreadyExistsException. - */ - constructor() { - super(); - } - - /** - * Defines the metadata of AdlsFileAlreadyExistsException - * - * @returns {object} metadata of AdlsFileAlreadyExistsException - * - */ - mapper() { - return { - required: false, - serializedName: 'FileAlreadyExistsException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsFileAlreadyExistsException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsFileAlreadyExistsException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsFileNotFoundException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsFileNotFoundException.js deleted file mode 100644 index fc7dedb0b7..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsFileNotFoundException.js +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * A WebHDFS exception thrown indicating the file or folder could not be found. - * Thrown when a 404 error response code is returned (not found). - * - * @extends models['AdlsRemoteException'] - */ -class AdlsFileNotFoundException extends models['AdlsRemoteException'] { - /** - * Create a AdlsFileNotFoundException. - */ - constructor() { - super(); - } - - /** - * Defines the metadata of AdlsFileNotFoundException - * - * @returns {object} metadata of AdlsFileNotFoundException - * - */ - mapper() { - return { - required: false, - serializedName: 'FileNotFoundException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsFileNotFoundException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsFileNotFoundException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsIOException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsIOException.js deleted file mode 100644 index 144d991c95..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsIOException.js +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * A WebHDFS exception thrown indicating there was an IO (read or write) error. - * Thrown when a 403 error response code is returned (forbidden). - * - * @extends models['AdlsRemoteException'] - */ -class AdlsIOException extends models['AdlsRemoteException'] { - /** - * Create a AdlsIOException. - */ - constructor() { - super(); - } - - /** - * Defines the metadata of AdlsIOException - * - * @returns {object} metadata of AdlsIOException - * - */ - mapper() { - return { - required: false, - serializedName: 'IOException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsIOException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsIOException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsIllegalArgumentException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsIllegalArgumentException.js deleted file mode 100644 index 3487ead2f7..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsIllegalArgumentException.js +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * A WebHDFS exception thrown indicating that one more arguments is incorrect. - * Thrown when a 400 error response code is returned (bad request). - * - * @extends models['AdlsRemoteException'] - */ -class AdlsIllegalArgumentException extends models['AdlsRemoteException'] { - /** - * Create a AdlsIllegalArgumentException. - */ - constructor() { - super(); - } - - /** - * Defines the metadata of AdlsIllegalArgumentException - * - * @returns {object} metadata of AdlsIllegalArgumentException - * - */ - mapper() { - return { - required: false, - serializedName: 'IllegalArgumentException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsIllegalArgumentException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsIllegalArgumentException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsRemoteException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsRemoteException.js deleted file mode 100644 index 63bc60d088..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsRemoteException.js +++ /dev/null @@ -1,80 +0,0 @@ -/* - * 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'; - -/** - * Data Lake Store filesystem exception based on the WebHDFS definition for - * RemoteExceptions. This is a WebHDFS 'catch all' exception - * - */ -class AdlsRemoteException { - /** - * Create a AdlsRemoteException. - * @property {string} [javaClassName] the full class package name for the - * exception thrown, such as 'java.lang.IllegalArgumentException'. - * @property {string} [message] the message associated with the exception - * that was thrown, such as 'Invalid value for webhdfs parameter - * "permission":...'. - * @property {string} exception Polymorphic Discriminator - */ - constructor() { - } - - /** - * Defines the metadata of AdlsRemoteException - * - * @returns {object} metadata of AdlsRemoteException - * - */ - mapper() { - return { - required: false, - serializedName: 'AdlsRemoteException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsRemoteException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsRemoteException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsRuntimeException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsRuntimeException.js deleted file mode 100644 index fa925f17ec..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsRuntimeException.js +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * A WebHDFS exception thrown when an unexpected error occurs during an - * operation. Thrown when a 500 error response code is returned (Internal - * server error). - * - * @extends models['AdlsRemoteException'] - */ -class AdlsRuntimeException extends models['AdlsRemoteException'] { - /** - * Create a AdlsRuntimeException. - */ - constructor() { - super(); - } - - /** - * Defines the metadata of AdlsRuntimeException - * - * @returns {object} metadata of AdlsRuntimeException - * - */ - mapper() { - return { - required: false, - serializedName: 'RuntimeException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsRuntimeException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsRuntimeException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsSecurityException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsSecurityException.js deleted file mode 100644 index 7bef0f8275..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsSecurityException.js +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * A WebHDFS exception thrown indicating that access is denied. Thrown when a - * 401 error response code is returned (Unauthorized). - * - * @extends models['AdlsRemoteException'] - */ -class AdlsSecurityException extends models['AdlsRemoteException'] { - /** - * Create a AdlsSecurityException. - */ - constructor() { - super(); - } - - /** - * Defines the metadata of AdlsSecurityException - * - * @returns {object} metadata of AdlsSecurityException - * - */ - mapper() { - return { - required: false, - serializedName: 'SecurityException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsSecurityException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsSecurityException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsThrottledException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsThrottledException.js deleted file mode 100644 index f06eca6765..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsThrottledException.js +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * A WebHDFS exception thrown indicating that the request is being throttled. - * Reducing the number of requests or request size helps to mitigate this - * error. - * - * @extends models['AdlsRemoteException'] - */ -class AdlsThrottledException extends models['AdlsRemoteException'] { - /** - * Create a AdlsThrottledException. - */ - constructor() { - super(); - } - - /** - * Defines the metadata of AdlsThrottledException - * - * @returns {object} metadata of AdlsThrottledException - * - */ - mapper() { - return { - required: false, - serializedName: 'ThrottledException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsThrottledException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsThrottledException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/adlsUnsupportedOperationException.js b/lib/services/dataLake.Store/lib/filesystem/models/adlsUnsupportedOperationException.js deleted file mode 100644 index 9bedfacb32..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/adlsUnsupportedOperationException.js +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const models = require('./index'); - -/** - * A WebHDFS exception thrown indicating that the requested operation is not - * supported. Thrown when a 400 error response code is returned (bad request). - * - * @extends models['AdlsRemoteException'] - */ -class AdlsUnsupportedOperationException extends models['AdlsRemoteException'] { - /** - * Create a AdlsUnsupportedOperationException. - */ - constructor() { - super(); - } - - /** - * Defines the metadata of AdlsUnsupportedOperationException - * - * @returns {object} metadata of AdlsUnsupportedOperationException - * - */ - mapper() { - return { - required: false, - serializedName: 'UnsupportedOperationException', - type: { - name: 'Composite', - polymorphicDiscriminator: { - serializedName: 'exception', - clientName: 'exception' - }, - uberParent: 'AdlsRemoteException', - className: 'AdlsUnsupportedOperationException', - modelProperties: { - javaClassName: { - required: false, - readOnly: true, - serializedName: 'javaClassName', - type: { - name: 'String' - } - }, - message: { - required: false, - readOnly: true, - serializedName: 'message', - type: { - name: 'String' - } - }, - exception: { - required: true, - serializedName: 'exception', - isPolymorphicDiscriminator: true, - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = AdlsUnsupportedOperationException; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/contentSummaryResult.js b/lib/services/dataLake.Store/lib/filesystem/models/contentSummaryResult.js deleted file mode 100644 index 33569c05d6..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/contentSummaryResult.js +++ /dev/null @@ -1,62 +0,0 @@ -/* - * 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'; - -/** - * Data Lake Store filesystem content summary information response. - * - */ -class ContentSummaryResult { - /** - * Create a ContentSummaryResult. - * @property {object} [contentSummary] the content summary for the specified - * path - * @property {number} [contentSummary.directoryCount] the number of - * directories. - * @property {number} [contentSummary.fileCount] the number of files. - * @property {number} [contentSummary.length] the number of bytes used by the - * content. - * @property {number} [contentSummary.spaceConsumed] the disk space consumed - * by the content. - */ - constructor() { - } - - /** - * Defines the metadata of ContentSummaryResult - * - * @returns {object} metadata of ContentSummaryResult - * - */ - mapper() { - return { - required: false, - serializedName: 'ContentSummaryResult', - type: { - name: 'Composite', - className: 'ContentSummaryResult', - modelProperties: { - contentSummary: { - required: false, - readOnly: true, - serializedName: 'contentSummary', - type: { - name: 'Composite', - className: 'ContentSummary' - } - } - } - } - }; - } -} - -module.exports = ContentSummaryResult; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/fileStatusProperties.js b/lib/services/dataLake.Store/lib/filesystem/models/fileStatusProperties.js deleted file mode 100644 index 73fed29d22..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/fileStatusProperties.js +++ /dev/null @@ -1,149 +0,0 @@ -/* - * 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'; - -/** - * Data Lake Store file or directory information. - * - */ -class FileStatusProperties { - /** - * Create a FileStatusProperties. - * @property {number} [accessTime] the last access time as ticks since the - * epoch. - * @property {number} [blockSize] the block size for the file. - * @property {number} [expirationTime] Gets the expiration time, if any, as - * ticks since the epoch. If the value is 0 or DateTime.MaxValue there is no - * expiration. - * @property {string} [group] the group owner. - * @property {number} [length] the number of bytes in a file. - * @property {number} [modificationTime] the modification time as ticks since - * the epoch. - * @property {string} [owner] the user who is the owner. - * @property {string} [pathSuffix] the path suffix. - * @property {string} [permission] the permission represented as an string. - * @property {string} [type] the type of the path object. Possible values - * include: 'FILE', 'DIRECTORY' - * @property {boolean} [aclBit] flag to indicate if extended acls are enabled - */ - constructor() { - } - - /** - * Defines the metadata of FileStatusProperties - * - * @returns {object} metadata of FileStatusProperties - * - */ - mapper() { - return { - required: false, - serializedName: 'FileStatusProperties', - type: { - name: 'Composite', - className: 'FileStatusProperties', - modelProperties: { - accessTime: { - required: false, - readOnly: true, - serializedName: 'accessTime', - type: { - name: 'Number' - } - }, - blockSize: { - required: false, - readOnly: true, - serializedName: 'blockSize', - type: { - name: 'Number' - } - }, - expirationTime: { - required: false, - readOnly: true, - serializedName: 'msExpirationTime', - type: { - name: 'Number' - } - }, - group: { - required: false, - readOnly: true, - serializedName: 'group', - type: { - name: 'String' - } - }, - length: { - required: false, - readOnly: true, - serializedName: 'length', - type: { - name: 'Number' - } - }, - modificationTime: { - required: false, - readOnly: true, - serializedName: 'modificationTime', - type: { - name: 'Number' - } - }, - owner: { - required: false, - readOnly: true, - serializedName: 'owner', - type: { - name: 'String' - } - }, - pathSuffix: { - required: false, - readOnly: true, - serializedName: 'pathSuffix', - type: { - name: 'String' - } - }, - permission: { - required: false, - readOnly: true, - serializedName: 'permission', - type: { - name: 'String' - } - }, - type: { - required: false, - readOnly: true, - serializedName: 'type', - type: { - name: 'Enum', - allowedValues: [ 'FILE', 'DIRECTORY' ] - } - }, - aclBit: { - required: false, - readOnly: true, - serializedName: 'aclBit', - type: { - name: 'Boolean' - } - } - } - } - }; - } -} - -module.exports = FileStatusProperties; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/fileStatusResult.js b/lib/services/dataLake.Store/lib/filesystem/models/fileStatusResult.js deleted file mode 100644 index 5940e4c7a8..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/fileStatusResult.js +++ /dev/null @@ -1,73 +0,0 @@ -/* - * 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'; - -/** - * Data Lake Store filesystem file status information response. - * - */ -class FileStatusResult { - /** - * Create a FileStatusResult. - * @property {object} [fileStatus] the file status object associated with the - * specified path. - * @property {number} [fileStatus.accessTime] the last access time as ticks - * since the epoch. - * @property {number} [fileStatus.blockSize] the block size for the file. - * @property {number} [fileStatus.expirationTime] Gets the expiration time, - * if any, as ticks since the epoch. If the value is 0 or DateTime.MaxValue - * there is no expiration. - * @property {string} [fileStatus.group] the group owner. - * @property {number} [fileStatus.length] the number of bytes in a file. - * @property {number} [fileStatus.modificationTime] the modification time as - * ticks since the epoch. - * @property {string} [fileStatus.owner] the user who is the owner. - * @property {string} [fileStatus.pathSuffix] the path suffix. - * @property {string} [fileStatus.permission] the permission represented as - * an string. - * @property {string} [fileStatus.type] the type of the path object. Possible - * values include: 'FILE', 'DIRECTORY' - * @property {boolean} [fileStatus.aclBit] flag to indicate if extended acls - * are enabled - */ - constructor() { - } - - /** - * Defines the metadata of FileStatusResult - * - * @returns {object} metadata of FileStatusResult - * - */ - mapper() { - return { - required: false, - serializedName: 'FileStatusResult', - type: { - name: 'Composite', - className: 'FileStatusResult', - modelProperties: { - fileStatus: { - required: false, - readOnly: true, - serializedName: 'fileStatus', - type: { - name: 'Composite', - className: 'FileStatusProperties' - } - } - } - } - }; - } -} - -module.exports = FileStatusResult; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/fileStatusesResult.js b/lib/services/dataLake.Store/lib/filesystem/models/fileStatusesResult.js deleted file mode 100644 index bff868c5f7..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/fileStatusesResult.js +++ /dev/null @@ -1,57 +0,0 @@ -/* - * 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'; - -/** - * Data Lake Store filesystem file status list information response. - * - */ -class FileStatusesResult { - /** - * Create a FileStatusesResult. - * @property {object} [fileStatuses] the object representing the list of file - * statuses. - * @property {array} [fileStatuses.fileStatus] the object containing the list - * of properties of the files. - */ - constructor() { - } - - /** - * Defines the metadata of FileStatusesResult - * - * @returns {object} metadata of FileStatusesResult - * - */ - mapper() { - return { - required: false, - serializedName: 'FileStatusesResult', - type: { - name: 'Composite', - className: 'FileStatusesResult', - modelProperties: { - fileStatuses: { - required: false, - readOnly: true, - serializedName: 'fileStatuses', - type: { - name: 'Composite', - className: 'FileStatuses' - } - } - } - } - }; - } -} - -module.exports = FileStatusesResult; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/index.d.ts b/lib/services/dataLake.Store/lib/filesystem/models/index.d.ts deleted file mode 100644 index 2055076f20..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/index.d.ts +++ /dev/null @@ -1,276 +0,0 @@ -/* - * 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. - */ - -import { BaseResource, CloudError } from "ms-rest-azure"; -import * as moment from "moment"; - -export { - - BaseResource, - CloudError -}; - -/** - * The result of the request or operation. - */ -export interface FileOperationResult { - /** - * the result of the operation or request. - */ - readonly operationResult?: boolean; -} - -/** - * Data Lake Store file or directory Access Control List information. - */ -export interface AclStatus { - /** - * the list of ACLSpec entries on a file or directory. - */ - entries?: string[]; - /** - * the group owner, an AAD Object ID. - */ - group?: string; - /** - * the user owner, an AAD Object ID. - */ - owner?: string; - /** - * The octal representation of the unnamed user, mask and other permissions. - */ - permission?: string; - /** - * the indicator of whether the sticky bit is on or off. - */ - readonly stickyBit?: boolean; -} - -/** - * Data Lake Store file or directory Access Control List information. - */ -export interface AclStatusResult { - /** - * the AclStatus object for a given file or directory. - */ - aclStatus?: AclStatus; -} - -/** - * Data Lake Store content summary information - */ -export interface ContentSummary { - /** - * the number of directories. - */ - readonly directoryCount?: number; - /** - * the number of files. - */ - readonly fileCount?: number; - /** - * the number of bytes used by the content. - */ - readonly length?: number; - /** - * the disk space consumed by the content. - */ - readonly spaceConsumed?: number; -} - -/** - * Data Lake Store filesystem content summary information response. - */ -export interface ContentSummaryResult { - /** - * the content summary for the specified path - */ - readonly contentSummary?: ContentSummary; -} - -/** - * Data Lake Store file or directory information. - */ -export interface FileStatusProperties { - /** - * the last access time as ticks since the epoch. - */ - readonly accessTime?: number; - /** - * the block size for the file. - */ - readonly blockSize?: number; - /** - * Gets the expiration time, if any, as ticks since the epoch. If the value is 0 or - * DateTime.MaxValue there is no expiration. - */ - readonly expirationTime?: number; - /** - * the group owner. - */ - readonly group?: string; - /** - * the number of bytes in a file. - */ - readonly length?: number; - /** - * the modification time as ticks since the epoch. - */ - readonly modificationTime?: number; - /** - * the user who is the owner. - */ - readonly owner?: string; - /** - * the path suffix. - */ - readonly pathSuffix?: string; - /** - * the permission represented as an string. - */ - readonly permission?: string; - /** - * the type of the path object. Possible values include: 'FILE', 'DIRECTORY' - */ - readonly type?: string; - /** - * flag to indicate if extended acls are enabled - */ - readonly aclBit?: boolean; -} - -/** - * Data Lake Store file status list information. - */ -export interface FileStatuses { - /** - * the object containing the list of properties of the files. - */ - readonly fileStatus?: FileStatusProperties[]; -} - -/** - * Data Lake Store filesystem file status list information response. - */ -export interface FileStatusesResult { - /** - * the object representing the list of file statuses. - */ - readonly fileStatuses?: FileStatuses; -} - -/** - * Data Lake Store filesystem file status information response. - */ -export interface FileStatusResult { - /** - * the file status object associated with the specified path. - */ - readonly fileStatus?: FileStatusProperties; -} - -/** - * Data Lake Store filesystem exception based on the WebHDFS definition for RemoteExceptions. This - * is a WebHDFS 'catch all' exception - */ -export interface AdlsRemoteException { - /** - * the full class package name for the exception thrown, such as - * 'java.lang.IllegalArgumentException'. - */ - readonly javaClassName?: string; - /** - * the message associated with the exception that was thrown, such as 'Invalid value for webhdfs - * parameter "permission":...'. - */ - readonly message?: string; - /** - * Polymorphic Discriminator - */ - exception: string; -} - -/** - * A WebHDFS exception thrown indicating that one more arguments is incorrect. Thrown when a 400 - * error response code is returned (bad request). - */ -export interface AdlsIllegalArgumentException extends AdlsRemoteException { -} - -/** - * A WebHDFS exception thrown indicating that the requested operation is not supported. Thrown when - * a 400 error response code is returned (bad request). - */ -export interface AdlsUnsupportedOperationException extends AdlsRemoteException { -} - -/** - * A WebHDFS exception thrown indicating that access is denied. Thrown when a 401 error response - * code is returned (Unauthorized). - */ -export interface AdlsSecurityException extends AdlsRemoteException { -} - -/** - * A WebHDFS exception thrown indicating there was an IO (read or write) error. Thrown when a 403 - * error response code is returned (forbidden). - */ -export interface AdlsIOException extends AdlsRemoteException { -} - -/** - * A WebHDFS exception thrown indicating the file or folder could not be found. Thrown when a 404 - * error response code is returned (not found). - */ -export interface AdlsFileNotFoundException extends AdlsRemoteException { -} - -/** - * A WebHDFS exception thrown indicating the file or folder already exists. Thrown when a 403 error - * response code is returned (forbidden). - */ -export interface AdlsFileAlreadyExistsException extends AdlsRemoteException { -} - -/** - * A WebHDFS exception thrown indicating the append or read is from a bad offset. Thrown when a 400 - * error response code is returned for append and open operations (Bad request). - */ -export interface AdlsBadOffsetException extends AdlsRemoteException { -} - -/** - * A WebHDFS exception thrown when an unexpected error occurs during an operation. Thrown when a - * 500 error response code is returned (Internal server error). - */ -export interface AdlsRuntimeException extends AdlsRemoteException { -} - -/** - * A WebHDFS exception thrown indicating that access is denied due to insufficient permissions. - * Thrown when a 403 error response code is returned (forbidden). - */ -export interface AdlsAccessControlException extends AdlsRemoteException { -} - -/** - * A WebHDFS exception thrown indicating that the request is being throttled. Reducing the number - * of requests or request size helps to mitigate this error. - */ -export interface AdlsThrottledException extends AdlsRemoteException { -} - -/** - * Data Lake Store filesystem error containing a specific WebHDFS exception. - */ -export interface AdlsError { - /** - * the object representing the actual WebHDFS exception being returned. - */ - readonly remoteException?: AdlsRemoteException; -} diff --git a/lib/services/dataLake.Store/lib/filesystem/models/index.js b/lib/services/dataLake.Store/lib/filesystem/models/index.js deleted file mode 100644 index 010fcdf236..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/models/index.js +++ /dev/null @@ -1,54 +0,0 @@ -/* - * 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. - */ - -/* jshint latedef:false */ -/* jshint forin:false */ -/* jshint noempty:false */ - -'use strict'; - -var msRestAzure = require('ms-rest-azure'); - -exports.BaseResource = msRestAzure.BaseResource; -exports.CloudError = msRestAzure.CloudError; -exports.FileOperationResult = require('./fileOperationResult'); -exports.AclStatus = require('./aclStatus'); -exports.AclStatusResult = require('./aclStatusResult'); -exports.ContentSummary = require('./contentSummary'); -exports.ContentSummaryResult = require('./contentSummaryResult'); -exports.FileStatusProperties = require('./fileStatusProperties'); -exports.FileStatuses = require('./fileStatuses'); -exports.FileStatusesResult = require('./fileStatusesResult'); -exports.FileStatusResult = require('./fileStatusResult'); -exports.AdlsRemoteException = require('./adlsRemoteException'); -exports.AdlsIllegalArgumentException = require('./adlsIllegalArgumentException'); -exports.AdlsUnsupportedOperationException = require('./adlsUnsupportedOperationException'); -exports.AdlsSecurityException = require('./adlsSecurityException'); -exports.AdlsIOException = require('./adlsIOException'); -exports.AdlsFileNotFoundException = require('./adlsFileNotFoundException'); -exports.AdlsFileAlreadyExistsException = require('./adlsFileAlreadyExistsException'); -exports.AdlsBadOffsetException = require('./adlsBadOffsetException'); -exports.AdlsRuntimeException = require('./adlsRuntimeException'); -exports.AdlsAccessControlException = require('./adlsAccessControlException'); -exports.AdlsThrottledException = require('./adlsThrottledException'); -exports.AdlsError = require('./adlsError'); -exports.discriminators = { - 'AdlsRemoteException.IllegalArgumentException' : exports.AdlsIllegalArgumentException, - 'AdlsRemoteException.UnsupportedOperationException' : exports.AdlsUnsupportedOperationException, - 'AdlsRemoteException.SecurityException' : exports.AdlsSecurityException, - 'AdlsRemoteException.IOException' : exports.AdlsIOException, - 'AdlsRemoteException.FileNotFoundException' : exports.AdlsFileNotFoundException, - 'AdlsRemoteException.FileAlreadyExistsException' : exports.AdlsFileAlreadyExistsException, - 'AdlsRemoteException.BadOffsetException' : exports.AdlsBadOffsetException, - 'AdlsRemoteException.RuntimeException' : exports.AdlsRuntimeException, - 'AdlsRemoteException.AccessControlException' : exports.AdlsAccessControlException, - 'AdlsRemoteException.ThrottledException' : exports.AdlsThrottledException, - 'AdlsRemoteException' : exports.AdlsRemoteException -}; diff --git a/lib/services/dataLake.Store/lib/filesystem/operations/fileSystem.js b/lib/services/dataLake.Store/lib/filesystem/operations/fileSystem.js deleted file mode 100644 index 2d288d3dc7..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/operations/fileSystem.js +++ /dev/null @@ -1,5855 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. - */ - -'use strict'; - -const msRest = require('ms-rest'); -const msRestAzure = require('ms-rest-azure'); -const WebResource = msRest.WebResource; - -/** - * Sets or removes the expiration time on the specified file. This operation - * can only be executed against files. Folders are not supported. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file on which to set or remove the expiration time. - * - * @param {string} expiryOption Indicates the type of expiration to use for the - * file: 1. NeverExpire: ExpireTime is ignored. 2. RelativeToNow: ExpireTime is - * an integer in milliseconds representing the expiration date relative to when - * file expiration is updated. 3. RelativeToCreationDate: ExpireTime is an - * integer in milliseconds representing the expiration date relative to file - * creation. 4. Absolute: ExpireTime is an integer in milliseconds, as a Unix - * timestamp relative to 1/1/1970 00:00:00. Possible values include: - * 'NeverExpire', 'RelativeToNow', 'RelativeToCreationDate', 'Absolute' - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.expireTime] The time that the file will expire, - * corresponding to the ExpiryOption that was set. - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _setFileExpiry(accountName, path, expiryOption, 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.'); - } - let expireTime = (options && options.expireTime !== undefined) ? options.expireTime : undefined; - let op = 'SETEXPIRY'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (expiryOption) { - let allowedValues = [ 'NeverExpire', 'RelativeToNow', 'RelativeToCreationDate', 'Absolute' ]; - if (!allowedValues.some( function(item) { return item === expiryOption; })) { - throw new Error(expiryOption + ' is not a valid value. The valid values are: ' + allowedValues); - } - } else { - throw new Error('expiryOption cannot be null or undefined.'); - } - if (expireTime !== null && expireTime !== undefined && typeof expireTime !== 'number') { - throw new Error('expireTime must be of type number.'); - } - 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 (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('/') ? '' : '/') + 'WebHdfsExt/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - queryParameters.push('expiryOption=' + encodeURIComponent(expiryOption)); - if (expireTime !== null && expireTime !== undefined) { - queryParameters.push('expireTime=' + encodeURIComponent(expireTime.toString())); - } - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Appends to the specified file, optionally first creating the file if it does - * not yet exist. This method supports multiple concurrent appends to the file. - * NOTE: The target must not contain data added by Create or normal (serial) - * Append. ConcurrentAppend and Append cannot be used interchangeably; once a - * target file has been modified using either of these append options, the - * other append option cannot be used on the target file. ConcurrentAppend does - * not guarantee order and can result in duplicated data landing in the target - * file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to which to append using concurrent append. - * - * @param {object} streamContents The file contents to include when appending - * to the file. The maximum content size is 4MB. For content larger than 4MB - * you must append the content in 4MB chunks. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.appendMode] Indicates the concurrent append call - * should create the file if it doesn't exist or just open the existing file - * for append. Possible values include: 'autocreate' - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the concurrent append. DATA indicates that more data will be - * sent immediately by the client, the file handle should remain open/locked, - * and file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _concurrentAppend(accountName, path, streamContents, 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.'); - } - let appendMode = (options && options.appendMode !== undefined) ? options.appendMode : undefined; - let syncFlag = (options && options.syncFlag !== undefined) ? options.syncFlag : 'DATA'; - let op = 'CONCURRENTAPPEND'; - let transferEncoding = 'chunked'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (streamContents === null || streamContents === undefined) { - throw new Error('streamContents cannot be null or undefined and it must be of type object.'); - } - if (appendMode) { - let allowedValues = [ 'autocreate' ]; - if (!allowedValues.some( function(item) { return item === appendMode; })) { - throw new Error(appendMode + ' is not a valid value. The valid values are: ' + allowedValues); - } - } - if (syncFlag) { - let allowedValues1 = [ 'DATA', 'METADATA', 'CLOSE' ]; - if (!allowedValues1.some( function(item) { return item === syncFlag; })) { - throw new Error(syncFlag + ' is not a valid value. The valid values are: ' + allowedValues1); - } - } - 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 (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('/') ? '' : '/') + 'WebHdfsExt/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (appendMode !== null && appendMode !== undefined) { - queryParameters.push('appendMode=' + encodeURIComponent(appendMode)); - } - queryParameters.push('op=' + encodeURIComponent(op)); - if (syncFlag !== null && syncFlag !== undefined) { - queryParameters.push('syncFlag=' + encodeURIComponent(syncFlag)); - } - 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/octet-stream'; - if (this.client.generateClientRequestId) { - httpRequest.headers['x-ms-client-request-id'] = msRestAzure.generateUuid(); - } - if (transferEncoding !== undefined && transferEncoding !== null) { - httpRequest.headers['Transfer-Encoding'] = transferEncoding; - } - 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 = streamContents; - 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Checks if the specified access is available at the given path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to check access. - * - * @param {string} fsaction File system operation read/write/execute in string - * form, matching regex pattern '[rwx-]{3}' - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _checkAccess(accountName, path, fsaction, 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.'); - } - let op = 'CHECKACCESS'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (fsaction === null || fsaction === undefined || typeof fsaction.valueOf() !== 'string') { - throw new Error('fsaction cannot be null or undefined and it must be of type string.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - queryParameters.push('fsaction=' + encodeURIComponent(fsaction)); - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'GET'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Creates a directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory to create. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.permission] Optional octal permission with which - * the directory should be created. - * - * @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 FileOperationResult} 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 _mkdirs(accountName, path, 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.'); - } - let permission = (options && options.permission !== undefined) ? options.permission : undefined; - let op = 'MKDIRS'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (permission !== null && permission !== undefined && typeof permission !== 'number') { - throw new Error('permission must be of type number.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (permission !== null && permission !== undefined) { - queryParameters.push('permission=' + encodeURIComponent(permission.toString())); - } - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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['FileOperationResult']().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); - }); -} - -/** - * Concatenates the list of source files into the destination file, removing - * all source files upon success. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * destination file resulting from the concatenation. - * - * @param {array} sources A list of comma separated Data Lake Store paths - * (starting with '/') of the files to concatenate, in the order in which they - * should be concatenated. - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _concat(accountName, path, sources, 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.'); - } - let op = 'CONCAT'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (!Array.isArray(sources)) { - throw new Error('sources cannot be null or undefined and it must be of type array.'); - } - for (let i = 0; i < sources.length; i++) { - if (sources[i] !== null && sources[i] !== undefined && typeof sources[i].valueOf() !== 'string') { - throw new Error('sources[i] must be of type string.'); - } - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - queryParameters.push('sources=' + encodeURIComponent(sources.join(','))); - queryParameters.push('op=' + encodeURIComponent(op)); - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Concatenates the list of source files into the destination file, deleting - * all source files upon success. This method accepts more source file paths - * than the Concat method. This method and the parameters it accepts are - * subject to change for usability in an upcoming version. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * destination file resulting from the concatenation. - * - * @param {object} streamContents A list of Data Lake Store paths (starting - * with '/') of the source files. Must be a comma-separated path list in the - * format: sources=/file/path/1.txt,/file/path/2.txt,/file/path/lastfile.csv - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.deleteSourceDirectory] Indicates that as an - * optimization instead of deleting each individual source stream, delete the - * source stream folder if all streams are in the same folder instead. This - * results in a substantial performance improvement when the only streams in - * the folder are part of the concatenation operation. WARNING: This includes - * the deletion of any other files that are not source files. Only set this to - * true when source files are the only files in the source directory. - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _msConcat(accountName, path, streamContents, 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.'); - } - let deleteSourceDirectory = (options && options.deleteSourceDirectory !== undefined) ? options.deleteSourceDirectory : undefined; - let op = 'MSCONCAT'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (deleteSourceDirectory !== null && deleteSourceDirectory !== undefined && typeof deleteSourceDirectory !== 'boolean') { - throw new Error('deleteSourceDirectory must be of type boolean.'); - } - if (streamContents === null || streamContents === undefined) { - throw new Error('streamContents cannot be null or undefined and it must be of type object.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (deleteSourceDirectory !== null && deleteSourceDirectory !== undefined) { - queryParameters.push('deleteSourceDirectory=' + encodeURIComponent(deleteSourceDirectory.toString())); - } - queryParameters.push('op=' + encodeURIComponent(op)); - 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/octet-stream'; - 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 = streamContents; - 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Get the list of file status objects specified by the file path, with - * optional pagination parameters - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory to list. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.listSize] Gets or sets the number of items to - * return. Optional. - * - * @param {string} [options.listAfter] Gets or sets the item or lexographical - * index after which to begin returning results. For example, a file list of - * 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also - * return 'd'. Optional. - * - * @param {string} [options.listBefore] Gets or sets the item or lexographical - * index before which to begin returning results. For example, a file list of - * 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' - * will also return 'a','b'. Optional. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of owner and group. tooid=false returns friendly names instead of - * the AAD Object ID. Default value is true, returning AAD object IDs. - * - * @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 FileStatusesResult} 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 _listFileStatus(accountName, path, 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.'); - } - let listSize = (options && options.listSize !== undefined) ? options.listSize : undefined; - let listAfter = (options && options.listAfter !== undefined) ? options.listAfter : undefined; - let listBefore = (options && options.listBefore !== undefined) ? options.listBefore : undefined; - let tooId = (options && options.tooId !== undefined) ? options.tooId : undefined; - let op = 'LISTSTATUS'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (listSize !== null && listSize !== undefined && typeof listSize !== 'number') { - throw new Error('listSize must be of type number.'); - } - if (listAfter !== null && listAfter !== undefined && typeof listAfter.valueOf() !== 'string') { - throw new Error('listAfter must be of type string.'); - } - if (listBefore !== null && listBefore !== undefined && typeof listBefore.valueOf() !== 'string') { - throw new Error('listBefore must be of type string.'); - } - if (tooId !== null && tooId !== undefined && typeof tooId !== 'boolean') { - throw new Error('tooId must be of type boolean.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (listSize !== null && listSize !== undefined) { - queryParameters.push('listSize=' + encodeURIComponent(listSize.toString())); - } - if (listAfter !== null && listAfter !== undefined) { - queryParameters.push('listAfter=' + encodeURIComponent(listAfter)); - } - if (listBefore !== null && listBefore !== undefined) { - queryParameters.push('listBefore=' + encodeURIComponent(listBefore)); - } - if (tooId !== null && tooId !== undefined) { - queryParameters.push('tooId=' + encodeURIComponent(tooId.toString())); - } - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'GET'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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['FileStatusesResult']().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); - }); -} - -/** - * Gets the file content summary object specified by the file path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file for which to retrieve the summary. - * - * @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 ContentSummaryResult} 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 _getContentSummary(accountName, path, 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.'); - } - let op = 'GETCONTENTSUMMARY'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'GET'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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['ContentSummaryResult']().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); - }); -} - -/** - * Get the file status object specified by the file path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to retrieve the status. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of owner and group. tooid=false returns friendly names instead of - * the AAD Object ID. Default value is true, returning AAD object IDs. - * - * @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 FileStatusResult} 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 _getFileStatus(accountName, path, 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.'); - } - let tooId = (options && options.tooId !== undefined) ? options.tooId : undefined; - let op = 'GETFILESTATUS'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (tooId !== null && tooId !== undefined && typeof tooId !== 'boolean') { - throw new Error('tooId must be of type boolean.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (tooId !== null && tooId !== undefined) { - queryParameters.push('tooId=' + encodeURIComponent(tooId.toString())); - } - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'GET'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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['FileStatusResult']().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); - }); -} - -/** - * Opens and reads from the specified file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to open. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.length] The number of bytes that the server will - * attempt to retrieve. It will retrieve <= length bytes. - * - * @param {number} [options.offset] The byte offset to start reading data from. - * - * @param {uuid} [options.fileSessionId] Optional unique GUID per file - * indicating all the reads with the same fileSessionId are from the same - * client and same session. This will give a performance benefit. - * - * @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. - * - * {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 _open(accountName, path, 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.'); - } - let length = (options && options.length !== undefined) ? options.length : undefined; - let offset = (options && options.offset !== undefined) ? options.offset : undefined; - let fileSessionId = (options && options.fileSessionId !== undefined) ? options.fileSessionId : undefined; - let read = 'true'; - let op = 'OPEN'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (length !== null && length !== undefined && typeof length !== 'number') { - throw new Error('length must be of type number.'); - } - if (offset !== null && offset !== undefined && typeof offset !== 'number') { - throw new Error('offset must be of type number.'); - } - if (fileSessionId !== null && fileSessionId !== undefined && !(typeof fileSessionId.valueOf() === 'string' && msRest.isValidUuid(fileSessionId))) { - throw new Error('fileSessionId must be of type string and must be a valid uuid.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (length !== null && length !== undefined) { - queryParameters.push('length=' + encodeURIComponent(length.toString())); - } - if (offset !== null && offset !== undefined) { - queryParameters.push('offset=' + encodeURIComponent(offset.toString())); - } - if (fileSessionId !== null && fileSessionId !== undefined) { - queryParameters.push('fileSessionId=' + encodeURIComponent(fileSessionId.toString())); - } - queryParameters.push('read=' + encodeURIComponent(read)); - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'GET'; - 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]; - } - } - } - httpRequest.body = null; - // Send Request - httpRequest.streamedResponse = true; - return client.pipeline(httpRequest, (err, response, responseBody) => { - if (err) { - return callback(err); - } - - let statusCode = response.statusCode; - if (statusCode !== 200) { - let error = new Error(`Unexpected status code: ${statusCode}`); - error.statusCode = response.statusCode; - error.request = msRest.stripRequest(httpRequest); - error.response = msRest.stripResponse(response); - if (responseBody === '') responseBody = null; - let parsedErrorResponse; - try { - if (responseBody !== undefined) 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 = response; - return callback(null, result, httpRequest, response); - }); -} - -/** - * Used for serial appends to the specified file. NOTE: The target must not - * contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot - * be used interchangeably; once a target file has been modified using either - * of these append options, the other append option cannot be used on the - * target file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to which to append. - * - * @param {object} streamContents The file contents to include when appending - * to the file. The maximum content size is 4MB. For content larger than 4MB - * you must append the content in 4MB chunks. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.offset] The optional offset in the stream to begin - * the append operation. Default is to append at the end of the stream. - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the concurrent append. DATA indicates that more data will be - * sent immediately by the client, the file handle should remain open/locked, - * and file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure - * single writer semantics, meaning that only clients that append to the file - * with the same leaseId will be allowed to do so. - * - * @param {uuid} [options.fileSessionId] Optional unique GUID per file - * indicating all the appends with the same fileSessionId are from the same - * client and same session. This will give a performance benefit when syncFlag - * is DATA or METADATA. - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _append(accountName, path, streamContents, 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.'); - } - let offset = (options && options.offset !== undefined) ? options.offset : undefined; - let syncFlag = (options && options.syncFlag !== undefined) ? options.syncFlag : 'CLOSE'; - let leaseId = (options && options.leaseId !== undefined) ? options.leaseId : undefined; - let fileSessionId = (options && options.fileSessionId !== undefined) ? options.fileSessionId : undefined; - let appendParameter = 'true'; - let op = 'APPEND'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (streamContents === null || streamContents === undefined) { - throw new Error('streamContents cannot be null or undefined and it must be of type object.'); - } - if (offset !== null && offset !== undefined && typeof offset !== 'number') { - throw new Error('offset must be of type number.'); - } - if (syncFlag) { - let allowedValues = [ 'DATA', 'METADATA', 'CLOSE' ]; - if (!allowedValues.some( function(item) { return item === syncFlag; })) { - throw new Error(syncFlag + ' is not a valid value. The valid values are: ' + allowedValues); - } - } - if (leaseId !== null && leaseId !== undefined && !(typeof leaseId.valueOf() === 'string' && msRest.isValidUuid(leaseId))) { - throw new Error('leaseId must be of type string and must be a valid uuid.'); - } - if (fileSessionId !== null && fileSessionId !== undefined && !(typeof fileSessionId.valueOf() === 'string' && msRest.isValidUuid(fileSessionId))) { - throw new Error('fileSessionId must be of type string and must be a valid uuid.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (offset !== null && offset !== undefined) { - queryParameters.push('offset=' + encodeURIComponent(offset.toString())); - } - if (syncFlag !== null && syncFlag !== undefined) { - queryParameters.push('syncFlag=' + encodeURIComponent(syncFlag)); - } - if (leaseId !== null && leaseId !== undefined) { - queryParameters.push('leaseId=' + encodeURIComponent(leaseId.toString())); - } - if (fileSessionId !== null && fileSessionId !== undefined) { - queryParameters.push('fileSessionId=' + encodeURIComponent(fileSessionId.toString())); - } - queryParameters.push('append=' + encodeURIComponent(appendParameter)); - queryParameters.push('op=' + encodeURIComponent(op)); - 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/octet-stream'; - 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 = streamContents; - 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Creates a file with optionally specified content. NOTE: If content is - * provided, the resulting file cannot be modified using ConcurrentAppend. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to create. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.streamContents] The file contents to include when - * creating the file. This parameter is optional, resulting in an empty file if - * not specified. The maximum content size is 4MB. For content larger than - * 4MB you must append the content in 4MB chunks. - * - * @param {boolean} [options.overwrite] The indication of if the file should be - * overwritten. - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the create. DATA indicates that more data will be sent - * immediately by the client, the file handle should remain open/locked, and - * file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure - * single writer semantics, meaning that only clients that append to the file - * with the same leaseId will be allowed to do so. - * - * @param {number} [options.permission] The octal representation of the unnamed - * user, mask and other permissions that should be set for the file when - * created. If not specified, it inherits these from the container. - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _create(accountName, path, 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.'); - } - let streamContents = (options && options.streamContents !== undefined) ? options.streamContents : undefined; - let overwrite = (options && options.overwrite !== undefined) ? options.overwrite : undefined; - let syncFlag = (options && options.syncFlag !== undefined) ? options.syncFlag : 'CLOSE'; - let leaseId = (options && options.leaseId !== undefined) ? options.leaseId : undefined; - let permission = (options && options.permission !== undefined) ? options.permission : undefined; - let write = 'true'; - let op = 'CREATE'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (streamContents !== null && streamContents !== undefined && typeof streamContents.valueOf() !== 'object') { - throw new Error('streamContents must be of type object.'); - } - if (overwrite !== null && overwrite !== undefined && typeof overwrite !== 'boolean') { - throw new Error('overwrite must be of type boolean.'); - } - if (syncFlag) { - let allowedValues = [ 'DATA', 'METADATA', 'CLOSE' ]; - if (!allowedValues.some( function(item) { return item === syncFlag; })) { - throw new Error(syncFlag + ' is not a valid value. The valid values are: ' + allowedValues); - } - } - if (leaseId !== null && leaseId !== undefined && !(typeof leaseId.valueOf() === 'string' && msRest.isValidUuid(leaseId))) { - throw new Error('leaseId must be of type string and must be a valid uuid.'); - } - if (permission !== null && permission !== undefined && typeof permission !== 'number') { - throw new Error('permission must be of type number.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (overwrite !== null && overwrite !== undefined) { - queryParameters.push('overwrite=' + encodeURIComponent(overwrite.toString())); - } - if (syncFlag !== null && syncFlag !== undefined) { - queryParameters.push('syncFlag=' + encodeURIComponent(syncFlag)); - } - if (leaseId !== null && leaseId !== undefined) { - queryParameters.push('leaseId=' + encodeURIComponent(leaseId.toString())); - } - if (permission !== null && permission !== undefined) { - queryParameters.push('permission=' + encodeURIComponent(permission.toString())); - } - queryParameters.push('write=' + encodeURIComponent(write)); - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - httpRequest.url = requestUrl; - httpRequest.headers = {}; - // Set Headers - httpRequest.headers['Content-Type'] = 'application/octet-stream'; - 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 = streamContents; - httpRequest.body = requestContent; - // Send Request - return client.pipeline(httpRequest, (err, response, responseBody) => { - if (err) { - return callback(err); - } - let statusCode = response.statusCode; - if (statusCode !== 201) { - 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Sets the Access Control List (ACL) for a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory on which to set the ACL. - * - * @param {string} aclspec The ACL spec included in ACL creation operations in - * the format '[default:]user|group|other::r|-w|-x|-' - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _setAcl(accountName, path, aclspec, 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.'); - } - let op = 'SETACL'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (aclspec === null || aclspec === undefined || typeof aclspec.valueOf() !== 'string') { - throw new Error('aclspec cannot be null or undefined and it must be of type string.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - queryParameters.push('aclspec=' + encodeURIComponent(aclspec)); - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Modifies existing Access Control List (ACL) entries on a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being modified. - * - * @param {string} aclspec The ACL specification included in ACL modification - * operations in the format '[default:]user|group|other::r|-w|-x|-' - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _modifyAclEntries(accountName, path, aclspec, 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.'); - } - let op = 'MODIFYACLENTRIES'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (aclspec === null || aclspec === undefined || typeof aclspec.valueOf() !== 'string') { - throw new Error('aclspec cannot be null or undefined and it must be of type string.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - queryParameters.push('aclspec=' + encodeURIComponent(aclspec)); - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Removes existing Access Control List (ACL) entries for a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being removed. - * - * @param {string} aclspec The ACL spec included in ACL removal operations in - * the format '[default:]user|group|other' - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _removeAclEntries(accountName, path, aclspec, 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.'); - } - let op = 'REMOVEACLENTRIES'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (aclspec === null || aclspec === undefined || typeof aclspec.valueOf() !== 'string') { - throw new Error('aclspec cannot be null or undefined and it must be of type string.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - queryParameters.push('aclspec=' + encodeURIComponent(aclspec)); - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Removes the existing Default Access Control List (ACL) of the specified - * directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory with the default ACL being removed. - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _removeDefaultAcl(accountName, path, 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.'); - } - let op = 'REMOVEDEFAULTACL'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Removes the existing Access Control List (ACL) of the specified file or - * directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being removed. - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _removeAcl(accountName, path, 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.'); - } - let op = 'REMOVEACL'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Gets Access Control List (ACL) entries for the specified file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to get the ACL. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of object ID for ACL entries. tooid=false returns friendly names - * instead of the AAD Object ID. Default value is true, returning AAD object - * IDs. - * - * @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 AclStatusResult} 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 _getAclStatus(accountName, path, 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.'); - } - let tooId = (options && options.tooId !== undefined) ? options.tooId : undefined; - let op = 'GETACLSTATUS'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (tooId !== null && tooId !== undefined && typeof tooId !== 'boolean') { - throw new Error('tooId must be of type boolean.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (tooId !== null && tooId !== undefined) { - queryParameters.push('tooId=' + encodeURIComponent(tooId.toString())); - } - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'GET'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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['AclStatusResult']().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); - }); -} - -/** - * Deletes the requested file or directory, optionally recursively. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory to delete. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.recursive] The optional switch indicating if the - * delete should be recursive - * - * @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 FileOperationResult} 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 _deleteMethod(accountName, path, 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.'); - } - let recursive = (options && options.recursive !== undefined) ? options.recursive : undefined; - let op = 'DELETE'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (recursive !== null && recursive !== undefined && typeof recursive !== 'boolean') { - throw new Error('recursive must be of type boolean.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (recursive !== null && recursive !== undefined) { - queryParameters.push('recursive=' + encodeURIComponent(recursive.toString())); - } - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'DELETE'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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['FileOperationResult']().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); - }); -} - -/** - * Rename a file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory to move/rename. - * - * @param {string} destination The path to move/rename the file or folder to - * - * @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 FileOperationResult} 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 _rename(accountName, path, destination, 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.'); - } - let op = 'RENAME'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (destination === null || destination === undefined || typeof destination.valueOf() !== 'string') { - throw new Error('destination cannot be null or undefined and it must be of type string.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - queryParameters.push('destination=' + encodeURIComponent(destination)); - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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['FileOperationResult']().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); - }); -} - -/** - * Sets the owner of a file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to set the owner. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.owner] The AAD Object ID of the user owner of the - * file or directory. If empty, the property will remain unchanged. - * - * @param {string} [options.group] The AAD Object ID of the group owner of the - * file or directory. If empty, the property will remain unchanged. - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _setOwner(accountName, path, 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.'); - } - let owner = (options && options.owner !== undefined) ? options.owner : undefined; - let group = (options && options.group !== undefined) ? options.group : undefined; - let op = 'SETOWNER'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (owner !== null && owner !== undefined && typeof owner.valueOf() !== 'string') { - throw new Error('owner must be of type string.'); - } - if (group !== null && group !== undefined && typeof group.valueOf() !== 'string') { - throw new Error('group must be of type string.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (owner !== null && owner !== undefined) { - queryParameters.push('owner=' + encodeURIComponent(owner)); - } - if (group !== null && group !== undefined) { - queryParameters.push('group=' + encodeURIComponent(group)); - } - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** - * Sets the permission of the file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to set the permission. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.permission] A string representation of the - * permission (i.e 'rwx'). If empty, this property remains unchanged. - * - * @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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _setPermission(accountName, path, 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.'); - } - let permission = (options && options.permission !== undefined) ? options.permission : undefined; - let op = 'SETPERMISSION'; - // Validate - try { - if (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (this.client.adlsFileSystemDnsSuffix === null || this.client.adlsFileSystemDnsSuffix === undefined || typeof this.client.adlsFileSystemDnsSuffix.valueOf() !== 'string') { - throw new Error('this.client.adlsFileSystemDnsSuffix cannot be null or undefined and it must be of type string.'); - } - if (path === null || path === undefined || typeof path.valueOf() !== 'string') { - throw new Error('path cannot be null or undefined and it must be of type string.'); - } - if (permission !== null && permission !== undefined && typeof permission.valueOf() !== 'string') { - throw new Error('permission must be of type string.'); - } - 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 (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('/') ? '' : '/') + 'webhdfs/v1/{path}'; - requestUrl = requestUrl.replace('{accountName}', accountName); - requestUrl = requestUrl.replace('{adlsFileSystemDnsSuffix}', this.client.adlsFileSystemDnsSuffix); - requestUrl = requestUrl.replace('{path}', encodeURIComponent(path)); - let queryParameters = []; - if (permission !== null && permission !== undefined) { - queryParameters.push('permission=' + encodeURIComponent(permission)); - } - queryParameters.push('op=' + encodeURIComponent(op)); - 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 = 'PUT'; - 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]; - } - } - } - httpRequest.body = null; - // 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) { - let internalError = null; - if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; - error.code = internalError ? internalError.code : parsedErrorResponse.code; - error.message = internalError ? internalError.message : parsedErrorResponse.message; - } - if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['AdlsError']().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; - - return callback(null, result, httpRequest, response); - }); -} - -/** Class representing a FileSystem. */ -class FileSystem { - /** - * Create a FileSystem. - * @param {DataLakeStoreFileSystemManagementClient} client Reference to the service client. - */ - constructor(client) { - this.client = client; - this._setFileExpiry = _setFileExpiry; - this._concurrentAppend = _concurrentAppend; - this._checkAccess = _checkAccess; - this._mkdirs = _mkdirs; - this._concat = _concat; - this._msConcat = _msConcat; - this._listFileStatus = _listFileStatus; - this._getContentSummary = _getContentSummary; - this._getFileStatus = _getFileStatus; - this._open = _open; - this._append = _append; - this._create = _create; - this._setAcl = _setAcl; - this._modifyAclEntries = _modifyAclEntries; - this._removeAclEntries = _removeAclEntries; - this._removeDefaultAcl = _removeDefaultAcl; - this._removeAcl = _removeAcl; - this._getAclStatus = _getAclStatus; - this._deleteMethod = _deleteMethod; - this._rename = _rename; - this._setOwner = _setOwner; - this._setPermission = _setPermission; - } - - /** - * Sets or removes the expiration time on the specified file. This operation - * can only be executed against files. Folders are not supported. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file on which to set or remove the expiration time. - * - * @param {string} expiryOption Indicates the type of expiration to use for the - * file: 1. NeverExpire: ExpireTime is ignored. 2. RelativeToNow: ExpireTime is - * an integer in milliseconds representing the expiration date relative to when - * file expiration is updated. 3. RelativeToCreationDate: ExpireTime is an - * integer in milliseconds representing the expiration date relative to file - * creation. 4. Absolute: ExpireTime is an integer in milliseconds, as a Unix - * timestamp relative to 1/1/1970 00:00:00. Possible values include: - * 'NeverExpire', 'RelativeToNow', 'RelativeToCreationDate', 'Absolute' - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.expireTime] The time that the file will expire, - * corresponding to the ExpiryOption that was set. - * - * @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. - */ - setFileExpiryWithHttpOperationResponse(accountName, path, expiryOption, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._setFileExpiry(accountName, path, expiryOption, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Sets or removes the expiration time on the specified file. This operation - * can only be executed against files. Folders are not supported. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file on which to set or remove the expiration time. - * - * @param {string} expiryOption Indicates the type of expiration to use for the - * file: 1. NeverExpire: ExpireTime is ignored. 2. RelativeToNow: ExpireTime is - * an integer in milliseconds representing the expiration date relative to when - * file expiration is updated. 3. RelativeToCreationDate: ExpireTime is an - * integer in milliseconds representing the expiration date relative to file - * creation. 4. Absolute: ExpireTime is an integer in milliseconds, as a Unix - * timestamp relative to 1/1/1970 00:00:00. Possible values include: - * 'NeverExpire', 'RelativeToNow', 'RelativeToCreationDate', 'Absolute' - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.expireTime] The time that the file will expire, - * corresponding to the ExpiryOption that was set. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - setFileExpiry(accountName, path, expiryOption, 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._setFileExpiry(accountName, path, expiryOption, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._setFileExpiry(accountName, path, expiryOption, options, optionalCallback); - } - } - - /** - * Appends to the specified file, optionally first creating the file if it does - * not yet exist. This method supports multiple concurrent appends to the file. - * NOTE: The target must not contain data added by Create or normal (serial) - * Append. ConcurrentAppend and Append cannot be used interchangeably; once a - * target file has been modified using either of these append options, the - * other append option cannot be used on the target file. ConcurrentAppend does - * not guarantee order and can result in duplicated data landing in the target - * file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to which to append using concurrent append. - * - * @param {object} streamContents The file contents to include when appending - * to the file. The maximum content size is 4MB. For content larger than 4MB - * you must append the content in 4MB chunks. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.appendMode] Indicates the concurrent append call - * should create the file if it doesn't exist or just open the existing file - * for append. Possible values include: 'autocreate' - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the concurrent append. DATA indicates that more data will be - * sent immediately by the client, the file handle should remain open/locked, - * and file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @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. - */ - concurrentAppendWithHttpOperationResponse(accountName, path, streamContents, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._concurrentAppend(accountName, path, streamContents, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Appends to the specified file, optionally first creating the file if it does - * not yet exist. This method supports multiple concurrent appends to the file. - * NOTE: The target must not contain data added by Create or normal (serial) - * Append. ConcurrentAppend and Append cannot be used interchangeably; once a - * target file has been modified using either of these append options, the - * other append option cannot be used on the target file. ConcurrentAppend does - * not guarantee order and can result in duplicated data landing in the target - * file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to which to append using concurrent append. - * - * @param {object} streamContents The file contents to include when appending - * to the file. The maximum content size is 4MB. For content larger than 4MB - * you must append the content in 4MB chunks. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.appendMode] Indicates the concurrent append call - * should create the file if it doesn't exist or just open the existing file - * for append. Possible values include: 'autocreate' - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the concurrent append. DATA indicates that more data will be - * sent immediately by the client, the file handle should remain open/locked, - * and file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - concurrentAppend(accountName, path, streamContents, 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._concurrentAppend(accountName, path, streamContents, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._concurrentAppend(accountName, path, streamContents, options, optionalCallback); - } - } - - /** - * Checks if the specified access is available at the given path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to check access. - * - * @param {string} fsaction File system operation read/write/execute in string - * form, matching regex pattern '[rwx-]{3}' - * - * @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. - */ - checkAccessWithHttpOperationResponse(accountName, path, fsaction, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._checkAccess(accountName, path, fsaction, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Checks if the specified access is available at the given path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to check access. - * - * @param {string} fsaction File system operation read/write/execute in string - * form, matching regex pattern '[rwx-]{3}' - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - checkAccess(accountName, path, fsaction, 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._checkAccess(accountName, path, fsaction, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._checkAccess(accountName, path, fsaction, options, optionalCallback); - } - } - - /** - * Creates a directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory to create. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.permission] Optional octal permission with which - * the directory should be created. - * - * @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. - */ - mkdirsWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._mkdirs(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Creates a directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory to create. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.permission] Optional octal permission with which - * the directory should be created. - * - * @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 {FileOperationResult} - 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 FileOperationResult} 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. - */ - mkdirs(accountName, path, 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._mkdirs(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._mkdirs(accountName, path, options, optionalCallback); - } - } - - /** - * Concatenates the list of source files into the destination file, removing - * all source files upon success. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * destination file resulting from the concatenation. - * - * @param {array} sources A list of comma separated Data Lake Store paths - * (starting with '/') of the files to concatenate, in the order in which they - * should be concatenated. - * - * @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. - */ - concatWithHttpOperationResponse(accountName, path, sources, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._concat(accountName, path, sources, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Concatenates the list of source files into the destination file, removing - * all source files upon success. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * destination file resulting from the concatenation. - * - * @param {array} sources A list of comma separated Data Lake Store paths - * (starting with '/') of the files to concatenate, in the order in which they - * should be concatenated. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - concat(accountName, path, sources, 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._concat(accountName, path, sources, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._concat(accountName, path, sources, options, optionalCallback); - } - } - - /** - * Concatenates the list of source files into the destination file, deleting - * all source files upon success. This method accepts more source file paths - * than the Concat method. This method and the parameters it accepts are - * subject to change for usability in an upcoming version. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * destination file resulting from the concatenation. - * - * @param {object} streamContents A list of Data Lake Store paths (starting - * with '/') of the source files. Must be a comma-separated path list in the - * format: sources=/file/path/1.txt,/file/path/2.txt,/file/path/lastfile.csv - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.deleteSourceDirectory] Indicates that as an - * optimization instead of deleting each individual source stream, delete the - * source stream folder if all streams are in the same folder instead. This - * results in a substantial performance improvement when the only streams in - * the folder are part of the concatenation operation. WARNING: This includes - * the deletion of any other files that are not source files. Only set this to - * true when source files are the only files in the source directory. - * - * @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. - */ - msConcatWithHttpOperationResponse(accountName, path, streamContents, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._msConcat(accountName, path, streamContents, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Concatenates the list of source files into the destination file, deleting - * all source files upon success. This method accepts more source file paths - * than the Concat method. This method and the parameters it accepts are - * subject to change for usability in an upcoming version. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * destination file resulting from the concatenation. - * - * @param {object} streamContents A list of Data Lake Store paths (starting - * with '/') of the source files. Must be a comma-separated path list in the - * format: sources=/file/path/1.txt,/file/path/2.txt,/file/path/lastfile.csv - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.deleteSourceDirectory] Indicates that as an - * optimization instead of deleting each individual source stream, delete the - * source stream folder if all streams are in the same folder instead. This - * results in a substantial performance improvement when the only streams in - * the folder are part of the concatenation operation. WARNING: This includes - * the deletion of any other files that are not source files. Only set this to - * true when source files are the only files in the source directory. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - msConcat(accountName, path, streamContents, 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._msConcat(accountName, path, streamContents, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._msConcat(accountName, path, streamContents, options, optionalCallback); - } - } - - /** - * Get the list of file status objects specified by the file path, with - * optional pagination parameters - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory to list. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.listSize] Gets or sets the number of items to - * return. Optional. - * - * @param {string} [options.listAfter] Gets or sets the item or lexographical - * index after which to begin returning results. For example, a file list of - * 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also - * return 'd'. Optional. - * - * @param {string} [options.listBefore] Gets or sets the item or lexographical - * index before which to begin returning results. For example, a file list of - * 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' - * will also return 'a','b'. Optional. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of owner and group. tooid=false returns friendly names instead of - * the AAD Object ID. Default value is true, returning AAD object IDs. - * - * @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. - */ - listFileStatusWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._listFileStatus(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Get the list of file status objects specified by the file path, with - * optional pagination parameters - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory to list. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.listSize] Gets or sets the number of items to - * return. Optional. - * - * @param {string} [options.listAfter] Gets or sets the item or lexographical - * index after which to begin returning results. For example, a file list of - * 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also - * return 'd'. Optional. - * - * @param {string} [options.listBefore] Gets or sets the item or lexographical - * index before which to begin returning results. For example, a file list of - * 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' - * will also return 'a','b'. Optional. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of owner and group. tooid=false returns friendly names instead of - * the AAD Object ID. Default value is true, returning AAD object IDs. - * - * @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 {FileStatusesResult} - 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 FileStatusesResult} 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. - */ - listFileStatus(accountName, path, 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._listFileStatus(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._listFileStatus(accountName, path, options, optionalCallback); - } - } - - /** - * Gets the file content summary object specified by the file path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file for which to retrieve the summary. - * - * @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. - */ - getContentSummaryWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._getContentSummary(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Gets the file content summary object specified by the file path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file for which to retrieve the summary. - * - * @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 {ContentSummaryResult} - 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 ContentSummaryResult} 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. - */ - getContentSummary(accountName, path, 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._getContentSummary(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._getContentSummary(accountName, path, options, optionalCallback); - } - } - - /** - * Get the file status object specified by the file path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to retrieve the status. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of owner and group. tooid=false returns friendly names instead of - * the AAD Object ID. Default value is true, returning AAD object IDs. - * - * @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. - */ - getFileStatusWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._getFileStatus(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Get the file status object specified by the file path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to retrieve the status. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of owner and group. tooid=false returns friendly names instead of - * the AAD Object ID. Default value is true, returning AAD object IDs. - * - * @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 {FileStatusResult} - 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 FileStatusResult} 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. - */ - getFileStatus(accountName, path, 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._getFileStatus(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._getFileStatus(accountName, path, options, optionalCallback); - } - } - - /** - * Opens and reads from the specified file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to open. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.length] The number of bytes that the server will - * attempt to retrieve. It will retrieve <= length bytes. - * - * @param {number} [options.offset] The byte offset to start reading data from. - * - * @param {uuid} [options.fileSessionId] Optional unique GUID per file - * indicating all the reads with the same fileSessionId are from the same - * client and same session. This will give a performance benefit. - * - * @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. - */ - openWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._open(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Opens and reads from the specified file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to open. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.length] The number of bytes that the server will - * attempt to retrieve. It will retrieve <= length bytes. - * - * @param {number} [options.offset] The byte offset to start reading data from. - * - * @param {uuid} [options.fileSessionId] Optional unique GUID per file - * indicating all the reads with the same fileSessionId are from the same - * client and same session. This will give a performance benefit. - * - * @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 {Object} - 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. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - open(accountName, path, 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._open(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._open(accountName, path, options, optionalCallback); - } - } - - /** - * Used for serial appends to the specified file. NOTE: The target must not - * contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot - * be used interchangeably; once a target file has been modified using either - * of these append options, the other append option cannot be used on the - * target file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to which to append. - * - * @param {object} streamContents The file contents to include when appending - * to the file. The maximum content size is 4MB. For content larger than 4MB - * you must append the content in 4MB chunks. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.offset] The optional offset in the stream to begin - * the append operation. Default is to append at the end of the stream. - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the concurrent append. DATA indicates that more data will be - * sent immediately by the client, the file handle should remain open/locked, - * and file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure - * single writer semantics, meaning that only clients that append to the file - * with the same leaseId will be allowed to do so. - * - * @param {uuid} [options.fileSessionId] Optional unique GUID per file - * indicating all the appends with the same fileSessionId are from the same - * client and same session. This will give a performance benefit when syncFlag - * is DATA or METADATA. - * - * @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. - */ - appendWithHttpOperationResponse(accountName, path, streamContents, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._append(accountName, path, streamContents, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Used for serial appends to the specified file. NOTE: The target must not - * contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot - * be used interchangeably; once a target file has been modified using either - * of these append options, the other append option cannot be used on the - * target file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to which to append. - * - * @param {object} streamContents The file contents to include when appending - * to the file. The maximum content size is 4MB. For content larger than 4MB - * you must append the content in 4MB chunks. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.offset] The optional offset in the stream to begin - * the append operation. Default is to append at the end of the stream. - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the concurrent append. DATA indicates that more data will be - * sent immediately by the client, the file handle should remain open/locked, - * and file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure - * single writer semantics, meaning that only clients that append to the file - * with the same leaseId will be allowed to do so. - * - * @param {uuid} [options.fileSessionId] Optional unique GUID per file - * indicating all the appends with the same fileSessionId are from the same - * client and same session. This will give a performance benefit when syncFlag - * is DATA or METADATA. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - append(accountName, path, streamContents, 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._append(accountName, path, streamContents, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._append(accountName, path, streamContents, options, optionalCallback); - } - } - - /** - * Creates a file with optionally specified content. NOTE: If content is - * provided, the resulting file cannot be modified using ConcurrentAppend. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to create. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.streamContents] The file contents to include when - * creating the file. This parameter is optional, resulting in an empty file if - * not specified. The maximum content size is 4MB. For content larger than - * 4MB you must append the content in 4MB chunks. - * - * @param {boolean} [options.overwrite] The indication of if the file should be - * overwritten. - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the create. DATA indicates that more data will be sent - * immediately by the client, the file handle should remain open/locked, and - * file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure - * single writer semantics, meaning that only clients that append to the file - * with the same leaseId will be allowed to do so. - * - * @param {number} [options.permission] The octal representation of the unnamed - * user, mask and other permissions that should be set for the file when - * created. If not specified, it inherits these from the container. - * - * @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. - */ - createWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._create(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Creates a file with optionally specified content. NOTE: If content is - * provided, the resulting file cannot be modified using ConcurrentAppend. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to create. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.streamContents] The file contents to include when - * creating the file. This parameter is optional, resulting in an empty file if - * not specified. The maximum content size is 4MB. For content larger than - * 4MB you must append the content in 4MB chunks. - * - * @param {boolean} [options.overwrite] The indication of if the file should be - * overwritten. - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the create. DATA indicates that more data will be sent - * immediately by the client, the file handle should remain open/locked, and - * file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure - * single writer semantics, meaning that only clients that append to the file - * with the same leaseId will be allowed to do so. - * - * @param {number} [options.permission] The octal representation of the unnamed - * user, mask and other permissions that should be set for the file when - * created. If not specified, it inherits these from the container. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - create(accountName, path, 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._create(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._create(accountName, path, options, optionalCallback); - } - } - - /** - * Sets the Access Control List (ACL) for a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory on which to set the ACL. - * - * @param {string} aclspec The ACL spec included in ACL creation operations in - * the format '[default:]user|group|other::r|-w|-x|-' - * - * @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. - */ - setAclWithHttpOperationResponse(accountName, path, aclspec, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._setAcl(accountName, path, aclspec, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Sets the Access Control List (ACL) for a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory on which to set the ACL. - * - * @param {string} aclspec The ACL spec included in ACL creation operations in - * the format '[default:]user|group|other::r|-w|-x|-' - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - setAcl(accountName, path, aclspec, 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._setAcl(accountName, path, aclspec, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._setAcl(accountName, path, aclspec, options, optionalCallback); - } - } - - /** - * Modifies existing Access Control List (ACL) entries on a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being modified. - * - * @param {string} aclspec The ACL specification included in ACL modification - * operations in the format '[default:]user|group|other::r|-w|-x|-' - * - * @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. - */ - modifyAclEntriesWithHttpOperationResponse(accountName, path, aclspec, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._modifyAclEntries(accountName, path, aclspec, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Modifies existing Access Control List (ACL) entries on a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being modified. - * - * @param {string} aclspec The ACL specification included in ACL modification - * operations in the format '[default:]user|group|other::r|-w|-x|-' - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - modifyAclEntries(accountName, path, aclspec, 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._modifyAclEntries(accountName, path, aclspec, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._modifyAclEntries(accountName, path, aclspec, options, optionalCallback); - } - } - - /** - * Removes existing Access Control List (ACL) entries for a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being removed. - * - * @param {string} aclspec The ACL spec included in ACL removal operations in - * the format '[default:]user|group|other' - * - * @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. - */ - removeAclEntriesWithHttpOperationResponse(accountName, path, aclspec, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._removeAclEntries(accountName, path, aclspec, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Removes existing Access Control List (ACL) entries for a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being removed. - * - * @param {string} aclspec The ACL spec included in ACL removal operations in - * the format '[default:]user|group|other' - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - removeAclEntries(accountName, path, aclspec, 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._removeAclEntries(accountName, path, aclspec, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._removeAclEntries(accountName, path, aclspec, options, optionalCallback); - } - } - - /** - * Removes the existing Default Access Control List (ACL) of the specified - * directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory with the default ACL being removed. - * - * @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. - */ - removeDefaultAclWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._removeDefaultAcl(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Removes the existing Default Access Control List (ACL) of the specified - * directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory with the default ACL being removed. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - removeDefaultAcl(accountName, path, 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._removeDefaultAcl(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._removeDefaultAcl(accountName, path, options, optionalCallback); - } - } - - /** - * Removes the existing Access Control List (ACL) of the specified file or - * directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being removed. - * - * @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. - */ - removeAclWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._removeAcl(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Removes the existing Access Control List (ACL) of the specified file or - * directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being removed. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - removeAcl(accountName, path, 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._removeAcl(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._removeAcl(accountName, path, options, optionalCallback); - } - } - - /** - * Gets Access Control List (ACL) entries for the specified file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to get the ACL. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of object ID for ACL entries. tooid=false returns friendly names - * instead of the AAD Object ID. Default value is true, returning AAD object - * IDs. - * - * @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. - */ - getAclStatusWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._getAclStatus(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Gets Access Control List (ACL) entries for the specified file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to get the ACL. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of object ID for ACL entries. tooid=false returns friendly names - * instead of the AAD Object ID. Default value is true, returning AAD object - * IDs. - * - * @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 {AclStatusResult} - 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 AclStatusResult} 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. - */ - getAclStatus(accountName, path, 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._getAclStatus(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._getAclStatus(accountName, path, options, optionalCallback); - } - } - - /** - * Deletes the requested file or directory, optionally recursively. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory to delete. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.recursive] The optional switch indicating if the - * delete should be recursive - * - * @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. - */ - deleteMethodWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._deleteMethod(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Deletes the requested file or directory, optionally recursively. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory to delete. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.recursive] The optional switch indicating if the - * delete should be recursive - * - * @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 {FileOperationResult} - 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 FileOperationResult} 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. - */ - deleteMethod(accountName, path, 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._deleteMethod(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._deleteMethod(accountName, path, options, optionalCallback); - } - } - - /** - * Rename a file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory to move/rename. - * - * @param {string} destination The path to move/rename the file or folder to - * - * @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. - */ - renameWithHttpOperationResponse(accountName, path, destination, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._rename(accountName, path, destination, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Rename a file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory to move/rename. - * - * @param {string} destination The path to move/rename the file or folder to - * - * @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 {FileOperationResult} - 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 FileOperationResult} 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. - */ - rename(accountName, path, destination, 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._rename(accountName, path, destination, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._rename(accountName, path, destination, options, optionalCallback); - } - } - - /** - * Sets the owner of a file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to set the owner. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.owner] The AAD Object ID of the user owner of the - * file or directory. If empty, the property will remain unchanged. - * - * @param {string} [options.group] The AAD Object ID of the group owner of the - * file or directory. If empty, the property will remain unchanged. - * - * @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. - */ - setOwnerWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._setOwner(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Sets the owner of a file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to set the owner. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.owner] The AAD Object ID of the user owner of the - * file or directory. If empty, the property will remain unchanged. - * - * @param {string} [options.group] The AAD Object ID of the group owner of the - * file or directory. If empty, the property will remain unchanged. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - setOwner(accountName, path, 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._setOwner(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._setOwner(accountName, path, options, optionalCallback); - } - } - - /** - * Sets the permission of the file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to set the permission. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.permission] A string representation of the - * permission (i.e 'rwx'). If empty, this property remains unchanged. - * - * @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. - */ - setPermissionWithHttpOperationResponse(accountName, path, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._setPermission(accountName, path, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Sets the permission of the file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to set the permission. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.permission] A string representation of the - * permission (i.e 'rwx'). If empty, this property remains unchanged. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - setPermission(accountName, path, 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._setPermission(accountName, path, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._setPermission(accountName, path, options, optionalCallback); - } - } - -} - -module.exports = FileSystem; diff --git a/lib/services/dataLake.Store/lib/filesystem/operations/index.d.ts b/lib/services/dataLake.Store/lib/filesystem/operations/index.d.ts deleted file mode 100644 index cd17fe23fc..0000000000 --- a/lib/services/dataLake.Store/lib/filesystem/operations/index.d.ts +++ /dev/null @@ -1,1758 +0,0 @@ -/* - * 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. -*/ - -import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse } from 'ms-rest'; -import * as stream from 'stream'; -import * as models from '../models'; - - -/** - * @class - * FileSystem - * __NOTE__: An instance of this class is automatically created for an - * instance of the DataLakeStoreFileSystemManagementClient. - */ -export interface FileSystem { - - - /** - * Sets or removes the expiration time on the specified file. This operation - * can only be executed against files. Folders are not supported. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file on which to set or remove the expiration time. - * - * @param {string} expiryOption Indicates the type of expiration to use for the - * file: 1. NeverExpire: ExpireTime is ignored. 2. RelativeToNow: ExpireTime is - * an integer in milliseconds representing the expiration date relative to when - * file expiration is updated. 3. RelativeToCreationDate: ExpireTime is an - * integer in milliseconds representing the expiration date relative to file - * creation. 4. Absolute: ExpireTime is an integer in milliseconds, as a Unix - * timestamp relative to 1/1/1970 00:00:00. Possible values include: - * 'NeverExpire', 'RelativeToNow', 'RelativeToCreationDate', 'Absolute' - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.expireTime] The time that the file will expire, - * corresponding to the ExpiryOption that was set. - * - * @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. - */ - setFileExpiryWithHttpOperationResponse(accountName: string, path: string, expiryOption: string, options?: { expireTime? : number, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Sets or removes the expiration time on the specified file. This operation - * can only be executed against files. Folders are not supported. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file on which to set or remove the expiration time. - * - * @param {string} expiryOption Indicates the type of expiration to use for the - * file: 1. NeverExpire: ExpireTime is ignored. 2. RelativeToNow: ExpireTime is - * an integer in milliseconds representing the expiration date relative to when - * file expiration is updated. 3. RelativeToCreationDate: ExpireTime is an - * integer in milliseconds representing the expiration date relative to file - * creation. 4. Absolute: ExpireTime is an integer in milliseconds, as a Unix - * timestamp relative to 1/1/1970 00:00:00. Possible values include: - * 'NeverExpire', 'RelativeToNow', 'RelativeToCreationDate', 'Absolute' - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.expireTime] The time that the file will expire, - * corresponding to the ExpiryOption that was set. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - setFileExpiry(accountName: string, path: string, expiryOption: string, options?: { expireTime? : number, customHeaders? : { [headerName: string]: string; } }): Promise; - setFileExpiry(accountName: string, path: string, expiryOption: string, callback: ServiceCallback): void; - setFileExpiry(accountName: string, path: string, expiryOption: string, options: { expireTime? : number, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Appends to the specified file, optionally first creating the file if it does - * not yet exist. This method supports multiple concurrent appends to the file. - * NOTE: The target must not contain data added by Create or normal (serial) - * Append. ConcurrentAppend and Append cannot be used interchangeably; once a - * target file has been modified using either of these append options, the - * other append option cannot be used on the target file. ConcurrentAppend does - * not guarantee order and can result in duplicated data landing in the target - * file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to which to append using concurrent append. - * - * @param {object} streamContents The file contents to include when appending - * to the file. The maximum content size is 4MB. For content larger than 4MB - * you must append the content in 4MB chunks. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.appendMode] Indicates the concurrent append call - * should create the file if it doesn't exist or just open the existing file - * for append. Possible values include: 'autocreate' - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the concurrent append. DATA indicates that more data will be - * sent immediately by the client, the file handle should remain open/locked, - * and file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @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. - */ - concurrentAppendWithHttpOperationResponse(accountName: string, path: string, streamContents: stream.Readable, options?: { appendMode? : string, syncFlag? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Appends to the specified file, optionally first creating the file if it does - * not yet exist. This method supports multiple concurrent appends to the file. - * NOTE: The target must not contain data added by Create or normal (serial) - * Append. ConcurrentAppend and Append cannot be used interchangeably; once a - * target file has been modified using either of these append options, the - * other append option cannot be used on the target file. ConcurrentAppend does - * not guarantee order and can result in duplicated data landing in the target - * file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to which to append using concurrent append. - * - * @param {object} streamContents The file contents to include when appending - * to the file. The maximum content size is 4MB. For content larger than 4MB - * you must append the content in 4MB chunks. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.appendMode] Indicates the concurrent append call - * should create the file if it doesn't exist or just open the existing file - * for append. Possible values include: 'autocreate' - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the concurrent append. DATA indicates that more data will be - * sent immediately by the client, the file handle should remain open/locked, - * and file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - concurrentAppend(accountName: string, path: string, streamContents: stream.Readable, options?: { appendMode? : string, syncFlag? : string, customHeaders? : { [headerName: string]: string; } }): Promise; - concurrentAppend(accountName: string, path: string, streamContents: stream.Readable, callback: ServiceCallback): void; - concurrentAppend(accountName: string, path: string, streamContents: stream.Readable, options: { appendMode? : string, syncFlag? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Checks if the specified access is available at the given path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to check access. - * - * @param {string} fsaction File system operation read/write/execute in string - * form, matching regex pattern '[rwx-]{3}' - * - * @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. - */ - checkAccessWithHttpOperationResponse(accountName: string, path: string, fsaction: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Checks if the specified access is available at the given path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to check access. - * - * @param {string} fsaction File system operation read/write/execute in string - * form, matching regex pattern '[rwx-]{3}' - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - checkAccess(accountName: string, path: string, fsaction: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - checkAccess(accountName: string, path: string, fsaction: string, callback: ServiceCallback): void; - checkAccess(accountName: string, path: string, fsaction: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Creates a directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory to create. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.permission] Optional octal permission with which - * the directory should be created. - * - * @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. - */ - mkdirsWithHttpOperationResponse(accountName: string, path: string, options?: { permission? : number, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Creates a directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory to create. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.permission] Optional octal permission with which - * the directory should be created. - * - * @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 {FileOperationResult} - 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. - * - * {FileOperationResult} [result] - The deserialized result object if an error did not occur. - * See {@link FileOperationResult} 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. - */ - mkdirs(accountName: string, path: string, options?: { permission? : number, customHeaders? : { [headerName: string]: string; } }): Promise; - mkdirs(accountName: string, path: string, callback: ServiceCallback): void; - mkdirs(accountName: string, path: string, options: { permission? : number, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Concatenates the list of source files into the destination file, removing - * all source files upon success. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * destination file resulting from the concatenation. - * - * @param {array} sources A list of comma separated Data Lake Store paths - * (starting with '/') of the files to concatenate, in the order in which they - * should be concatenated. - * - * @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. - */ - concatWithHttpOperationResponse(accountName: string, path: string, sources: string[], options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Concatenates the list of source files into the destination file, removing - * all source files upon success. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * destination file resulting from the concatenation. - * - * @param {array} sources A list of comma separated Data Lake Store paths - * (starting with '/') of the files to concatenate, in the order in which they - * should be concatenated. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - concat(accountName: string, path: string, sources: string[], options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - concat(accountName: string, path: string, sources: string[], callback: ServiceCallback): void; - concat(accountName: string, path: string, sources: string[], options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Concatenates the list of source files into the destination file, deleting - * all source files upon success. This method accepts more source file paths - * than the Concat method. This method and the parameters it accepts are - * subject to change for usability in an upcoming version. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * destination file resulting from the concatenation. - * - * @param {object} streamContents A list of Data Lake Store paths (starting - * with '/') of the source files. Must be a comma-separated path list in the - * format: sources=/file/path/1.txt,/file/path/2.txt,/file/path/lastfile.csv - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.deleteSourceDirectory] Indicates that as an - * optimization instead of deleting each individual source stream, delete the - * source stream folder if all streams are in the same folder instead. This - * results in a substantial performance improvement when the only streams in - * the folder are part of the concatenation operation. WARNING: This includes - * the deletion of any other files that are not source files. Only set this to - * true when source files are the only files in the source directory. - * - * @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. - */ - msConcatWithHttpOperationResponse(accountName: string, path: string, streamContents: stream.Readable, options?: { deleteSourceDirectory? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Concatenates the list of source files into the destination file, deleting - * all source files upon success. This method accepts more source file paths - * than the Concat method. This method and the parameters it accepts are - * subject to change for usability in an upcoming version. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * destination file resulting from the concatenation. - * - * @param {object} streamContents A list of Data Lake Store paths (starting - * with '/') of the source files. Must be a comma-separated path list in the - * format: sources=/file/path/1.txt,/file/path/2.txt,/file/path/lastfile.csv - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.deleteSourceDirectory] Indicates that as an - * optimization instead of deleting each individual source stream, delete the - * source stream folder if all streams are in the same folder instead. This - * results in a substantial performance improvement when the only streams in - * the folder are part of the concatenation operation. WARNING: This includes - * the deletion of any other files that are not source files. Only set this to - * true when source files are the only files in the source directory. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - msConcat(accountName: string, path: string, streamContents: stream.Readable, options?: { deleteSourceDirectory? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise; - msConcat(accountName: string, path: string, streamContents: stream.Readable, callback: ServiceCallback): void; - msConcat(accountName: string, path: string, streamContents: stream.Readable, options: { deleteSourceDirectory? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Get the list of file status objects specified by the file path, with - * optional pagination parameters - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory to list. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.listSize] Gets or sets the number of items to - * return. Optional. - * - * @param {string} [options.listAfter] Gets or sets the item or lexographical - * index after which to begin returning results. For example, a file list of - * 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also - * return 'd'. Optional. - * - * @param {string} [options.listBefore] Gets or sets the item or lexographical - * index before which to begin returning results. For example, a file list of - * 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' - * will also return 'a','b'. Optional. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of owner and group. tooid=false returns friendly names instead of - * the AAD Object ID. Default value is true, returning AAD object IDs. - * - * @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. - */ - listFileStatusWithHttpOperationResponse(accountName: string, path: string, options?: { listSize? : number, listAfter? : string, listBefore? : string, tooId? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Get the list of file status objects specified by the file path, with - * optional pagination parameters - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory to list. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.listSize] Gets or sets the number of items to - * return. Optional. - * - * @param {string} [options.listAfter] Gets or sets the item or lexographical - * index after which to begin returning results. For example, a file list of - * 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also - * return 'd'. Optional. - * - * @param {string} [options.listBefore] Gets or sets the item or lexographical - * index before which to begin returning results. For example, a file list of - * 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' - * will also return 'a','b'. Optional. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of owner and group. tooid=false returns friendly names instead of - * the AAD Object ID. Default value is true, returning AAD object IDs. - * - * @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 {FileStatusesResult} - 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. - * - * {FileStatusesResult} [result] - The deserialized result object if an error did not occur. - * See {@link FileStatusesResult} 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. - */ - listFileStatus(accountName: string, path: string, options?: { listSize? : number, listAfter? : string, listBefore? : string, tooId? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise; - listFileStatus(accountName: string, path: string, callback: ServiceCallback): void; - listFileStatus(accountName: string, path: string, options: { listSize? : number, listAfter? : string, listBefore? : string, tooId? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets the file content summary object specified by the file path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file for which to retrieve the summary. - * - * @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. - */ - getContentSummaryWithHttpOperationResponse(accountName: string, path: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets the file content summary object specified by the file path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file for which to retrieve the summary. - * - * @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 {ContentSummaryResult} - 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. - * - * {ContentSummaryResult} [result] - The deserialized result object if an error did not occur. - * See {@link ContentSummaryResult} 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. - */ - getContentSummary(accountName: string, path: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - getContentSummary(accountName: string, path: string, callback: ServiceCallback): void; - getContentSummary(accountName: string, path: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Get the file status object specified by the file path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to retrieve the status. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of owner and group. tooid=false returns friendly names instead of - * the AAD Object ID. Default value is true, returning AAD object IDs. - * - * @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. - */ - getFileStatusWithHttpOperationResponse(accountName: string, path: string, options?: { tooId? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Get the file status object specified by the file path. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to retrieve the status. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of owner and group. tooid=false returns friendly names instead of - * the AAD Object ID. Default value is true, returning AAD object IDs. - * - * @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 {FileStatusResult} - 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. - * - * {FileStatusResult} [result] - The deserialized result object if an error did not occur. - * See {@link FileStatusResult} 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. - */ - getFileStatus(accountName: string, path: string, options?: { tooId? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise; - getFileStatus(accountName: string, path: string, callback: ServiceCallback): void; - getFileStatus(accountName: string, path: string, options: { tooId? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Opens and reads from the specified file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to open. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.length] The number of bytes that the server will - * attempt to retrieve. It will retrieve <= length bytes. - * - * @param {number} [options.offset] The byte offset to start reading data from. - * - * @param {uuid} [options.fileSessionId] Optional unique GUID per file - * indicating all the reads with the same fileSessionId are from the same - * client and same session. This will give a performance benefit. - * - * @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. - */ - openWithHttpOperationResponse(accountName: string, path: string, options?: { length? : number, offset? : number, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Opens and reads from the specified file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to open. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.length] The number of bytes that the server will - * attempt to retrieve. It will retrieve <= length bytes. - * - * @param {number} [options.offset] The byte offset to start reading data from. - * - * @param {uuid} [options.fileSessionId] Optional unique GUID per file - * indicating all the reads with the same fileSessionId are from the same - * client and same session. This will give a performance benefit. - * - * @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 {Object} - 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. - * - * {Object} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - open(accountName: string, path: string, options?: { length? : number, offset? : number, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }): Promise; - open(accountName: string, path: string, callback: ServiceCallback): void; - open(accountName: string, path: string, options: { length? : number, offset? : number, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Used for serial appends to the specified file. NOTE: The target must not - * contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot - * be used interchangeably; once a target file has been modified using either - * of these append options, the other append option cannot be used on the - * target file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to which to append. - * - * @param {object} streamContents The file contents to include when appending - * to the file. The maximum content size is 4MB. For content larger than 4MB - * you must append the content in 4MB chunks. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.offset] The optional offset in the stream to begin - * the append operation. Default is to append at the end of the stream. - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the concurrent append. DATA indicates that more data will be - * sent immediately by the client, the file handle should remain open/locked, - * and file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure - * single writer semantics, meaning that only clients that append to the file - * with the same leaseId will be allowed to do so. - * - * @param {uuid} [options.fileSessionId] Optional unique GUID per file - * indicating all the appends with the same fileSessionId are from the same - * client and same session. This will give a performance benefit when syncFlag - * is DATA or METADATA. - * - * @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. - */ - appendWithHttpOperationResponse(accountName: string, path: string, streamContents: stream.Readable, options?: { offset? : number, syncFlag? : string, leaseId? : string, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Used for serial appends to the specified file. NOTE: The target must not - * contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot - * be used interchangeably; once a target file has been modified using either - * of these append options, the other append option cannot be used on the - * target file. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to which to append. - * - * @param {object} streamContents The file contents to include when appending - * to the file. The maximum content size is 4MB. For content larger than 4MB - * you must append the content in 4MB chunks. - * - * @param {object} [options] Optional Parameters. - * - * @param {number} [options.offset] The optional offset in the stream to begin - * the append operation. Default is to append at the end of the stream. - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the concurrent append. DATA indicates that more data will be - * sent immediately by the client, the file handle should remain open/locked, - * and file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure - * single writer semantics, meaning that only clients that append to the file - * with the same leaseId will be allowed to do so. - * - * @param {uuid} [options.fileSessionId] Optional unique GUID per file - * indicating all the appends with the same fileSessionId are from the same - * client and same session. This will give a performance benefit when syncFlag - * is DATA or METADATA. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - append(accountName: string, path: string, streamContents: stream.Readable, options?: { offset? : number, syncFlag? : string, leaseId? : string, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }): Promise; - append(accountName: string, path: string, streamContents: stream.Readable, callback: ServiceCallback): void; - append(accountName: string, path: string, streamContents: stream.Readable, options: { offset? : number, syncFlag? : string, leaseId? : string, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Creates a file with optionally specified content. NOTE: If content is - * provided, the resulting file cannot be modified using ConcurrentAppend. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to create. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.streamContents] The file contents to include when - * creating the file. This parameter is optional, resulting in an empty file if - * not specified. The maximum content size is 4MB. For content larger than - * 4MB you must append the content in 4MB chunks. - * - * @param {boolean} [options.overwrite] The indication of if the file should be - * overwritten. - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the create. DATA indicates that more data will be sent - * immediately by the client, the file handle should remain open/locked, and - * file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure - * single writer semantics, meaning that only clients that append to the file - * with the same leaseId will be allowed to do so. - * - * @param {number} [options.permission] The octal representation of the unnamed - * user, mask and other permissions that should be set for the file when - * created. If not specified, it inherits these from the container. - * - * @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. - */ - createWithHttpOperationResponse(accountName: string, path: string, options?: { streamContents? : stream.Readable, overwrite? : boolean, syncFlag? : string, leaseId? : string, permission? : number, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Creates a file with optionally specified content. NOTE: If content is - * provided, the resulting file cannot be modified using ConcurrentAppend. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file to create. - * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.streamContents] The file contents to include when - * creating the file. This parameter is optional, resulting in an empty file if - * not specified. The maximum content size is 4MB. For content larger than - * 4MB you must append the content in 4MB chunks. - * - * @param {boolean} [options.overwrite] The indication of if the file should be - * overwritten. - * - * @param {string} [options.syncFlag] Optionally indicates what to do after - * completion of the create. DATA indicates that more data will be sent - * immediately by the client, the file handle should remain open/locked, and - * file metadata (including file length, last modified time) should NOT get - * updated. METADATA indicates that more data will be sent immediately by the - * client, the file handle should remain open/locked, and file metadata should - * get updated. CLOSE indicates that the client is done sending data, the file - * handle should be closed/unlocked, and file metadata should get updated. - * Possible values include: 'DATA', 'METADATA', 'CLOSE' - * - * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure - * single writer semantics, meaning that only clients that append to the file - * with the same leaseId will be allowed to do so. - * - * @param {number} [options.permission] The octal representation of the unnamed - * user, mask and other permissions that should be set for the file when - * created. If not specified, it inherits these from the container. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - create(accountName: string, path: string, options?: { streamContents? : stream.Readable, overwrite? : boolean, syncFlag? : string, leaseId? : string, permission? : number, customHeaders? : { [headerName: string]: string; } }): Promise; - create(accountName: string, path: string, callback: ServiceCallback): void; - create(accountName: string, path: string, options: { streamContents? : stream.Readable, overwrite? : boolean, syncFlag? : string, leaseId? : string, permission? : number, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Sets the Access Control List (ACL) for a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory on which to set the ACL. - * - * @param {string} aclspec The ACL spec included in ACL creation operations in - * the format '[default:]user|group|other::r|-w|-x|-' - * - * @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. - */ - setAclWithHttpOperationResponse(accountName: string, path: string, aclspec: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Sets the Access Control List (ACL) for a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory on which to set the ACL. - * - * @param {string} aclspec The ACL spec included in ACL creation operations in - * the format '[default:]user|group|other::r|-w|-x|-' - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - setAcl(accountName: string, path: string, aclspec: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - setAcl(accountName: string, path: string, aclspec: string, callback: ServiceCallback): void; - setAcl(accountName: string, path: string, aclspec: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Modifies existing Access Control List (ACL) entries on a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being modified. - * - * @param {string} aclspec The ACL specification included in ACL modification - * operations in the format '[default:]user|group|other::r|-w|-x|-' - * - * @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. - */ - modifyAclEntriesWithHttpOperationResponse(accountName: string, path: string, aclspec: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Modifies existing Access Control List (ACL) entries on a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being modified. - * - * @param {string} aclspec The ACL specification included in ACL modification - * operations in the format '[default:]user|group|other::r|-w|-x|-' - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - modifyAclEntries(accountName: string, path: string, aclspec: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - modifyAclEntries(accountName: string, path: string, aclspec: string, callback: ServiceCallback): void; - modifyAclEntries(accountName: string, path: string, aclspec: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Removes existing Access Control List (ACL) entries for a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being removed. - * - * @param {string} aclspec The ACL spec included in ACL removal operations in - * the format '[default:]user|group|other' - * - * @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. - */ - removeAclEntriesWithHttpOperationResponse(accountName: string, path: string, aclspec: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Removes existing Access Control List (ACL) entries for a file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being removed. - * - * @param {string} aclspec The ACL spec included in ACL removal operations in - * the format '[default:]user|group|other' - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - removeAclEntries(accountName: string, path: string, aclspec: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - removeAclEntries(accountName: string, path: string, aclspec: string, callback: ServiceCallback): void; - removeAclEntries(accountName: string, path: string, aclspec: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Removes the existing Default Access Control List (ACL) of the specified - * directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory with the default ACL being removed. - * - * @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. - */ - removeDefaultAclWithHttpOperationResponse(accountName: string, path: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Removes the existing Default Access Control List (ACL) of the specified - * directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * directory with the default ACL being removed. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - removeDefaultAcl(accountName: string, path: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - removeDefaultAcl(accountName: string, path: string, callback: ServiceCallback): void; - removeDefaultAcl(accountName: string, path: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Removes the existing Access Control List (ACL) of the specified file or - * directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being removed. - * - * @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. - */ - removeAclWithHttpOperationResponse(accountName: string, path: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Removes the existing Access Control List (ACL) of the specified file or - * directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory with the ACL being removed. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - removeAcl(accountName: string, path: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - removeAcl(accountName: string, path: string, callback: ServiceCallback): void; - removeAcl(accountName: string, path: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets Access Control List (ACL) entries for the specified file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to get the ACL. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of object ID for ACL entries. tooid=false returns friendly names - * instead of the AAD Object ID. Default value is true, returning AAD object - * IDs. - * - * @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. - */ - getAclStatusWithHttpOperationResponse(accountName: string, path: string, options?: { tooId? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets Access Control List (ACL) entries for the specified file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to get the ACL. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.tooId] An optional switch to return friendly names - * in place of object ID for ACL entries. tooid=false returns friendly names - * instead of the AAD Object ID. Default value is true, returning AAD object - * IDs. - * - * @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 {AclStatusResult} - 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. - * - * {AclStatusResult} [result] - The deserialized result object if an error did not occur. - * See {@link AclStatusResult} 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. - */ - getAclStatus(accountName: string, path: string, options?: { tooId? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise; - getAclStatus(accountName: string, path: string, callback: ServiceCallback): void; - getAclStatus(accountName: string, path: string, options: { tooId? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Deletes the requested file or directory, optionally recursively. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory to delete. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.recursive] The optional switch indicating if the - * delete should be recursive - * - * @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. - */ - deleteMethodWithHttpOperationResponse(accountName: string, path: string, options?: { recursive? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Deletes the requested file or directory, optionally recursively. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory to delete. - * - * @param {object} [options] Optional Parameters. - * - * @param {boolean} [options.recursive] The optional switch indicating if the - * delete should be recursive - * - * @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 {FileOperationResult} - 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. - * - * {FileOperationResult} [result] - The deserialized result object if an error did not occur. - * See {@link FileOperationResult} 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. - */ - deleteMethod(accountName: string, path: string, options?: { recursive? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise; - deleteMethod(accountName: string, path: string, callback: ServiceCallback): void; - deleteMethod(accountName: string, path: string, options: { recursive? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Rename a file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory to move/rename. - * - * @param {string} destination The path to move/rename the file or folder to - * - * @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. - */ - renameWithHttpOperationResponse(accountName: string, path: string, destination: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Rename a file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory to move/rename. - * - * @param {string} destination The path to move/rename the file or folder to - * - * @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 {FileOperationResult} - 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. - * - * {FileOperationResult} [result] - The deserialized result object if an error did not occur. - * See {@link FileOperationResult} 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. - */ - rename(accountName: string, path: string, destination: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - rename(accountName: string, path: string, destination: string, callback: ServiceCallback): void; - rename(accountName: string, path: string, destination: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Sets the owner of a file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to set the owner. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.owner] The AAD Object ID of the user owner of the - * file or directory. If empty, the property will remain unchanged. - * - * @param {string} [options.group] The AAD Object ID of the group owner of the - * file or directory. If empty, the property will remain unchanged. - * - * @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. - */ - setOwnerWithHttpOperationResponse(accountName: string, path: string, options?: { owner? : string, group? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Sets the owner of a file or directory. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to set the owner. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.owner] The AAD Object ID of the user owner of the - * file or directory. If empty, the property will remain unchanged. - * - * @param {string} [options.group] The AAD Object ID of the group owner of the - * file or directory. If empty, the property will remain unchanged. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - setOwner(accountName: string, path: string, options?: { owner? : string, group? : string, customHeaders? : { [headerName: string]: string; } }): Promise; - setOwner(accountName: string, path: string, callback: ServiceCallback): void; - setOwner(accountName: string, path: string, options: { owner? : string, group? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Sets the permission of the file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to set the permission. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.permission] A string representation of the - * permission (i.e 'rwx'). If empty, this property remains unchanged. - * - * @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. - */ - setPermissionWithHttpOperationResponse(accountName: string, path: string, options?: { permission? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Sets the permission of the file or folder. - * - * @param {string} accountName The Azure Data Lake Store account to execute - * filesystem operations on. - * - * @param {string} path The Data Lake Store path (starting with '/') of the - * file or directory for which to set the permission. - * - * @param {object} [options] Optional Parameters. - * - * @param {string} [options.permission] A string representation of the - * permission (i.e 'rwx'). If empty, this property remains unchanged. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - setPermission(accountName: string, path: string, options?: { permission? : string, customHeaders? : { [headerName: string]: string; } }): Promise; - setPermission(accountName: string, path: string, callback: ServiceCallback): void; - setPermission(accountName: string, path: string, options: { permission? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; -} diff --git a/lib/services/dataLake.Store/package.json b/lib/services/dataLake.Store/package.json deleted file mode 100644 index 00c01dcc5e..0000000000 --- a/lib/services/dataLake.Store/package.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "name": "azure-arm-datalake-store", - "author": "Microsoft Corporation", - "contributors": [ - "Goldsmith, Benjamin " - ], - "version": "3.1.0-preview", - "description": "Microsoft Azure Data Lake Store Management Client Library for node", - "tags": [ - "azure", - "sdk" - ], - "keywords": [ - "node", - "azure" - ], - "main": "./lib/dataLakeStore.js", - "types": "./lib/dataLakeStore.d.ts", - "license": "MIT", - "dependencies": { - "ms-rest": "^2.2.2", - "ms-rest-azure": "^2.3.3" - }, - "homepage": "http://github.com/Azure/azure-sdk-for-node", - "repository": { - "type": "git", - "url": "git@github.com:Azure/azure-sdk-for-node.git" - }, - "bugs": { - "url": "http://github.com/Azure/azure-sdk-for-node/issues" - }, - "scripts": { - "test": "npm -s run-script jshint" - } -} \ No newline at end of file diff --git a/lib/services/graphManagement/lib/models/aDGroup.js b/lib/services/graphManagement/lib/models/aDGroup.js index cf18d4c62a..4b860380aa 100644 --- a/lib/services/graphManagement/lib/models/aDGroup.js +++ b/lib/services/graphManagement/lib/models/aDGroup.js @@ -20,13 +20,14 @@ const models = require('./index'); class ADGroup extends models['DirectoryObject'] { /** * Create a ADGroup. - * @member {string} [displayName] The display name of the group. - * @member {boolean} [mailEnabled] Whether the group is mail-enabled. Must be - * false. This is because only pure security groups can be created using the - * Graph API. - * @member {string} [mailNickname] The mail alias for the group. - * @member {boolean} [securityEnabled] Whether the group is security-enable. - * @member {string} [mail] The primary email address of the group. + * @property {string} [displayName] The display name of the group. + * @property {boolean} [mailEnabled] Whether the group is mail-enabled. Must + * be false. This is because only pure security groups can be created using + * the Graph API. + * @property {string} [mailNickname] The mail alias for the group. + * @property {boolean} [securityEnabled] Whether the group is + * security-enable. + * @property {string} [mail] The primary email address of the group. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/addOwnerParameters.js b/lib/services/graphManagement/lib/models/addOwnerParameters.js index 58e49cb1d4..5a82a7a606 100644 --- a/lib/services/graphManagement/lib/models/addOwnerParameters.js +++ b/lib/services/graphManagement/lib/models/addOwnerParameters.js @@ -17,7 +17,7 @@ class AddOwnerParameters { /** * Create a AddOwnerParameters. - * @member {string} url A owner object URL, such as + * @property {string} url A owner object URL, such as * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user, diff --git a/lib/services/graphManagement/lib/models/appRole.js b/lib/services/graphManagement/lib/models/appRole.js index c440fb20e3..73286258de 100644 --- a/lib/services/graphManagement/lib/models/appRole.js +++ b/lib/services/graphManagement/lib/models/appRole.js @@ -16,21 +16,21 @@ class AppRole { /** * Create a AppRole. - * @member {string} [id] Unique role identifier inside the appRoles + * @property {string} [id] Unique role identifier inside the appRoles * collection. - * @member {array} [allowedMemberTypes] Specifies whether this app role + * @property {array} [allowedMemberTypes] Specifies whether this app role * definition can be assigned to users and groups by setting to 'User', or to * other applications (that are accessing this application in daemon service * scenarios) by setting to 'Application', or to both. - * @member {string} [description] Permission help text that appears in the + * @property {string} [description] Permission help text that appears in the * admin app assignment and consent experiences. - * @member {string} [displayName] Display name for the permission that + * @property {string} [displayName] Display name for the permission that * appears in the admin consent and app assignment experiences. - * @member {boolean} [isEnabled] When creating or updating a role definition, - * this must be set to true (which is the default). To delete a role, this - * must first be set to false. At that point, in a subsequent call, this role - * may be removed. - * @member {string} [value] Specifies the value of the roles claim that the + * @property {boolean} [isEnabled] When creating or updating a role + * definition, this must be set to true (which is the default). To delete a + * role, this must first be set to false. At that point, in a subsequent + * call, this role may be removed. + * @property {string} [value] Specifies the value of the roles claim that the * application should expect in the authentication and access tokens. */ constructor() { diff --git a/lib/services/graphManagement/lib/models/application.js b/lib/services/graphManagement/lib/models/application.js index cde51e7052..75aad9291e 100644 --- a/lib/services/graphManagement/lib/models/application.js +++ b/lib/services/graphManagement/lib/models/application.js @@ -20,25 +20,29 @@ const models = require('./index'); class Application extends models['DirectoryObject'] { /** * Create a Application. - * @member {string} [appId] The application ID. - * @member {array} [appRoles] The collection of application roles that an + * @property {string} [appId] The application ID. + * @property {array} [appRoles] The collection of application roles that an * application may declare. These roles can be assigned to users, groups or * service principals. - * @member {array} [appPermissions] The application permissions. - * @member {boolean} [availableToOtherTenants] Whether the application is be - * available to other tenants. - * @member {string} [displayName] The display name of the application. - * @member {array} [identifierUris] A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the + * @property {array} [appPermissions] The application permissions. + * @property {boolean} [availableToOtherTenants] Whether the application is + * be available to other tenants. + * @property {string} [displayName] The display name of the application. + * @property {array} [identifierUris] A collection of URIs for the * application. - * @member {string} [homepage] The home page of the application. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit + * @property {array} [replyUrls] A collection of reply URLs for the + * application. + * @property {string} [homepage] The home page of the application. + * @property {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit * grant flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this + * @property {array} [requiredResourceAccess] Specifies resources that this * application requires access to and the set of OAuth permission scopes and * application roles that it needs under each of those resources. This * pre-configuration of required resource access drives the consent * experience. + * @property {array} [keyCredentials] A collection of KeyCredential objects. + * @property {array} [passwordCredentials] A collection of PasswordCredential + * objects */ constructor() { super(); @@ -205,6 +209,60 @@ class Application extends models['DirectoryObject'] { } } } + }, + keyCredentials: { + required: false, + serializedName: 'keyCredentials', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'KeyCredentialElementType', + type: { + name: 'Composite', + additionalProperties: { + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'ObjectElementType', + type: { + name: 'Object' + } + } + } + }, + className: 'KeyCredential' + } + } + } + }, + passwordCredentials: { + required: false, + serializedName: 'passwordCredentials', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'PasswordCredentialElementType', + type: { + name: 'Composite', + additionalProperties: { + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'ObjectElementType', + type: { + name: 'Object' + } + } + } + }, + className: 'PasswordCredential' + } + } + } } } } diff --git a/lib/services/graphManagement/lib/models/applicationCreateParameters.js b/lib/services/graphManagement/lib/models/applicationCreateParameters.js index 9ad3b2398f..6d651b41b7 100644 --- a/lib/services/graphManagement/lib/models/applicationCreateParameters.js +++ b/lib/services/graphManagement/lib/models/applicationCreateParameters.js @@ -17,22 +17,22 @@ class ApplicationCreateParameters { /** * Create a ApplicationCreateParameters. - * @member {array} [appRoles] The collection of application roles that an + * @property {array} [appRoles] The collection of application roles that an * application may declare. These roles can be assigned to users, groups or * service principals. - * @member {boolean} availableToOtherTenants Whether the application is + * @property {boolean} availableToOtherTenants Whether the application is * available to other tenants. - * @member {string} displayName The display name of the application. - * @member {string} [homepage] The home page of the application. - * @member {array} identifierUris A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the + * @property {string} displayName The display name of the application. + * @property {string} [homepage] The home page of the application. + * @property {array} identifierUris A collection of URIs for the application. + * @property {array} [replyUrls] A collection of reply URLs for the * application. - * @member {array} [keyCredentials] The list of KeyCredential objects. - * @member {array} [passwordCredentials] The list of PasswordCredential + * @property {array} [keyCredentials] The list of KeyCredential objects. + * @property {array} [passwordCredentials] The list of PasswordCredential * objects. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit + * @property {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit * grant flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this + * @property {array} [requiredResourceAccess] Specifies resources that this * application requires access to and the set of OAuth permission scopes and * application roles that it needs under each of those resources. This * pre-configuration of required resource access drives the consent diff --git a/lib/services/graphManagement/lib/models/applicationListResult.js b/lib/services/graphManagement/lib/models/applicationListResult.js index b7ec05b49f..37ec0800ee 100644 --- a/lib/services/graphManagement/lib/models/applicationListResult.js +++ b/lib/services/graphManagement/lib/models/applicationListResult.js @@ -16,7 +16,7 @@ class ApplicationListResult extends Array { /** * Create a ApplicationListResult. - * @member {string} [odatanextLink] The URL to get the next set of results. + * @property {string} [odatanextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/applicationUpdateParameters.js b/lib/services/graphManagement/lib/models/applicationUpdateParameters.js index 31ac3cb8c4..db801f8238 100644 --- a/lib/services/graphManagement/lib/models/applicationUpdateParameters.js +++ b/lib/services/graphManagement/lib/models/applicationUpdateParameters.js @@ -17,22 +17,23 @@ class ApplicationUpdateParameters { /** * Create a ApplicationUpdateParameters. - * @member {array} [appRoles] The collection of application roles that an + * @property {array} [appRoles] The collection of application roles that an * application may declare. These roles can be assigned to users, groups or * service principals. - * @member {boolean} [availableToOtherTenants] Whether the application is + * @property {boolean} [availableToOtherTenants] Whether the application is * available to other tenants - * @member {string} [displayName] The display name of the application. - * @member {string} [homepage] The home page of the application. - * @member {array} [identifierUris] A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the + * @property {string} [displayName] The display name of the application. + * @property {string} [homepage] The home page of the application. + * @property {array} [identifierUris] A collection of URIs for the * application. - * @member {array} [keyCredentials] The list of KeyCredential objects. - * @member {array} [passwordCredentials] The list of PasswordCredential + * @property {array} [replyUrls] A collection of reply URLs for the + * application. + * @property {array} [keyCredentials] The list of KeyCredential objects. + * @property {array} [passwordCredentials] The list of PasswordCredential * objects. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit + * @property {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit * grant flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this + * @property {array} [requiredResourceAccess] Specifies resources that this * application requires access to and the set of OAuth permission scopes and * application roles that it needs under each of those resources. This * pre-configuration of required resource access drives the consent diff --git a/lib/services/graphManagement/lib/models/checkGroupMembershipParameters.js b/lib/services/graphManagement/lib/models/checkGroupMembershipParameters.js index d0cf630d12..e831ed3c7d 100644 --- a/lib/services/graphManagement/lib/models/checkGroupMembershipParameters.js +++ b/lib/services/graphManagement/lib/models/checkGroupMembershipParameters.js @@ -17,8 +17,8 @@ class CheckGroupMembershipParameters { /** * Create a CheckGroupMembershipParameters. - * @member {string} groupId The object ID of the group to check. - * @member {string} memberId The object ID of the contact, group, user, or + * @property {string} groupId The object ID of the group to check. + * @property {string} memberId The object ID of the contact, group, user, or * service principal to check for membership in the specified group. */ constructor() { diff --git a/lib/services/graphManagement/lib/models/checkGroupMembershipResult.js b/lib/services/graphManagement/lib/models/checkGroupMembershipResult.js index a98312b9ff..b02f7ea336 100644 --- a/lib/services/graphManagement/lib/models/checkGroupMembershipResult.js +++ b/lib/services/graphManagement/lib/models/checkGroupMembershipResult.js @@ -17,7 +17,7 @@ class CheckGroupMembershipResult { /** * Create a CheckGroupMembershipResult. - * @member {boolean} [value] True if the specified user, group, contact, or + * @property {boolean} [value] True if the specified user, group, contact, or * service principal has either direct or transitive membership in the * specified group; otherwise, false. */ diff --git a/lib/services/graphManagement/lib/models/directoryObject.js b/lib/services/graphManagement/lib/models/directoryObject.js index e90c0ebad4..93011a4764 100644 --- a/lib/services/graphManagement/lib/models/directoryObject.js +++ b/lib/services/graphManagement/lib/models/directoryObject.js @@ -17,10 +17,10 @@ class DirectoryObject { /** * Create a DirectoryObject. - * @member {string} [objectId] The object ID. - * @member {date} [deletionTimestamp] The time at which the directory object - * was deleted. - * @member {string} objectType Polymorphic Discriminator + * @property {string} [objectId] The object ID. + * @property {date} [deletionTimestamp] The time at which the directory + * object was deleted. + * @property {string} objectType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/directoryObjectListResult.js b/lib/services/graphManagement/lib/models/directoryObjectListResult.js index 25d5bfff6e..54846d976b 100644 --- a/lib/services/graphManagement/lib/models/directoryObjectListResult.js +++ b/lib/services/graphManagement/lib/models/directoryObjectListResult.js @@ -16,7 +16,7 @@ class DirectoryObjectListResult extends Array { /** * Create a DirectoryObjectListResult. - * @member {string} [odatanextLink] The URL to get the next set of results. + * @property {string} [odatanextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/domain.js b/lib/services/graphManagement/lib/models/domain.js index c2465d0ca3..3f18264877 100644 --- a/lib/services/graphManagement/lib/models/domain.js +++ b/lib/services/graphManagement/lib/models/domain.js @@ -17,11 +17,12 @@ class Domain { /** * Create a Domain. - * @member {string} [authenticationType] the type of the authentication into - * the domain. - * @member {boolean} [isDefault] if this is the default domain in the tenant. - * @member {boolean} [isVerified] if this domain's ownership is verified. - * @member {string} name the domain name. + * @property {string} [authenticationType] the type of the authentication + * into the domain. + * @property {boolean} [isDefault] if this is the default domain in the + * tenant. + * @property {boolean} [isVerified] if this domain's ownership is verified. + * @property {string} name the domain name. */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/getObjectsParameters.js b/lib/services/graphManagement/lib/models/getObjectsParameters.js index a05cfd7fed..63a38df4ab 100644 --- a/lib/services/graphManagement/lib/models/getObjectsParameters.js +++ b/lib/services/graphManagement/lib/models/getObjectsParameters.js @@ -17,9 +17,9 @@ class GetObjectsParameters { /** * Create a GetObjectsParameters. - * @member {array} [objectIds] The requested object IDs. - * @member {array} [types] The requested object types. - * @member {boolean} [includeDirectoryObjectReferences] If true, also + * @property {array} [objectIds] The requested object IDs. + * @property {array} [types] The requested object types. + * @property {boolean} [includeDirectoryObjectReferences] If true, also * searches for object IDs in the partner tenant. */ constructor() { diff --git a/lib/services/graphManagement/lib/models/graphError.js b/lib/services/graphManagement/lib/models/graphError.js index 23cb3eff35..b3031d9013 100644 --- a/lib/services/graphManagement/lib/models/graphError.js +++ b/lib/services/graphManagement/lib/models/graphError.js @@ -17,8 +17,8 @@ class GraphError { /** * Create a GraphError. - * @member {string} [code] Error code. - * @member {string} [message] Error message value. + * @property {string} [code] Error code. + * @property {string} [message] Error message value. */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/groupAddMemberParameters.js b/lib/services/graphManagement/lib/models/groupAddMemberParameters.js index fb4956bcfe..f201c3dae0 100644 --- a/lib/services/graphManagement/lib/models/groupAddMemberParameters.js +++ b/lib/services/graphManagement/lib/models/groupAddMemberParameters.js @@ -17,7 +17,7 @@ class GroupAddMemberParameters { /** * Create a GroupAddMemberParameters. - * @member {string} url A member object URL, such as + * @property {string} url A member object URL, such as * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member diff --git a/lib/services/graphManagement/lib/models/groupCreateParameters.js b/lib/services/graphManagement/lib/models/groupCreateParameters.js index f2e8570a59..263043aa00 100644 --- a/lib/services/graphManagement/lib/models/groupCreateParameters.js +++ b/lib/services/graphManagement/lib/models/groupCreateParameters.js @@ -17,8 +17,8 @@ class GroupCreateParameters { /** * Create a GroupCreateParameters. - * @member {string} displayName Group display name - * @member {string} mailNickname Mail nickname + * @property {string} displayName Group display name + * @property {string} mailNickname Mail nickname */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/groupGetMemberGroupsParameters.js b/lib/services/graphManagement/lib/models/groupGetMemberGroupsParameters.js index 810ac8971b..00a60d278c 100644 --- a/lib/services/graphManagement/lib/models/groupGetMemberGroupsParameters.js +++ b/lib/services/graphManagement/lib/models/groupGetMemberGroupsParameters.js @@ -17,7 +17,7 @@ class GroupGetMemberGroupsParameters { /** * Create a GroupGetMemberGroupsParameters. - * @member {boolean} securityEnabledOnly If true, only membership in + * @property {boolean} securityEnabledOnly If true, only membership in * security-enabled groups should be checked. Otherwise, membership in all * groups should be checked. */ diff --git a/lib/services/graphManagement/lib/models/groupListResult.js b/lib/services/graphManagement/lib/models/groupListResult.js index 328199b3b4..4c164fc034 100644 --- a/lib/services/graphManagement/lib/models/groupListResult.js +++ b/lib/services/graphManagement/lib/models/groupListResult.js @@ -16,7 +16,7 @@ class GroupListResult extends Array { /** * Create a GroupListResult. - * @member {string} [odatanextLink] The URL to get the next set of results. + * @property {string} [odatanextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/index.d.ts b/lib/services/graphManagement/lib/models/index.d.ts index 5faedd14fe..bf32a0bed7 100644 --- a/lib/services/graphManagement/lib/models/index.d.ts +++ b/lib/services/graphManagement/lib/models/index.d.ts @@ -1,958 +1,1004 @@ /* * 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 GraphError class. - * @constructor * Active Directory error information. - * - * @member {string} [code] Error code. - * @member {string} [message] Error message value. */ export interface GraphError { + /** + * Error code. + */ code?: string; + /** + * Error message value. + */ message?: string; } /** - * @class - * Initializes a new instance of the DirectoryObject class. - * @constructor * Represents an Azure Active Directory object. - * - * @member {string} [objectId] The object ID. - * @member {date} [deletionTimestamp] The time at which the directory object - * was deleted. - * @member {string} objectType Polymorphic Discriminator */ export interface DirectoryObject { + /** + * The object ID. + */ readonly objectId?: string; + /** + * The time at which the directory object was deleted. + */ readonly deletionTimestamp?: Date; + /** + * Polymorphic Discriminator + */ objectType: 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 KeyCredential class. - * @constructor * Active Directory Key Credential information. - * - * @member {date} [startDate] Start date. - * @member {date} [endDate] End date. - * @member {string} [value] Key value. - * @member {string} [keyId] Key ID. - * @member {string} [usage] Usage. Acceptable values are 'Verify' and 'Sign'. - * @member {string} [type] Type. Acceptable values are 'AsymmetricX509Cert' and - * 'Symmetric'. - * @member {buffer} [customKeyIdentifier] Custom Key Identifier */ export interface KeyCredential { + /** + * Start date. + */ startDate?: Date; + /** + * End date. + */ endDate?: Date; + /** + * Key value. + */ value?: string; + /** + * Key ID. + */ keyId?: string; + /** + * Usage. Acceptable values are 'Verify' and 'Sign'. + */ usage?: string; + /** + * Type. Acceptable values are 'AsymmetricX509Cert' and 'Symmetric'. + */ type?: string; - customKeyIdentifier?: Buffer; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Custom Key Identifier */ - [property: string]: any; + customKeyIdentifier?: string; + /** + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the PasswordCredential class. - * @constructor * Active Directory Password Credential information. - * - * @member {date} [startDate] Start date. - * @member {date} [endDate] End date. - * @member {string} [keyId] Key ID. - * @member {string} [value] Key value. */ export interface PasswordCredential { + /** + * Start date. + */ startDate?: Date; + /** + * End date. + */ endDate?: Date; + /** + * Key ID. + */ keyId?: string; + /** + * Key value. + */ value?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Custom Key Identifier + */ + customKeyIdentifier?: Buffer; + /** + * 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 ResourceAccess class. - * @constructor - * Specifies an OAuth 2.0 permission scope or an app role that an application - * requires. The resourceAccess property of the RequiredResourceAccess type is - * a collection of ResourceAccess. - * - * @member {string} id The unique identifier for one of the OAuth2Permission or - * AppRole instances that the resource application exposes. - * @member {string} [type] Specifies whether the id property references an - * OAuth2Permission or an AppRole. Possible values are "scope" or "role". + * Specifies an OAuth 2.0 permission scope or an app role that an application requires. The + * resourceAccess property of the RequiredResourceAccess type is a collection of ResourceAccess. */ export interface ResourceAccess { + /** + * The unique identifier for one of the OAuth2Permission or AppRole instances that the resource + * application exposes. + */ id: string; + /** + * Specifies whether the id property references an OAuth2Permission or an AppRole. Possible + * values are "scope" or "role". + */ 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 RequiredResourceAccess class. - * @constructor - * Specifies the set of OAuth 2.0 permission scopes and app roles under the - * specified resource that an application requires access to. The specified - * OAuth 2.0 permission scopes may be requested by client applications (through - * the requiredResourceAccess collection) when calling a resource application. - * The requiredResourceAccess property of the Application entity is a - * collection of ReqiredResourceAccess. - * - * @member {array} resourceAccess The list of OAuth2.0 permission scopes and - * app roles that the application requires from the specified resource. - * @member {string} [resourceAppId] The unique identifier for the resource that - * the application requires access to. This should be equal to the appId - * declared on the target resource application. + * Specifies the set of OAuth 2.0 permission scopes and app roles under the specified resource that + * an application requires access to. The specified OAuth 2.0 permission scopes may be requested by + * client applications (through the requiredResourceAccess collection) when calling a resource + * application. The requiredResourceAccess property of the Application entity is a collection of + * RequiredResourceAccess. */ export interface RequiredResourceAccess { + /** + * The list of OAuth2.0 permission scopes and app roles that the application requires from the + * specified resource. + */ resourceAccess: ResourceAccess[]; + /** + * The unique identifier for the resource that the application requires access to. This should be + * equal to the appId declared on the target resource application. + */ resourceAppId?: 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; -} - -/** - * @class - * Initializes a new instance of the AppRole class. - * @constructor - * @member {string} [id] Unique role identifier inside the appRoles collection. - * @member {array} [allowedMemberTypes] Specifies whether this app role - * definition can be assigned to users and groups by setting to 'User', or to - * other applications (that are accessing this application in daemon service - * scenarios) by setting to 'Application', or to both. - * @member {string} [description] Permission help text that appears in the - * admin app assignment and consent experiences. - * @member {string} [displayName] Display name for the permission that appears - * in the admin consent and app assignment experiences. - * @member {boolean} [isEnabled] When creating or updating a role definition, - * this must be set to true (which is the default). To delete a role, this must - * first be set to false. At that point, in a subsequent call, this role may be - * removed. - * @member {string} [value] Specifies the value of the roles claim that the - * application should expect in the authentication and access tokens. - */ + [additionalPropertyName: string]: any; +} + export interface AppRole { + /** + * Unique role identifier inside the appRoles collection. + */ id?: string; + /** + * Specifies whether this app role definition can be assigned to users and groups by setting to + * 'User', or to other applications (that are accessing this application in daemon service + * scenarios) by setting to 'Application', or to both. + */ allowedMemberTypes?: string[]; + /** + * Permission help text that appears in the admin app assignment and consent experiences. + */ description?: string; + /** + * Display name for the permission that appears in the admin consent and app assignment + * experiences. + */ displayName?: string; + /** + * When creating or updating a role definition, this must be set to true (which is the default). + * To delete a role, this must first be set to false. At that point, in a subsequent call, this + * role may be removed. + */ isEnabled?: boolean; + /** + * Specifies the value of the roles claim that the application should expect in the + * authentication and access tokens. + */ value?: string; } /** - * @class - * Initializes a new instance of the ApplicationCreateParameters class. - * @constructor * Request parameters for creating a new application. - * - * @member {array} [appRoles] The collection of application roles that an - * application may declare. These roles can be assigned to users, groups or - * service principals. - * @member {boolean} availableToOtherTenants Whether the application is - * available to other tenants. - * @member {string} displayName The display name of the application. - * @member {string} [homepage] The home page of the application. - * @member {array} identifierUris A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the application. - * @member {array} [keyCredentials] The list of KeyCredential objects. - * @member {array} [passwordCredentials] The list of PasswordCredential - * objects. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit grant - * flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this - * application requires access to and the set of OAuth permission scopes and - * application roles that it needs under each of those resources. This - * pre-configuration of required resource access drives the consent experience. - */ +*/ export interface ApplicationCreateParameters { + /** + * The collection of application roles that an application may declare. These roles can be + * assigned to users, groups or service principals. + */ appRoles?: AppRole[]; + /** + * Whether the application is available to other tenants. + */ availableToOtherTenants: boolean; + /** + * The display name of the application. + */ displayName: string; + /** + * The home page of the application. + */ homepage?: string; + /** + * A collection of URIs for the application. + */ identifierUris: string[]; + /** + * A collection of reply URLs for the application. + */ replyUrls?: string[]; + /** + * The list of KeyCredential objects. + */ keyCredentials?: KeyCredential[]; + /** + * The list of PasswordCredential objects. + */ passwordCredentials?: PasswordCredential[]; + /** + * Whether to allow implicit grant flow for OAuth2 + */ oauth2AllowImplicitFlow?: boolean; + /** + * Specifies resources that this application requires access to and the set of OAuth permission + * scopes and application roles that it needs under each of those resources. This + * pre-configuration of required resource access drives the consent experience. + */ requiredResourceAccess?: RequiredResourceAccess[]; /** - * @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 ApplicationUpdateParameters class. - * @constructor * Request parameters for updating an existing application. - * - * @member {array} [appRoles] The collection of application roles that an - * application may declare. These roles can be assigned to users, groups or - * service principals. - * @member {boolean} [availableToOtherTenants] Whether the application is - * available to other tenants - * @member {string} [displayName] The display name of the application. - * @member {string} [homepage] The home page of the application. - * @member {array} [identifierUris] A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the application. - * @member {array} [keyCredentials] The list of KeyCredential objects. - * @member {array} [passwordCredentials] The list of PasswordCredential - * objects. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit grant - * flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this - * application requires access to and the set of OAuth permission scopes and - * application roles that it needs under each of those resources. This - * pre-configuration of required resource access drives the consent experience. - */ +*/ export interface ApplicationUpdateParameters { + /** + * The collection of application roles that an application may declare. These roles can be + * assigned to users, groups or service principals. + */ appRoles?: AppRole[]; + /** + * Whether the application is available to other tenants + */ availableToOtherTenants?: boolean; + /** + * The display name of the application. + */ displayName?: string; + /** + * The home page of the application. + */ homepage?: string; + /** + * A collection of URIs for the application. + */ identifierUris?: string[]; + /** + * A collection of reply URLs for the application. + */ replyUrls?: string[]; + /** + * The list of KeyCredential objects. + */ keyCredentials?: KeyCredential[]; + /** + * The list of PasswordCredential objects. + */ passwordCredentials?: PasswordCredential[]; + /** + * Whether to allow implicit grant flow for OAuth2 + */ oauth2AllowImplicitFlow?: boolean; + /** + * Specifies resources that this application requires access to and the set of OAuth permission + * scopes and application roles that it needs under each of those resources. This + * pre-configuration of required resource access drives the consent experience. + */ requiredResourceAccess?: RequiredResourceAccess[]; /** - * @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 Application class. - * @constructor * Active Directory application information. - * - * @member {string} [appId] The application ID. - * @member {array} [appRoles] The collection of application roles that an - * application may declare. These roles can be assigned to users, groups or - * service principals. - * @member {array} [appPermissions] The application permissions. - * @member {boolean} [availableToOtherTenants] Whether the application is be - * available to other tenants. - * @member {string} [displayName] The display name of the application. - * @member {array} [identifierUris] A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the application. - * @member {string} [homepage] The home page of the application. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit grant - * flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this - * application requires access to and the set of OAuth permission scopes and - * application roles that it needs under each of those resources. This - * pre-configuration of required resource access drives the consent experience. - */ +*/ export interface Application extends DirectoryObject { + /** + * The application ID. + */ appId?: string; + /** + * The collection of application roles that an application may declare. These roles can be + * assigned to users, groups or service principals. + */ appRoles?: AppRole[]; + /** + * The application permissions. + */ appPermissions?: string[]; + /** + * Whether the application is be available to other tenants. + */ availableToOtherTenants?: boolean; + /** + * The display name of the application. + */ displayName?: string; + /** + * A collection of URIs for the application. + */ identifierUris?: string[]; + /** + * A collection of reply URLs for the application. + */ replyUrls?: string[]; + /** + * The home page of the application. + */ homepage?: string; + /** + * Whether to allow implicit grant flow for OAuth2 + */ oauth2AllowImplicitFlow?: boolean; + /** + * Specifies resources that this application requires access to and the set of OAuth permission + * scopes and application roles that it needs under each of those resources. This + * pre-configuration of required resource access drives the consent experience. + */ requiredResourceAccess?: RequiredResourceAccess[]; + /** + * A collection of KeyCredential objects. + */ + keyCredentials?: KeyCredential[]; + /** + * A collection of PasswordCredential objects + */ + passwordCredentials?: PasswordCredential[]; } /** - * @class - * Initializes a new instance of the AddOwnerParameters class. - * @constructor * Request parameters for adding a owner to an application. - * - * @member {string} url A owner object URL, such as - * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", - * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and - * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user, - * application, servicePrincipal, group) to be added. - */ +*/ export interface AddOwnerParameters { + /** + * A owner object URL, such as + * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", + * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user, application, + * servicePrincipal, group) to be added. + */ url: 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 KeyCredentialsUpdateParameters class. - * @constructor * Request parameters for a KeyCredentials update operation - * - * @member {array} value A collection of KeyCredentials. - */ +*/ export interface KeyCredentialsUpdateParameters { + /** + * A collection of KeyCredentials. + */ value: KeyCredential[]; } /** - * @class - * Initializes a new instance of the PasswordCredentialsUpdateParameters class. - * @constructor * Request parameters for a PasswordCredentials update operation. - * - * @member {array} value A collection of PasswordCredentials. - */ +*/ export interface PasswordCredentialsUpdateParameters { + /** + * A collection of PasswordCredentials. + */ value: PasswordCredential[]; } /** - * @class - * Initializes a new instance of the GroupAddMemberParameters class. - * @constructor * Request parameters for adding a member to a group. - * - * @member {string} url A member object URL, such as - * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", - * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and - * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member (user, - * application, servicePrincipal, group) to be added. - */ +*/ export interface GroupAddMemberParameters { + /** + * A member object URL, such as + * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", + * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member (user, application, + * servicePrincipal, group) to be added. + */ url: 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 GroupCreateParameters class. - * @constructor * Request parameters for creating a new group. - * - * @member {string} displayName Group display name - * @member {string} mailNickname Mail nickname - */ +*/ export interface GroupCreateParameters { + /** + * Group display name + */ displayName: string; + /** + * Mail nickname + */ mailNickname: 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 ADGroup class. - * @constructor * Active Directory group information. - * - * @member {string} [displayName] The display name of the group. - * @member {boolean} [mailEnabled] Whether the group is mail-enabled. Must be - * false. This is because only pure security groups can be created using the - * Graph API. - * @member {string} [mailNickname] The mail alias for the group. - * @member {boolean} [securityEnabled] Whether the group is security-enable. - * @member {string} [mail] The primary email address of the group. - */ +*/ export interface ADGroup extends DirectoryObject { + /** + * The display name of the group. + */ displayName?: string; + /** + * Whether the group is mail-enabled. Must be false. This is because only pure security groups + * can be created using the Graph API. + */ mailEnabled?: boolean; + /** + * The mail alias for the group. + */ mailNickname?: string; + /** + * Whether the group is security-enable. + */ securityEnabled?: boolean; + /** + * The primary email address of the group. + */ mail?: string; } /** - * @class - * Initializes a new instance of the GroupGetMemberGroupsParameters class. - * @constructor * Request parameters for GetMemberGroups API call. - * - * @member {boolean} securityEnabledOnly If true, only membership in - * security-enabled groups should be checked. Otherwise, membership in all - * groups should be checked. - */ +*/ export interface GroupGetMemberGroupsParameters { + /** + * If true, only membership in security-enabled groups should be checked. Otherwise, membership + * in all groups should be checked. + */ securityEnabledOnly: 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 CheckGroupMembershipParameters class. - * @constructor * Request parameters for IsMemberOf API call. - * - * @member {string} groupId The object ID of the group to check. - * @member {string} memberId The object ID of the contact, group, user, or - * service principal to check for membership in the specified group. - */ +*/ export interface CheckGroupMembershipParameters { + /** + * The object ID of the group to check. + */ groupId: string; + /** + * The object ID of the contact, group, user, or service principal to check for membership in the + * specified group. + */ memberId: 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 CheckGroupMembershipResult class. - * @constructor * Server response for IsMemberOf API call - * - * @member {boolean} [value] True if the specified user, group, contact, or - * service principal has either direct or transitive membership in the - * specified group; otherwise, false. - */ +*/ export interface CheckGroupMembershipResult { + /** + * True if the specified user, group, contact, or service principal has either direct or + * transitive membership in the specified group; otherwise, false. + */ value?: 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 ServicePrincipalCreateParameters class. - * @constructor * Request parameters for creating a new service principal. - * - * @member {boolean} [accountEnabled] Whether the account is enabled - * @member {string} appId application Id - * @member {boolean} [appRoleAssignmentRequired] Specifies whether an - * AppRoleAssignment to a user or group is required before Azure AD will issue - * a user or access token to the application. - * @member {string} [displayName] The display name for the service principal. - * @member {string} [errorUrl] - * @member {string} [homepage] The URL to the homepage of the associated - * application. - * @member {array} [keyCredentials] A collection of KeyCredential objects. - * @member {array} [passwordCredentials] A collection of PasswordCredential - * objects - * @member {string} [publisherName] The display name of the tenant in which the - * associated application is specified. - * @member {array} [replyUrls] A collection of reply URLs for the service - * principal. - * @member {string} [samlMetadataUrl] - * @member {array} [servicePrincipalNames] A collection of service principal - * names. - * @member {array} [tags] - */ +*/ export interface ServicePrincipalCreateParameters { + /** + * Whether the account is enabled + */ accountEnabled?: boolean; + /** + * application Id + */ appId: string; + /** + * Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will + * issue a user or access token to the application. + */ appRoleAssignmentRequired?: boolean; + /** + * The display name for the service principal. + */ displayName?: string; errorUrl?: string; + /** + * The URL to the homepage of the associated application. + */ homepage?: string; + /** + * A collection of KeyCredential objects. + */ keyCredentials?: KeyCredential[]; + /** + * A collection of PasswordCredential objects + */ passwordCredentials?: PasswordCredential[]; + /** + * The display name of the tenant in which the associated application is specified. + */ publisherName?: string; + /** + * A collection of reply URLs for the service principal. + */ replyUrls?: string[]; samlMetadataUrl?: string; + /** + * A collection of service principal names. + */ servicePrincipalNames?: string[]; tags?: 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 ServicePrincipalUpdateParameters class. - * @constructor * Request parameters for creating a new service principal. - * - * @member {boolean} [accountEnabled] Whether the account is enabled - * @member {string} [appId] application Id - * @member {boolean} [appRoleAssignmentRequired] Specifies whether an - * AppRoleAssignment to a user or group is required before Azure AD will issue - * a user or access token to the application. - * @member {string} [displayName] The display name for the service principal. - * @member {string} [errorUrl] - * @member {string} [homepage] The URL to the homepage of the associated - * application. - * @member {array} [keyCredentials] A collection of KeyCredential objects. - * @member {array} [passwordCredentials] A collection of PasswordCredential - * objects - * @member {string} [publisherName] The display name of the tenant in which the - * associated application is specified. - * @member {array} [replyUrls] A collection of reply URLs for the service - * principal. - * @member {string} [samlMetadataUrl] - * @member {array} [servicePrincipalNames] A collection of service principal - * names. - * @member {array} [tags] - */ +*/ export interface ServicePrincipalUpdateParameters { + /** + * Whether the account is enabled + */ accountEnabled?: boolean; + /** + * application Id + */ appId?: string; + /** + * Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will + * issue a user or access token to the application. + */ appRoleAssignmentRequired?: boolean; + /** + * The display name for the service principal. + */ displayName?: string; errorUrl?: string; + /** + * The URL to the homepage of the associated application. + */ homepage?: string; + /** + * A collection of KeyCredential objects. + */ keyCredentials?: KeyCredential[]; + /** + * A collection of PasswordCredential objects + */ passwordCredentials?: PasswordCredential[]; + /** + * The display name of the tenant in which the associated application is specified. + */ publisherName?: string; + /** + * A collection of reply URLs for the service principal. + */ replyUrls?: string[]; samlMetadataUrl?: string; + /** + * A collection of service principal names. + */ servicePrincipalNames?: string[]; tags?: 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 ServicePrincipal class. - * @constructor * Active Directory service principal information. - * - * @member {string} [displayName] The display name of the service principal. - * @member {string} [appId] The application ID. - * @member {array} [appRoles] The collection of application roles that an - * application may declare. These roles can be assigned to users, groups or - * service principals. - * @member {array} [servicePrincipalNames] A collection of service principal - * names. - */ +*/ export interface ServicePrincipal extends DirectoryObject { + /** + * The display name of the service principal. + */ displayName?: string; + /** + * The application ID. + */ appId?: string; + /** + * The collection of application roles that an application may declare. These roles can be + * assigned to users, groups or service principals. + */ appRoles?: AppRole[]; + /** + * A collection of service principal names. + */ servicePrincipalNames?: string[]; } /** - * @class - * Initializes a new instance of the PasswordProfile class. - * @constructor * The password profile associated with a user. - * - * @member {string} password Password - * @member {boolean} [forceChangePasswordNextLogin] Whether to force a password - * change on next login. - */ +*/ export interface PasswordProfile { + /** + * Password + */ password: string; + /** + * Whether to force a password change on next login. + */ forceChangePasswordNextLogin?: boolean; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; -} - -/** - * @class - * Initializes a new instance of the UserBase class. - * @constructor - * @member {string} [immutableId] This must be specified if you are using a - * federated domain for the user's userPrincipalName (UPN) property when - * creating a new user account. It is used to associate an on-premises Active - * Directory user account with their Azure AD user object. - * @member {string} [usageLocation] A two letter country code (ISO standard - * 3166). Required for users that will be assigned licenses due to legal - * requirement to check for availability of services in countries. Examples - * include: "US", "JP", and "GB". - * @member {string} [givenName] The given name for the user. - * @member {string} [surname] The user's surname (family name or last name). - * @member {string} [userType] A string value that can be used to classify user - * types in your directory, such as 'Member' and 'Guest'. Possible values - * include: 'Member', 'Guest' - */ + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; +} + export interface UserBase { + /** + * This must be specified if you are using a federated domain for the user's userPrincipalName + * (UPN) property when creating a new user account. It is used to associate an on-premises Active + * Directory user account with their Azure AD user object. + */ immutableId?: string; + /** + * A two letter country code (ISO standard 3166). Required for users that will be assigned + * licenses due to legal requirement to check for availability of services in countries. Examples + * include: "US", "JP", and "GB". + */ usageLocation?: string; + /** + * The given name for the user. + */ givenName?: string; + /** + * The user's surname (family name or last name). + */ surname?: string; + /** + * A string value that can be used to classify user types in your directory, such as 'Member' and + * 'Guest'. Possible values include: 'Member', 'Guest' + */ userType?: 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 UserCreateParameters class. - * @constructor * Request parameters for creating a new work or school account user. - * - * @member {boolean} accountEnabled Whether the account is enabled. - * @member {string} displayName The display name of the user. - * @member {object} passwordProfile Password Profile - * @member {string} [passwordProfile.password] Password - * @member {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether to - * force a password change on next login. - * @member {string} userPrincipalName The user principal name - * (someuser@contoso.com). It must contain one of the verified domains for the - * tenant. - * @member {string} mailNickname The mail alias for the user. - * @member {string} [mail] The primary email address of the user. - */ +*/ export interface UserCreateParameters extends UserBase { + /** + * Whether the account is enabled. + */ accountEnabled: boolean; + /** + * The display name of the user. + */ displayName: string; + /** + * Password Profile + */ passwordProfile: PasswordProfile; + /** + * The user principal name (someuser@contoso.com). It must contain one of the verified domains + * for the tenant. + */ userPrincipalName: string; + /** + * The mail alias for the user. + */ mailNickname: string; + /** + * The primary email address of the user. + */ mail?: string; } /** - * @class - * Initializes a new instance of the UserUpdateParameters class. - * @constructor * Request parameters for updating an existing work or school account user. - * - * @member {boolean} [accountEnabled] Whether the account is enabled. - * @member {string} [displayName] The display name of the user. - * @member {object} [passwordProfile] The password profile of the user. - * @member {string} [passwordProfile.password] Password - * @member {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether to - * force a password change on next login. - * @member {string} [userPrincipalName] The user principal name - * (someuser@contoso.com). It must contain one of the verified domains for the - * tenant. - * @member {string} [mailNickname] The mail alias for the user. - */ +*/ export interface UserUpdateParameters extends UserBase { + /** + * Whether the account is enabled. + */ accountEnabled?: boolean; + /** + * The display name of the user. + */ displayName?: string; + /** + * The password profile of the user. + */ passwordProfile?: PasswordProfile; + /** + * The user principal name (someuser@contoso.com). It must contain one of the verified domains + * for the tenant. + */ userPrincipalName?: string; + /** + * The mail alias for the user. + */ mailNickname?: string; } /** - * @class - * Initializes a new instance of the SignInName class. - * @constructor - * Contains information about a sign-in name of a local account user in an - * Azure Active Directory B2C tenant. - * - * @member {string} [type] A string value that can be used to classify user - * sign-in types in your directory, such as 'emailAddress' or 'userName'. - * @member {string} [value] The sign-in used by the local account. Must be - * unique across the company/tenant. For example, 'johnc@example.com'. - */ + * Contains information about a sign-in name of a local account user in an Azure Active Directory + * B2C tenant. +*/ export interface SignInName { + /** + * A string value that can be used to classify user sign-in types in your directory, such as + * 'emailAddress' or 'userName'. + */ type?: string; + /** + * The sign-in used by the local account. Must be unique across the company/tenant. For example, + * 'johnc@example.com'. + */ value?: 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 User class. - * @constructor * Active Directory user information. - * - * @member {string} [immutableId] This must be specified if you are using a - * federated domain for the user's userPrincipalName (UPN) property when - * creating a new user account. It is used to associate an on-premises Active - * Directory user account with their Azure AD user object. - * @member {string} [usageLocation] A two letter country code (ISO standard - * 3166). Required for users that will be assigned licenses due to legal - * requirement to check for availability of services in countries. Examples - * include: "US", "JP", and "GB". - * @member {string} [givenName] The given name for the user. - * @member {string} [surname] The user's surname (family name or last name). - * @member {string} [userType] A string value that can be used to classify user - * types in your directory, such as 'Member' and 'Guest'. Possible values - * include: 'Member', 'Guest' - * @member {boolean} [accountEnabled] Whether the account is enabled. - * @member {string} [displayName] The display name of the user. - * @member {string} [userPrincipalName] The principal name of the user. - * @member {string} [mailNickname] The mail alias for the user. - * @member {string} [mail] The primary email address of the user. - * @member {array} [signInNames] The sign-in names of the user. - */ +*/ export interface User extends DirectoryObject { + /** + * This must be specified if you are using a federated domain for the user's userPrincipalName + * (UPN) property when creating a new user account. It is used to associate an on-premises Active + * Directory user account with their Azure AD user object. + */ immutableId?: string; + /** + * A two letter country code (ISO standard 3166). Required for users that will be assigned + * licenses due to legal requirement to check for availability of services in countries. Examples + * include: "US", "JP", and "GB". + */ usageLocation?: string; + /** + * The given name for the user. + */ givenName?: string; + /** + * The user's surname (family name or last name). + */ surname?: string; + /** + * A string value that can be used to classify user types in your directory, such as 'Member' and + * 'Guest'. Possible values include: 'Member', 'Guest' + */ userType?: string; + /** + * Whether the account is enabled. + */ accountEnabled?: boolean; + /** + * The display name of the user. + */ displayName?: string; + /** + * The principal name of the user. + */ userPrincipalName?: string; + /** + * The mail alias for the user. + */ mailNickname?: string; + /** + * The primary email address of the user. + */ mail?: string; + /** + * The sign-in names of the user. + */ signInNames?: SignInName[]; } /** - * @class - * Initializes a new instance of the UserGetMemberGroupsParameters class. - * @constructor * Request parameters for GetMemberGroups API call. - * - * @member {boolean} securityEnabledOnly If true, only membership in - * security-enabled groups should be checked. Otherwise, membership in all - * groups should be checked. - */ +*/ export interface UserGetMemberGroupsParameters { + /** + * If true, only membership in security-enabled groups should be checked. Otherwise, membership + * in all groups should be checked. + */ securityEnabledOnly: 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 GetObjectsParameters class. - * @constructor * Request parameters for the GetObjectsByObjectIds API. - * - * @member {array} [objectIds] The requested object IDs. - * @member {array} [types] The requested object types. - * @member {boolean} [includeDirectoryObjectReferences] If true, also searches - * for object IDs in the partner tenant. - */ +*/ export interface GetObjectsParameters { + /** + * The requested object IDs. + */ objectIds?: string[]; + /** + * The requested object types. + */ types?: string[]; + /** + * If true, also searches for object IDs in the partner tenant. + */ includeDirectoryObjectReferences?: 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 Domain class. - * @constructor * Active Directory Domain information. - * - * @member {string} [authenticationType] the type of the authentication into - * the domain. - * @member {boolean} [isDefault] if this is the default domain in the tenant. - * @member {boolean} [isVerified] if this domain's ownership is verified. - * @member {string} name the domain name. - */ +*/ export interface Domain { + /** + * the type of the authentication into the domain. + */ readonly authenticationType?: string; + /** + * if this is the default domain in the tenant. + */ readonly isDefault?: boolean; + /** + * if this domain's ownership is verified. + */ readonly isVerified?: boolean; + /** + * the domain name. + */ name: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; -} - -/** - * @class - * Initializes a new instance of the Permissions class. - * @constructor - * @member {string} [odatatype] - * Microsoft.DirectoryServices.OAuth2PermissionGrant - * @member {string} [clientId] The objectId of the Service Principal associated - * with the app - * @member {string} [consentType] Typically set to AllPrincipals - * @member {object} [principalId] Set to null if AllPrincipals is set - * @member {string} [resourceId] Service Principal Id of the resource you want - * to grant - * @member {string} [scope] Typically set to user_impersonation - * @member {string} [startTime] Start time for TTL - * @member {string} [expiryTime] Expiry time for TTL - */ + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; +} + export interface Permissions { + /** + * Microsoft.DirectoryServices.OAuth2PermissionGrant + */ odatatype?: string; + /** + * The objectId of the Service Principal associated with the app + */ clientId?: string; + /** + * Typically set to AllPrincipals + */ consentType?: string; + /** + * Set to null if AllPrincipals is set + */ principalId?: any; + /** + * Service Principal Id of the resource you want to grant + */ resourceId?: string; + /** + * Typically set to user_impersonation + */ scope?: string; + /** + * Start time for TTL + */ startTime?: string; + /** + * Expiry time for TTL + */ expiryTime?: string; } - /** - * @class - * Initializes a new instance of the DirectoryObjectListResult class. - * @constructor * DirectoryObject list operation result. - * - * @member {string} [odatanextLink] The URL to get the next set of results. - */ +*/ export interface DirectoryObjectListResult extends Array { + /** + * The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the ApplicationListResult class. - * @constructor * Application list operation result. - * - * @member {string} [odatanextLink] The URL to get the next set of results. - */ +*/ export interface ApplicationListResult extends Array { + /** + * The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the KeyCredentialListResult class. - * @constructor * KeyCredential list operation result. - * - */ +*/ export interface KeyCredentialListResult extends Array { } /** - * @class - * Initializes a new instance of the PasswordCredentialListResult class. - * @constructor * PasswordCredential list operation result. - * - */ +*/ export interface PasswordCredentialListResult extends Array { } /** - * @class - * Initializes a new instance of the GroupListResult class. - * @constructor * Server response for Get tenant groups API call - * - * @member {string} [odatanextLink] The URL to get the next set of results. - */ +*/ export interface GroupListResult extends Array { + /** + * The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the GroupGetMemberGroupsResult class. - * @constructor * Server response for GetMemberGroups API call. - * - */ +*/ export interface GroupGetMemberGroupsResult extends Array { } /** - * @class - * Initializes a new instance of the ServicePrincipalListResult class. - * @constructor * Server response for get tenant service principals API call. - * - * @member {string} [odatanextLink] the URL to get the next set of results. - */ +*/ export interface ServicePrincipalListResult extends Array { + /** + * the URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the UserListResult class. - * @constructor * Server response for Get tenant users API call. - * - * @member {string} [odatanextLink] The URL to get the next set of results. - */ +*/ export interface UserListResult extends Array { + /** + * The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the UserGetMemberGroupsResult class. - * @constructor * Server response for GetMemberGroups API call. - * - */ +*/ export interface UserGetMemberGroupsResult extends Array { } /** - * @class - * Initializes a new instance of the DomainListResult class. - * @constructor * Server response for Get tenant domains API call. - * - */ +*/ export interface DomainListResult extends Array { } diff --git a/lib/services/graphManagement/lib/models/keyCredential.js b/lib/services/graphManagement/lib/models/keyCredential.js index 742322cbbc..f127c00479 100644 --- a/lib/services/graphManagement/lib/models/keyCredential.js +++ b/lib/services/graphManagement/lib/models/keyCredential.js @@ -17,14 +17,15 @@ class KeyCredential { /** * Create a KeyCredential. - * @member {date} [startDate] Start date. - * @member {date} [endDate] End date. - * @member {string} [value] Key value. - * @member {string} [keyId] Key ID. - * @member {string} [usage] Usage. Acceptable values are 'Verify' and 'Sign'. - * @member {string} [type] Type. Acceptable values are 'AsymmetricX509Cert' + * @property {date} [startDate] Start date. + * @property {date} [endDate] End date. + * @property {string} [value] Key value. + * @property {string} [keyId] Key ID. + * @property {string} [usage] Usage. Acceptable values are 'Verify' and + * 'Sign'. + * @property {string} [type] Type. Acceptable values are 'AsymmetricX509Cert' * and 'Symmetric'. - * @member {buffer} [customKeyIdentifier] Custom Key Identifier + * @property {string} [customKeyIdentifier] Custom Key Identifier */ constructor() { } @@ -101,7 +102,7 @@ class KeyCredential { required: false, serializedName: 'customKeyIdentifier', type: { - name: 'ByteArray' + name: 'String' } } } diff --git a/lib/services/graphManagement/lib/models/keyCredentialsUpdateParameters.js b/lib/services/graphManagement/lib/models/keyCredentialsUpdateParameters.js index 6496544fd8..aaf3334c41 100644 --- a/lib/services/graphManagement/lib/models/keyCredentialsUpdateParameters.js +++ b/lib/services/graphManagement/lib/models/keyCredentialsUpdateParameters.js @@ -17,7 +17,7 @@ class KeyCredentialsUpdateParameters { /** * Create a KeyCredentialsUpdateParameters. - * @member {array} value A collection of KeyCredentials. + * @property {array} value A collection of KeyCredentials. */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/passwordCredential.js b/lib/services/graphManagement/lib/models/passwordCredential.js index 02120fcc77..b1901ef48b 100644 --- a/lib/services/graphManagement/lib/models/passwordCredential.js +++ b/lib/services/graphManagement/lib/models/passwordCredential.js @@ -17,10 +17,11 @@ class PasswordCredential { /** * Create a PasswordCredential. - * @member {date} [startDate] Start date. - * @member {date} [endDate] End date. - * @member {string} [keyId] Key ID. - * @member {string} [value] Key value. + * @property {date} [startDate] Start date. + * @property {date} [endDate] End date. + * @property {string} [keyId] Key ID. + * @property {string} [value] Key value. + * @property {buffer} [customKeyIdentifier] Custom Key Identifier */ constructor() { } @@ -78,6 +79,13 @@ class PasswordCredential { type: { name: 'String' } + }, + customKeyIdentifier: { + required: false, + serializedName: 'customKeyIdentifier', + type: { + name: 'ByteArray' + } } } } diff --git a/lib/services/graphManagement/lib/models/passwordCredentialsUpdateParameters.js b/lib/services/graphManagement/lib/models/passwordCredentialsUpdateParameters.js index ca2cc587c1..6bb7de753e 100644 --- a/lib/services/graphManagement/lib/models/passwordCredentialsUpdateParameters.js +++ b/lib/services/graphManagement/lib/models/passwordCredentialsUpdateParameters.js @@ -17,7 +17,7 @@ class PasswordCredentialsUpdateParameters { /** * Create a PasswordCredentialsUpdateParameters. - * @member {array} value A collection of PasswordCredentials. + * @property {array} value A collection of PasswordCredentials. */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/passwordProfile.js b/lib/services/graphManagement/lib/models/passwordProfile.js index 5be23506eb..ce8955eea0 100644 --- a/lib/services/graphManagement/lib/models/passwordProfile.js +++ b/lib/services/graphManagement/lib/models/passwordProfile.js @@ -17,8 +17,8 @@ class PasswordProfile { /** * Create a PasswordProfile. - * @member {string} password Password - * @member {boolean} [forceChangePasswordNextLogin] Whether to force a + * @property {string} password Password + * @property {boolean} [forceChangePasswordNextLogin] Whether to force a * password change on next login. */ constructor() { diff --git a/lib/services/graphManagement/lib/models/permissions.js b/lib/services/graphManagement/lib/models/permissions.js index b2961bb5f6..815cb2d112 100644 --- a/lib/services/graphManagement/lib/models/permissions.js +++ b/lib/services/graphManagement/lib/models/permissions.js @@ -16,17 +16,17 @@ class Permissions { /** * Create a Permissions. - * @member {string} [odatatype] + * @property {string} [odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant - * @member {string} [clientId] The objectId of the Service Principal + * @property {string} [clientId] The objectId of the Service Principal * associated with the app - * @member {string} [consentType] Typically set to AllPrincipals - * @member {object} [principalId] Set to null if AllPrincipals is set - * @member {string} [resourceId] Service Principal Id of the resource you + * @property {string} [consentType] Typically set to AllPrincipals + * @property {object} [principalId] Set to null if AllPrincipals is set + * @property {string} [resourceId] Service Principal Id of the resource you * want to grant - * @member {string} [scope] Typically set to user_impersonation - * @member {string} [startTime] Start time for TTL - * @member {string} [expiryTime] Expiry time for TTL + * @property {string} [scope] Typically set to user_impersonation + * @property {string} [startTime] Start time for TTL + * @property {string} [expiryTime] Expiry time for TTL */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/requiredResourceAccess.js b/lib/services/graphManagement/lib/models/requiredResourceAccess.js index fa512813cb..82275b9fac 100644 --- a/lib/services/graphManagement/lib/models/requiredResourceAccess.js +++ b/lib/services/graphManagement/lib/models/requiredResourceAccess.js @@ -16,15 +16,15 @@ * OAuth 2.0 permission scopes may be requested by client applications (through * the requiredResourceAccess collection) when calling a resource application. * The requiredResourceAccess property of the Application entity is a - * collection of ReqiredResourceAccess. + * collection of RequiredResourceAccess. * */ class RequiredResourceAccess { /** * Create a RequiredResourceAccess. - * @member {array} resourceAccess The list of OAuth2.0 permission scopes and - * app roles that the application requires from the specified resource. - * @member {string} [resourceAppId] The unique identifier for the resource + * @property {array} resourceAccess The list of OAuth2.0 permission scopes + * and app roles that the application requires from the specified resource. + * @property {string} [resourceAppId] The unique identifier for the resource * that the application requires access to. This should be equal to the appId * declared on the target resource application. */ diff --git a/lib/services/graphManagement/lib/models/resourceAccess.js b/lib/services/graphManagement/lib/models/resourceAccess.js index 95ed68e953..045b88105f 100644 --- a/lib/services/graphManagement/lib/models/resourceAccess.js +++ b/lib/services/graphManagement/lib/models/resourceAccess.js @@ -19,9 +19,10 @@ class ResourceAccess { /** * Create a ResourceAccess. - * @member {string} id The unique identifier for one of the OAuth2Permission - * or AppRole instances that the resource application exposes. - * @member {string} [type] Specifies whether the id property references an + * @property {string} id The unique identifier for one of the + * OAuth2Permission or AppRole instances that the resource application + * exposes. + * @property {string} [type] Specifies whether the id property references an * OAuth2Permission or an AppRole. Possible values are "scope" or "role". */ constructor() { diff --git a/lib/services/graphManagement/lib/models/servicePrincipal.js b/lib/services/graphManagement/lib/models/servicePrincipal.js index 884bfe3290..f8f1cc52a7 100644 --- a/lib/services/graphManagement/lib/models/servicePrincipal.js +++ b/lib/services/graphManagement/lib/models/servicePrincipal.js @@ -20,13 +20,14 @@ const models = require('./index'); class ServicePrincipal extends models['DirectoryObject'] { /** * Create a ServicePrincipal. - * @member {string} [displayName] The display name of the service principal. - * @member {string} [appId] The application ID. - * @member {array} [appRoles] The collection of application roles that an + * @property {string} [displayName] The display name of the service + * principal. + * @property {string} [appId] The application ID. + * @property {array} [appRoles] The collection of application roles that an * application may declare. These roles can be assigned to users, groups or * service principals. - * @member {array} [servicePrincipalNames] A collection of service principal - * names. + * @property {array} [servicePrincipalNames] A collection of service + * principal names. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/servicePrincipalCreateParameters.js b/lib/services/graphManagement/lib/models/servicePrincipalCreateParameters.js index ac86b0b7d6..edd05d2e7a 100644 --- a/lib/services/graphManagement/lib/models/servicePrincipalCreateParameters.js +++ b/lib/services/graphManagement/lib/models/servicePrincipalCreateParameters.js @@ -17,26 +17,27 @@ class ServicePrincipalCreateParameters { /** * Create a ServicePrincipalCreateParameters. - * @member {boolean} [accountEnabled] Whether the account is enabled - * @member {string} appId application Id - * @member {boolean} [appRoleAssignmentRequired] Specifies whether an + * @property {boolean} [accountEnabled] Whether the account is enabled + * @property {string} appId application Id + * @property {boolean} [appRoleAssignmentRequired] Specifies whether an * AppRoleAssignment to a user or group is required before Azure AD will * issue a user or access token to the application. - * @member {string} [displayName] The display name for the service principal. - * @member {string} [errorUrl] - * @member {string} [homepage] The URL to the homepage of the associated + * @property {string} [displayName] The display name for the service + * principal. + * @property {string} [errorUrl] + * @property {string} [homepage] The URL to the homepage of the associated * application. - * @member {array} [keyCredentials] A collection of KeyCredential objects. - * @member {array} [passwordCredentials] A collection of PasswordCredential + * @property {array} [keyCredentials] A collection of KeyCredential objects. + * @property {array} [passwordCredentials] A collection of PasswordCredential * objects - * @member {string} [publisherName] The display name of the tenant in which + * @property {string} [publisherName] The display name of the tenant in which * the associated application is specified. - * @member {array} [replyUrls] A collection of reply URLs for the service + * @property {array} [replyUrls] A collection of reply URLs for the service * principal. - * @member {string} [samlMetadataUrl] - * @member {array} [servicePrincipalNames] A collection of service principal - * names. - * @member {array} [tags] + * @property {string} [samlMetadataUrl] + * @property {array} [servicePrincipalNames] A collection of service + * principal names. + * @property {array} [tags] */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/servicePrincipalListResult.js b/lib/services/graphManagement/lib/models/servicePrincipalListResult.js index c0f153512f..a8b374f172 100644 --- a/lib/services/graphManagement/lib/models/servicePrincipalListResult.js +++ b/lib/services/graphManagement/lib/models/servicePrincipalListResult.js @@ -16,7 +16,7 @@ class ServicePrincipalListResult extends Array { /** * Create a ServicePrincipalListResult. - * @member {string} [odatanextLink] the URL to get the next set of results. + * @property {string} [odatanextLink] the URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/servicePrincipalUpdateParameters.js b/lib/services/graphManagement/lib/models/servicePrincipalUpdateParameters.js index e77c75ca62..ac38988ebe 100644 --- a/lib/services/graphManagement/lib/models/servicePrincipalUpdateParameters.js +++ b/lib/services/graphManagement/lib/models/servicePrincipalUpdateParameters.js @@ -17,26 +17,27 @@ class ServicePrincipalUpdateParameters { /** * Create a ServicePrincipalUpdateParameters. - * @member {boolean} [accountEnabled] Whether the account is enabled - * @member {string} [appId] application Id - * @member {boolean} [appRoleAssignmentRequired] Specifies whether an + * @property {boolean} [accountEnabled] Whether the account is enabled + * @property {string} [appId] application Id + * @property {boolean} [appRoleAssignmentRequired] Specifies whether an * AppRoleAssignment to a user or group is required before Azure AD will * issue a user or access token to the application. - * @member {string} [displayName] The display name for the service principal. - * @member {string} [errorUrl] - * @member {string} [homepage] The URL to the homepage of the associated + * @property {string} [displayName] The display name for the service + * principal. + * @property {string} [errorUrl] + * @property {string} [homepage] The URL to the homepage of the associated * application. - * @member {array} [keyCredentials] A collection of KeyCredential objects. - * @member {array} [passwordCredentials] A collection of PasswordCredential + * @property {array} [keyCredentials] A collection of KeyCredential objects. + * @property {array} [passwordCredentials] A collection of PasswordCredential * objects - * @member {string} [publisherName] The display name of the tenant in which + * @property {string} [publisherName] The display name of the tenant in which * the associated application is specified. - * @member {array} [replyUrls] A collection of reply URLs for the service + * @property {array} [replyUrls] A collection of reply URLs for the service * principal. - * @member {string} [samlMetadataUrl] - * @member {array} [servicePrincipalNames] A collection of service principal - * names. - * @member {array} [tags] + * @property {string} [samlMetadataUrl] + * @property {array} [servicePrincipalNames] A collection of service + * principal names. + * @property {array} [tags] */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/signInName.js b/lib/services/graphManagement/lib/models/signInName.js index 39f967e795..9c7fa82f7f 100644 --- a/lib/services/graphManagement/lib/models/signInName.js +++ b/lib/services/graphManagement/lib/models/signInName.js @@ -18,9 +18,9 @@ class SignInName { /** * Create a SignInName. - * @member {string} [type] A string value that can be used to classify user + * @property {string} [type] A string value that can be used to classify user * sign-in types in your directory, such as 'emailAddress' or 'userName'. - * @member {string} [value] The sign-in used by the local account. Must be + * @property {string} [value] The sign-in used by the local account. Must be * unique across the company/tenant. For example, 'johnc@example.com'. */ constructor() { diff --git a/lib/services/graphManagement/lib/models/user.js b/lib/services/graphManagement/lib/models/user.js index 600108e146..80779764be 100644 --- a/lib/services/graphManagement/lib/models/user.js +++ b/lib/services/graphManagement/lib/models/user.js @@ -20,25 +20,26 @@ const models = require('./index'); class User extends models['DirectoryObject'] { /** * Create a User. - * @member {string} [immutableId] This must be specified if you are using a + * @property {string} [immutableId] This must be specified if you are using a * federated domain for the user's userPrincipalName (UPN) property when * creating a new user account. It is used to associate an on-premises Active * Directory user account with their Azure AD user object. - * @member {string} [usageLocation] A two letter country code (ISO standard + * @property {string} [usageLocation] A two letter country code (ISO standard * 3166). Required for users that will be assigned licenses due to legal * requirement to check for availability of services in countries. Examples * include: "US", "JP", and "GB". - * @member {string} [givenName] The given name for the user. - * @member {string} [surname] The user's surname (family name or last name). - * @member {string} [userType] A string value that can be used to classify + * @property {string} [givenName] The given name for the user. + * @property {string} [surname] The user's surname (family name or last + * name). + * @property {string} [userType] A string value that can be used to classify * user types in your directory, such as 'Member' and 'Guest'. Possible * values include: 'Member', 'Guest' - * @member {boolean} [accountEnabled] Whether the account is enabled. - * @member {string} [displayName] The display name of the user. - * @member {string} [userPrincipalName] The principal name of the user. - * @member {string} [mailNickname] The mail alias for the user. - * @member {string} [mail] The primary email address of the user. - * @member {array} [signInNames] The sign-in names of the user. + * @property {boolean} [accountEnabled] Whether the account is enabled. + * @property {string} [displayName] The display name of the user. + * @property {string} [userPrincipalName] The principal name of the user. + * @property {string} [mailNickname] The mail alias for the user. + * @property {string} [mail] The primary email address of the user. + * @property {array} [signInNames] The sign-in names of the user. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/userBase.js b/lib/services/graphManagement/lib/models/userBase.js index c50f11342d..7a831cc859 100644 --- a/lib/services/graphManagement/lib/models/userBase.js +++ b/lib/services/graphManagement/lib/models/userBase.js @@ -16,17 +16,18 @@ class UserBase { /** * Create a UserBase. - * @member {string} [immutableId] This must be specified if you are using a + * @property {string} [immutableId] This must be specified if you are using a * federated domain for the user's userPrincipalName (UPN) property when * creating a new user account. It is used to associate an on-premises Active * Directory user account with their Azure AD user object. - * @member {string} [usageLocation] A two letter country code (ISO standard + * @property {string} [usageLocation] A two letter country code (ISO standard * 3166). Required for users that will be assigned licenses due to legal * requirement to check for availability of services in countries. Examples * include: "US", "JP", and "GB". - * @member {string} [givenName] The given name for the user. - * @member {string} [surname] The user's surname (family name or last name). - * @member {string} [userType] A string value that can be used to classify + * @property {string} [givenName] The given name for the user. + * @property {string} [surname] The user's surname (family name or last + * name). + * @property {string} [userType] A string value that can be used to classify * user types in your directory, such as 'Member' and 'Guest'. Possible * values include: 'Member', 'Guest' */ diff --git a/lib/services/graphManagement/lib/models/userCreateParameters.js b/lib/services/graphManagement/lib/models/userCreateParameters.js index 7680e2ae42..5ea2cb3f20 100644 --- a/lib/services/graphManagement/lib/models/userCreateParameters.js +++ b/lib/services/graphManagement/lib/models/userCreateParameters.js @@ -20,17 +20,17 @@ const models = require('./index'); class UserCreateParameters extends models['UserBase'] { /** * Create a UserCreateParameters. - * @member {boolean} accountEnabled Whether the account is enabled. - * @member {string} displayName The display name of the user. - * @member {object} passwordProfile Password Profile - * @member {string} [passwordProfile.password] Password - * @member {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether + * @property {boolean} accountEnabled Whether the account is enabled. + * @property {string} displayName The display name of the user. + * @property {object} passwordProfile Password Profile + * @property {string} [passwordProfile.password] Password + * @property {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether * to force a password change on next login. - * @member {string} userPrincipalName The user principal name + * @property {string} userPrincipalName The user principal name * (someuser@contoso.com). It must contain one of the verified domains for * the tenant. - * @member {string} mailNickname The mail alias for the user. - * @member {string} [mail] The primary email address of the user. + * @property {string} mailNickname The mail alias for the user. + * @property {string} [mail] The primary email address of the user. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/userGetMemberGroupsParameters.js b/lib/services/graphManagement/lib/models/userGetMemberGroupsParameters.js index 5ba64e6efa..524a8faa47 100644 --- a/lib/services/graphManagement/lib/models/userGetMemberGroupsParameters.js +++ b/lib/services/graphManagement/lib/models/userGetMemberGroupsParameters.js @@ -17,7 +17,7 @@ class UserGetMemberGroupsParameters { /** * Create a UserGetMemberGroupsParameters. - * @member {boolean} securityEnabledOnly If true, only membership in + * @property {boolean} securityEnabledOnly If true, only membership in * security-enabled groups should be checked. Otherwise, membership in all * groups should be checked. */ diff --git a/lib/services/graphManagement/lib/models/userListResult.js b/lib/services/graphManagement/lib/models/userListResult.js index 9c4465bb9c..f8419fa94a 100644 --- a/lib/services/graphManagement/lib/models/userListResult.js +++ b/lib/services/graphManagement/lib/models/userListResult.js @@ -16,7 +16,7 @@ class UserListResult extends Array { /** * Create a UserListResult. - * @member {string} [odatanextLink] The URL to get the next set of results. + * @property {string} [odatanextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/userUpdateParameters.js b/lib/services/graphManagement/lib/models/userUpdateParameters.js index 5c99c86054..7fc9c5df0f 100644 --- a/lib/services/graphManagement/lib/models/userUpdateParameters.js +++ b/lib/services/graphManagement/lib/models/userUpdateParameters.js @@ -20,16 +20,16 @@ const models = require('./index'); class UserUpdateParameters extends models['UserBase'] { /** * Create a UserUpdateParameters. - * @member {boolean} [accountEnabled] Whether the account is enabled. - * @member {string} [displayName] The display name of the user. - * @member {object} [passwordProfile] The password profile of the user. - * @member {string} [passwordProfile.password] Password - * @member {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether + * @property {boolean} [accountEnabled] Whether the account is enabled. + * @property {string} [displayName] The display name of the user. + * @property {object} [passwordProfile] The password profile of the user. + * @property {string} [passwordProfile.password] Password + * @property {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether * to force a password change on next login. - * @member {string} [userPrincipalName] The user principal name + * @property {string} [userPrincipalName] The user principal name * (someuser@contoso.com). It must contain one of the verified domains for * the tenant. - * @member {string} [mailNickname] The mail alias for the user. + * @property {string} [mailNickname] The mail alias for the user. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/operations/index.d.ts b/lib/services/graphManagement/lib/operations/index.d.ts index 6c07de1e44..89ac79ab51 100644 --- a/lib/services/graphManagement/lib/operations/index.d.ts +++ b/lib/services/graphManagement/lib/operations/index.d.ts @@ -4050,7 +4050,7 @@ export interface OAuth2 { * @param {object} [options] Optional Parameters. * * @param {object} [options.body] The relevant app Service Principal Object Id - * and the Service Principal Objecit Id you want to grant. + * and the Service Principal Object Id you want to grant. * * @param {string} [options.body.odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant @@ -4089,7 +4089,7 @@ export interface OAuth2 { * @param {object} [options] Optional Parameters. * * @param {object} [options.body] The relevant app Service Principal Object Id - * and the Service Principal Objecit Id you want to grant. + * and the Service Principal Object Id you want to grant. * * @param {string} [options.body.odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant diff --git a/lib/services/graphManagement/lib/operations/oAuth2.js b/lib/services/graphManagement/lib/operations/oAuth2.js index a38d0b851f..c9d2fe0aeb 100644 --- a/lib/services/graphManagement/lib/operations/oAuth2.js +++ b/lib/services/graphManagement/lib/operations/oAuth2.js @@ -163,7 +163,7 @@ function _get(options, callback) { * @param {object} [options] Optional Parameters. * * @param {object} [options.body] The relevant app Service Principal Object Id - * and the Service Principal Objecit Id you want to grant. + * and the Service Principal Object Id you want to grant. * * @param {string} [options.body.odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant @@ -430,7 +430,7 @@ class OAuth2 { * @param {object} [options] Optional Parameters. * * @param {object} [options.body] The relevant app Service Principal Object Id - * and the Service Principal Objecit Id you want to grant. + * and the Service Principal Object Id you want to grant. * * @param {string} [options.body.odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant @@ -481,7 +481,7 @@ class OAuth2 { * @param {object} [options] Optional Parameters. * * @param {object} [options.body] The relevant app Service Principal Object Id - * and the Service Principal Objecit Id you want to grant. + * and the Service Principal Object Id you want to grant. * * @param {string} [options.body.odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant diff --git a/lib/services/graphManagement/package.json b/lib/services/graphManagement/package.json index 206a3b5b38..2242630873 100644 --- a/lib/services/graphManagement/package.json +++ b/lib/services/graphManagement/package.json @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +} diff --git a/lib/services/kustoManagement/LICENSE.txt b/lib/services/kustoManagement/LICENSE.txt new file mode 100644 index 0000000000..a70e8cf660 --- /dev/null +++ b/lib/services/kustoManagement/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 Microsoft + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/lib/services/kustoManagement/README.md b/lib/services/kustoManagement/README.md new file mode 100644 index 0000000000..05b83ac845 --- /dev/null +++ b/lib/services/kustoManagement/README.md @@ -0,0 +1,43 @@ +--- +uid: azure-arm-kusto +summary: *content + +--- +**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 - KustoManagementClient +This project provides a Node.js package for accessing Azure. Right now it supports: +- **Node.js version 6.x.x or higher** + +### Features + + +### How to Install + +```bash +npm install azure-arm-kusto +``` + +### How to use + +#### Authentication, client creation and get clusters as an example. + +```javascript +const msRestAzure = require("ms-rest-azure"); +const KustoManagementClient = require("azure-arm-kusto"); +msRestAzure.interactiveLogin().then((creds) => { + const subscriptionId = ""; + const client = new KustoManagementClient(creds, subscriptionId); + const resourceGroupName = "testresourceGroupName"; + const clusterName = "testclusterName"; + return client.clusters.get(resourceGroupName, clusterName).then((result) => { + console.log("The result is:"); + console.log(result); + }); +}).catch((err) => { + console.log('An error occurred:'); + console.dir(err, {depth: null, colors: true}); +}); + +### Related projects + +- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) diff --git a/lib/services/dataLake.Store/lib/account/dataLakeStoreAccountManagementClient.d.ts b/lib/services/kustoManagement/lib/kustoManagementClient.d.ts similarity index 82% rename from lib/services/dataLake.Store/lib/account/dataLakeStoreAccountManagementClient.d.ts rename to lib/services/kustoManagement/lib/kustoManagementClient.d.ts index 511c8934ee..955d1414f3 100644 --- a/lib/services/dataLake.Store/lib/account/dataLakeStoreAccountManagementClient.d.ts +++ b/lib/services/kustoManagement/lib/kustoManagementClient.d.ts @@ -13,9 +13,9 @@ import { AzureServiceClient, AzureServiceClientOptions } from 'ms-rest-azure'; import * as models from "./models"; import * as operations from "./operations"; -export default class DataLakeStoreAccountManagementClient extends AzureServiceClient { +export default class KustoManagementClient extends AzureServiceClient { /** - * Initializes a new instance of the DataLakeStoreAccountManagementClient class. + * Initializes a new instance of the KustoManagementClient class. * @constructor * * @class @@ -56,12 +56,10 @@ export default class DataLakeStoreAccountManagementClient extends AzureServiceCl generateClientRequestId: boolean; // Operation groups - accounts: operations.Accounts; - firewallRules: operations.FirewallRules; - virtualNetworkRules: operations.VirtualNetworkRules; - trustedIdProviders: operations.TrustedIdProviders; + clusters: operations.Clusters; + databases: operations.Databases; + eventHubConnections: operations.EventHubConnections; operations: operations.Operations; - locations: operations.Locations; } -export { DataLakeStoreAccountManagementClient, models as DataLakeStoreAccountManagementModels }; +export { KustoManagementClient, models as KustoManagementModels }; diff --git a/lib/services/dataLake.Store/lib/account/dataLakeStoreAccountManagementClient.js b/lib/services/kustoManagement/lib/kustoManagementClient.js similarity index 80% rename from lib/services/dataLake.Store/lib/account/dataLakeStoreAccountManagementClient.js rename to lib/services/kustoManagement/lib/kustoManagementClient.js index 9ccf8f3e43..037a6acc51 100644 --- a/lib/services/dataLake.Store/lib/account/dataLakeStoreAccountManagementClient.js +++ b/lib/services/kustoManagement/lib/kustoManagementClient.js @@ -22,10 +22,10 @@ const models = require('./models'); const operations = require('./operations'); -/** Class representing a DataLakeStoreAccountManagementClient. */ -class DataLakeStoreAccountManagementClient extends ServiceClient { +/** Class representing a KustoManagementClient. */ +class KustoManagementClient extends ServiceClient { /** - * Create a DataLakeStoreAccountManagementClient. + * Create a KustoManagementClient. * @param {credentials} credentials - Credentials needed for the client to connect to Azure. * @param {string} subscriptionId - Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. * @param {string} [baseUri] - The base URI of the service. @@ -50,7 +50,7 @@ class DataLakeStoreAccountManagementClient extends ServiceClient { super(credentials, options); - this.apiVersion = '2016-11-01'; + this.apiVersion = '2018-09-07-preview'; this.acceptLanguage = 'en-US'; this.longRunningOperationRetryTimeout = 30; this.generateClientRequestId = true; @@ -72,19 +72,17 @@ class DataLakeStoreAccountManagementClient extends ServiceClient { if(options.generateClientRequestId !== null && options.generateClientRequestId !== undefined) { this.generateClientRequestId = options.generateClientRequestId; } - this.accounts = new operations.Accounts(this); - this.firewallRules = new operations.FirewallRules(this); - this.virtualNetworkRules = new operations.VirtualNetworkRules(this); - this.trustedIdProviders = new operations.TrustedIdProviders(this); + this.clusters = new operations.Clusters(this); + this.databases = new operations.Databases(this); + this.eventHubConnections = new operations.EventHubConnections(this); this.operations = new operations.Operations(this); - this.locations = new operations.Locations(this); this.models = models; msRest.addSerializationMixin(this); } } -module.exports = DataLakeStoreAccountManagementClient; -module.exports['default'] = DataLakeStoreAccountManagementClient; -module.exports.DataLakeStoreAccountManagementClient = DataLakeStoreAccountManagementClient; -module.exports.DataLakeStoreAccountManagementModels = models; +module.exports = KustoManagementClient; +module.exports['default'] = KustoManagementClient; +module.exports.KustoManagementClient = KustoManagementClient; +module.exports.KustoManagementModels = models; diff --git a/lib/services/kustoManagement/lib/models/azureCapacity.js b/lib/services/kustoManagement/lib/models/azureCapacity.js new file mode 100644 index 0000000000..906cc942e4 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/azureCapacity.js @@ -0,0 +1,76 @@ +/* + * 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'; + +/** + * Class representing a AzureCapacity. + */ +class AzureCapacity { + /** + * Create a AzureCapacity. + * @property {string} scaleType Scale type. Possible values include: + * 'automatic', 'manual', 'none' + * @property {number} minimum Minimum allowed capacity. + * @property {number} maximum Maximum allowed capacity. + * @property {number} default The default capacity that would be used. + */ + constructor() { + } + + /** + * Defines the metadata of AzureCapacity + * + * @returns {object} metadata of AzureCapacity + * + */ + mapper() { + return { + required: false, + serializedName: 'AzureCapacity', + type: { + name: 'Composite', + className: 'AzureCapacity', + modelProperties: { + scaleType: { + required: true, + serializedName: 'scaleType', + type: { + name: 'String' + } + }, + minimum: { + required: true, + serializedName: 'minimum', + type: { + name: 'Number' + } + }, + maximum: { + required: true, + serializedName: 'maximum', + type: { + name: 'Number' + } + }, + default: { + required: true, + serializedName: 'default', + type: { + name: 'Number' + } + } + } + } + }; + } +} + +module.exports = AzureCapacity; diff --git a/lib/services/dataLake.Store/lib/account/models/trustedIdProvider.js b/lib/services/kustoManagement/lib/models/azureEntityResource.js similarity index 69% rename from lib/services/dataLake.Store/lib/account/models/trustedIdProvider.js rename to lib/services/kustoManagement/lib/models/azureEntityResource.js index 0060534f65..83674c0ce4 100644 --- a/lib/services/dataLake.Store/lib/account/models/trustedIdProvider.js +++ b/lib/services/kustoManagement/lib/models/azureEntityResource.js @@ -13,32 +13,33 @@ const models = require('./index'); /** - * Data Lake Store trusted identity provider information. + * The resource model definition for a Azure Resource Manager resource with an + * etag. * - * @extends models['SubResource'] + * @extends models['Resource'] */ -class TrustedIdProvider extends models['SubResource'] { +class AzureEntityResource extends models['Resource'] { /** - * Create a TrustedIdProvider. - * @property {string} [idProvider] The URL of this trusted identity provider. + * Create a AzureEntityResource. + * @property {string} [etag] Resource Etag. */ constructor() { super(); } /** - * Defines the metadata of TrustedIdProvider + * Defines the metadata of AzureEntityResource * - * @returns {object} metadata of TrustedIdProvider + * @returns {object} metadata of AzureEntityResource * */ mapper() { return { required: false, - serializedName: 'TrustedIdProvider', + serializedName: 'AzureEntityResource', type: { name: 'Composite', - className: 'TrustedIdProvider', + className: 'AzureEntityResource', modelProperties: { id: { required: false, @@ -64,10 +65,10 @@ class TrustedIdProvider extends models['SubResource'] { name: 'String' } }, - idProvider: { + etag: { required: false, readOnly: true, - serializedName: 'properties.idProvider', + serializedName: 'etag', type: { name: 'String' } @@ -78,4 +79,4 @@ class TrustedIdProvider extends models['SubResource'] { } } -module.exports = TrustedIdProvider; +module.exports = AzureEntityResource; diff --git a/lib/services/kustoManagement/lib/models/azureResourceSku.js b/lib/services/kustoManagement/lib/models/azureResourceSku.js new file mode 100644 index 0000000000..f6b2640581 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/azureResourceSku.js @@ -0,0 +1,78 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Class representing a AzureResourceSku. + */ +class AzureResourceSku { + /** + * Create a AzureResourceSku. + * @property {string} [resourceType] Resource Namespace and Type. + * @property {object} [sku] The SKU details. + * @property {string} [sku.name] SKU name. Possible values include: 'KC8', + * 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * @property {number} [sku.capacity] SKU capacity. + * @property {object} [capacity] The SKU capacity. + * @property {string} [capacity.scaleType] Scale type. Possible values + * include: 'automatic', 'manual', 'none' + * @property {number} [capacity.minimum] Minimum allowed capacity. + * @property {number} [capacity.maximum] Maximum allowed capacity. + * @property {number} [capacity.default] The default capacity that would be + * used. + */ + constructor() { + } + + /** + * Defines the metadata of AzureResourceSku + * + * @returns {object} metadata of AzureResourceSku + * + */ + mapper() { + return { + required: false, + serializedName: 'AzureResourceSku', + type: { + name: 'Composite', + className: 'AzureResourceSku', + modelProperties: { + resourceType: { + required: false, + serializedName: 'resourceType', + type: { + name: 'String' + } + }, + sku: { + required: false, + serializedName: 'sku', + type: { + name: 'Composite', + className: 'AzureSku' + } + }, + capacity: { + required: false, + serializedName: 'capacity', + type: { + name: 'Composite', + className: 'AzureCapacity' + } + } + } + } + }; + } +} + +module.exports = AzureResourceSku; diff --git a/lib/services/kustoManagement/lib/models/azureSku.js b/lib/services/kustoManagement/lib/models/azureSku.js new file mode 100644 index 0000000000..99238926bb --- /dev/null +++ b/lib/services/kustoManagement/lib/models/azureSku.js @@ -0,0 +1,69 @@ +/* + * 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'; + +/** + * Class representing a AzureSku. + */ +class AzureSku { + /** + * Create a AzureSku. + * @property {string} name SKU name. Possible values include: 'KC8', 'KC16', + * 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * @property {number} [capacity] SKU capacity. + */ + constructor() { + } + + /** + * Defines the metadata of AzureSku + * + * @returns {object} metadata of AzureSku + * + */ + mapper() { + return { + required: false, + serializedName: 'AzureSku', + type: { + name: 'Composite', + className: 'AzureSku', + modelProperties: { + name: { + required: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + capacity: { + required: false, + serializedName: 'capacity', + type: { + name: 'Number' + } + }, + tier: { + required: true, + isConstant: true, + serializedName: 'tier', + defaultValue: 'Standard', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = AzureSku; diff --git a/lib/services/kustoManagement/lib/models/checkNameResult.js b/lib/services/kustoManagement/lib/models/checkNameResult.js new file mode 100644 index 0000000000..27b8cabe91 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/checkNameResult.js @@ -0,0 +1,69 @@ +/* + * 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'; + +/** + * Class representing a CheckNameResult. + */ +class CheckNameResult { + /** + * Create a CheckNameResult. + * @property {boolean} [nameAvailable] Specifies a Boolean value that + * indicates if the name is available. + * @property {string} [name] The name that was checked. + * @property {string} [message] Message indicating an unavailable name due to + * a conflict, or a description of the naming rules that are violated. + */ + constructor() { + } + + /** + * Defines the metadata of CheckNameResult + * + * @returns {object} metadata of CheckNameResult + * + */ + mapper() { + return { + required: false, + serializedName: 'CheckNameResult', + type: { + name: 'Composite', + className: 'CheckNameResult', + modelProperties: { + nameAvailable: { + required: false, + serializedName: 'nameAvailable', + type: { + name: 'Boolean' + } + }, + name: { + required: false, + serializedName: 'name', + type: { + name: 'String' + } + }, + message: { + required: false, + serializedName: 'message', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = CheckNameResult; diff --git a/lib/services/dataLake.Store/lib/account/models/dataLakeStoreAccountBasic.js b/lib/services/kustoManagement/lib/models/cluster.js similarity index 53% rename from lib/services/dataLake.Store/lib/account/models/dataLakeStoreAccountBasic.js rename to lib/services/kustoManagement/lib/models/cluster.js index e829771eeb..73eebccb16 100644 --- a/lib/services/dataLake.Store/lib/account/models/dataLakeStoreAccountBasic.js +++ b/lib/services/kustoManagement/lib/models/cluster.js @@ -13,42 +13,45 @@ const models = require('./index'); /** - * Basic Data Lake Store account information, returned on list calls. + * Class representing a Kusto cluster. * - * @extends models['Resource'] + * @extends models['TrackedResource'] */ -class DataLakeStoreAccountBasic extends models['Resource'] { +class Cluster extends models['TrackedResource'] { /** - * Create a DataLakeStoreAccountBasic. - * @property {uuid} [accountId] The unique identifier associated with this - * Data Lake Store account. - * @property {string} [provisioningState] The provisioning status of the Data - * Lake Store account. Possible values include: 'Failed', 'Creating', - * 'Running', 'Succeeded', 'Patching', 'Suspending', 'Resuming', 'Deleting', - * 'Deleted', 'Undeleting', 'Canceled' - * @property {string} [state] The state of the Data Lake Store account. - * Possible values include: 'Active', 'Suspended' - * @property {date} [creationTime] The account creation time. - * @property {date} [lastModifiedTime] The account last modified time. - * @property {string} [endpoint] The full CName endpoint for this account. + * Create a Cluster. + * @property {string} [etag] An ETag of the resource created. + * @property {object} sku The SKU of the cluster. + * @property {string} [sku.name] SKU name. Possible values include: 'KC8', + * 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * @property {number} [sku.capacity] SKU capacity. + * @property {string} [state] The state of the resource. Possible values + * include: 'Creating', 'Unavailable', 'Running', 'Deleting', 'Deleted', + * 'Stopping', 'Stopped', 'Starting' + * @property {string} [provisioningState] The provisioned state of the + * resource. Possible values include: 'Running', 'Creating', 'Deleting', + * 'Succeeded', 'Failed' + * @property {string} [uri] The cluster URI. + * @property {string} [dataIngestionUri] The cluster data ingestion URI. + * @property {array} [trustedExternalTenants] The cluster's external tenants. */ constructor() { super(); } /** - * Defines the metadata of DataLakeStoreAccountBasic + * Defines the metadata of Cluster * - * @returns {object} metadata of DataLakeStoreAccountBasic + * @returns {object} metadata of Cluster * */ mapper() { return { required: false, - serializedName: 'DataLakeStoreAccountBasic', + serializedName: 'Cluster', type: { name: 'Composite', - className: 'DataLakeStoreAccountBasic', + className: 'Cluster', modelProperties: { id: { required: false, @@ -74,17 +77,8 @@ class DataLakeStoreAccountBasic extends models['Resource'] { name: 'String' } }, - location: { - required: false, - readOnly: true, - serializedName: 'location', - type: { - name: 'String' - } - }, tags: { required: false, - readOnly: true, serializedName: 'tags', type: { name: 'Dictionary', @@ -97,21 +91,28 @@ class DataLakeStoreAccountBasic extends models['Resource'] { } } }, - accountId: { - required: false, - readOnly: true, - serializedName: 'properties.accountId', + location: { + required: true, + serializedName: 'location', type: { name: 'String' } }, - provisioningState: { + etag: { required: false, readOnly: true, - serializedName: 'properties.provisioningState', + serializedName: 'etag', + type: { + name: 'String' + } + }, + sku: { + required: true, + serializedName: 'sku', + defaultValue: {}, type: { - name: 'Enum', - allowedValues: [ 'Failed', 'Creating', 'Running', 'Succeeded', 'Patching', 'Suspending', 'Resuming', 'Deleting', 'Deleted', 'Undeleting', 'Canceled' ] + name: 'Composite', + className: 'AzureSku' } }, state: { @@ -119,33 +120,47 @@ class DataLakeStoreAccountBasic extends models['Resource'] { readOnly: true, serializedName: 'properties.state', type: { - name: 'Enum', - allowedValues: [ 'Active', 'Suspended' ] + name: 'String' } }, - creationTime: { + provisioningState: { required: false, readOnly: true, - serializedName: 'properties.creationTime', + serializedName: 'properties.provisioningState', type: { - name: 'DateTime' + name: 'String' } }, - lastModifiedTime: { + uri: { required: false, readOnly: true, - serializedName: 'properties.lastModifiedTime', + serializedName: 'properties.uri', type: { - name: 'DateTime' + name: 'String' } }, - endpoint: { + dataIngestionUri: { required: false, readOnly: true, - serializedName: 'properties.endpoint', + serializedName: 'properties.dataIngestionUri', type: { name: 'String' } + }, + trustedExternalTenants: { + required: false, + serializedName: 'properties.trustedExternalTenants', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'TrustedExternalTenantElementType', + type: { + name: 'Composite', + className: 'TrustedExternalTenant' + } + } + } } } } @@ -153,4 +168,4 @@ class DataLakeStoreAccountBasic extends models['Resource'] { } } -module.exports = DataLakeStoreAccountBasic; +module.exports = Cluster; diff --git a/lib/services/kustoManagement/lib/models/clusterCheckNameRequest.js b/lib/services/kustoManagement/lib/models/clusterCheckNameRequest.js new file mode 100644 index 0000000000..e52276f0e8 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/clusterCheckNameRequest.js @@ -0,0 +1,60 @@ +/* + * 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'; + +/** + * Class representing a ClusterCheckNameRequest. + */ +class ClusterCheckNameRequest { + /** + * Create a ClusterCheckNameRequest. + * @property {string} name Cluster name. + */ + constructor() { + } + + /** + * Defines the metadata of ClusterCheckNameRequest + * + * @returns {object} metadata of ClusterCheckNameRequest + * + */ + mapper() { + return { + required: false, + serializedName: 'ClusterCheckNameRequest', + type: { + name: 'Composite', + className: 'ClusterCheckNameRequest', + modelProperties: { + name: { + required: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: true, + isConstant: true, + serializedName: 'type', + defaultValue: 'Microsoft.Kusto/clusters', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = ClusterCheckNameRequest; diff --git a/lib/services/kustoManagement/lib/models/clusterListResult.js b/lib/services/kustoManagement/lib/models/clusterListResult.js new file mode 100644 index 0000000000..14d6c6d180 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/clusterListResult.js @@ -0,0 +1,59 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The list Kusto clusters operation response. + */ +class ClusterListResult extends Array { + /** + * Create a ClusterListResult. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ClusterListResult + * + * @returns {object} metadata of ClusterListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'ClusterListResult', + type: { + name: 'Composite', + className: 'ClusterListResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'ClusterElementType', + type: { + name: 'Composite', + className: 'Cluster' + } + } + } + } + } + } + }; + } +} + +module.exports = ClusterListResult; diff --git a/lib/services/kustoManagement/lib/models/clusterUpdate.js b/lib/services/kustoManagement/lib/models/clusterUpdate.js new file mode 100644 index 0000000000..038ad2bd38 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/clusterUpdate.js @@ -0,0 +1,172 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Class representing an update to a Kusto cluster. + * + * @extends models['Resource'] + */ +class ClusterUpdate extends models['Resource'] { + /** + * Create a ClusterUpdate. + * @property {object} [tags] Resource tags. + * @property {string} [location] Resource location. + * @property {string} [etag] An ETag of the resource updated. + * @property {object} [sku] The SKU of the cluster. + * @property {string} [sku.name] SKU name. Possible values include: 'KC8', + * 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * @property {number} [sku.capacity] SKU capacity. + * @property {string} [state] The state of the resource. Possible values + * include: 'Creating', 'Unavailable', 'Running', 'Deleting', 'Deleted', + * 'Stopping', 'Stopped', 'Starting' + * @property {string} [provisioningState] The provisioned state of the + * resource. Possible values include: 'Running', 'Creating', 'Deleting', + * 'Succeeded', 'Failed' + * @property {string} [uri] The cluster URI. + * @property {string} [dataIngestionUri] The cluster data ingestion URI. + * @property {array} [trustedExternalTenants] The cluster's external tenants. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ClusterUpdate + * + * @returns {object} metadata of ClusterUpdate + * + */ + mapper() { + return { + required: false, + serializedName: 'ClusterUpdate', + type: { + name: 'Composite', + className: 'ClusterUpdate', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + location: { + required: false, + serializedName: 'location', + type: { + name: 'String' + } + }, + etag: { + required: false, + readOnly: true, + serializedName: 'etag', + type: { + name: 'String' + } + }, + sku: { + required: false, + serializedName: 'sku', + type: { + name: 'Composite', + className: 'AzureSku' + } + }, + state: { + required: false, + readOnly: true, + serializedName: 'properties.state', + type: { + name: 'String' + } + }, + provisioningState: { + required: false, + readOnly: true, + serializedName: 'properties.provisioningState', + type: { + name: 'String' + } + }, + uri: { + required: false, + readOnly: true, + serializedName: 'properties.uri', + type: { + name: 'String' + } + }, + dataIngestionUri: { + required: false, + readOnly: true, + serializedName: 'properties.dataIngestionUri', + type: { + name: 'String' + } + }, + trustedExternalTenants: { + required: false, + serializedName: 'properties.trustedExternalTenants', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'TrustedExternalTenantElementType', + type: { + name: 'Composite', + className: 'TrustedExternalTenant' + } + } + } + } + } + } + }; + } +} + +module.exports = ClusterUpdate; diff --git a/lib/services/kustoManagement/lib/models/database.js b/lib/services/kustoManagement/lib/models/database.js new file mode 100644 index 0000000000..ef65324d1e --- /dev/null +++ b/lib/services/kustoManagement/lib/models/database.js @@ -0,0 +1,142 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Class representing a Kusto database. + * + * @extends models['TrackedResource'] + */ +class Database extends models['TrackedResource'] { + /** + * Create a Database. + * @property {string} [etag] An ETag of the resource created. + * @property {string} [provisioningState] The provisioned state of the + * resource. Possible values include: 'Running', 'Creating', 'Deleting', + * 'Succeeded', 'Failed' + * @property {number} softDeletePeriodInDays The number of days data should + * be kept before it stops being accessible to queries. + * @property {number} [hotCachePeriodInDays] The number of days of data that + * should be kept in cache for fast queries. + * @property {object} [statistics] The statistics of the database. + * @property {number} [statistics.size] The database size - the total size of + * compressed data and index in bytes. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of Database + * + * @returns {object} metadata of Database + * + */ + mapper() { + return { + required: false, + serializedName: 'Database', + type: { + name: 'Composite', + className: 'Database', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + location: { + required: true, + serializedName: 'location', + type: { + name: 'String' + } + }, + etag: { + required: false, + readOnly: true, + serializedName: 'etag', + type: { + name: 'String' + } + }, + provisioningState: { + required: false, + readOnly: true, + serializedName: 'properties.provisioningState', + type: { + name: 'String' + } + }, + softDeletePeriodInDays: { + required: true, + serializedName: 'properties.softDeletePeriodInDays', + type: { + name: 'Number' + } + }, + hotCachePeriodInDays: { + required: false, + serializedName: 'properties.hotCachePeriodInDays', + type: { + name: 'Number' + } + }, + statistics: { + required: false, + serializedName: 'properties.statistics', + type: { + name: 'Composite', + className: 'DatabaseStatistics' + } + } + } + } + }; + } +} + +module.exports = Database; diff --git a/lib/services/kustoManagement/lib/models/databaseCheckNameRequest.js b/lib/services/kustoManagement/lib/models/databaseCheckNameRequest.js new file mode 100644 index 0000000000..9d21449bfa --- /dev/null +++ b/lib/services/kustoManagement/lib/models/databaseCheckNameRequest.js @@ -0,0 +1,60 @@ +/* + * 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'; + +/** + * Class representing a DatabaseCheckNameRequest. + */ +class DatabaseCheckNameRequest { + /** + * Create a DatabaseCheckNameRequest. + * @property {string} name Database name. + */ + constructor() { + } + + /** + * Defines the metadata of DatabaseCheckNameRequest + * + * @returns {object} metadata of DatabaseCheckNameRequest + * + */ + mapper() { + return { + required: false, + serializedName: 'DatabaseCheckNameRequest', + type: { + name: 'Composite', + className: 'DatabaseCheckNameRequest', + modelProperties: { + name: { + required: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: true, + isConstant: true, + serializedName: 'type', + defaultValue: 'Microsoft.Kusto/clusters/databases', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = DatabaseCheckNameRequest; diff --git a/lib/services/kustoManagement/lib/models/databaseListResult.js b/lib/services/kustoManagement/lib/models/databaseListResult.js new file mode 100644 index 0000000000..2501a1592c --- /dev/null +++ b/lib/services/kustoManagement/lib/models/databaseListResult.js @@ -0,0 +1,59 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The list Kusto databases operation response. + */ +class DatabaseListResult extends Array { + /** + * Create a DatabaseListResult. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of DatabaseListResult + * + * @returns {object} metadata of DatabaseListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'DatabaseListResult', + type: { + name: 'Composite', + className: 'DatabaseListResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'DatabaseElementType', + type: { + name: 'Composite', + className: 'Database' + } + } + } + } + } + } + }; + } +} + +module.exports = DatabaseListResult; diff --git a/lib/services/kustoManagement/lib/models/databasePrincipal.js b/lib/services/kustoManagement/lib/models/databasePrincipal.js new file mode 100644 index 0000000000..32ba0470a8 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/databasePrincipal.js @@ -0,0 +1,94 @@ +/* + * 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'; + +/** + * Class representing a DatabasePrincipal. + */ +class DatabasePrincipal { + /** + * Create a DatabasePrincipal. + * @property {string} role Database principal role. Possible values include: + * 'Admin', 'Ingestor', 'Monitor', 'User', 'UnrestrictedViewers', 'Viewer' + * @property {string} name Database principal name. + * @property {string} type Database principal type. Possible values include: + * 'App', 'Group', 'User' + * @property {string} [fqn] Database principal fully qualified name. + * @property {string} [email] Database principal email if exists. + * @property {string} [appId] Application id - relevant only for application + * principal type. + */ + constructor() { + } + + /** + * Defines the metadata of DatabasePrincipal + * + * @returns {object} metadata of DatabasePrincipal + * + */ + mapper() { + return { + required: false, + serializedName: 'DatabasePrincipal', + type: { + name: 'Composite', + className: 'DatabasePrincipal', + modelProperties: { + role: { + required: true, + serializedName: 'role', + type: { + name: 'String' + } + }, + name: { + required: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + fqn: { + required: false, + serializedName: 'fqn', + type: { + name: 'String' + } + }, + email: { + required: false, + serializedName: 'email', + type: { + name: 'String' + } + }, + appId: { + required: false, + serializedName: 'appId', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = DatabasePrincipal; diff --git a/lib/services/kustoManagement/lib/models/databasePrincipalListRequest.js b/lib/services/kustoManagement/lib/models/databasePrincipalListRequest.js new file mode 100644 index 0000000000..96e38f627b --- /dev/null +++ b/lib/services/kustoManagement/lib/models/databasePrincipalListRequest.js @@ -0,0 +1,60 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The list Kusto database principals operation request. + * + */ +class DatabasePrincipalListRequest { + /** + * Create a DatabasePrincipalListRequest. + * @property {array} [value] The list of Kusto database principals. + */ + constructor() { + } + + /** + * Defines the metadata of DatabasePrincipalListRequest + * + * @returns {object} metadata of DatabasePrincipalListRequest + * + */ + mapper() { + return { + required: false, + serializedName: 'DatabasePrincipalListRequest', + type: { + name: 'Composite', + className: 'DatabasePrincipalListRequest', + modelProperties: { + value: { + required: false, + serializedName: 'value', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'DatabasePrincipalElementType', + type: { + name: 'Composite', + className: 'DatabasePrincipal' + } + } + } + } + } + } + }; + } +} + +module.exports = DatabasePrincipalListRequest; diff --git a/lib/services/kustoManagement/lib/models/databasePrincipalListResult.js b/lib/services/kustoManagement/lib/models/databasePrincipalListResult.js new file mode 100644 index 0000000000..74091a260d --- /dev/null +++ b/lib/services/kustoManagement/lib/models/databasePrincipalListResult.js @@ -0,0 +1,59 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The list Kusto database principals operation response. + */ +class DatabasePrincipalListResult extends Array { + /** + * Create a DatabasePrincipalListResult. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of DatabasePrincipalListResult + * + * @returns {object} metadata of DatabasePrincipalListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'DatabasePrincipalListResult', + type: { + name: 'Composite', + className: 'DatabasePrincipalListResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'DatabasePrincipalElementType', + type: { + name: 'Composite', + className: 'DatabasePrincipal' + } + } + } + } + } + } + }; + } +} + +module.exports = DatabasePrincipalListResult; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/fileOperationResult.js b/lib/services/kustoManagement/lib/models/databaseStatistics.js similarity index 53% rename from lib/services/dataLake.Store/lib/filesystem/models/fileOperationResult.js rename to lib/services/kustoManagement/lib/models/databaseStatistics.js index adab3af571..d5ce0a8193 100644 --- a/lib/services/dataLake.Store/lib/filesystem/models/fileOperationResult.js +++ b/lib/services/kustoManagement/lib/models/databaseStatistics.js @@ -11,38 +11,36 @@ 'use strict'; /** - * The result of the request or operation. - * + * Class representing a DatabaseStatistics. */ -class FileOperationResult { +class DatabaseStatistics { /** - * Create a FileOperationResult. - * @property {boolean} [operationResult] the result of the operation or - * request. + * Create a DatabaseStatistics. + * @property {number} [size] The database size - the total size of compressed + * data and index in bytes. */ constructor() { } /** - * Defines the metadata of FileOperationResult + * Defines the metadata of DatabaseStatistics * - * @returns {object} metadata of FileOperationResult + * @returns {object} metadata of DatabaseStatistics * */ mapper() { return { required: false, - serializedName: 'FileOperationResult', + serializedName: 'DatabaseStatistics', type: { name: 'Composite', - className: 'FileOperationResult', + className: 'DatabaseStatistics', modelProperties: { - operationResult: { + size: { required: false, - readOnly: true, - serializedName: 'boolean', + serializedName: 'size', type: { - name: 'Boolean' + name: 'Number' } } } @@ -51,4 +49,4 @@ class FileOperationResult { } } -module.exports = FileOperationResult; +module.exports = DatabaseStatistics; diff --git a/lib/services/kustoManagement/lib/models/databaseUpdate.js b/lib/services/kustoManagement/lib/models/databaseUpdate.js new file mode 100644 index 0000000000..db268fc531 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/databaseUpdate.js @@ -0,0 +1,129 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Class representing an update to a Kusto database. + * + * @extends models['Resource'] + */ +class DatabaseUpdate extends models['Resource'] { + /** + * Create a DatabaseUpdate. + * @property {string} [location] Resource location. + * @property {string} [etag] An ETag of the resource updated. + * @property {string} [provisioningState] The provisioned state of the + * resource. Possible values include: 'Running', 'Creating', 'Deleting', + * 'Succeeded', 'Failed' + * @property {number} softDeletePeriodInDays The number of days data should + * be kept before it stops being accessible to queries. + * @property {number} [hotCachePeriodInDays] The number of days of data that + * should be kept in cache for fast queries. + * @property {object} [statistics] The statistics of the database. + * @property {number} [statistics.size] The database size - the total size of + * compressed data and index in bytes. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of DatabaseUpdate + * + * @returns {object} metadata of DatabaseUpdate + * + */ + mapper() { + return { + required: false, + serializedName: 'DatabaseUpdate', + type: { + name: 'Composite', + className: 'DatabaseUpdate', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + location: { + required: false, + serializedName: 'location', + type: { + name: 'String' + } + }, + etag: { + required: false, + readOnly: true, + serializedName: 'etag', + type: { + name: 'String' + } + }, + provisioningState: { + required: false, + readOnly: true, + serializedName: 'properties.provisioningState', + type: { + name: 'String' + } + }, + softDeletePeriodInDays: { + required: true, + serializedName: 'properties.softDeletePeriodInDays', + type: { + name: 'Number' + } + }, + hotCachePeriodInDays: { + required: false, + serializedName: 'properties.hotCachePeriodInDays', + type: { + name: 'Number' + } + }, + statistics: { + required: false, + serializedName: 'properties.statistics', + type: { + name: 'Composite', + className: 'DatabaseStatistics' + } + } + } + } + }; + } +} + +module.exports = DatabaseUpdate; diff --git a/lib/services/kustoManagement/lib/models/eventHubConnection.js b/lib/services/kustoManagement/lib/models/eventHubConnection.js new file mode 100644 index 0000000000..29f5fa2e8f --- /dev/null +++ b/lib/services/kustoManagement/lib/models/eventHubConnection.js @@ -0,0 +1,125 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Class representing an event hub connection. + * + * @extends models['ProxyResource'] + */ +class EventHubConnection extends models['ProxyResource'] { + /** + * Create a EventHubConnection. + * @property {string} [location] Resource location. + * @property {string} eventHubResourceId The resource ID of the event hub to + * be used to create a data connection. + * @property {string} consumerGroup The event hub consumer group. + * @property {string} [tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * @property {string} [mappingRuleName] The mapping rule to be used to ingest + * the data. Optionally the mapping information can be added to each message. + * @property {string} [dataFormat] The data format of the message. Optionally + * the data format can be added to each message. Possible values include: + * 'MULTIJSON', 'JSON', 'CSV' + */ + constructor() { + super(); + } + + /** + * Defines the metadata of EventHubConnection + * + * @returns {object} metadata of EventHubConnection + * + */ + mapper() { + return { + required: false, + serializedName: 'EventHubConnection', + type: { + name: 'Composite', + className: 'EventHubConnection', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + location: { + required: false, + serializedName: 'location', + type: { + name: 'String' + } + }, + eventHubResourceId: { + required: true, + serializedName: 'properties.eventHubResourceId', + type: { + name: 'String' + } + }, + consumerGroup: { + required: true, + serializedName: 'properties.consumerGroup', + type: { + name: 'String' + } + }, + tableName: { + required: false, + serializedName: 'properties.tableName', + type: { + name: 'String' + } + }, + mappingRuleName: { + required: false, + serializedName: 'properties.mappingRuleName', + type: { + name: 'String' + } + }, + dataFormat: { + required: false, + serializedName: 'properties.dataFormat', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = EventHubConnection; diff --git a/lib/services/kustoManagement/lib/models/eventHubConnectionListResult.js b/lib/services/kustoManagement/lib/models/eventHubConnectionListResult.js new file mode 100644 index 0000000000..cf29802e85 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/eventHubConnectionListResult.js @@ -0,0 +1,59 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The list Kusto event hub connections operation response. + */ +class EventHubConnectionListResult extends Array { + /** + * Create a EventHubConnectionListResult. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of EventHubConnectionListResult + * + * @returns {object} metadata of EventHubConnectionListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'EventHubConnectionListResult', + type: { + name: 'Composite', + className: 'EventHubConnectionListResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'EventHubConnectionElementType', + type: { + name: 'Composite', + className: 'EventHubConnection' + } + } + } + } + } + } + }; + } +} + +module.exports = EventHubConnectionListResult; diff --git a/lib/services/kustoManagement/lib/models/eventHubConnectionUpdate.js b/lib/services/kustoManagement/lib/models/eventHubConnectionUpdate.js new file mode 100644 index 0000000000..fda6c0dceb --- /dev/null +++ b/lib/services/kustoManagement/lib/models/eventHubConnectionUpdate.js @@ -0,0 +1,125 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Class representing an update to event hub connection. + * + * @extends models['ProxyResource'] + */ +class EventHubConnectionUpdate extends models['ProxyResource'] { + /** + * Create a EventHubConnectionUpdate. + * @property {string} [location] Resource location. + * @property {string} eventHubResourceId The resource ID of the event hub to + * be used to create a data connection. + * @property {string} consumerGroup The event hub consumer group. + * @property {string} [tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * @property {string} [mappingRuleName] The mapping rule to be used to ingest + * the data. Optionally the mapping information can be added to each message. + * @property {string} [dataFormat] The data format of the message. Optionally + * the data format can be added to each message. Possible values include: + * 'MULTIJSON', 'JSON', 'CSV' + */ + constructor() { + super(); + } + + /** + * Defines the metadata of EventHubConnectionUpdate + * + * @returns {object} metadata of EventHubConnectionUpdate + * + */ + mapper() { + return { + required: false, + serializedName: 'EventHubConnectionUpdate', + type: { + name: 'Composite', + className: 'EventHubConnectionUpdate', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + location: { + required: false, + serializedName: 'location', + type: { + name: 'String' + } + }, + eventHubResourceId: { + required: true, + serializedName: 'properties.eventHubResourceId', + type: { + name: 'String' + } + }, + consumerGroup: { + required: true, + serializedName: 'properties.consumerGroup', + type: { + name: 'String' + } + }, + tableName: { + required: false, + serializedName: 'properties.tableName', + type: { + name: 'String' + } + }, + mappingRuleName: { + required: false, + serializedName: 'properties.mappingRuleName', + type: { + name: 'String' + } + }, + dataFormat: { + required: false, + serializedName: 'properties.dataFormat', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = EventHubConnectionUpdate; diff --git a/lib/services/kustoManagement/lib/models/eventHubConnectionValidation.js b/lib/services/kustoManagement/lib/models/eventHubConnectionValidation.js new file mode 100644 index 0000000000..7b94224125 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/eventHubConnectionValidation.js @@ -0,0 +1,98 @@ +/* + * 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'; + +/** + * Class representing an event hub connection validation. + * + */ +class EventHubConnectionValidation { + /** + * Create a EventHubConnectionValidation. + * @property {string} [eventhubConnectionName] The name of the event hub + * connection. + * @property {string} eventHubResourceId The resource ID of the event hub to + * be used to create a data connection. + * @property {string} consumerGroup The event hub consumer group. + * @property {string} [tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * @property {string} [mappingRuleName] The mapping rule to be used to ingest + * the data. Optionally the mapping information can be added to each message. + * @property {string} [dataFormat] The data format of the message. Optionally + * the data format can be added to each message. Possible values include: + * 'MULTIJSON', 'JSON', 'CSV' + */ + constructor() { + } + + /** + * Defines the metadata of EventHubConnectionValidation + * + * @returns {object} metadata of EventHubConnectionValidation + * + */ + mapper() { + return { + required: false, + serializedName: 'EventHubConnectionValidation', + type: { + name: 'Composite', + className: 'EventHubConnectionValidation', + modelProperties: { + eventhubConnectionName: { + required: false, + serializedName: 'eventhubConnectionName', + type: { + name: 'String' + } + }, + eventHubResourceId: { + required: true, + serializedName: 'properties.eventHubResourceId', + type: { + name: 'String' + } + }, + consumerGroup: { + required: true, + serializedName: 'properties.consumerGroup', + type: { + name: 'String' + } + }, + tableName: { + required: false, + serializedName: 'properties.tableName', + type: { + name: 'String' + } + }, + mappingRuleName: { + required: false, + serializedName: 'properties.mappingRuleName', + type: { + name: 'String' + } + }, + dataFormat: { + required: false, + serializedName: 'properties.dataFormat', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = EventHubConnectionValidation; diff --git a/lib/services/kustoManagement/lib/models/eventHubConnectionValidationListResult.js b/lib/services/kustoManagement/lib/models/eventHubConnectionValidationListResult.js new file mode 100644 index 0000000000..7365a7747c --- /dev/null +++ b/lib/services/kustoManagement/lib/models/eventHubConnectionValidationListResult.js @@ -0,0 +1,61 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The list Kusto event hub connection validation result. + * + */ +class EventHubConnectionValidationListResult { + /** + * Create a EventHubConnectionValidationListResult. + * @property {array} [value] The list of Kusto event hub connection + * validation errors. + */ + constructor() { + } + + /** + * Defines the metadata of EventHubConnectionValidationListResult + * + * @returns {object} metadata of EventHubConnectionValidationListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'EventHubConnectionValidationListResult', + type: { + name: 'Composite', + className: 'EventHubConnectionValidationListResult', + modelProperties: { + value: { + required: false, + serializedName: 'value', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'EventHubConnectionValidationResultElementType', + type: { + name: 'Composite', + className: 'EventHubConnectionValidationResult' + } + } + } + } + } + } + }; + } +} + +module.exports = EventHubConnectionValidationListResult; diff --git a/lib/services/kustoManagement/lib/models/eventHubConnectionValidationResult.js b/lib/services/kustoManagement/lib/models/eventHubConnectionValidationResult.js new file mode 100644 index 0000000000..8292ebc591 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/eventHubConnectionValidationResult.js @@ -0,0 +1,52 @@ +/* + * 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'; + +/** + * Class representing a EventHubConnectionValidationResult. + */ +class EventHubConnectionValidationResult { + /** + * Create a EventHubConnectionValidationResult. + * @property {string} [errorMessage] A message which indicates a problem in + * event hub connection validation. + */ + constructor() { + } + + /** + * Defines the metadata of EventHubConnectionValidationResult + * + * @returns {object} metadata of EventHubConnectionValidationResult + * + */ + mapper() { + return { + required: false, + serializedName: 'EventHubConnectionValidationResult', + type: { + name: 'Composite', + className: 'EventHubConnectionValidationResult', + modelProperties: { + errorMessage: { + required: false, + serializedName: 'errorMessage', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = EventHubConnectionValidationResult; diff --git a/lib/services/kustoManagement/lib/models/index.d.ts b/lib/services/kustoManagement/lib/models/index.d.ts new file mode 100644 index 0000000000..ae29d4d6fd --- /dev/null +++ b/lib/services/kustoManagement/lib/models/index.d.ts @@ -0,0 +1,539 @@ +/* + * 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. + */ + +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; + +export { + + BaseResource, + CloudError +}; + +export interface TrustedExternalTenant { + /** + * GUID representing an external tenant. + */ + value?: string; +} + +export interface AzureSku { + /** + * SKU name. Possible values include: 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', + * 'L16' + */ + name: string; + /** + * SKU capacity. + */ + capacity?: number; +} + +export interface AzureCapacity { + /** + * Scale type. Possible values include: 'automatic', 'manual', 'none' + */ + scaleType: string; + /** + * Minimum allowed capacity. + */ + minimum: number; + /** + * Maximum allowed capacity. + */ + maximum: number; + /** + * The default capacity that would be used. + */ + default: number; +} + +export interface AzureResourceSku { + /** + * Resource Namespace and Type. + */ + resourceType?: string; + /** + * The SKU details. + */ + sku?: AzureSku; + /** + * The SKU capacity. + */ + capacity?: AzureCapacity; +} + +export interface DatabaseStatistics { + /** + * The database size - the total size of compressed data and index in bytes. + */ + size?: number; +} + +/** + * Class representing an event hub connection validation. +*/ +export interface EventHubConnectionValidation { + /** + * The name of the event hub connection. + */ + eventhubConnectionName?: string; + /** + * The resource ID of the event hub to be used to create a data connection. + */ + eventHubResourceId: string; + /** + * The event hub consumer group. + */ + consumerGroup: string; + /** + * The table where the data should be ingested. Optionally the table information can be added to + * each message. + */ + tableName?: string; + /** + * The mapping rule to be used to ingest the data. Optionally the mapping information can be + * added to each message. + */ + mappingRuleName?: string; + /** + * The data format of the message. Optionally the data format can be added to each message. + * Possible values include: 'MULTIJSON', 'JSON', 'CSV' + */ + dataFormat?: string; +} + +export interface Resource extends BaseResource { + /** + * Fully qualified resource Id for the resource. Ex - + * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + */ + readonly id?: string; + /** + * The name of the resource + */ + readonly name?: string; + /** + * The type of the resource. Ex- Microsoft.Compute/virtualMachines or + * Microsoft.Storage/storageAccounts. + */ + readonly type?: string; +} + +/** + * The resource model definition for a ARM tracked top level resource +*/ +export interface TrackedResource extends Resource { + /** + * Resource tags. + */ + tags?: { [propertyName: string]: string }; + /** + * The geo-location where the resource lives + */ + location: string; +} + +/** + * Class representing a Kusto cluster. +*/ +export interface Cluster extends TrackedResource { + /** + * An ETag of the resource created. + */ + readonly etag?: string; + /** + * The SKU of the cluster. + */ + sku: AzureSku; + /** + * The state of the resource. Possible values include: 'Creating', 'Unavailable', 'Running', + * 'Deleting', 'Deleted', 'Stopping', 'Stopped', 'Starting' + */ + readonly state?: string; + /** + * The provisioned state of the resource. Possible values include: 'Running', 'Creating', + * 'Deleting', 'Succeeded', 'Failed' + */ + readonly provisioningState?: string; + /** + * The cluster URI. + */ + readonly uri?: string; + /** + * The cluster data ingestion URI. + */ + readonly dataIngestionUri?: string; + /** + * The cluster's external tenants. + */ + trustedExternalTenants?: TrustedExternalTenant[]; +} + +/** + * Class representing an update to a Kusto cluster. +*/ +export interface ClusterUpdate extends Resource { + /** + * Resource tags. + */ + tags?: { [propertyName: string]: string }; + /** + * Resource location. + */ + location?: string; + /** + * An ETag of the resource updated. + */ + readonly etag?: string; + /** + * The SKU of the cluster. + */ + sku?: AzureSku; + /** + * The state of the resource. Possible values include: 'Creating', 'Unavailable', 'Running', + * 'Deleting', 'Deleted', 'Stopping', 'Stopped', 'Starting' + */ + readonly state?: string; + /** + * The provisioned state of the resource. Possible values include: 'Running', 'Creating', + * 'Deleting', 'Succeeded', 'Failed' + */ + readonly provisioningState?: string; + /** + * The cluster URI. + */ + readonly uri?: string; + /** + * The cluster data ingestion URI. + */ + readonly dataIngestionUri?: string; + /** + * The cluster's external tenants. + */ + trustedExternalTenants?: TrustedExternalTenant[]; +} + +/** + * Class representing a Kusto database. +*/ +export interface Database extends TrackedResource { + /** + * An ETag of the resource created. + */ + readonly etag?: string; + /** + * The provisioned state of the resource. Possible values include: 'Running', 'Creating', + * 'Deleting', 'Succeeded', 'Failed' + */ + readonly provisioningState?: string; + /** + * The number of days data should be kept before it stops being accessible to queries. + */ + softDeletePeriodInDays: number; + /** + * The number of days of data that should be kept in cache for fast queries. + */ + hotCachePeriodInDays?: number; + /** + * The statistics of the database. + */ + statistics?: DatabaseStatistics; +} + +/** + * Class representing an update to a Kusto database. +*/ +export interface DatabaseUpdate extends Resource { + /** + * Resource location. + */ + location?: string; + /** + * An ETag of the resource updated. + */ + readonly etag?: string; + /** + * The provisioned state of the resource. Possible values include: 'Running', 'Creating', + * 'Deleting', 'Succeeded', 'Failed' + */ + readonly provisioningState?: string; + /** + * The number of days data should be kept before it stops being accessible to queries. + */ + softDeletePeriodInDays: number; + /** + * The number of days of data that should be kept in cache for fast queries. + */ + hotCachePeriodInDays?: number; + /** + * The statistics of the database. + */ + statistics?: DatabaseStatistics; +} + +export interface DatabasePrincipal { + /** + * Database principal role. Possible values include: 'Admin', 'Ingestor', 'Monitor', 'User', + * 'UnrestrictedViewers', 'Viewer' + */ + role: string; + /** + * Database principal name. + */ + name: string; + /** + * Database principal type. Possible values include: 'App', 'Group', 'User' + */ + type: string; + /** + * Database principal fully qualified name. + */ + fqn?: string; + /** + * Database principal email if exists. + */ + email?: string; + /** + * Application id - relevant only for application principal type. + */ + appId?: string; +} + +/** + * The resource model definition for a ARM proxy resource. It will have everything other than + * required location and tags +*/ +export interface ProxyResource extends Resource { +} + +/** + * Class representing an update to event hub connection. +*/ +export interface EventHubConnectionUpdate extends ProxyResource { + /** + * Resource location. + */ + location?: string; + /** + * The resource ID of the event hub to be used to create a data connection. + */ + eventHubResourceId: string; + /** + * The event hub consumer group. + */ + consumerGroup: string; + /** + * The table where the data should be ingested. Optionally the table information can be added to + * each message. + */ + tableName?: string; + /** + * The mapping rule to be used to ingest the data. Optionally the mapping information can be + * added to each message. + */ + mappingRuleName?: string; + /** + * The data format of the message. Optionally the data format can be added to each message. + * Possible values include: 'MULTIJSON', 'JSON', 'CSV' + */ + dataFormat?: string; +} + +/** + * Class representing an event hub connection. +*/ +export interface EventHubConnection extends ProxyResource { + /** + * Resource location. + */ + location?: string; + /** + * The resource ID of the event hub to be used to create a data connection. + */ + eventHubResourceId: string; + /** + * The event hub consumer group. + */ + consumerGroup: string; + /** + * The table where the data should be ingested. Optionally the table information can be added to + * each message. + */ + tableName?: string; + /** + * The mapping rule to be used to ingest the data. Optionally the mapping information can be + * added to each message. + */ + mappingRuleName?: string; + /** + * The data format of the message. Optionally the data format can be added to each message. + * Possible values include: 'MULTIJSON', 'JSON', 'CSV' + */ + dataFormat?: string; +} + +export interface EventHubConnectionValidationResult { + /** + * A message which indicates a problem in event hub connection validation. + */ + errorMessage?: string; +} + +/** + * The list Kusto database principals operation request. +*/ +export interface DatabasePrincipalListRequest { + /** + * The list of Kusto database principals. + */ + value?: DatabasePrincipal[]; +} + +/** + * The list Kusto event hub connection validation result. +*/ +export interface EventHubConnectionValidationListResult { + /** + * The list of Kusto event hub connection validation errors. + */ + value?: EventHubConnectionValidationResult[]; +} + +export interface ClusterCheckNameRequest { + /** + * Cluster name. + */ + name: string; +} + +export interface DatabaseCheckNameRequest { + /** + * Database name. + */ + name: string; +} + +export interface CheckNameResult { + /** + * Specifies a Boolean value that indicates if the name is available. + */ + nameAvailable?: boolean; + /** + * The name that was checked. + */ + name?: string; + /** + * Message indicating an unavailable name due to a conflict, or a description of the naming rules + * that are violated. + */ + message?: string; +} + +/** + * @summary The object that describes the operation. +*/ +export interface OperationDisplay { + /** + * @summary Friendly name of the resource provider. + */ + provider?: string; + /** + * @summary The operation type. + * @description For example: read, write, delete. + */ + operation?: string; + /** + * @summary The resource type on which the operation is performed. + */ + resource?: string; + /** + * @summary The friendly name of the operation. + */ + description?: string; +} + +/** + * @summary A REST API operation +*/ +export interface Operation { + /** + * @summary The operation name. + * @description This is of the format {provider}/{resource}/{operation}. + */ + name?: string; + /** + * @summary The object that describes the operation. + */ + display?: OperationDisplay; + /** + * @summary The intended executor of the operation. + */ + origin?: string; + /** + * @summary Properties of the operation. + */ + properties?: any; +} + +/** + * The resource model definition for a Azure Resource Manager resource with an etag. +*/ +export interface AzureEntityResource extends Resource { + /** + * Resource Etag. + */ + readonly etag?: string; +} + +/** + * The list Kusto clusters operation response. +*/ +export interface ClusterListResult extends Array { +} + +/** + * List of available SKUs for a new Kusto Cluster. +*/ +export interface ListSkusResult extends Array { +} + +/** + * List of available SKUs for an existing Kusto Cluster. +*/ +export interface ListResourceSkusResult extends Array { +} + +/** + * The list Kusto databases operation response. +*/ +export interface DatabaseListResult extends Array { +} + +/** + * The list Kusto database principals operation response. +*/ +export interface DatabasePrincipalListResult extends Array { +} + +/** + * The list Kusto event hub connections operation response. +*/ +export interface EventHubConnectionListResult extends Array { +} + +/** + * @summary Result of the request to list REST API operations. It contains a list of operations and + * a URL nextLink to get the next set of results. +*/ +export interface OperationListResult extends Array { + /** + * @summary The URL to get the next set of operation list results if there are any. + */ + nextLink?: string; +} diff --git a/lib/services/kustoManagement/lib/models/index.js b/lib/services/kustoManagement/lib/models/index.js new file mode 100644 index 0000000000..eabd4e0f36 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/index.js @@ -0,0 +1,52 @@ +/* + * 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. + */ + +/* jshint latedef:false */ +/* jshint forin:false */ +/* jshint noempty:false */ + +'use strict'; + +var msRestAzure = require('ms-rest-azure'); + +exports.BaseResource = msRestAzure.BaseResource; +exports.CloudError = msRestAzure.CloudError; +exports.TrustedExternalTenant = require('./trustedExternalTenant'); +exports.AzureSku = require('./azureSku'); +exports.AzureCapacity = require('./azureCapacity'); +exports.AzureResourceSku = require('./azureResourceSku'); +exports.DatabaseStatistics = require('./databaseStatistics'); +exports.EventHubConnectionValidation = require('./eventHubConnectionValidation'); +exports.Resource = require('./resource'); +exports.TrackedResource = require('./trackedResource'); +exports.Cluster = require('./cluster'); +exports.ClusterUpdate = require('./clusterUpdate'); +exports.Database = require('./database'); +exports.DatabaseUpdate = require('./databaseUpdate'); +exports.DatabasePrincipal = require('./databasePrincipal'); +exports.ProxyResource = require('./proxyResource'); +exports.EventHubConnectionUpdate = require('./eventHubConnectionUpdate'); +exports.EventHubConnection = require('./eventHubConnection'); +exports.EventHubConnectionValidationResult = require('./eventHubConnectionValidationResult'); +exports.DatabasePrincipalListRequest = require('./databasePrincipalListRequest'); +exports.EventHubConnectionValidationListResult = require('./eventHubConnectionValidationListResult'); +exports.ClusterCheckNameRequest = require('./clusterCheckNameRequest'); +exports.DatabaseCheckNameRequest = require('./databaseCheckNameRequest'); +exports.CheckNameResult = require('./checkNameResult'); +exports.OperationDisplay = require('./operationDisplay'); +exports.Operation = require('./operation'); +exports.AzureEntityResource = require('./azureEntityResource'); +exports.ClusterListResult = require('./clusterListResult'); +exports.ListSkusResult = require('./listSkusResult'); +exports.ListResourceSkusResult = require('./listResourceSkusResult'); +exports.DatabaseListResult = require('./databaseListResult'); +exports.DatabasePrincipalListResult = require('./databasePrincipalListResult'); +exports.EventHubConnectionListResult = require('./eventHubConnectionListResult'); +exports.OperationListResult = require('./operationListResult'); diff --git a/lib/services/kustoManagement/lib/models/listResourceSkusResult.js b/lib/services/kustoManagement/lib/models/listResourceSkusResult.js new file mode 100644 index 0000000000..62068e2b53 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/listResourceSkusResult.js @@ -0,0 +1,59 @@ +/* + * 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'; + +/** + * List of available SKUs for an existing Kusto Cluster. + */ +class ListResourceSkusResult extends Array { + /** + * Create a ListResourceSkusResult. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ListResourceSkusResult + * + * @returns {object} metadata of ListResourceSkusResult + * + */ + mapper() { + return { + required: false, + serializedName: 'ListResourceSkusResult', + type: { + name: 'Composite', + className: 'ListResourceSkusResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'AzureResourceSkuElementType', + type: { + name: 'Composite', + className: 'AzureResourceSku' + } + } + } + } + } + } + }; + } +} + +module.exports = ListResourceSkusResult; diff --git a/lib/services/kustoManagement/lib/models/listSkusResult.js b/lib/services/kustoManagement/lib/models/listSkusResult.js new file mode 100644 index 0000000000..111a04b054 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/listSkusResult.js @@ -0,0 +1,59 @@ +/* + * 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'; + +/** + * List of available SKUs for a new Kusto Cluster. + */ +class ListSkusResult extends Array { + /** + * Create a ListSkusResult. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ListSkusResult + * + * @returns {object} metadata of ListSkusResult + * + */ + mapper() { + return { + required: false, + serializedName: 'ListSkusResult', + type: { + name: 'Composite', + className: 'ListSkusResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'AzureSkuElementType', + type: { + name: 'Composite', + className: 'AzureSku' + } + } + } + } + } + } + }; + } +} + +module.exports = ListSkusResult; diff --git a/lib/services/kustoManagement/lib/models/operation.js b/lib/services/kustoManagement/lib/models/operation.js new file mode 100644 index 0000000000..6ae00902ac --- /dev/null +++ b/lib/services/kustoManagement/lib/models/operation.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'; + +/** + * @summary A REST API operation + * + */ +class Operation { + /** + * Create a Operation. + * @property {string} [name] The operation name. This is of the format + * {provider}/{resource}/{operation}. + * @property {object} [display] The object that describes the operation. + * @property {string} [display.provider] + * @property {string} [display.operation] For example: read, write, delete. + * @property {string} [display.resource] + * @property {string} [display.description] + * @property {string} [origin] The intended executor of the operation. + * @property {object} [properties] Properties of the operation. + */ + constructor() { + } + + /** + * Defines the metadata of Operation + * + * @returns {object} metadata of Operation + * + */ + mapper() { + return { + required: false, + serializedName: 'Operation', + type: { + name: 'Composite', + className: 'Operation', + modelProperties: { + name: { + required: false, + serializedName: 'name', + type: { + name: 'String' + } + }, + display: { + required: false, + serializedName: 'display', + type: { + name: 'Composite', + className: 'OperationDisplay' + } + }, + origin: { + required: false, + serializedName: 'origin', + type: { + name: 'String' + } + }, + properties: { + required: false, + serializedName: 'properties', + type: { + name: 'Object' + } + } + } + } + }; + } +} + +module.exports = Operation; diff --git a/lib/services/kustoManagement/lib/models/operationDisplay.js b/lib/services/kustoManagement/lib/models/operationDisplay.js new file mode 100644 index 0000000000..889bff3f1c --- /dev/null +++ b/lib/services/kustoManagement/lib/models/operationDisplay.js @@ -0,0 +1,78 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * @summary The object that describes the operation. + * + */ +class OperationDisplay { + /** + * Create a OperationDisplay. + * @property {string} [provider] Friendly name of the resource provider. + * @property {string} [operation] The operation type. For example: read, + * write, delete. + * @property {string} [resource] The resource type on which the operation is + * performed. + * @property {string} [description] The friendly name of the operation. + */ + constructor() { + } + + /** + * Defines the metadata of OperationDisplay + * + * @returns {object} metadata of OperationDisplay + * + */ + mapper() { + return { + required: false, + serializedName: 'Operation_display', + type: { + name: 'Composite', + className: 'OperationDisplay', + modelProperties: { + provider: { + required: false, + serializedName: 'provider', + type: { + name: 'String' + } + }, + operation: { + required: false, + serializedName: 'operation', + type: { + name: 'String' + } + }, + resource: { + required: false, + serializedName: 'resource', + type: { + name: 'String' + } + }, + description: { + required: false, + serializedName: 'description', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = OperationDisplay; diff --git a/lib/services/kustoManagement/lib/models/operationListResult.js b/lib/services/kustoManagement/lib/models/operationListResult.js new file mode 100644 index 0000000000..45b95bc658 --- /dev/null +++ b/lib/services/kustoManagement/lib/models/operationListResult.js @@ -0,0 +1,68 @@ +/* + * 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'; + +/** + * @summary Result of the request to list REST API operations. It contains a + * list of operations and a URL nextLink to get the next set of results. + */ +class OperationListResult extends Array { + /** + * Create a OperationListResult. + * @property {string} [nextLink] + */ + constructor() { + super(); + } + + /** + * Defines the metadata of OperationListResult + * + * @returns {object} metadata of OperationListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'OperationListResult', + type: { + name: 'Composite', + className: 'OperationListResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'OperationElementType', + type: { + name: 'Composite', + className: 'Operation' + } + } + } + }, + nextLink: { + required: false, + serializedName: 'nextLink', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = OperationListResult; diff --git a/lib/services/kustoManagement/lib/models/proxyResource.js b/lib/services/kustoManagement/lib/models/proxyResource.js new file mode 100644 index 0000000000..43e93ec60e --- /dev/null +++ b/lib/services/kustoManagement/lib/models/proxyResource.js @@ -0,0 +1,73 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * The resource model definition for a ARM proxy resource. It will have + * everything other than required location and tags + * + * @extends models['Resource'] + */ +class ProxyResource extends models['Resource'] { + /** + * Create a ProxyResource. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ProxyResource + * + * @returns {object} metadata of ProxyResource + * + */ + mapper() { + return { + required: false, + serializedName: 'ProxyResource', + type: { + name: 'Composite', + className: 'ProxyResource', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = ProxyResource; diff --git a/lib/services/kustoManagement/lib/models/resource.js b/lib/services/kustoManagement/lib/models/resource.js new file mode 100644 index 0000000000..8dc0265e3c --- /dev/null +++ b/lib/services/kustoManagement/lib/models/resource.js @@ -0,0 +1,76 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Class representing a Resource. + * @extends models['BaseResource'] + */ +class Resource extends models['BaseResource'] { + /** + * Create a Resource. + * @property {string} [id] Fully qualified resource Id for the resource. Ex - + * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + * @property {string} [name] The name of the resource + * @property {string} [type] The type of the resource. Ex- + * Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of Resource + * + * @returns {object} metadata of Resource + * + */ + mapper() { + return { + required: false, + serializedName: 'Resource', + type: { + name: 'Composite', + className: 'Resource', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = Resource; diff --git a/lib/services/dataLake.Store/lib/account/models/firewallRule.js b/lib/services/kustoManagement/lib/models/trackedResource.js similarity index 57% rename from lib/services/dataLake.Store/lib/account/models/firewallRule.js rename to lib/services/kustoManagement/lib/models/trackedResource.js index 7d0ef1165a..d74a5106d9 100644 --- a/lib/services/dataLake.Store/lib/account/models/firewallRule.js +++ b/lib/services/kustoManagement/lib/models/trackedResource.js @@ -13,37 +13,33 @@ const models = require('./index'); /** - * Data Lake Store firewall rule information. + * The resource model definition for a ARM tracked top level resource * - * @extends models['SubResource'] + * @extends models['Resource'] */ -class FirewallRule extends models['SubResource'] { +class TrackedResource extends models['Resource'] { /** - * Create a FirewallRule. - * @property {string} [startIpAddress] The start IP address for the firewall - * rule. This can be either ipv4 or ipv6. Start and End should be in the same - * protocol. - * @property {string} [endIpAddress] The end IP address for the firewall - * rule. This can be either ipv4 or ipv6. Start and End should be in the same - * protocol. + * Create a TrackedResource. + * @property {object} [tags] Resource tags. + * @property {string} location The geo-location where the resource lives */ constructor() { super(); } /** - * Defines the metadata of FirewallRule + * Defines the metadata of TrackedResource * - * @returns {object} metadata of FirewallRule + * @returns {object} metadata of TrackedResource * */ mapper() { return { required: false, - serializedName: 'FirewallRule', + serializedName: 'TrackedResource', type: { name: 'Composite', - className: 'FirewallRule', + className: 'TrackedResource', modelProperties: { id: { required: false, @@ -69,18 +65,23 @@ class FirewallRule extends models['SubResource'] { name: 'String' } }, - startIpAddress: { + tags: { required: false, - readOnly: true, - serializedName: 'properties.startIpAddress', + serializedName: 'tags', type: { - name: 'String' + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } } }, - endIpAddress: { - required: false, - readOnly: true, - serializedName: 'properties.endIpAddress', + location: { + required: true, + serializedName: 'location', type: { name: 'String' } @@ -91,4 +92,4 @@ class FirewallRule extends models['SubResource'] { } } -module.exports = FirewallRule; +module.exports = TrackedResource; diff --git a/lib/services/dataLake.Store/lib/account/models/updateKeyVaultMetaInfo.js b/lib/services/kustoManagement/lib/models/trustedExternalTenant.js similarity index 51% rename from lib/services/dataLake.Store/lib/account/models/updateKeyVaultMetaInfo.js rename to lib/services/kustoManagement/lib/models/trustedExternalTenant.js index 812de14bd1..63902b764d 100644 --- a/lib/services/dataLake.Store/lib/account/models/updateKeyVaultMetaInfo.js +++ b/lib/services/kustoManagement/lib/models/trustedExternalTenant.js @@ -11,35 +11,33 @@ 'use strict'; /** - * The Key Vault update information used for user managed key rotation. - * + * Class representing a TrustedExternalTenant. */ -class UpdateKeyVaultMetaInfo { +class TrustedExternalTenant { /** - * Create a UpdateKeyVaultMetaInfo. - * @property {string} [encryptionKeyVersion] The version of the user managed - * encryption key to update through a key rotation. + * Create a TrustedExternalTenant. + * @property {string} [value] GUID representing an external tenant. */ constructor() { } /** - * Defines the metadata of UpdateKeyVaultMetaInfo + * Defines the metadata of TrustedExternalTenant * - * @returns {object} metadata of UpdateKeyVaultMetaInfo + * @returns {object} metadata of TrustedExternalTenant * */ mapper() { return { required: false, - serializedName: 'UpdateKeyVaultMetaInfo', + serializedName: 'TrustedExternalTenant', type: { name: 'Composite', - className: 'UpdateKeyVaultMetaInfo', + className: 'TrustedExternalTenant', modelProperties: { - encryptionKeyVersion: { + value: { required: false, - serializedName: 'encryptionKeyVersion', + serializedName: 'value', type: { name: 'String' } @@ -50,4 +48,4 @@ class UpdateKeyVaultMetaInfo { } } -module.exports = UpdateKeyVaultMetaInfo; +module.exports = TrustedExternalTenant; diff --git a/lib/services/kustoManagement/lib/operations/clusters.js b/lib/services/kustoManagement/lib/operations/clusters.js new file mode 100644 index 0000000000..e9241e3a10 --- /dev/null +++ b/lib/services/kustoManagement/lib/operations/clusters.js @@ -0,0 +1,3601 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * Gets a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 Cluster} 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 _get(resourceGroupName, clusterName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['Cluster']().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); + }); +} + + +/** + * Create or update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * CreateOrUpdate operation. + * + * @param {object} parameters.sku The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 Cluster} 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 _createOrUpdate(resourceGroupName, clusterName, parameters, 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.'); + } + + // Send request + this.beginCreateOrUpdate(resourceGroupName, clusterName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['Cluster']().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); + }); + }); +} + + +/** + * Update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * Update operation. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.sku] The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @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 Cluster} 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 _update(resourceGroupName, clusterName, parameters, 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.'); + } + + // Send request + this.beginUpdate(resourceGroupName, clusterName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['Cluster']().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); + }); + }); +} + + +/** + * Deletes a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _deleteMethod(resourceGroupName, clusterName, 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.'); + } + + // Send request + this.beginDeleteMethod(resourceGroupName, clusterName, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + + return callback(null, result, httpRequest, response); + }); + }); +} + + +/** + * Stops a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _stop(resourceGroupName, clusterName, 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.'); + } + + // Send request + this.beginStop(resourceGroupName, clusterName, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + + return callback(null, result, httpRequest, response); + }); + }); +} + + +/** + * Starts a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _start(resourceGroupName, clusterName, 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.'); + } + + // Send request + this.beginStart(resourceGroupName, clusterName, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + + return callback(null, result, httpRequest, response); + }); + }); +} + +/** + * Lists all Kusto clusters within a resource group. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @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 ClusterListResult} 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 _listByResourceGroup(resourceGroupName, 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 (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 (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 (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 (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.Kusto/clusters'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['ClusterListResult']().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 all Kusto clusters within a subscription. + * + * @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 ClusterListResult} 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 _list(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 (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 (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}/providers/Microsoft.Kusto/clusters'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['ClusterListResult']().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 eligible SKUs for Kusto resource provider. + * + * @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 ListSkusResult} 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 _listSkus(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.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 (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 (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}/providers/Microsoft.Kusto/skus'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['ListSkusResult']().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); + }); +} + +/** + * Checks that the cluster name is valid and is not already in use. + * + * @param {string} location Azure location. + * + * @param {object} clusterName The name of the cluster. + * + * @param {string} clusterName.name Cluster name. + * + * @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 CheckNameResult} 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 _checkNameAvailability(location, clusterName, 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.'); + } + if (clusterName === null || clusterName === undefined) + { + clusterName = {}; + } + // Validate + try { + 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 (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 (location === null || location === undefined || typeof location.valueOf() !== 'string') { + throw new Error('location cannot be null or undefined and it must be of type string.'); + } + if (clusterName === null || clusterName === undefined) { + throw new Error('clusterName 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}/providers/Microsoft.Kusto/locations/{location}/checkNameAvailability'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{location}', encodeURIComponent(location)); + 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 (clusterName !== null && clusterName !== undefined) { + let requestModelMapper = new client.models['ClusterCheckNameRequest']().mapper(); + requestModel = client.serialize(requestModelMapper, clusterName, 'clusterName'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(clusterName, 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['CheckNameResult']().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); + }); +} + +/** + * Returns the SKUs available for the provided resource. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 ListResourceSkusResult} 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 _listSkusByResource(resourceGroupName, clusterName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/skus'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['ListResourceSkusResult']().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); + }); +} + +/** + * Create or update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * CreateOrUpdate operation. + * + * @param {object} parameters.sku The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 Cluster} 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 _beginCreateOrUpdate(resourceGroupName, clusterName, parameters, 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.'); + } + if (parameters === null || parameters === undefined) + { + parameters = {}; + } + // Validate + try { + 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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'PUT'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['Cluster']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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 && statusCode !== 201) { + 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['Cluster']().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); + } + } + // Deserialize Response + if (statusCode === 201) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['Cluster']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError1.request = msRest.stripRequest(httpRequest); + deserializationError1.response = msRest.stripResponse(response); + return callback(deserializationError1); + } + } + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * Update operation. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.sku] The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @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 Cluster} 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 _beginUpdate(resourceGroupName, clusterName, parameters, 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.'); + } + if (parameters === null || parameters === undefined) + { + parameters = {}; + } + // Validate + try { + 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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'PATCH'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['ClusterUpdate']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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 && statusCode !== 201) { + 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['Cluster']().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); + } + } + // Deserialize Response + if (statusCode === 201) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['Cluster']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError1.request = msRest.stripRequest(httpRequest); + deserializationError1.response = msRest.stripResponse(response); + return callback(deserializationError1); + } + } + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Deletes a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _beginDeleteMethod(resourceGroupName, clusterName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'DELETE'; + 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]; + } + } + } + httpRequest.body = null; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 200 && statusCode !== 202 && statusCode !== 204) { + 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; + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Stops a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _beginStop(resourceGroupName, clusterName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/stop'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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]; + } + } + } + httpRequest.body = null; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 200 && statusCode !== 202) { + 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; + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Starts a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _beginStart(resourceGroupName, clusterName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/start'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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]; + } + } + } + httpRequest.body = null; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 200 && statusCode !== 202) { + 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; + + return callback(null, result, httpRequest, response); + }); +} + +/** Class representing a Clusters. */ +class Clusters { + /** + * Create a Clusters. + * @param {KustoManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._get = _get; + this._createOrUpdate = _createOrUpdate; + this._update = _update; + this._deleteMethod = _deleteMethod; + this._stop = _stop; + this._start = _start; + this._listByResourceGroup = _listByResourceGroup; + this._list = _list; + this._listSkus = _listSkus; + this._checkNameAvailability = _checkNameAvailability; + this._listSkusByResource = _listSkusByResource; + this._beginCreateOrUpdate = _beginCreateOrUpdate; + this._beginUpdate = _beginUpdate; + this._beginDeleteMethod = _beginDeleteMethod; + this._beginStop = _beginStop; + this._beginStart = _beginStart; + } + + /** + * Gets a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName, clusterName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._get(resourceGroupName, clusterName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {Cluster} - 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 Cluster} 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. + */ + get(resourceGroupName, clusterName, 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._get(resourceGroupName, clusterName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._get(resourceGroupName, clusterName, options, optionalCallback); + } + } + + /** + * Create or update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * CreateOrUpdate operation. + * + * @param {object} parameters.sku The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName, clusterName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._createOrUpdate(resourceGroupName, clusterName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Create or update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * CreateOrUpdate operation. + * + * @param {object} parameters.sku The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 {Cluster} - 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 Cluster} 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. + */ + createOrUpdate(resourceGroupName, clusterName, parameters, 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._createOrUpdate(resourceGroupName, clusterName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._createOrUpdate(resourceGroupName, clusterName, parameters, options, optionalCallback); + } + } + + /** + * Update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * Update operation. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.sku] The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName, clusterName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._update(resourceGroupName, clusterName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * Update operation. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.sku] The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @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 {Cluster} - 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 Cluster} 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. + */ + update(resourceGroupName, clusterName, parameters, 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._update(resourceGroupName, clusterName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._update(resourceGroupName, clusterName, parameters, options, optionalCallback); + } + } + + /** + * Deletes a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName, clusterName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._deleteMethod(resourceGroupName, clusterName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Deletes a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + deleteMethod(resourceGroupName, clusterName, 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._deleteMethod(resourceGroupName, clusterName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._deleteMethod(resourceGroupName, clusterName, options, optionalCallback); + } + } + + /** + * Stops a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + stopWithHttpOperationResponse(resourceGroupName, clusterName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._stop(resourceGroupName, clusterName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Stops a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + stop(resourceGroupName, clusterName, 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._stop(resourceGroupName, clusterName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._stop(resourceGroupName, clusterName, options, optionalCallback); + } + } + + /** + * Starts a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + startWithHttpOperationResponse(resourceGroupName, clusterName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._start(resourceGroupName, clusterName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Starts a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + start(resourceGroupName, clusterName, 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._start(resourceGroupName, clusterName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._start(resourceGroupName, clusterName, options, optionalCallback); + } + } + + /** + * Lists all Kusto clusters within a resource group. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @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. + */ + listByResourceGroupWithHttpOperationResponse(resourceGroupName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listByResourceGroup(resourceGroupName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists all Kusto clusters within a resource group. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @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 {ClusterListResult} - 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 ClusterListResult} 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. + */ + listByResourceGroup(resourceGroupName, 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._listByResourceGroup(resourceGroupName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listByResourceGroup(resourceGroupName, options, optionalCallback); + } + } + + /** + * Lists all Kusto clusters within a subscription. + * + * @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. + */ + listWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists all Kusto clusters within a subscription. + * + * @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 {ClusterListResult} - 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 ClusterListResult} 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. + */ + list(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._list(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(options, optionalCallback); + } + } + + /** + * Lists eligible SKUs for Kusto resource provider. + * + * @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. + */ + listSkusWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listSkus(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists eligible SKUs for Kusto resource provider. + * + * @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 {ListSkusResult} - 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 ListSkusResult} 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. + */ + listSkus(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._listSkus(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listSkus(options, optionalCallback); + } + } + + /** + * Checks that the cluster name is valid and is not already in use. + * + * @param {string} location Azure location. + * + * @param {object} clusterName The name of the cluster. + * + * @param {string} clusterName.name Cluster name. + * + * @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. + */ + checkNameAvailabilityWithHttpOperationResponse(location, clusterName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._checkNameAvailability(location, clusterName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Checks that the cluster name is valid and is not already in use. + * + * @param {string} location Azure location. + * + * @param {object} clusterName The name of the cluster. + * + * @param {string} clusterName.name Cluster name. + * + * @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 {CheckNameResult} - 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 CheckNameResult} 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. + */ + checkNameAvailability(location, clusterName, 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._checkNameAvailability(location, clusterName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._checkNameAvailability(location, clusterName, options, optionalCallback); + } + } + + /** + * Returns the SKUs available for the provided resource. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + listSkusByResourceWithHttpOperationResponse(resourceGroupName, clusterName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listSkusByResource(resourceGroupName, clusterName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Returns the SKUs available for the provided resource. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {ListResourceSkusResult} - 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 ListResourceSkusResult} 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. + */ + listSkusByResource(resourceGroupName, clusterName, 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._listSkusByResource(resourceGroupName, clusterName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listSkusByResource(resourceGroupName, clusterName, options, optionalCallback); + } + } + + /** + * Create or update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * CreateOrUpdate operation. + * + * @param {object} parameters.sku The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName, clusterName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginCreateOrUpdate(resourceGroupName, clusterName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Create or update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * CreateOrUpdate operation. + * + * @param {object} parameters.sku The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 {Cluster} - 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 Cluster} 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. + */ + beginCreateOrUpdate(resourceGroupName, clusterName, parameters, 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._beginCreateOrUpdate(resourceGroupName, clusterName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginCreateOrUpdate(resourceGroupName, clusterName, parameters, options, optionalCallback); + } + } + + /** + * Update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * Update operation. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.sku] The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @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. + */ + beginUpdateWithHttpOperationResponse(resourceGroupName, clusterName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginUpdate(resourceGroupName, clusterName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * Update operation. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.sku] The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @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 {Cluster} - 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 Cluster} 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. + */ + beginUpdate(resourceGroupName, clusterName, parameters, 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._beginUpdate(resourceGroupName, clusterName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginUpdate(resourceGroupName, clusterName, parameters, options, optionalCallback); + } + } + + /** + * Deletes a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName, clusterName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginDeleteMethod(resourceGroupName, clusterName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Deletes a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + beginDeleteMethod(resourceGroupName, clusterName, 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._beginDeleteMethod(resourceGroupName, clusterName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginDeleteMethod(resourceGroupName, clusterName, options, optionalCallback); + } + } + + /** + * Stops a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + beginStopWithHttpOperationResponse(resourceGroupName, clusterName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginStop(resourceGroupName, clusterName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Stops a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + beginStop(resourceGroupName, clusterName, 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._beginStop(resourceGroupName, clusterName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginStop(resourceGroupName, clusterName, options, optionalCallback); + } + } + + /** + * Starts a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + beginStartWithHttpOperationResponse(resourceGroupName, clusterName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginStart(resourceGroupName, clusterName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Starts a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + beginStart(resourceGroupName, clusterName, 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._beginStart(resourceGroupName, clusterName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginStart(resourceGroupName, clusterName, options, optionalCallback); + } + } + +} + +module.exports = Clusters; diff --git a/lib/services/kustoManagement/lib/operations/databases.js b/lib/services/kustoManagement/lib/operations/databases.js new file mode 100644 index 0000000000..1cebc2a5ca --- /dev/null +++ b/lib/services/kustoManagement/lib/operations/databases.js @@ -0,0 +1,3088 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * Checks that the database name is valid and is not already in use. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} databaseName The name of the database. + * + * @param {string} databaseName.name Database name. + * + * @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 CheckNameResult} 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 _checkNameAvailability(resourceGroupName, clusterName, databaseName, 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.'); + } + if (databaseName === null || databaseName === undefined) + { + databaseName = {}; + } + // Validate + try { + 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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (databaseName === null || databaseName === undefined) { + throw new Error('databaseName 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.Kusto/clusters/{clusterName}/checkNameAvailability'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 (databaseName !== null && databaseName !== undefined) { + let requestModelMapper = new client.models['DatabaseCheckNameRequest']().mapper(); + requestModel = client.serialize(requestModelMapper, databaseName, 'databaseName'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(databaseName, 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['CheckNameResult']().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); + }); +} + +/** + * Returns the list of databases of the given Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 DatabaseListResult} 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 _listByCluster(resourceGroupName, clusterName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['DatabaseListResult']().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); + }); +} + +/** + * Returns a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 Database} 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 _get(resourceGroupName, clusterName, databaseName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases/{databaseName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['Database']().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); + }); +} + + +/** + * Creates or updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the + * CreateOrUpdate operation. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 Database} 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 _createOrUpdate(resourceGroupName, clusterName, databaseName, parameters, 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.'); + } + + // Send request + this.beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['Database']().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); + }); + }); +} + + +/** + * Updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the Update + * operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @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 Database} 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 _update(resourceGroupName, clusterName, databaseName, parameters, 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.'); + } + + // Send request + this.beginUpdate(resourceGroupName, clusterName, databaseName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['Database']().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); + }); + }); +} + + +/** + * Deletes the database with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _deleteMethod(resourceGroupName, clusterName, databaseName, 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.'); + } + + // Send request + this.beginDeleteMethod(resourceGroupName, clusterName, databaseName, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + + return callback(null, result, httpRequest, response); + }); + }); +} + +/** + * Returns a list of database principals of the given Kusto cluster and + * database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 DatabasePrincipalListResult} 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 _listPrincipals(resourceGroupName, clusterName, databaseName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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]; + } + } + } + httpRequest.body = null; + // 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['DatabasePrincipalListResult']().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); + }); +} + +/** + * Add Database principals permissions. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} databasePrincipalsToAdd List of database principals to add. + * + * @param {array} [databasePrincipalsToAdd.value] The list of Kusto database + * principals. + * + * @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 DatabasePrincipalListResult} 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 _addPrincipals(resourceGroupName, clusterName, databaseName, databasePrincipalsToAdd, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (databasePrincipalsToAdd === null || databasePrincipalsToAdd === undefined) { + throw new Error('databasePrincipalsToAdd 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.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 (databasePrincipalsToAdd !== null && databasePrincipalsToAdd !== undefined) { + let requestModelMapper = new client.models['DatabasePrincipalListRequest']().mapper(); + requestModel = client.serialize(requestModelMapper, databasePrincipalsToAdd, 'databasePrincipalsToAdd'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(databasePrincipalsToAdd, 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['DatabasePrincipalListResult']().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); + }); +} + +/** + * Remove Database principals permissions. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} databasePrincipalsToRemove List of database principals to + * remove. + * + * @param {array} [databasePrincipalsToRemove.value] The list of Kusto database + * principals. + * + * @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 DatabasePrincipalListResult} 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 _removePrincipals(resourceGroupName, clusterName, databaseName, databasePrincipalsToRemove, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (databasePrincipalsToRemove === null || databasePrincipalsToRemove === undefined) { + throw new Error('databasePrincipalsToRemove 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.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 (databasePrincipalsToRemove !== null && databasePrincipalsToRemove !== undefined) { + let requestModelMapper = new client.models['DatabasePrincipalListRequest']().mapper(); + requestModel = client.serialize(requestModelMapper, databasePrincipalsToRemove, 'databasePrincipalsToRemove'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(databasePrincipalsToRemove, 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['DatabasePrincipalListResult']().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); + }); +} + +/** + * Creates or updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the + * CreateOrUpdate operation. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 Database} 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 _beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, parameters, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases/{databaseName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'PUT'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['Database']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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 && statusCode !== 201 && statusCode !== 202) { + 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['Database']().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); + } + } + // Deserialize Response + if (statusCode === 201) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['Database']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError1.request = msRest.stripRequest(httpRequest); + deserializationError1.response = msRest.stripResponse(response); + return callback(deserializationError1); + } + } + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the Update + * operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @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 Database} 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 _beginUpdate(resourceGroupName, clusterName, databaseName, parameters, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases/{databaseName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'PATCH'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['DatabaseUpdate']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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 && statusCode !== 201 && statusCode !== 202) { + 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['Database']().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); + } + } + // Deserialize Response + if (statusCode === 201) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['Database']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError1.request = msRest.stripRequest(httpRequest); + deserializationError1.response = msRest.stripResponse(response); + return callback(deserializationError1); + } + } + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Deletes the database with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _beginDeleteMethod(resourceGroupName, clusterName, databaseName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases/{databaseName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'DELETE'; + 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]; + } + } + } + httpRequest.body = null; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 200 && statusCode !== 202 && statusCode !== 204) { + 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; + + return callback(null, result, httpRequest, response); + }); +} + +/** Class representing a Databases. */ +class Databases { + /** + * Create a Databases. + * @param {KustoManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._checkNameAvailability = _checkNameAvailability; + this._listByCluster = _listByCluster; + this._get = _get; + this._createOrUpdate = _createOrUpdate; + this._update = _update; + this._deleteMethod = _deleteMethod; + this._listPrincipals = _listPrincipals; + this._addPrincipals = _addPrincipals; + this._removePrincipals = _removePrincipals; + this._beginCreateOrUpdate = _beginCreateOrUpdate; + this._beginUpdate = _beginUpdate; + this._beginDeleteMethod = _beginDeleteMethod; + } + + /** + * Checks that the database name is valid and is not already in use. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} databaseName The name of the database. + * + * @param {string} databaseName.name Database name. + * + * @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. + */ + checkNameAvailabilityWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._checkNameAvailability(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Checks that the database name is valid and is not already in use. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} databaseName The name of the database. + * + * @param {string} databaseName.name Database name. + * + * @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 {CheckNameResult} - 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 CheckNameResult} 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. + */ + checkNameAvailability(resourceGroupName, clusterName, databaseName, 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._checkNameAvailability(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._checkNameAvailability(resourceGroupName, clusterName, databaseName, options, optionalCallback); + } + } + + /** + * Returns the list of databases of the given Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + listByClusterWithHttpOperationResponse(resourceGroupName, clusterName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listByCluster(resourceGroupName, clusterName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Returns the list of databases of the given Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {DatabaseListResult} - 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 DatabaseListResult} 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. + */ + listByCluster(resourceGroupName, clusterName, 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._listByCluster(resourceGroupName, clusterName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listByCluster(resourceGroupName, clusterName, options, optionalCallback); + } + } + + /** + * Returns a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._get(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Returns a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 {Database} - 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 Database} 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. + */ + get(resourceGroupName, clusterName, databaseName, 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._get(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._get(resourceGroupName, clusterName, databaseName, options, optionalCallback); + } + } + + /** + * Creates or updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the + * CreateOrUpdate operation. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._createOrUpdate(resourceGroupName, clusterName, databaseName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Creates or updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the + * CreateOrUpdate operation. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 {Database} - 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 Database} 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. + */ + createOrUpdate(resourceGroupName, clusterName, databaseName, parameters, 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._createOrUpdate(resourceGroupName, clusterName, databaseName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._createOrUpdate(resourceGroupName, clusterName, databaseName, parameters, options, optionalCallback); + } + } + + /** + * Updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the Update + * operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._update(resourceGroupName, clusterName, databaseName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the Update + * operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @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 {Database} - 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 Database} 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. + */ + update(resourceGroupName, clusterName, databaseName, parameters, 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._update(resourceGroupName, clusterName, databaseName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._update(resourceGroupName, clusterName, databaseName, parameters, options, optionalCallback); + } + } + + /** + * Deletes the database with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._deleteMethod(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Deletes the database with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + deleteMethod(resourceGroupName, clusterName, databaseName, 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._deleteMethod(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._deleteMethod(resourceGroupName, clusterName, databaseName, options, optionalCallback); + } + } + + /** + * Returns a list of database principals of the given Kusto cluster and + * database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + */ + listPrincipalsWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listPrincipals(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Returns a list of database principals of the given Kusto cluster and + * database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 {DatabasePrincipalListResult} - 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 DatabasePrincipalListResult} 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. + */ + listPrincipals(resourceGroupName, clusterName, databaseName, 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._listPrincipals(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listPrincipals(resourceGroupName, clusterName, databaseName, options, optionalCallback); + } + } + + /** + * Add Database principals permissions. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} databasePrincipalsToAdd List of database principals to add. + * + * @param {array} [databasePrincipalsToAdd.value] The list of Kusto database + * principals. + * + * @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. + */ + addPrincipalsWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, databasePrincipalsToAdd, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._addPrincipals(resourceGroupName, clusterName, databaseName, databasePrincipalsToAdd, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Add Database principals permissions. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} databasePrincipalsToAdd List of database principals to add. + * + * @param {array} [databasePrincipalsToAdd.value] The list of Kusto database + * principals. + * + * @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 {DatabasePrincipalListResult} - 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 DatabasePrincipalListResult} 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. + */ + addPrincipals(resourceGroupName, clusterName, databaseName, databasePrincipalsToAdd, 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._addPrincipals(resourceGroupName, clusterName, databaseName, databasePrincipalsToAdd, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._addPrincipals(resourceGroupName, clusterName, databaseName, databasePrincipalsToAdd, options, optionalCallback); + } + } + + /** + * Remove Database principals permissions. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} databasePrincipalsToRemove List of database principals to + * remove. + * + * @param {array} [databasePrincipalsToRemove.value] The list of Kusto database + * principals. + * + * @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. + */ + removePrincipalsWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, databasePrincipalsToRemove, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._removePrincipals(resourceGroupName, clusterName, databaseName, databasePrincipalsToRemove, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Remove Database principals permissions. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} databasePrincipalsToRemove List of database principals to + * remove. + * + * @param {array} [databasePrincipalsToRemove.value] The list of Kusto database + * principals. + * + * @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 {DatabasePrincipalListResult} - 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 DatabasePrincipalListResult} 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. + */ + removePrincipals(resourceGroupName, clusterName, databaseName, databasePrincipalsToRemove, 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._removePrincipals(resourceGroupName, clusterName, databaseName, databasePrincipalsToRemove, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._removePrincipals(resourceGroupName, clusterName, databaseName, databasePrincipalsToRemove, options, optionalCallback); + } + } + + /** + * Creates or updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the + * CreateOrUpdate operation. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Creates or updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the + * CreateOrUpdate operation. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 {Database} - 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 Database} 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. + */ + beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, parameters, 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._beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, parameters, options, optionalCallback); + } + } + + /** + * Updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the Update + * operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @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. + */ + beginUpdateWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginUpdate(resourceGroupName, clusterName, databaseName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the Update + * operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @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 {Database} - 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 Database} 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. + */ + beginUpdate(resourceGroupName, clusterName, databaseName, parameters, 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._beginUpdate(resourceGroupName, clusterName, databaseName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginUpdate(resourceGroupName, clusterName, databaseName, parameters, options, optionalCallback); + } + } + + /** + * Deletes the database with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginDeleteMethod(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Deletes the database with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + beginDeleteMethod(resourceGroupName, clusterName, databaseName, 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._beginDeleteMethod(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginDeleteMethod(resourceGroupName, clusterName, databaseName, options, optionalCallback); + } + } + +} + +module.exports = Databases; diff --git a/lib/services/kustoManagement/lib/operations/eventHubConnections.js b/lib/services/kustoManagement/lib/operations/eventHubConnections.js new file mode 100644 index 0000000000..f1b39442c9 --- /dev/null +++ b/lib/services/kustoManagement/lib/operations/eventHubConnections.js @@ -0,0 +1,2451 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * Returns the list of Event Hub connections of the given Kusto database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 EventHubConnectionListResult} 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 _listByDatabase(resourceGroupName, clusterName, databaseName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['EventHubConnectionListResult']().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); + }); +} + +/** + * Checks that the Event Hub data connection parameters are valid. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.eventhubConnectionName] The name of the event + * hub connection. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 EventHubConnectionValidationListResult} 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 _eventhubConnectionValidation(resourceGroupName, clusterName, databaseName, parameters, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (parameters === null || parameters === undefined) { + throw new Error('parameters 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.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubConnectionValidation'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['EventHubConnectionValidation']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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['EventHubConnectionValidationListResult']().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); + }); +} + +/** + * Returns an Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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 EventHubConnection} 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 _get(resourceGroupName, clusterName, databaseName, eventHubConnectionName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + if (eventHubConnectionName === null || eventHubConnectionName === undefined || typeof eventHubConnectionName.valueOf() !== 'string') { + throw new Error('eventHubConnectionName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{eventHubConnectionName}', encodeURIComponent(eventHubConnectionName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['EventHubConnection']().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); + }); +} + + +/** + * Creates or updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 EventHubConnection} 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 _createOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, 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.'); + } + + // Send request + this.beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['EventHubConnection']().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); + }); + }); +} + + +/** + * Updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the Update operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 EventHubConnection} 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 _update(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, 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.'); + } + + // Send request + this.beginUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['EventHubConnection']().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); + }); + }); +} + + +/** + * Deletes the Event Hub connection with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _deleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, 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.'); + } + + // Send request + this.beginDeleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + + return callback(null, result, httpRequest, response); + }); + }); +} + +/** + * Creates or updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 EventHubConnection} 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 _beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + if (eventHubConnectionName === null || eventHubConnectionName === undefined || typeof eventHubConnectionName.valueOf() !== 'string') { + throw new Error('eventHubConnectionName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{eventHubConnectionName}', encodeURIComponent(eventHubConnectionName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'PUT'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['EventHubConnection']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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 && statusCode !== 201 && statusCode !== 202) { + 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['EventHubConnection']().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); + } + } + // Deserialize Response + if (statusCode === 201) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['EventHubConnection']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError1.request = msRest.stripRequest(httpRequest); + deserializationError1.response = msRest.stripResponse(response); + return callback(deserializationError1); + } + } + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the Update operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 EventHubConnection} 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 _beginUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + if (eventHubConnectionName === null || eventHubConnectionName === undefined || typeof eventHubConnectionName.valueOf() !== 'string') { + throw new Error('eventHubConnectionName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{eventHubConnectionName}', encodeURIComponent(eventHubConnectionName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'PATCH'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['EventHubConnectionUpdate']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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 && statusCode !== 201 && statusCode !== 202) { + 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['EventHubConnection']().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); + } + } + // Deserialize Response + if (statusCode === 201) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['EventHubConnection']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError1.request = msRest.stripRequest(httpRequest); + deserializationError1.response = msRest.stripResponse(response); + return callback(deserializationError1); + } + } + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Deletes the Event Hub connection with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _beginDeleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, 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 (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 (clusterName === null || clusterName === undefined || typeof clusterName.valueOf() !== 'string') { + throw new Error('clusterName cannot be null or undefined and it must be of type string.'); + } + if (databaseName === null || databaseName === undefined || typeof databaseName.valueOf() !== 'string') { + throw new Error('databaseName cannot be null or undefined and it must be of type string.'); + } + if (eventHubConnectionName === null || eventHubConnectionName === undefined || typeof eventHubConnectionName.valueOf() !== 'string') { + throw new Error('eventHubConnectionName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.Kusto/clusters/{clusterName}/databases/{databaseName}/eventhubconnections/{eventHubConnectionName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{clusterName}', encodeURIComponent(clusterName)); + requestUrl = requestUrl.replace('{databaseName}', encodeURIComponent(databaseName)); + requestUrl = requestUrl.replace('{eventHubConnectionName}', encodeURIComponent(eventHubConnectionName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'DELETE'; + 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]; + } + } + } + httpRequest.body = null; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 200 && statusCode !== 202 && statusCode !== 204) { + 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; + + return callback(null, result, httpRequest, response); + }); +} + +/** Class representing a EventHubConnections. */ +class EventHubConnections { + /** + * Create a EventHubConnections. + * @param {KustoManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._listByDatabase = _listByDatabase; + this._eventhubConnectionValidation = _eventhubConnectionValidation; + this._get = _get; + this._createOrUpdate = _createOrUpdate; + this._update = _update; + this._deleteMethod = _deleteMethod; + this._beginCreateOrUpdate = _beginCreateOrUpdate; + this._beginUpdate = _beginUpdate; + this._beginDeleteMethod = _beginDeleteMethod; + } + + /** + * Returns the list of Event Hub connections of the given Kusto database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + */ + listByDatabaseWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listByDatabase(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Returns the list of Event Hub connections of the given Kusto database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 {EventHubConnectionListResult} - 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 EventHubConnectionListResult} 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. + */ + listByDatabase(resourceGroupName, clusterName, databaseName, 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._listByDatabase(resourceGroupName, clusterName, databaseName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listByDatabase(resourceGroupName, clusterName, databaseName, options, optionalCallback); + } + } + + /** + * Checks that the Event Hub data connection parameters are valid. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.eventhubConnectionName] The name of the event + * hub connection. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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. + */ + eventhubConnectionValidationWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._eventhubConnectionValidation(resourceGroupName, clusterName, databaseName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Checks that the Event Hub data connection parameters are valid. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.eventhubConnectionName] The name of the event + * hub connection. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 {EventHubConnectionValidationListResult} - 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 EventHubConnectionValidationListResult} 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. + */ + eventhubConnectionValidation(resourceGroupName, clusterName, databaseName, parameters, 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._eventhubConnectionValidation(resourceGroupName, clusterName, databaseName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._eventhubConnectionValidation(resourceGroupName, clusterName, databaseName, parameters, options, optionalCallback); + } + } + + /** + * Returns an Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._get(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Returns an Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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 {EventHubConnection} - 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 EventHubConnection} 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. + */ + get(resourceGroupName, clusterName, databaseName, eventHubConnectionName, 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._get(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._get(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options, optionalCallback); + } + } + + /** + * Creates or updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._createOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Creates or updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 {EventHubConnection} - 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 EventHubConnection} 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. + */ + createOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, 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._createOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._createOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, optionalCallback); + } + } + + /** + * Updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the Update operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._update(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the Update operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 {EventHubConnection} - 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 EventHubConnection} 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. + */ + update(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, 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._update(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._update(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, optionalCallback); + } + } + + /** + * Deletes the Event Hub connection with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._deleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Deletes the Event Hub connection with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + deleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, 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._deleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._deleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options, optionalCallback); + } + } + + /** + * Creates or updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Creates or updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 {EventHubConnection} - 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 EventHubConnection} 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. + */ + beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, 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._beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginCreateOrUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, optionalCallback); + } + } + + /** + * Updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the Update operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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. + */ + beginUpdateWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the Update operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 {EventHubConnection} - 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 EventHubConnection} 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. + */ + beginUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, 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._beginUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginUpdate(resourceGroupName, clusterName, databaseName, eventHubConnectionName, parameters, options, optionalCallback); + } + } + + /** + * Deletes the Event Hub connection with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginDeleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Deletes the Event Hub connection with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + beginDeleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, 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._beginDeleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginDeleteMethod(resourceGroupName, clusterName, databaseName, eventHubConnectionName, options, optionalCallback); + } + } + +} + +module.exports = EventHubConnections; diff --git a/lib/services/kustoManagement/lib/operations/index.d.ts b/lib/services/kustoManagement/lib/operations/index.d.ts new file mode 100644 index 0000000000..473e0e99bb --- /dev/null +++ b/lib/services/kustoManagement/lib/operations/index.d.ts @@ -0,0 +1,3016 @@ +/* + * 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. +*/ + +import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse } from 'ms-rest'; +import * as models from '../models'; + + +/** + * @class + * Clusters + * __NOTE__: An instance of this class is automatically created for an + * instance of the KustoManagementClient. + */ +export interface Clusters { + + + /** + * Gets a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {Cluster} - 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. + * + * {Cluster} [result] - The deserialized result object if an error did not occur. + * See {@link Cluster} 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. + */ + get(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, clusterName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, clusterName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Create or update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * CreateOrUpdate operation. + * + * @param {object} parameters.sku The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, parameters: models.Cluster, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Create or update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * CreateOrUpdate operation. + * + * @param {object} parameters.sku The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 {Cluster} - 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. + * + * {Cluster} [result] - The deserialized result object if an error did not occur. + * See {@link Cluster} 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. + */ + createOrUpdate(resourceGroupName: string, clusterName: string, parameters: models.Cluster, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, clusterName: string, parameters: models.Cluster, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, clusterName: string, parameters: models.Cluster, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * Update operation. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.sku] The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, parameters: models.ClusterUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * Update operation. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.sku] The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @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 {Cluster} - 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. + * + * {Cluster} [result] - The deserialized result object if an error did not occur. + * See {@link Cluster} 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. + */ + update(resourceGroupName: string, clusterName: string, parameters: models.ClusterUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + update(resourceGroupName: string, clusterName: string, parameters: models.ClusterUpdate, callback: ServiceCallback): void; + update(resourceGroupName: string, clusterName: string, parameters: models.ClusterUpdate, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + deleteMethod(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, clusterName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, clusterName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Stops a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + stopWithHttpOperationResponse(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Stops a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + stop(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + stop(resourceGroupName: string, clusterName: string, callback: ServiceCallback): void; + stop(resourceGroupName: string, clusterName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Starts a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + startWithHttpOperationResponse(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Starts a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + start(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + start(resourceGroupName: string, clusterName: string, callback: ServiceCallback): void; + start(resourceGroupName: string, clusterName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists all Kusto clusters within a resource group. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @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. + */ + listByResourceGroupWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all Kusto clusters within a resource group. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @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 {ClusterListResult} - 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. + * + * {ClusterListResult} [result] - The deserialized result object if an error did not occur. + * See {@link ClusterListResult} 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. + */ + listByResourceGroup(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByResourceGroup(resourceGroupName: string, callback: ServiceCallback): void; + listByResourceGroup(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists all Kusto clusters within a subscription. + * + * @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. + */ + listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all Kusto clusters within a subscription. + * + * @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 {ClusterListResult} - 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. + * + * {ClusterListResult} [result] - The deserialized result object if an error did not occur. + * See {@link ClusterListResult} 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. + */ + list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(callback: ServiceCallback): void; + list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists eligible SKUs for Kusto resource provider. + * + * @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. + */ + listSkusWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists eligible SKUs for Kusto resource provider. + * + * @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 {ListSkusResult} - 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. + * + * {ListSkusResult} [result] - The deserialized result object if an error did not occur. + * See {@link ListSkusResult} 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. + */ + listSkus(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listSkus(callback: ServiceCallback): void; + listSkus(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Checks that the cluster name is valid and is not already in use. + * + * @param {string} location Azure location. + * + * @param {object} clusterName The name of the cluster. + * + * @param {string} clusterName.name Cluster name. + * + * @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. + */ + checkNameAvailabilityWithHttpOperationResponse(location: string, clusterName: models.ClusterCheckNameRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Checks that the cluster name is valid and is not already in use. + * + * @param {string} location Azure location. + * + * @param {object} clusterName The name of the cluster. + * + * @param {string} clusterName.name Cluster name. + * + * @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 {CheckNameResult} - 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. + * + * {CheckNameResult} [result] - The deserialized result object if an error did not occur. + * See {@link CheckNameResult} 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. + */ + checkNameAvailability(location: string, clusterName: models.ClusterCheckNameRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + checkNameAvailability(location: string, clusterName: models.ClusterCheckNameRequest, callback: ServiceCallback): void; + checkNameAvailability(location: string, clusterName: models.ClusterCheckNameRequest, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Returns the SKUs available for the provided resource. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + listSkusByResourceWithHttpOperationResponse(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Returns the SKUs available for the provided resource. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {ListResourceSkusResult} - 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. + * + * {ListResourceSkusResult} [result] - The deserialized result object if an error did not occur. + * See {@link ListResourceSkusResult} 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. + */ + listSkusByResource(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listSkusByResource(resourceGroupName: string, clusterName: string, callback: ServiceCallback): void; + listSkusByResource(resourceGroupName: string, clusterName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Create or update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * CreateOrUpdate operation. + * + * @param {object} parameters.sku The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, parameters: models.Cluster, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Create or update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * CreateOrUpdate operation. + * + * @param {object} parameters.sku The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 {Cluster} - 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. + * + * {Cluster} [result] - The deserialized result object if an error did not occur. + * See {@link Cluster} 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. + */ + beginCreateOrUpdate(resourceGroupName: string, clusterName: string, parameters: models.Cluster, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginCreateOrUpdate(resourceGroupName: string, clusterName: string, parameters: models.Cluster, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, clusterName: string, parameters: models.Cluster, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * Update operation. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.sku] The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @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. + */ + beginUpdateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, parameters: models.ClusterUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Update a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} parameters The Kusto cluster parameters supplied to the + * Update operation. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.sku] The SKU of the cluster. + * + * @param {string} parameters.sku.name SKU name. Possible values include: + * 'KC8', 'KC16', 'KS8', 'KS16', 'D13_v2', 'D14_v2', 'L8', 'L16' + * + * @param {number} [parameters.sku.capacity] SKU capacity. + * + * @param {array} [parameters.trustedExternalTenants] The cluster's external + * tenants. + * + * @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 {Cluster} - 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. + * + * {Cluster} [result] - The deserialized result object if an error did not occur. + * See {@link Cluster} 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. + */ + beginUpdate(resourceGroupName: string, clusterName: string, parameters: models.ClusterUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginUpdate(resourceGroupName: string, clusterName: string, parameters: models.ClusterUpdate, callback: ServiceCallback): void; + beginUpdate(resourceGroupName: string, clusterName: string, parameters: models.ClusterUpdate, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + beginDeleteMethod(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginDeleteMethod(resourceGroupName: string, clusterName: string, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, clusterName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Stops a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + beginStopWithHttpOperationResponse(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Stops a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + beginStop(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginStop(resourceGroupName: string, clusterName: string, callback: ServiceCallback): void; + beginStop(resourceGroupName: string, clusterName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Starts a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + beginStartWithHttpOperationResponse(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Starts a Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + beginStart(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginStart(resourceGroupName: string, clusterName: string, callback: ServiceCallback): void; + beginStart(resourceGroupName: string, clusterName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * Databases + * __NOTE__: An instance of this class is automatically created for an + * instance of the KustoManagementClient. + */ +export interface Databases { + + + /** + * Checks that the database name is valid and is not already in use. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} databaseName The name of the database. + * + * @param {string} databaseName.name Database name. + * + * @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. + */ + checkNameAvailabilityWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: models.DatabaseCheckNameRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Checks that the database name is valid and is not already in use. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {object} databaseName The name of the database. + * + * @param {string} databaseName.name Database name. + * + * @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 {CheckNameResult} - 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. + * + * {CheckNameResult} [result] - The deserialized result object if an error did not occur. + * See {@link CheckNameResult} 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. + */ + checkNameAvailability(resourceGroupName: string, clusterName: string, databaseName: models.DatabaseCheckNameRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + checkNameAvailability(resourceGroupName: string, clusterName: string, databaseName: models.DatabaseCheckNameRequest, callback: ServiceCallback): void; + checkNameAvailability(resourceGroupName: string, clusterName: string, databaseName: models.DatabaseCheckNameRequest, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Returns the list of databases of the given Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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. + */ + listByClusterWithHttpOperationResponse(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Returns the list of databases of the given Kusto cluster. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @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 {DatabaseListResult} - 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. + * + * {DatabaseListResult} [result] - The deserialized result object if an error did not occur. + * See {@link DatabaseListResult} 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. + */ + listByCluster(resourceGroupName: string, clusterName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByCluster(resourceGroupName: string, clusterName: string, callback: ServiceCallback): void; + listByCluster(resourceGroupName: string, clusterName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Returns a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Returns a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 {Database} - 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. + * + * {Database} [result] - The deserialized result object if an error did not occur. + * See {@link Database} 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. + */ + get(resourceGroupName: string, clusterName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, clusterName: string, databaseName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, clusterName: string, databaseName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the + * CreateOrUpdate operation. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.Database, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the + * CreateOrUpdate operation. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 {Database} - 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. + * + * {Database} [result] - The deserialized result object if an error did not occur. + * See {@link Database} 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. + */ + createOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.Database, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.Database, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.Database, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the Update + * operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.DatabaseUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the Update + * operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @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 {Database} - 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. + * + * {Database} [result] - The deserialized result object if an error did not occur. + * See {@link Database} 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. + */ + update(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.DatabaseUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + update(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.DatabaseUpdate, callback: ServiceCallback): void; + update(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.DatabaseUpdate, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes the database with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes the database with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + deleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Returns a list of database principals of the given Kusto cluster and + * database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + */ + listPrincipalsWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Returns a list of database principals of the given Kusto cluster and + * database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 {DatabasePrincipalListResult} - 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. + * + * {DatabasePrincipalListResult} [result] - The deserialized result object if an error did not occur. + * See {@link DatabasePrincipalListResult} 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. + */ + listPrincipals(resourceGroupName: string, clusterName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listPrincipals(resourceGroupName: string, clusterName: string, databaseName: string, callback: ServiceCallback): void; + listPrincipals(resourceGroupName: string, clusterName: string, databaseName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Add Database principals permissions. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} databasePrincipalsToAdd List of database principals to add. + * + * @param {array} [databasePrincipalsToAdd.value] The list of Kusto database + * principals. + * + * @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. + */ + addPrincipalsWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, databasePrincipalsToAdd: models.DatabasePrincipalListRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Add Database principals permissions. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} databasePrincipalsToAdd List of database principals to add. + * + * @param {array} [databasePrincipalsToAdd.value] The list of Kusto database + * principals. + * + * @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 {DatabasePrincipalListResult} - 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. + * + * {DatabasePrincipalListResult} [result] - The deserialized result object if an error did not occur. + * See {@link DatabasePrincipalListResult} 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. + */ + addPrincipals(resourceGroupName: string, clusterName: string, databaseName: string, databasePrincipalsToAdd: models.DatabasePrincipalListRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + addPrincipals(resourceGroupName: string, clusterName: string, databaseName: string, databasePrincipalsToAdd: models.DatabasePrincipalListRequest, callback: ServiceCallback): void; + addPrincipals(resourceGroupName: string, clusterName: string, databaseName: string, databasePrincipalsToAdd: models.DatabasePrincipalListRequest, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Remove Database principals permissions. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} databasePrincipalsToRemove List of database principals to + * remove. + * + * @param {array} [databasePrincipalsToRemove.value] The list of Kusto database + * principals. + * + * @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. + */ + removePrincipalsWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, databasePrincipalsToRemove: models.DatabasePrincipalListRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Remove Database principals permissions. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} databasePrincipalsToRemove List of database principals to + * remove. + * + * @param {array} [databasePrincipalsToRemove.value] The list of Kusto database + * principals. + * + * @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 {DatabasePrincipalListResult} - 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. + * + * {DatabasePrincipalListResult} [result] - The deserialized result object if an error did not occur. + * See {@link DatabasePrincipalListResult} 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. + */ + removePrincipals(resourceGroupName: string, clusterName: string, databaseName: string, databasePrincipalsToRemove: models.DatabasePrincipalListRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + removePrincipals(resourceGroupName: string, clusterName: string, databaseName: string, databasePrincipalsToRemove: models.DatabasePrincipalListRequest, callback: ServiceCallback): void; + removePrincipals(resourceGroupName: string, clusterName: string, databaseName: string, databasePrincipalsToRemove: models.DatabasePrincipalListRequest, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the + * CreateOrUpdate operation. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.Database, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the + * CreateOrUpdate operation. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @param {object} [parameters.tags] Resource tags. + * + * @param {string} parameters.location The geo-location where the resource + * lives + * + * @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 {Database} - 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. + * + * {Database} [result] - The deserialized result object if an error did not occur. + * See {@link Database} 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. + */ + beginCreateOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.Database, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginCreateOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.Database, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.Database, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the Update + * operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @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. + */ + beginUpdateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.DatabaseUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates a database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The database parameters supplied to the Update + * operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {number} parameters.softDeletePeriodInDays The number of days data + * should be kept before it stops being accessible to queries. + * + * @param {number} [parameters.hotCachePeriodInDays] The number of days of data + * that should be kept in cache for fast queries. + * + * @param {object} [parameters.statistics] The statistics of the database. + * + * @param {number} [parameters.statistics.size] The database size - the total + * size of compressed data and index in bytes. + * + * @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 {Database} - 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. + * + * {Database} [result] - The deserialized result object if an error did not occur. + * See {@link Database} 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. + */ + beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.DatabaseUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.DatabaseUpdate, callback: ServiceCallback): void; + beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.DatabaseUpdate, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes the database with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes the database with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + beginDeleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginDeleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * EventHubConnections + * __NOTE__: An instance of this class is automatically created for an + * instance of the KustoManagementClient. + */ +export interface EventHubConnections { + + + /** + * Returns the list of Event Hub connections of the given Kusto database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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. + */ + listByDatabaseWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Returns the list of Event Hub connections of the given Kusto database. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @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 {EventHubConnectionListResult} - 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. + * + * {EventHubConnectionListResult} [result] - The deserialized result object if an error did not occur. + * See {@link EventHubConnectionListResult} 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. + */ + listByDatabase(resourceGroupName: string, clusterName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByDatabase(resourceGroupName: string, clusterName: string, databaseName: string, callback: ServiceCallback): void; + listByDatabase(resourceGroupName: string, clusterName: string, databaseName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Checks that the Event Hub data connection parameters are valid. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.eventhubConnectionName] The name of the event + * hub connection. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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. + */ + eventhubConnectionValidationWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.EventHubConnectionValidation, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Checks that the Event Hub data connection parameters are valid. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.eventhubConnectionName] The name of the event + * hub connection. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 {EventHubConnectionValidationListResult} - 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. + * + * {EventHubConnectionValidationListResult} [result] - The deserialized result object if an error did not occur. + * See {@link EventHubConnectionValidationListResult} 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. + */ + eventhubConnectionValidation(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.EventHubConnectionValidation, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + eventhubConnectionValidation(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.EventHubConnectionValidation, callback: ServiceCallback): void; + eventhubConnectionValidation(resourceGroupName: string, clusterName: string, databaseName: string, parameters: models.EventHubConnectionValidation, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Returns an Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Returns an Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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 {EventHubConnection} - 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. + * + * {EventHubConnection} [result] - The deserialized result object if an error did not occur. + * See {@link EventHubConnection} 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. + */ + get(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 {EventHubConnection} - 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. + * + * {EventHubConnection} [result] - The deserialized result object if an error did not occur. + * See {@link EventHubConnection} 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. + */ + createOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnection, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnection, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the Update operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnectionUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the Update operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 {EventHubConnection} - 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. + * + * {EventHubConnection} [result] - The deserialized result object if an error did not occur. + * See {@link EventHubConnection} 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. + */ + update(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnectionUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + update(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnectionUpdate, callback: ServiceCallback): void; + update(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnectionUpdate, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes the Event Hub connection with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes the Event Hub connection with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + deleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the CreateOrUpdate operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 {EventHubConnection} - 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. + * + * {EventHubConnection} [result] - The deserialized result object if an error did not occur. + * See {@link EventHubConnection} 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. + */ + beginCreateOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginCreateOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnection, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnection, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the Update operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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. + */ + beginUpdateWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnectionUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates a Event Hub connection. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @param {object} parameters The Event Hub connection parameters supplied to + * the Update operation. + * + * @param {string} [parameters.location] Resource location. + * + * @param {string} parameters.eventHubResourceId The resource ID of the event + * hub to be used to create a data connection. + * + * @param {string} parameters.consumerGroup The event hub consumer group. + * + * @param {string} [parameters.tableName] The table where the data should be + * ingested. Optionally the table information can be added to each message. + * + * @param {string} [parameters.mappingRuleName] The mapping rule to be used to + * ingest the data. Optionally the mapping information can be added to each + * message. + * + * @param {string} [parameters.dataFormat] The data format of the message. + * Optionally the data format can be added to each message. Possible values + * include: 'MULTIJSON', 'JSON', 'CSV' + * + * @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 {EventHubConnection} - 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. + * + * {EventHubConnection} [result] - The deserialized result object if an error did not occur. + * See {@link EventHubConnection} 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. + */ + beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnectionUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnectionUpdate, callback: ServiceCallback): void; + beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, parameters: models.EventHubConnectionUpdate, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes the Event Hub connection with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes the Event Hub connection with the given name. + * + * @param {string} resourceGroupName The name of the resource group containing + * the Kusto cluster. + * + * @param {string} clusterName The name of the Kusto cluster. + * + * @param {string} databaseName The name of the database in the Kusto cluster. + * + * @param {string} eventHubConnectionName The name of the event hub connection. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + beginDeleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginDeleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, clusterName: string, databaseName: string, eventHubConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * Operations + * __NOTE__: An instance of this class is automatically created for an + * instance of the KustoManagementClient. + */ +export interface Operations { + + + /** + * Lists available operations for the Microsoft.Kusto provider. + * + * @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. + */ + listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists available operations for the Microsoft.Kusto provider. + * + * @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 {OperationListResult} - 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. + * + * {OperationListResult} [result] - The deserialized result object if an error did not occur. + * See {@link OperationListResult} 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. + */ + list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(callback: ServiceCallback): void; + list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists available operations for the Microsoft.Kusto provider. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists available operations for the Microsoft.Kusto provider. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {OperationListResult} - 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. + * + * {OperationListResult} [result] - The deserialized result object if an error did not occur. + * See {@link OperationListResult} 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. + */ + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} diff --git a/lib/services/kustoManagement/lib/operations/index.js b/lib/services/kustoManagement/lib/operations/index.js new file mode 100644 index 0000000000..e6ecebc32f --- /dev/null +++ b/lib/services/kustoManagement/lib/operations/index.js @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/* jshint latedef:false */ +/* jshint forin:false */ +/* jshint noempty:false */ + +'use strict'; + +exports.Clusters = require('./clusters'); +exports.Databases = require('./databases'); +exports.EventHubConnections = require('./eventHubConnections'); +exports.Operations = require('./operations'); diff --git a/lib/services/kustoManagement/lib/operations/operations.js b/lib/services/kustoManagement/lib/operations/operations.js new file mode 100644 index 0000000000..289ecdb50d --- /dev/null +++ b/lib/services/kustoManagement/lib/operations/operations.js @@ -0,0 +1,449 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * Lists available operations for the Microsoft.Kusto provider. + * + * @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 OperationListResult} 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 _list(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.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 (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('/') ? '' : '/') + 'providers/Microsoft.Kusto/operations'; + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['OperationListResult']().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 available operations for the Microsoft.Kusto provider. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 OperationListResult} 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 _listNext(nextPageLink, 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 (nextPageLink === null || nextPageLink === undefined || typeof nextPageLink.valueOf() !== 'string') { + throw new Error('nextPageLink cannot be null or undefined and it must be of type string.'); + } + 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 requestUrl = '{nextLink}'; + requestUrl = requestUrl.replace('{nextLink}', nextPageLink); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['OperationListResult']().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); + }); +} + +/** Class representing a Operations. */ +class Operations { + /** + * Create a Operations. + * @param {KustoManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._list = _list; + this._listNext = _listNext; + } + + /** + * Lists available operations for the Microsoft.Kusto provider. + * + * @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. + */ + listWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists available operations for the Microsoft.Kusto provider. + * + * @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 {OperationListResult} - 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 OperationListResult} 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. + */ + list(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._list(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(options, optionalCallback); + } + } + + /** + * Lists available operations for the Microsoft.Kusto provider. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listNext(nextPageLink, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists available operations for the Microsoft.Kusto provider. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {OperationListResult} - 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 OperationListResult} 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. + */ + listNext(nextPageLink, 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._listNext(nextPageLink, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listNext(nextPageLink, options, optionalCallback); + } + } + +} + +module.exports = Operations; diff --git a/lib/services/kustoManagement/package.json b/lib/services/kustoManagement/package.json new file mode 100644 index 0000000000..6ec944a032 --- /dev/null +++ b/lib/services/kustoManagement/package.json @@ -0,0 +1,25 @@ +{ + "name": "azure-arm-kusto", + "author": "Microsoft Corporation", + "description": "KustoManagementClient Library with typescript type definitions for node", + "version": "1.0.0-preview", + "dependencies": { + "ms-rest": "^2.3.3", + "ms-rest-azure": "^2.5.5" + }, + "keywords": [ + "node", + "azure" + ], + "license": "MIT", + "main": "./lib/kustoManagementClient.js", + "types": "./lib/kustoManagementClient.d.ts", + "homepage": "https://github.com/azure/azure-sdk-for-node/tree/master/lib/services/kustoManagement", + "repository": { + "type": "git", + "url": "https://github.com/azure/azure-sdk-for-node.git" + }, + "bugs": { + "url": "https://github.com/azure/azure-sdk-for-node/issues" + } +} diff --git a/lib/services/logicManagement/README.md b/lib/services/logicManagement/README.md index 13683f4f53..9f4a33ce62 100644 --- a/lib/services/logicManagement/README.md +++ b/lib/services/logicManagement/README.md @@ -3,40 +3,43 @@ uid: azure-arm-logic summary: *content --- -# Microsoft Azure SDK for Node.js - LogicManagementClient +**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 - LogicManagementClient + 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-logic ``` -## How to use +### How to use -### Authentication, client creation and listBySubscription workflows as an example. +#### Authentication, client creation, and listBySubscription workflows as an example. ```javascript const msRestAzure = require("ms-rest-azure"); const LogicManagementClient = require("azure-arm-logic"); msRestAzure.interactiveLogin().then((creds) => { - const subscriptionId = ""; - const client = new LogicManagementClient(creds, subscriptionId); - const top = 1; - const filter = "testfilter"; - return client.workflows.listBySubscription(top, filter).then((result) => { - console.log("The result is:"); - console.log(result); - }); + const subscriptionId = ""; + const client = new LogicManagementClient(creds, subscriptionId); + const top = 1; + const filter = "testfilter"; + + return client.workflows.listBySubscription(top, filter).then((result) => { + console.log("The result is:"); + console.log(result); + }); }).catch((err) => { console.log('An error occurred:'); 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/logicManagement/lib/logicManagementClient.d.ts b/lib/services/logicManagement/lib/logicManagementClient.d.ts index 9c6a7d813f..f9918481b2 100644 --- a/lib/services/logicManagement/lib/logicManagementClient.d.ts +++ b/lib/services/logicManagement/lib/logicManagementClient.d.ts @@ -64,6 +64,8 @@ export default class LogicManagementClient extends AzureServiceClient { workflowRuns: operations.WorkflowRuns; workflowRunActions: operations.WorkflowRunActions; workflowRunActionRepetitions: operations.WorkflowRunActionRepetitions; + workflowRunActionRepetitionsRequestHistories: operations.WorkflowRunActionRepetitionsRequestHistories; + workflowRunActionRequestHistories: operations.WorkflowRunActionRequestHistories; workflowRunActionScopeRepetitions: operations.WorkflowRunActionScopeRepetitions; workflowRunOperations: operations.WorkflowRunOperations; integrationAccounts: operations.IntegrationAccounts; diff --git a/lib/services/logicManagement/lib/logicManagementClient.js b/lib/services/logicManagement/lib/logicManagementClient.js index 5a26bf5fb0..06baa7badf 100644 --- a/lib/services/logicManagement/lib/logicManagementClient.js +++ b/lib/services/logicManagement/lib/logicManagementClient.js @@ -80,6 +80,8 @@ class LogicManagementClient extends ServiceClient { this.workflowRuns = new operations.WorkflowRuns(this); this.workflowRunActions = new operations.WorkflowRunActions(this); this.workflowRunActionRepetitions = new operations.WorkflowRunActionRepetitions(this); + this.workflowRunActionRepetitionsRequestHistories = new operations.WorkflowRunActionRepetitionsRequestHistories(this); + this.workflowRunActionRequestHistories = new operations.WorkflowRunActionRequestHistories(this); this.workflowRunActionScopeRepetitions = new operations.WorkflowRunActionScopeRepetitions(this); this.workflowRunOperations = new operations.WorkflowRunOperations(this); this.integrationAccounts = new operations.IntegrationAccounts(this); diff --git a/lib/services/logicManagement/lib/models/aS2AcknowledgementConnectionSettings.js b/lib/services/logicManagement/lib/models/aS2AcknowledgementConnectionSettings.js index 22622a355a..2cb3139de7 100644 --- a/lib/services/logicManagement/lib/models/aS2AcknowledgementConnectionSettings.js +++ b/lib/services/logicManagement/lib/models/aS2AcknowledgementConnectionSettings.js @@ -17,14 +17,14 @@ class AS2AcknowledgementConnectionSettings { /** * Create a AS2AcknowledgementConnectionSettings. - * @member {boolean} ignoreCertificateNameMismatch The value indicating + * @property {boolean} ignoreCertificateNameMismatch The value indicating * whether to ignore mismatch in certificate name. - * @member {boolean} supportHttpStatusCodeContinue The value indicating + * @property {boolean} supportHttpStatusCodeContinue The value indicating * whether to support HTTP status code 'CONTINUE'. - * @member {boolean} keepHttpConnectionAlive The value indicating whether to - * keep the connection alive. - * @member {boolean} unfoldHttpHeaders The value indicating whether to unfold - * the HTTP headers. + * @property {boolean} keepHttpConnectionAlive The value indicating whether + * to keep the connection alive. + * @property {boolean} unfoldHttpHeaders The value indicating whether to + * unfold the HTTP headers. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/aS2AgreementContent.js b/lib/services/logicManagement/lib/models/aS2AgreementContent.js index 4416e9faaf..2bc3b98c8f 100644 --- a/lib/services/logicManagement/lib/models/aS2AgreementContent.js +++ b/lib/services/logicManagement/lib/models/aS2AgreementContent.js @@ -17,340 +17,342 @@ class AS2AgreementContent { /** * Create a AS2AgreementContent. - * @member {object} receiveAgreement The AS2 one-way receive agreement. - * @member {object} [receiveAgreement.senderBusinessIdentity] The sender + * @property {object} receiveAgreement The AS2 one-way receive agreement. + * @property {object} [receiveAgreement.senderBusinessIdentity] The sender * business identity - * @member {string} [receiveAgreement.senderBusinessIdentity.qualifier] The + * @property {string} [receiveAgreement.senderBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [receiveAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [receiveAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.receiverBusinessIdentity.value] The + * @property {string} [receiveAgreement.senderBusinessIdentity.value] The + * user defined business identity value. + * @property {object} [receiveAgreement.receiverBusinessIdentity] The + * receiver business identity + * @property {string} [receiveAgreement.receiverBusinessIdentity.qualifier] + * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [receiveAgreement.receiverBusinessIdentity.value] The * user defined business identity value. - * @member {object} [receiveAgreement.protocolSettings] The AS2 protocol + * @property {object} [receiveAgreement.protocolSettings] The AS2 protocol * settings. - * @member {object} + * @property {object} * [receiveAgreement.protocolSettings.messageConnectionSettings] The message * connection settings. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} + * @property {object} * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings] The * acknowledgement connection settings. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} [receiveAgreement.protocolSettings.mdnSettings] The MDN + * @property {object} [receiveAgreement.protocolSettings.mdnSettings] The MDN * settings. - * @member {boolean} [receiveAgreement.protocolSettings.mdnSettings.needMdn] - * The value indicating whether to send or request a MDN. - * @member {boolean} [receiveAgreement.protocolSettings.mdnSettings.signMdn] - * The value indicating whether the MDN needs to be signed or not. - * @member {boolean} + * @property {boolean} + * [receiveAgreement.protocolSettings.mdnSettings.needMdn] The value + * indicating whether to send or request a MDN. + * @property {boolean} + * [receiveAgreement.protocolSettings.mdnSettings.signMdn] The value + * indicating whether the MDN needs to be signed or not. + * @property {boolean} * [receiveAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] The * value indicating whether to send the asynchronous MDN. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The * receipt delivery URL. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] * The disposition notification to header value. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] * The value indicating whether to sign the outbound MDN if optional. - * @member {string} [receiveAgreement.protocolSettings.mdnSettings.mdnText] + * @property {string} [receiveAgreement.protocolSettings.mdnSettings.mdnText] * The MDN text. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] * The value indicating whether to send inbound MDN to message box. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The * signing or hashing algorithm. Possible values include: 'NotSpecified', * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [receiveAgreement.protocolSettings.securitySettings] The - * security settings. - * @member {boolean} + * @property {object} [receiveAgreement.protocolSettings.securitySettings] + * The security settings. + * @property {boolean} * [receiveAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] * The value indicating whether to send or request a MDN. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.securitySettings.signingCertificateName] * The name of the signing certificate. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.securitySettings.encryptionCertificateName] * The name of the encryption certificate. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] * The value indicating whether to enable NRR for inbound MDN. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} [receiveAgreement.protocolSettings.validationSettings] + * @property {object} [receiveAgreement.protocolSettings.validationSettings] * The validation settings. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.overrideMessageProperties] * The value indicating whether to override incoming message properties with * those in agreement. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.encryptMessage] The * value indicating whether the message has to be encrypted. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.signMessage] The * value indicating whether the message has to be signed. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.compressMessage] The * value indicating whether the message has to be compressed. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateMessage] * The value indicating whether to check for duplicate message. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] * The number of days to look back for duplicate interchange. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] * The value indicating whether to check for certificate revocation list on * send. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] * The value indicating whether to check for certificate revocation list on * receive. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.validationSettings.encryptionAlgorithm] * The encryption algorithm. Possible values include: 'NotSpecified', 'None', * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.validationSettings.signingAlgorithm] * The signing algorithm. Possible values include: 'NotSpecified', 'Default', * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [receiveAgreement.protocolSettings.envelopeSettings] The - * envelope settings. - * @member {string} + * @property {object} [receiveAgreement.protocolSettings.envelopeSettings] + * The envelope settings. + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.messageContentType] * The message content type. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] * The value indicating whether to transmit file name in mime header. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.fileNameTemplate] The * template for file name. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] * The value indicating whether to suspend message on file name generation * error. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.autogenerateFileName] * The value indicating whether to auto generate file name. - * @member {object} [receiveAgreement.protocolSettings.errorSettings] The + * @property {object} [receiveAgreement.protocolSettings.errorSettings] The * error settings. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] * The value indicating whether to suspend duplicate message. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] * The value indicating whether to resend message If MDN is not received. - * @member {object} sendAgreement The AS2 one-way send agreement. - * @member {object} [sendAgreement.senderBusinessIdentity] The sender + * @property {object} sendAgreement The AS2 one-way send agreement. + * @property {object} [sendAgreement.senderBusinessIdentity] The sender * business identity - * @member {string} [sendAgreement.senderBusinessIdentity.qualifier] The + * @property {string} [sendAgreement.senderBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.senderBusinessIdentity.value] The user + * @property {string} [sendAgreement.senderBusinessIdentity.value] The user * defined business identity value. - * @member {object} [sendAgreement.receiverBusinessIdentity] The receiver + * @property {object} [sendAgreement.receiverBusinessIdentity] The receiver * business identity - * @member {string} [sendAgreement.receiverBusinessIdentity.qualifier] The + * @property {string} [sendAgreement.receiverBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.receiverBusinessIdentity.value] The user + * @property {string} [sendAgreement.receiverBusinessIdentity.value] The user * defined business identity value. - * @member {object} [sendAgreement.protocolSettings] The AS2 protocol + * @property {object} [sendAgreement.protocolSettings] The AS2 protocol * settings. - * @member {object} + * @property {object} * [sendAgreement.protocolSettings.messageConnectionSettings] The message * connection settings. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} + * @property {object} * [sendAgreement.protocolSettings.acknowledgementConnectionSettings] The * acknowledgement connection settings. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} [sendAgreement.protocolSettings.mdnSettings] The MDN + * @property {object} [sendAgreement.protocolSettings.mdnSettings] The MDN * settings. - * @member {boolean} [sendAgreement.protocolSettings.mdnSettings.needMdn] The - * value indicating whether to send or request a MDN. - * @member {boolean} [sendAgreement.protocolSettings.mdnSettings.signMdn] The - * value indicating whether the MDN needs to be signed or not. - * @member {boolean} + * @property {boolean} [sendAgreement.protocolSettings.mdnSettings.needMdn] + * The value indicating whether to send or request a MDN. + * @property {boolean} [sendAgreement.protocolSettings.mdnSettings.signMdn] + * The value indicating whether the MDN needs to be signed or not. + * @property {boolean} * [sendAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] The * value indicating whether to send the asynchronous MDN. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The * receipt delivery URL. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] The * disposition notification to header value. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] The * value indicating whether to sign the outbound MDN if optional. - * @member {string} [sendAgreement.protocolSettings.mdnSettings.mdnText] The - * MDN text. - * @member {boolean} + * @property {string} [sendAgreement.protocolSettings.mdnSettings.mdnText] + * The MDN text. + * @property {boolean} * [sendAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] * The value indicating whether to send inbound MDN to message box. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The * signing or hashing algorithm. Possible values include: 'NotSpecified', * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [sendAgreement.protocolSettings.securitySettings] The + * @property {object} [sendAgreement.protocolSettings.securitySettings] The * security settings. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] * The value indicating whether to send or request a MDN. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.securitySettings.signingCertificateName] * The name of the signing certificate. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.securitySettings.encryptionCertificateName] * The name of the encryption certificate. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] * The value indicating whether to enable NRR for inbound MDN. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] The * Sha2 algorithm format. Valid values are Sha2, ShaHashSize, * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} [sendAgreement.protocolSettings.validationSettings] The + * @property {object} [sendAgreement.protocolSettings.validationSettings] The * validation settings. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.overrideMessageProperties] * The value indicating whether to override incoming message properties with * those in agreement. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.encryptMessage] The * value indicating whether the message has to be encrypted. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.signMessage] The value * indicating whether the message has to be signed. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.compressMessage] The * value indicating whether the message has to be compressed. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.checkDuplicateMessage] * The value indicating whether to check for duplicate message. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] * The number of days to look back for duplicate interchange. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] * The value indicating whether to check for certificate revocation list on * send. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] * The value indicating whether to check for certificate revocation list on * receive. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.validationSettings.encryptionAlgorithm] * The encryption algorithm. Possible values include: 'NotSpecified', 'None', * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.validationSettings.signingAlgorithm] The * signing algorithm. Possible values include: 'NotSpecified', 'Default', * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [sendAgreement.protocolSettings.envelopeSettings] The + * @property {object} [sendAgreement.protocolSettings.envelopeSettings] The * envelope settings. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.messageContentType] The * message content type. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] * The value indicating whether to transmit file name in mime header. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.fileNameTemplate] The * template for file name. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] * The value indicating whether to suspend message on file name generation * error. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.autogenerateFileName] The * value indicating whether to auto generate file name. - * @member {object} [sendAgreement.protocolSettings.errorSettings] The error - * settings. - * @member {boolean} + * @property {object} [sendAgreement.protocolSettings.errorSettings] The + * error settings. + * @property {boolean} * [sendAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] The * value indicating whether to suspend duplicate message. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] The * value indicating whether to resend message If MDN is not received. */ diff --git a/lib/services/logicManagement/lib/models/aS2EnvelopeSettings.js b/lib/services/logicManagement/lib/models/aS2EnvelopeSettings.js index 4827d27b48..2c03a83a55 100644 --- a/lib/services/logicManagement/lib/models/aS2EnvelopeSettings.js +++ b/lib/services/logicManagement/lib/models/aS2EnvelopeSettings.js @@ -17,13 +17,13 @@ class AS2EnvelopeSettings { /** * Create a AS2EnvelopeSettings. - * @member {string} messageContentType The message content type. - * @member {boolean} transmitFileNameInMimeHeader The value indicating + * @property {string} messageContentType The message content type. + * @property {boolean} transmitFileNameInMimeHeader The value indicating * whether to transmit file name in mime header. - * @member {string} fileNameTemplate The template for file name. - * @member {boolean} suspendMessageOnFileNameGenerationError The value + * @property {string} fileNameTemplate The template for file name. + * @property {boolean} suspendMessageOnFileNameGenerationError The value * indicating whether to suspend message on file name generation error. - * @member {boolean} autogenerateFileName The value indicating whether to + * @property {boolean} autogenerateFileName The value indicating whether to * auto generate file name. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/aS2ErrorSettings.js b/lib/services/logicManagement/lib/models/aS2ErrorSettings.js index a52c1df388..463fa41df0 100644 --- a/lib/services/logicManagement/lib/models/aS2ErrorSettings.js +++ b/lib/services/logicManagement/lib/models/aS2ErrorSettings.js @@ -17,9 +17,9 @@ class AS2ErrorSettings { /** * Create a AS2ErrorSettings. - * @member {boolean} suspendDuplicateMessage The value indicating whether to - * suspend duplicate message. - * @member {boolean} resendIfMdnNotReceived The value indicating whether to + * @property {boolean} suspendDuplicateMessage The value indicating whether + * to suspend duplicate message. + * @property {boolean} resendIfMdnNotReceived The value indicating whether to * resend message If MDN is not received. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/aS2MdnSettings.js b/lib/services/logicManagement/lib/models/aS2MdnSettings.js index a53335a89c..715f3885d7 100644 --- a/lib/services/logicManagement/lib/models/aS2MdnSettings.js +++ b/lib/services/logicManagement/lib/models/aS2MdnSettings.js @@ -17,21 +17,21 @@ class AS2MdnSettings { /** * Create a AS2MdnSettings. - * @member {boolean} needMdn The value indicating whether to send or request - * a MDN. - * @member {boolean} signMdn The value indicating whether the MDN needs to be - * signed or not. - * @member {boolean} sendMdnAsynchronously The value indicating whether to + * @property {boolean} needMdn The value indicating whether to send or + * request a MDN. + * @property {boolean} signMdn The value indicating whether the MDN needs to + * be signed or not. + * @property {boolean} sendMdnAsynchronously The value indicating whether to * send the asynchronous MDN. - * @member {string} [receiptDeliveryUrl] The receipt delivery URL. - * @member {string} [dispositionNotificationTo] The disposition notification - * to header value. - * @member {boolean} signOutboundMdnIfOptional The value indicating whether + * @property {string} [receiptDeliveryUrl] The receipt delivery URL. + * @property {string} [dispositionNotificationTo] The disposition + * notification to header value. + * @property {boolean} signOutboundMdnIfOptional The value indicating whether * to sign the outbound MDN if optional. - * @member {string} [mdnText] The MDN text. - * @member {boolean} sendInboundMdnToMessageBox The value indicating whether - * to send inbound MDN to message box. - * @member {string} micHashingAlgorithm The signing or hashing algorithm. + * @property {string} [mdnText] The MDN text. + * @property {boolean} sendInboundMdnToMessageBox The value indicating + * whether to send inbound MDN to message box. + * @property {string} micHashingAlgorithm The signing or hashing algorithm. * Possible values include: 'NotSpecified', 'None', 'MD5', 'SHA1', 'SHA2256', * 'SHA2384', 'SHA2512' */ diff --git a/lib/services/logicManagement/lib/models/aS2MessageConnectionSettings.js b/lib/services/logicManagement/lib/models/aS2MessageConnectionSettings.js index 3f51d34d65..1a82b2df91 100644 --- a/lib/services/logicManagement/lib/models/aS2MessageConnectionSettings.js +++ b/lib/services/logicManagement/lib/models/aS2MessageConnectionSettings.js @@ -17,14 +17,14 @@ class AS2MessageConnectionSettings { /** * Create a AS2MessageConnectionSettings. - * @member {boolean} ignoreCertificateNameMismatch The value indicating + * @property {boolean} ignoreCertificateNameMismatch The value indicating * whether to ignore mismatch in certificate name. - * @member {boolean} supportHttpStatusCodeContinue The value indicating + * @property {boolean} supportHttpStatusCodeContinue The value indicating * whether to support HTTP status code 'CONTINUE'. - * @member {boolean} keepHttpConnectionAlive The value indicating whether to - * keep the connection alive. - * @member {boolean} unfoldHttpHeaders The value indicating whether to unfold - * the HTTP headers. + * @property {boolean} keepHttpConnectionAlive The value indicating whether + * to keep the connection alive. + * @property {boolean} unfoldHttpHeaders The value indicating whether to + * unfold the HTTP headers. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/aS2OneWayAgreement.js b/lib/services/logicManagement/lib/models/aS2OneWayAgreement.js index 18cf1224ca..ff12bf5031 100644 --- a/lib/services/logicManagement/lib/models/aS2OneWayAgreement.js +++ b/lib/services/logicManagement/lib/models/aS2OneWayAgreement.js @@ -17,149 +17,155 @@ class AS2OneWayAgreement { /** * Create a AS2OneWayAgreement. - * @member {object} senderBusinessIdentity The sender business identity - * @member {string} [senderBusinessIdentity.qualifier] The business identity - * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [senderBusinessIdentity.value] The user defined business - * identity value. - * @member {object} receiverBusinessIdentity The receiver business identity - * @member {string} [receiverBusinessIdentity.qualifier] The business + * @property {object} senderBusinessIdentity The sender business identity + * @property {string} [senderBusinessIdentity.qualifier] The business * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiverBusinessIdentity.value] The user defined + * @property {string} [senderBusinessIdentity.value] The user defined * business identity value. - * @member {object} protocolSettings The AS2 protocol settings. - * @member {object} [protocolSettings.messageConnectionSettings] The message - * connection settings. - * @member {boolean} + * @property {object} receiverBusinessIdentity The receiver business identity + * @property {string} [receiverBusinessIdentity.qualifier] The business + * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [receiverBusinessIdentity.value] The user defined + * business identity value. + * @property {object} protocolSettings The AS2 protocol settings. + * @property {object} [protocolSettings.messageConnectionSettings] The + * message connection settings. + * @property {boolean} * [protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] The * value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [protocolSettings.messageConnectionSettings.unfoldHttpHeaders] The value * indicating whether to unfold the HTTP headers. - * @member {object} [protocolSettings.acknowledgementConnectionSettings] The - * acknowledgement connection settings. - * @member {boolean} + * @property {object} [protocolSettings.acknowledgementConnectionSettings] + * The acknowledgement connection settings. + * @property {boolean} * [protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] The * value indicating whether to unfold the HTTP headers. - * @member {object} [protocolSettings.mdnSettings] The MDN settings. - * @member {boolean} [protocolSettings.mdnSettings.needMdn] The value + * @property {object} [protocolSettings.mdnSettings] The MDN settings. + * @property {boolean} [protocolSettings.mdnSettings.needMdn] The value * indicating whether to send or request a MDN. - * @member {boolean} [protocolSettings.mdnSettings.signMdn] The value + * @property {boolean} [protocolSettings.mdnSettings.signMdn] The value * indicating whether the MDN needs to be signed or not. - * @member {boolean} [protocolSettings.mdnSettings.sendMdnAsynchronously] The - * value indicating whether to send the asynchronous MDN. - * @member {string} [protocolSettings.mdnSettings.receiptDeliveryUrl] The + * @property {boolean} [protocolSettings.mdnSettings.sendMdnAsynchronously] + * The value indicating whether to send the asynchronous MDN. + * @property {string} [protocolSettings.mdnSettings.receiptDeliveryUrl] The * receipt delivery URL. - * @member {string} [protocolSettings.mdnSettings.dispositionNotificationTo] - * The disposition notification to header value. - * @member {boolean} [protocolSettings.mdnSettings.signOutboundMdnIfOptional] - * The value indicating whether to sign the outbound MDN if optional. - * @member {string} [protocolSettings.mdnSettings.mdnText] The MDN text. - * @member {boolean} + * @property {string} + * [protocolSettings.mdnSettings.dispositionNotificationTo] The disposition + * notification to header value. + * @property {boolean} + * [protocolSettings.mdnSettings.signOutboundMdnIfOptional] The value + * indicating whether to sign the outbound MDN if optional. + * @property {string} [protocolSettings.mdnSettings.mdnText] The MDN text. + * @property {boolean} * [protocolSettings.mdnSettings.sendInboundMdnToMessageBox] The value * indicating whether to send inbound MDN to message box. - * @member {string} [protocolSettings.mdnSettings.micHashingAlgorithm] The + * @property {string} [protocolSettings.mdnSettings.micHashingAlgorithm] The * signing or hashing algorithm. Possible values include: 'NotSpecified', * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [protocolSettings.securitySettings] The security + * @property {object} [protocolSettings.securitySettings] The security * settings. - * @member {boolean} + * @property {boolean} * [protocolSettings.securitySettings.overrideGroupSigningCertificate] The * value indicating whether to send or request a MDN. - * @member {string} + * @property {string} * [protocolSettings.securitySettings.signingCertificateName] The name of the * signing certificate. - * @member {string} + * @property {string} * [protocolSettings.securitySettings.encryptionCertificateName] The name of * the encryption certificate. - * @member {boolean} + * @property {boolean} * [protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] The * value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} + * @property {boolean} * [protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] The * value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} + * @property {boolean} * [protocolSettings.securitySettings.enableNrrForOutboundMdn] The value * indicating whether to enable NRR for outbound MDN. - * @member {boolean} + * @property {boolean} * [protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} + * @property {boolean} * [protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} + * @property {boolean} * [protocolSettings.securitySettings.enableNrrForInboundMdn] The value * indicating whether to enable NRR for inbound MDN. - * @member {string} [protocolSettings.securitySettings.sha2AlgorithmFormat] + * @property {string} [protocolSettings.securitySettings.sha2AlgorithmFormat] * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} [protocolSettings.validationSettings] The validation + * @property {object} [protocolSettings.validationSettings] The validation * settings. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.overrideMessageProperties] The value * indicating whether to override incoming message properties with those in * agreement. - * @member {boolean} [protocolSettings.validationSettings.encryptMessage] The - * value indicating whether the message has to be encrypted. - * @member {boolean} [protocolSettings.validationSettings.signMessage] The + * @property {boolean} [protocolSettings.validationSettings.encryptMessage] + * The value indicating whether the message has to be encrypted. + * @property {boolean} [protocolSettings.validationSettings.signMessage] The * value indicating whether the message has to be signed. - * @member {boolean} [protocolSettings.validationSettings.compressMessage] + * @property {boolean} [protocolSettings.validationSettings.compressMessage] * The value indicating whether the message has to be compressed. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.checkDuplicateMessage] The value * indicating whether to check for duplicate message. - * @member {number} + * @property {number} * [protocolSettings.validationSettings.interchangeDuplicatesValidityDays] * The number of days to look back for duplicate interchange. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.checkCertificateRevocationListOnSend] * The value indicating whether to check for certificate revocation list on * send. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] * The value indicating whether to check for certificate revocation list on * receive. - * @member {string} [protocolSettings.validationSettings.encryptionAlgorithm] - * The encryption algorithm. Possible values include: 'NotSpecified', 'None', - * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} [protocolSettings.validationSettings.signingAlgorithm] + * @property {string} + * [protocolSettings.validationSettings.encryptionAlgorithm] The encryption + * algorithm. Possible values include: 'NotSpecified', 'None', 'DES3', 'RC2', + * 'AES128', 'AES192', 'AES256' + * @property {string} [protocolSettings.validationSettings.signingAlgorithm] * The signing algorithm. Possible values include: 'NotSpecified', 'Default', * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [protocolSettings.envelopeSettings] The envelope + * @property {object} [protocolSettings.envelopeSettings] The envelope * settings. - * @member {string} [protocolSettings.envelopeSettings.messageContentType] + * @property {string} [protocolSettings.envelopeSettings.messageContentType] * The message content type. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] The value * indicating whether to transmit file name in mime header. - * @member {string} [protocolSettings.envelopeSettings.fileNameTemplate] The - * template for file name. - * @member {boolean} + * @property {string} [protocolSettings.envelopeSettings.fileNameTemplate] + * The template for file name. + * @property {boolean} * [protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] * The value indicating whether to suspend message on file name generation * error. - * @member {boolean} [protocolSettings.envelopeSettings.autogenerateFileName] - * The value indicating whether to auto generate file name. - * @member {object} [protocolSettings.errorSettings] The error settings. - * @member {boolean} [protocolSettings.errorSettings.suspendDuplicateMessage] - * The value indicating whether to suspend duplicate message. - * @member {boolean} [protocolSettings.errorSettings.resendIfMdnNotReceived] - * The value indicating whether to resend message If MDN is not received. + * @property {boolean} + * [protocolSettings.envelopeSettings.autogenerateFileName] The value + * indicating whether to auto generate file name. + * @property {object} [protocolSettings.errorSettings] The error settings. + * @property {boolean} + * [protocolSettings.errorSettings.suspendDuplicateMessage] The value + * indicating whether to suspend duplicate message. + * @property {boolean} + * [protocolSettings.errorSettings.resendIfMdnNotReceived] The value + * indicating whether to resend message If MDN is not received. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/aS2ProtocolSettings.js b/lib/services/logicManagement/lib/models/aS2ProtocolSettings.js index 6229d5dbae..baaa76378d 100644 --- a/lib/services/logicManagement/lib/models/aS2ProtocolSettings.js +++ b/lib/services/logicManagement/lib/models/aS2ProtocolSettings.js @@ -17,114 +17,114 @@ class AS2ProtocolSettings { /** * Create a AS2ProtocolSettings. - * @member {object} messageConnectionSettings The message connection + * @property {object} messageConnectionSettings The message connection * settings. - * @member {boolean} + * @property {boolean} * [messageConnectionSettings.ignoreCertificateNameMismatch] The value * indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [messageConnectionSettings.supportHttpStatusCodeContinue] The value * indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} [messageConnectionSettings.keepHttpConnectionAlive] The - * value indicating whether to keep the connection alive. - * @member {boolean} [messageConnectionSettings.unfoldHttpHeaders] The value - * indicating whether to unfold the HTTP headers. - * @member {object} acknowledgementConnectionSettings The acknowledgement + * @property {boolean} [messageConnectionSettings.keepHttpConnectionAlive] + * The value indicating whether to keep the connection alive. + * @property {boolean} [messageConnectionSettings.unfoldHttpHeaders] The + * value indicating whether to unfold the HTTP headers. + * @property {object} acknowledgementConnectionSettings The acknowledgement * connection settings. - * @member {boolean} + * @property {boolean} * [acknowledgementConnectionSettings.ignoreCertificateNameMismatch] The * value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [acknowledgementConnectionSettings.supportHttpStatusCodeContinue] The * value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [acknowledgementConnectionSettings.keepHttpConnectionAlive] The value * indicating whether to keep the connection alive. - * @member {boolean} [acknowledgementConnectionSettings.unfoldHttpHeaders] + * @property {boolean} [acknowledgementConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} mdnSettings The MDN settings. - * @member {boolean} [mdnSettings.needMdn] The value indicating whether to + * @property {object} mdnSettings The MDN settings. + * @property {boolean} [mdnSettings.needMdn] The value indicating whether to * send or request a MDN. - * @member {boolean} [mdnSettings.signMdn] The value indicating whether the + * @property {boolean} [mdnSettings.signMdn] The value indicating whether the * MDN needs to be signed or not. - * @member {boolean} [mdnSettings.sendMdnAsynchronously] The value indicating - * whether to send the asynchronous MDN. - * @member {string} [mdnSettings.receiptDeliveryUrl] The receipt delivery + * @property {boolean} [mdnSettings.sendMdnAsynchronously] The value + * indicating whether to send the asynchronous MDN. + * @property {string} [mdnSettings.receiptDeliveryUrl] The receipt delivery * URL. - * @member {string} [mdnSettings.dispositionNotificationTo] The disposition + * @property {string} [mdnSettings.dispositionNotificationTo] The disposition * notification to header value. - * @member {boolean} [mdnSettings.signOutboundMdnIfOptional] The value + * @property {boolean} [mdnSettings.signOutboundMdnIfOptional] The value * indicating whether to sign the outbound MDN if optional. - * @member {string} [mdnSettings.mdnText] The MDN text. - * @member {boolean} [mdnSettings.sendInboundMdnToMessageBox] The value + * @property {string} [mdnSettings.mdnText] The MDN text. + * @property {boolean} [mdnSettings.sendInboundMdnToMessageBox] The value * indicating whether to send inbound MDN to message box. - * @member {string} [mdnSettings.micHashingAlgorithm] The signing or hashing - * algorithm. Possible values include: 'NotSpecified', 'None', 'MD5', 'SHA1', - * 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} securitySettings The security settings. - * @member {boolean} [securitySettings.overrideGroupSigningCertificate] The + * @property {string} [mdnSettings.micHashingAlgorithm] The signing or + * hashing algorithm. Possible values include: 'NotSpecified', 'None', 'MD5', + * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' + * @property {object} securitySettings The security settings. + * @property {boolean} [securitySettings.overrideGroupSigningCertificate] The * value indicating whether to send or request a MDN. - * @member {string} [securitySettings.signingCertificateName] The name of the - * signing certificate. - * @member {string} [securitySettings.encryptionCertificateName] The name of - * the encryption certificate. - * @member {boolean} [securitySettings.enableNrrForInboundEncodedMessages] + * @property {string} [securitySettings.signingCertificateName] The name of + * the signing certificate. + * @property {string} [securitySettings.encryptionCertificateName] The name + * of the encryption certificate. + * @property {boolean} [securitySettings.enableNrrForInboundEncodedMessages] * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} [securitySettings.enableNrrForInboundDecodedMessages] + * @property {boolean} [securitySettings.enableNrrForInboundDecodedMessages] * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} [securitySettings.enableNrrForOutboundMdn] The value + * @property {boolean} [securitySettings.enableNrrForOutboundMdn] The value * indicating whether to enable NRR for outbound MDN. - * @member {boolean} [securitySettings.enableNrrForOutboundEncodedMessages] + * @property {boolean} [securitySettings.enableNrrForOutboundEncodedMessages] * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} [securitySettings.enableNrrForOutboundDecodedMessages] + * @property {boolean} [securitySettings.enableNrrForOutboundDecodedMessages] * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} [securitySettings.enableNrrForInboundMdn] The value + * @property {boolean} [securitySettings.enableNrrForInboundMdn] The value * indicating whether to enable NRR for inbound MDN. - * @member {string} [securitySettings.sha2AlgorithmFormat] The Sha2 algorithm - * format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, + * @property {string} [securitySettings.sha2AlgorithmFormat] The Sha2 + * algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, * Sha2UnderscoreHashSize. - * @member {object} validationSettings The validation settings. - * @member {boolean} [validationSettings.overrideMessageProperties] The value - * indicating whether to override incoming message properties with those in - * agreement. - * @member {boolean} [validationSettings.encryptMessage] The value indicating - * whether the message has to be encrypted. - * @member {boolean} [validationSettings.signMessage] The value indicating + * @property {object} validationSettings The validation settings. + * @property {boolean} [validationSettings.overrideMessageProperties] The + * value indicating whether to override incoming message properties with + * those in agreement. + * @property {boolean} [validationSettings.encryptMessage] The value + * indicating whether the message has to be encrypted. + * @property {boolean} [validationSettings.signMessage] The value indicating * whether the message has to be signed. - * @member {boolean} [validationSettings.compressMessage] The value + * @property {boolean} [validationSettings.compressMessage] The value * indicating whether the message has to be compressed. - * @member {boolean} [validationSettings.checkDuplicateMessage] The value + * @property {boolean} [validationSettings.checkDuplicateMessage] The value * indicating whether to check for duplicate message. - * @member {number} [validationSettings.interchangeDuplicatesValidityDays] + * @property {number} [validationSettings.interchangeDuplicatesValidityDays] * The number of days to look back for duplicate interchange. - * @member {boolean} + * @property {boolean} * [validationSettings.checkCertificateRevocationListOnSend] The value * indicating whether to check for certificate revocation list on send. - * @member {boolean} + * @property {boolean} * [validationSettings.checkCertificateRevocationListOnReceive] The value * indicating whether to check for certificate revocation list on receive. - * @member {string} [validationSettings.encryptionAlgorithm] The encryption + * @property {string} [validationSettings.encryptionAlgorithm] The encryption * algorithm. Possible values include: 'NotSpecified', 'None', 'DES3', 'RC2', * 'AES128', 'AES192', 'AES256' - * @member {string} [validationSettings.signingAlgorithm] The signing + * @property {string} [validationSettings.signingAlgorithm] The signing * algorithm. Possible values include: 'NotSpecified', 'Default', 'SHA1', * 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} envelopeSettings The envelope settings. - * @member {string} [envelopeSettings.messageContentType] The message content - * type. - * @member {boolean} [envelopeSettings.transmitFileNameInMimeHeader] The + * @property {object} envelopeSettings The envelope settings. + * @property {string} [envelopeSettings.messageContentType] The message + * content type. + * @property {boolean} [envelopeSettings.transmitFileNameInMimeHeader] The * value indicating whether to transmit file name in mime header. - * @member {string} [envelopeSettings.fileNameTemplate] The template for file - * name. - * @member {boolean} + * @property {string} [envelopeSettings.fileNameTemplate] The template for + * file name. + * @property {boolean} * [envelopeSettings.suspendMessageOnFileNameGenerationError] The value * indicating whether to suspend message on file name generation error. - * @member {boolean} [envelopeSettings.autogenerateFileName] The value + * @property {boolean} [envelopeSettings.autogenerateFileName] The value * indicating whether to auto generate file name. - * @member {object} errorSettings The error settings. - * @member {boolean} [errorSettings.suspendDuplicateMessage] The value + * @property {object} errorSettings The error settings. + * @property {boolean} [errorSettings.suspendDuplicateMessage] The value * indicating whether to suspend duplicate message. - * @member {boolean} [errorSettings.resendIfMdnNotReceived] The value + * @property {boolean} [errorSettings.resendIfMdnNotReceived] The value * indicating whether to resend message If MDN is not received. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/aS2SecuritySettings.js b/lib/services/logicManagement/lib/models/aS2SecuritySettings.js index b30d320eef..b57df242cd 100644 --- a/lib/services/logicManagement/lib/models/aS2SecuritySettings.js +++ b/lib/services/logicManagement/lib/models/aS2SecuritySettings.js @@ -17,25 +17,25 @@ class AS2SecuritySettings { /** * Create a AS2SecuritySettings. - * @member {boolean} overrideGroupSigningCertificate The value indicating + * @property {boolean} overrideGroupSigningCertificate The value indicating * whether to send or request a MDN. - * @member {string} [signingCertificateName] The name of the signing + * @property {string} [signingCertificateName] The name of the signing * certificate. - * @member {string} [encryptionCertificateName] The name of the encryption + * @property {string} [encryptionCertificateName] The name of the encryption * certificate. - * @member {boolean} enableNrrForInboundEncodedMessages The value indicating - * whether to enable NRR for inbound encoded messages. - * @member {boolean} enableNrrForInboundDecodedMessages The value indicating - * whether to enable NRR for inbound decoded messages. - * @member {boolean} enableNrrForOutboundMdn The value indicating whether to - * enable NRR for outbound MDN. - * @member {boolean} enableNrrForOutboundEncodedMessages The value indicating - * whether to enable NRR for outbound encoded messages. - * @member {boolean} enableNrrForOutboundDecodedMessages The value indicating - * whether to enable NRR for outbound decoded messages. - * @member {boolean} enableNrrForInboundMdn The value indicating whether to + * @property {boolean} enableNrrForInboundEncodedMessages The value + * indicating whether to enable NRR for inbound encoded messages. + * @property {boolean} enableNrrForInboundDecodedMessages The value + * indicating whether to enable NRR for inbound decoded messages. + * @property {boolean} enableNrrForOutboundMdn The value indicating whether + * to enable NRR for outbound MDN. + * @property {boolean} enableNrrForOutboundEncodedMessages The value + * indicating whether to enable NRR for outbound encoded messages. + * @property {boolean} enableNrrForOutboundDecodedMessages The value + * indicating whether to enable NRR for outbound decoded messages. + * @property {boolean} enableNrrForInboundMdn The value indicating whether to * enable NRR for inbound MDN. - * @member {string} [sha2AlgorithmFormat] The Sha2 algorithm format. Valid + * @property {string} [sha2AlgorithmFormat] The Sha2 algorithm format. Valid * values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/aS2ValidationSettings.js b/lib/services/logicManagement/lib/models/aS2ValidationSettings.js index 629454191f..8c0f62ba70 100644 --- a/lib/services/logicManagement/lib/models/aS2ValidationSettings.js +++ b/lib/services/logicManagement/lib/models/aS2ValidationSettings.js @@ -17,27 +17,27 @@ class AS2ValidationSettings { /** * Create a AS2ValidationSettings. - * @member {boolean} overrideMessageProperties The value indicating whether + * @property {boolean} overrideMessageProperties The value indicating whether * to override incoming message properties with those in agreement. - * @member {boolean} encryptMessage The value indicating whether the message - * has to be encrypted. - * @member {boolean} signMessage The value indicating whether the message has - * to be signed. - * @member {boolean} compressMessage The value indicating whether the message - * has to be compressed. - * @member {boolean} checkDuplicateMessage The value indicating whether to + * @property {boolean} encryptMessage The value indicating whether the + * message has to be encrypted. + * @property {boolean} signMessage The value indicating whether the message + * has to be signed. + * @property {boolean} compressMessage The value indicating whether the + * message has to be compressed. + * @property {boolean} checkDuplicateMessage The value indicating whether to * check for duplicate message. - * @member {number} interchangeDuplicatesValidityDays The number of days to + * @property {number} interchangeDuplicatesValidityDays The number of days to * look back for duplicate interchange. - * @member {boolean} checkCertificateRevocationListOnSend The value + * @property {boolean} checkCertificateRevocationListOnSend The value * indicating whether to check for certificate revocation list on send. - * @member {boolean} checkCertificateRevocationListOnReceive The value + * @property {boolean} checkCertificateRevocationListOnReceive The value * indicating whether to check for certificate revocation list on receive. - * @member {string} encryptionAlgorithm The encryption algorithm. Possible + * @property {string} encryptionAlgorithm The encryption algorithm. Possible * values include: 'NotSpecified', 'None', 'DES3', 'RC2', 'AES128', 'AES192', * 'AES256' - * @member {string} [signingAlgorithm] The signing algorithm. Possible values - * include: 'NotSpecified', 'Default', 'SHA1', 'SHA2256', 'SHA2384', + * @property {string} [signingAlgorithm] The signing algorithm. Possible + * values include: 'NotSpecified', 'Default', 'SHA1', 'SHA2256', 'SHA2384', * 'SHA2512' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/agreementContent.js b/lib/services/logicManagement/lib/models/agreementContent.js index c3b500b349..7131beff28 100644 --- a/lib/services/logicManagement/lib/models/agreementContent.js +++ b/lib/services/logicManagement/lib/models/agreementContent.js @@ -17,1452 +17,1473 @@ class AgreementContent { /** * Create a AgreementContent. - * @member {object} [aS2] The AS2 agreement content. - * @member {object} [aS2.receiveAgreement] The AS2 one-way receive agreement. - * @member {object} [aS2.receiveAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [aS2.receiveAgreement.senderBusinessIdentity.qualifier] + * @property {object} [aS2] The AS2 agreement content. + * @property {object} [aS2.receiveAgreement] The AS2 one-way receive + * agreement. + * @property {object} [aS2.receiveAgreement.senderBusinessIdentity] The + * sender business identity + * @property {string} [aS2.receiveAgreement.senderBusinessIdentity.qualifier] * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [aS2.receiveAgreement.senderBusinessIdentity.value] The + * @property {string} [aS2.receiveAgreement.senderBusinessIdentity.value] The * user defined business identity value. - * @member {object} [aS2.receiveAgreement.receiverBusinessIdentity] The + * @property {object} [aS2.receiveAgreement.receiverBusinessIdentity] The * receiver business identity - * @member {string} [aS2.receiveAgreement.receiverBusinessIdentity.qualifier] - * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [aS2.receiveAgreement.receiverBusinessIdentity.value] The - * user defined business identity value. - * @member {object} [aS2.receiveAgreement.protocolSettings] The AS2 protocol - * settings. - * @member {object} + * @property {string} + * [aS2.receiveAgreement.receiverBusinessIdentity.qualifier] The business + * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [aS2.receiveAgreement.receiverBusinessIdentity.value] + * The user defined business identity value. + * @property {object} [aS2.receiveAgreement.protocolSettings] The AS2 + * protocol settings. + * @property {object} * [aS2.receiveAgreement.protocolSettings.messageConnectionSettings] The * message connection settings. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} + * @property {object} * [aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings] * The acknowledgement connection settings. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} [aS2.receiveAgreement.protocolSettings.mdnSettings] The + * @property {object} [aS2.receiveAgreement.protocolSettings.mdnSettings] The * MDN settings. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.mdnSettings.needMdn] The value * indicating whether to send or request a MDN. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.mdnSettings.signMdn] The value * indicating whether the MDN needs to be signed or not. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] * The value indicating whether to send the asynchronous MDN. - * @member {string} + * @property {string} * [aS2.receiveAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The * receipt delivery URL. - * @member {string} + * @property {string} * [aS2.receiveAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] * The disposition notification to header value. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] * The value indicating whether to sign the outbound MDN if optional. - * @member {string} + * @property {string} * [aS2.receiveAgreement.protocolSettings.mdnSettings.mdnText] The MDN text. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] * The value indicating whether to send inbound MDN to message box. - * @member {string} + * @property {string} * [aS2.receiveAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] * The signing or hashing algorithm. Possible values include: 'NotSpecified', * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [aS2.receiveAgreement.protocolSettings.securitySettings] - * The security settings. - * @member {boolean} + * @property {object} + * [aS2.receiveAgreement.protocolSettings.securitySettings] The security + * settings. + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] * The value indicating whether to send or request a MDN. - * @member {string} + * @property {string} * [aS2.receiveAgreement.protocolSettings.securitySettings.signingCertificateName] * The name of the signing certificate. - * @member {string} + * @property {string} * [aS2.receiveAgreement.protocolSettings.securitySettings.encryptionCertificateName] * The name of the encryption certificate. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] * The value indicating whether to enable NRR for inbound MDN. - * @member {string} + * @property {string} * [aS2.receiveAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} + * @property {object} * [aS2.receiveAgreement.protocolSettings.validationSettings] The validation * settings. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.validationSettings.overrideMessageProperties] * The value indicating whether to override incoming message properties with * those in agreement. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.validationSettings.encryptMessage] * The value indicating whether the message has to be encrypted. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.validationSettings.signMessage] The * value indicating whether the message has to be signed. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.validationSettings.compressMessage] * The value indicating whether the message has to be compressed. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.validationSettings.checkDuplicateMessage] * The value indicating whether to check for duplicate message. - * @member {number} + * @property {number} * [aS2.receiveAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] * The number of days to look back for duplicate interchange. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] * The value indicating whether to check for certificate revocation list on * send. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] * The value indicating whether to check for certificate revocation list on * receive. - * @member {string} + * @property {string} * [aS2.receiveAgreement.protocolSettings.validationSettings.encryptionAlgorithm] * The encryption algorithm. Possible values include: 'NotSpecified', 'None', * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} + * @property {string} * [aS2.receiveAgreement.protocolSettings.validationSettings.signingAlgorithm] * The signing algorithm. Possible values include: 'NotSpecified', 'Default', * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [aS2.receiveAgreement.protocolSettings.envelopeSettings] - * The envelope settings. - * @member {string} + * @property {object} + * [aS2.receiveAgreement.protocolSettings.envelopeSettings] The envelope + * settings. + * @property {string} * [aS2.receiveAgreement.protocolSettings.envelopeSettings.messageContentType] * The message content type. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] * The value indicating whether to transmit file name in mime header. - * @member {string} + * @property {string} * [aS2.receiveAgreement.protocolSettings.envelopeSettings.fileNameTemplate] * The template for file name. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] * The value indicating whether to suspend message on file name generation * error. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.envelopeSettings.autogenerateFileName] * The value indicating whether to auto generate file name. - * @member {object} [aS2.receiveAgreement.protocolSettings.errorSettings] The - * error settings. - * @member {boolean} + * @property {object} [aS2.receiveAgreement.protocolSettings.errorSettings] + * The error settings. + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] * The value indicating whether to suspend duplicate message. - * @member {boolean} + * @property {boolean} * [aS2.receiveAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] * The value indicating whether to resend message If MDN is not received. - * @member {object} [aS2.sendAgreement] The AS2 one-way send agreement. - * @member {object} [aS2.sendAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [aS2.sendAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [aS2.sendAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [aS2.sendAgreement.receiverBusinessIdentity] The receiver + * @property {object} [aS2.sendAgreement] The AS2 one-way send agreement. + * @property {object} [aS2.sendAgreement.senderBusinessIdentity] The sender * business identity - * @member {string} [aS2.sendAgreement.receiverBusinessIdentity.qualifier] + * @property {string} [aS2.sendAgreement.senderBusinessIdentity.qualifier] * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [aS2.sendAgreement.receiverBusinessIdentity.value] The + * @property {string} [aS2.sendAgreement.senderBusinessIdentity.value] The * user defined business identity value. - * @member {object} [aS2.sendAgreement.protocolSettings] The AS2 protocol + * @property {object} [aS2.sendAgreement.receiverBusinessIdentity] The + * receiver business identity + * @property {string} [aS2.sendAgreement.receiverBusinessIdentity.qualifier] + * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [aS2.sendAgreement.receiverBusinessIdentity.value] The + * user defined business identity value. + * @property {object} [aS2.sendAgreement.protocolSettings] The AS2 protocol * settings. - * @member {object} + * @property {object} * [aS2.sendAgreement.protocolSettings.messageConnectionSettings] The message * connection settings. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} + * @property {object} * [aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings] The * acknowledgement connection settings. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} [aS2.sendAgreement.protocolSettings.mdnSettings] The MDN - * settings. - * @member {boolean} [aS2.sendAgreement.protocolSettings.mdnSettings.needMdn] - * The value indicating whether to send or request a MDN. - * @member {boolean} [aS2.sendAgreement.protocolSettings.mdnSettings.signMdn] - * The value indicating whether the MDN needs to be signed or not. - * @member {boolean} + * @property {object} [aS2.sendAgreement.protocolSettings.mdnSettings] The + * MDN settings. + * @property {boolean} + * [aS2.sendAgreement.protocolSettings.mdnSettings.needMdn] The value + * indicating whether to send or request a MDN. + * @property {boolean} + * [aS2.sendAgreement.protocolSettings.mdnSettings.signMdn] The value + * indicating whether the MDN needs to be signed or not. + * @property {boolean} * [aS2.sendAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] The * value indicating whether to send the asynchronous MDN. - * @member {string} + * @property {string} * [aS2.sendAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The * receipt delivery URL. - * @member {string} + * @property {string} * [aS2.sendAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] * The disposition notification to header value. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] * The value indicating whether to sign the outbound MDN if optional. - * @member {string} [aS2.sendAgreement.protocolSettings.mdnSettings.mdnText] - * The MDN text. - * @member {boolean} + * @property {string} + * [aS2.sendAgreement.protocolSettings.mdnSettings.mdnText] The MDN text. + * @property {boolean} * [aS2.sendAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] * The value indicating whether to send inbound MDN to message box. - * @member {string} + * @property {string} * [aS2.sendAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The * signing or hashing algorithm. Possible values include: 'NotSpecified', * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [aS2.sendAgreement.protocolSettings.securitySettings] The - * security settings. - * @member {boolean} + * @property {object} [aS2.sendAgreement.protocolSettings.securitySettings] + * The security settings. + * @property {boolean} * [aS2.sendAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] * The value indicating whether to send or request a MDN. - * @member {string} + * @property {string} * [aS2.sendAgreement.protocolSettings.securitySettings.signingCertificateName] * The name of the signing certificate. - * @member {string} + * @property {string} * [aS2.sendAgreement.protocolSettings.securitySettings.encryptionCertificateName] * The name of the encryption certificate. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] * The value indicating whether to enable NRR for inbound MDN. - * @member {string} + * @property {string} * [aS2.sendAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} [aS2.sendAgreement.protocolSettings.validationSettings] + * @property {object} [aS2.sendAgreement.protocolSettings.validationSettings] * The validation settings. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.validationSettings.overrideMessageProperties] * The value indicating whether to override incoming message properties with * those in agreement. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.validationSettings.encryptMessage] The * value indicating whether the message has to be encrypted. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.validationSettings.signMessage] The * value indicating whether the message has to be signed. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.validationSettings.compressMessage] * The value indicating whether the message has to be compressed. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.validationSettings.checkDuplicateMessage] * The value indicating whether to check for duplicate message. - * @member {number} + * @property {number} * [aS2.sendAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] * The number of days to look back for duplicate interchange. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] * The value indicating whether to check for certificate revocation list on * send. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] * The value indicating whether to check for certificate revocation list on * receive. - * @member {string} + * @property {string} * [aS2.sendAgreement.protocolSettings.validationSettings.encryptionAlgorithm] * The encryption algorithm. Possible values include: 'NotSpecified', 'None', * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} + * @property {string} * [aS2.sendAgreement.protocolSettings.validationSettings.signingAlgorithm] * The signing algorithm. Possible values include: 'NotSpecified', 'Default', * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [aS2.sendAgreement.protocolSettings.envelopeSettings] The - * envelope settings. - * @member {string} + * @property {object} [aS2.sendAgreement.protocolSettings.envelopeSettings] + * The envelope settings. + * @property {string} * [aS2.sendAgreement.protocolSettings.envelopeSettings.messageContentType] * The message content type. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] * The value indicating whether to transmit file name in mime header. - * @member {string} + * @property {string} * [aS2.sendAgreement.protocolSettings.envelopeSettings.fileNameTemplate] The * template for file name. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] * The value indicating whether to suspend message on file name generation * error. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.envelopeSettings.autogenerateFileName] * The value indicating whether to auto generate file name. - * @member {object} [aS2.sendAgreement.protocolSettings.errorSettings] The + * @property {object} [aS2.sendAgreement.protocolSettings.errorSettings] The * error settings. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] * The value indicating whether to suspend duplicate message. - * @member {boolean} + * @property {boolean} * [aS2.sendAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] * The value indicating whether to resend message If MDN is not received. - * @member {object} [x12] The X12 agreement content. - * @member {object} [x12.receiveAgreement] The X12 one-way receive agreement. - * @member {object} [x12.receiveAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [x12.receiveAgreement.senderBusinessIdentity.qualifier] + * @property {object} [x12] The X12 agreement content. + * @property {object} [x12.receiveAgreement] The X12 one-way receive + * agreement. + * @property {object} [x12.receiveAgreement.senderBusinessIdentity] The + * sender business identity + * @property {string} [x12.receiveAgreement.senderBusinessIdentity.qualifier] * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [x12.receiveAgreement.senderBusinessIdentity.value] The + * @property {string} [x12.receiveAgreement.senderBusinessIdentity.value] The * user defined business identity value. - * @member {object} [x12.receiveAgreement.receiverBusinessIdentity] The + * @property {object} [x12.receiveAgreement.receiverBusinessIdentity] The * receiver business identity - * @member {string} [x12.receiveAgreement.receiverBusinessIdentity.qualifier] - * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [x12.receiveAgreement.receiverBusinessIdentity.value] The - * user defined business identity value. - * @member {object} [x12.receiveAgreement.protocolSettings] The X12 protocol - * settings. - * @member {object} + * @property {string} + * [x12.receiveAgreement.receiverBusinessIdentity.qualifier] The business + * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [x12.receiveAgreement.receiverBusinessIdentity.value] + * The user defined business identity value. + * @property {object} [x12.receiveAgreement.protocolSettings] The X12 + * protocol settings. + * @property {object} * [x12.receiveAgreement.protocolSettings.validationSettings] The X12 * validation settings. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [x12.receiveAgreement.protocolSettings.framingSettings] + * @property {object} [x12.receiveAgreement.protocolSettings.framingSettings] * The X12 framing settings. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.framingSettings.componentSeparator] * The component separator. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] * The value indicating whether to replace separators in payload. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.framingSettings.replaceCharacter] * The replacement character. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.framingSettings.segmentTerminator] * The segment terminator. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.framingSettings.characterSet] The * X12 character set. Possible values include: 'NotSpecified', 'Basic', * 'Extended', 'UTF8' - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The segment terminator suffix. Possible values include: 'NotSpecified', * 'None', 'CR', 'LF', 'CRLF' - * @member {object} [x12.receiveAgreement.protocolSettings.envelopeSettings] - * The X12 envelope settings. - * @member {number} + * @property {object} + * [x12.receiveAgreement.protocolSettings.envelopeSettings] The X12 envelope + * settings. + * @property {number} * [x12.receiveAgreement.protocolSettings.envelopeSettings.controlStandardsId] * The controls standards id. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] * The value indicating whether to use control standards id as repetition * character. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.senderApplicationId] * The sender application id. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.receiverApplicationId] * The receiver application id. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.controlVersionNumber] * The control version number. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] * The functional group id. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] * The group header agency code. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] * The group header version. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] * The group header date format. Possible values include: 'NotSpecified', * 'CCYYMMDD', 'YYMMDD' - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] * The group header time format. Possible values include: 'NotSpecified', * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.envelopeSettings.usageIndicator] * The usage indicator. Possible values include: 'NotSpecified', 'Test', * 'Information', 'Production' - * @member {object} + * @property {object} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings] The X12 * acknowledgment settings. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] * The functional acknowledgement version. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] * The value indicating whether implementation acknowledgement is needed. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] * The implementation acknowledgement version. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} [x12.receiveAgreement.protocolSettings.messageFilter] The - * X12 message filter. - * @member {string} + * @property {object} [x12.receiveAgreement.protocolSettings.messageFilter] + * The X12 message filter. + * @property {string} * [x12.receiveAgreement.protocolSettings.messageFilter.messageFilterType] * The message filter type. Possible values include: 'NotSpecified', * 'Include', 'Exclude' - * @member {object} [x12.receiveAgreement.protocolSettings.securitySettings] - * The X12 security settings. - * @member {string} + * @property {object} + * [x12.receiveAgreement.protocolSettings.securitySettings] The X12 security + * settings. + * @property {string} * [x12.receiveAgreement.protocolSettings.securitySettings.authorizationQualifier] * The authorization qualifier. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.securitySettings.authorizationValue] * The authorization value. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.securitySettings.securityQualifier] * The security qualifier. - * @member {string} + * @property {string} * [x12.receiveAgreement.protocolSettings.securitySettings.passwordValue] The * password value. - * @member {object} + * @property {object} * [x12.receiveAgreement.protocolSettings.processingSettings] The X12 * processing settings. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.processingSettings.convertImpliedDecimal] * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [x12.receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} [x12.receiveAgreement.protocolSettings.envelopeOverrides] - * The X12 envelope override settings. - * @member {array} + * @property {array} + * [x12.receiveAgreement.protocolSettings.envelopeOverrides] The X12 envelope + * override settings. + * @property {array} * [x12.receiveAgreement.protocolSettings.validationOverrides] The X12 * validation override settings. - * @member {array} [x12.receiveAgreement.protocolSettings.messageFilterList] - * The X12 message filter list. - * @member {array} [x12.receiveAgreement.protocolSettings.schemaReferences] + * @property {array} + * [x12.receiveAgreement.protocolSettings.messageFilterList] The X12 message + * filter list. + * @property {array} [x12.receiveAgreement.protocolSettings.schemaReferences] * The X12 schema references. - * @member {array} + * @property {array} * [x12.receiveAgreement.protocolSettings.x12DelimiterOverrides] The X12 * delimiter override settings. - * @member {object} [x12.sendAgreement] The X12 one-way send agreement. - * @member {object} [x12.sendAgreement.senderBusinessIdentity] The sender + * @property {object} [x12.sendAgreement] The X12 one-way send agreement. + * @property {object} [x12.sendAgreement.senderBusinessIdentity] The sender * business identity - * @member {string} [x12.sendAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [x12.sendAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [x12.sendAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [x12.sendAgreement.receiverBusinessIdentity.qualifier] + * @property {string} [x12.sendAgreement.senderBusinessIdentity.qualifier] + * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [x12.sendAgreement.senderBusinessIdentity.value] The + * user defined business identity value. + * @property {object} [x12.sendAgreement.receiverBusinessIdentity] The + * receiver business identity + * @property {string} [x12.sendAgreement.receiverBusinessIdentity.qualifier] * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [x12.sendAgreement.receiverBusinessIdentity.value] The + * @property {string} [x12.sendAgreement.receiverBusinessIdentity.value] The * user defined business identity value. - * @member {object} [x12.sendAgreement.protocolSettings] The X12 protocol + * @property {object} [x12.sendAgreement.protocolSettings] The X12 protocol * settings. - * @member {object} [x12.sendAgreement.protocolSettings.validationSettings] + * @property {object} [x12.sendAgreement.protocolSettings.validationSettings] * The X12 validation settings. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [x12.sendAgreement.protocolSettings.framingSettings] The - * X12 framing settings. - * @member {number} + * @property {object} [x12.sendAgreement.protocolSettings.framingSettings] + * The X12 framing settings. + * @property {number} * [x12.sendAgreement.protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.framingSettings.componentSeparator] * The component separator. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] * The value indicating whether to replace separators in payload. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.framingSettings.replaceCharacter] The * replacement character. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.framingSettings.segmentTerminator] The * segment terminator. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.framingSettings.characterSet] The X12 * character set. Possible values include: 'NotSpecified', 'Basic', * 'Extended', 'UTF8' - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The segment terminator suffix. Possible values include: 'NotSpecified', * 'None', 'CR', 'LF', 'CRLF' - * @member {object} [x12.sendAgreement.protocolSettings.envelopeSettings] The - * X12 envelope settings. - * @member {number} + * @property {object} [x12.sendAgreement.protocolSettings.envelopeSettings] + * The X12 envelope settings. + * @property {number} * [x12.sendAgreement.protocolSettings.envelopeSettings.controlStandardsId] * The controls standards id. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] * The value indicating whether to use control standards id as repetition * character. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.senderApplicationId] * The sender application id. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.receiverApplicationId] * The receiver application id. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.controlVersionNumber] * The control version number. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] * The functional group id. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] * The group header agency code. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] * The group header version. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] * The group header date format. Possible values include: 'NotSpecified', * 'CCYYMMDD', 'YYMMDD' - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] * The group header time format. Possible values include: 'NotSpecified', * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.envelopeSettings.usageIndicator] The * usage indicator. Possible values include: 'NotSpecified', 'Test', * 'Information', 'Production' - * @member {object} + * @property {object} * [x12.sendAgreement.protocolSettings.acknowledgementSettings] The X12 * acknowledgment settings. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] * The functional acknowledgement version. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] * The value indicating whether implementation acknowledgement is needed. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] * The implementation acknowledgement version. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} [x12.sendAgreement.protocolSettings.messageFilter] The + * @property {object} [x12.sendAgreement.protocolSettings.messageFilter] The * X12 message filter. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.messageFilter.messageFilterType] The * message filter type. Possible values include: 'NotSpecified', 'Include', * 'Exclude' - * @member {object} [x12.sendAgreement.protocolSettings.securitySettings] The - * X12 security settings. - * @member {string} + * @property {object} [x12.sendAgreement.protocolSettings.securitySettings] + * The X12 security settings. + * @property {string} * [x12.sendAgreement.protocolSettings.securitySettings.authorizationQualifier] * The authorization qualifier. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.securitySettings.authorizationValue] * The authorization value. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.securitySettings.securityQualifier] * The security qualifier. - * @member {string} + * @property {string} * [x12.sendAgreement.protocolSettings.securitySettings.passwordValue] The * password value. - * @member {object} [x12.sendAgreement.protocolSettings.processingSettings] + * @property {object} [x12.sendAgreement.protocolSettings.processingSettings] * The X12 processing settings. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.processingSettings.convertImpliedDecimal] * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [x12.sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} [x12.sendAgreement.protocolSettings.envelopeOverrides] The - * X12 envelope override settings. - * @member {array} [x12.sendAgreement.protocolSettings.validationOverrides] + * @property {array} [x12.sendAgreement.protocolSettings.envelopeOverrides] + * The X12 envelope override settings. + * @property {array} [x12.sendAgreement.protocolSettings.validationOverrides] * The X12 validation override settings. - * @member {array} [x12.sendAgreement.protocolSettings.messageFilterList] The - * X12 message filter list. - * @member {array} [x12.sendAgreement.protocolSettings.schemaReferences] The - * X12 schema references. - * @member {array} [x12.sendAgreement.protocolSettings.x12DelimiterOverrides] - * The X12 delimiter override settings. - * @member {object} [edifact] The EDIFACT agreement content. - * @member {object} [edifact.receiveAgreement] The EDIFACT one-way receive + * @property {array} [x12.sendAgreement.protocolSettings.messageFilterList] + * The X12 message filter list. + * @property {array} [x12.sendAgreement.protocolSettings.schemaReferences] + * The X12 schema references. + * @property {array} + * [x12.sendAgreement.protocolSettings.x12DelimiterOverrides] The X12 + * delimiter override settings. + * @property {object} [edifact] The EDIFACT agreement content. + * @property {object} [edifact.receiveAgreement] The EDIFACT one-way receive * agreement. - * @member {object} [edifact.receiveAgreement.senderBusinessIdentity] The + * @property {object} [edifact.receiveAgreement.senderBusinessIdentity] The * sender business identity - * @member {string} + * @property {string} * [edifact.receiveAgreement.senderBusinessIdentity.qualifier] The business * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [edifact.receiveAgreement.senderBusinessIdentity.value] + * @property {string} [edifact.receiveAgreement.senderBusinessIdentity.value] * The user defined business identity value. - * @member {object} [edifact.receiveAgreement.receiverBusinessIdentity] The + * @property {object} [edifact.receiveAgreement.receiverBusinessIdentity] The * receiver business identity - * @member {string} + * @property {string} * [edifact.receiveAgreement.receiverBusinessIdentity.qualifier] The business * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [edifact.receiveAgreement.receiverBusinessIdentity.value] - * The user defined business identity value. - * @member {object} [edifact.receiveAgreement.protocolSettings] The EDIFACT + * @property {string} + * [edifact.receiveAgreement.receiverBusinessIdentity.value] The user defined + * business identity value. + * @property {object} [edifact.receiveAgreement.protocolSettings] The EDIFACT * protocol settings. - * @member {object} + * @property {object} * [edifact.receiveAgreement.protocolSettings.validationSettings] The EDIFACT * validation settings. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} + * @property {object} * [edifact.receiveAgreement.protocolSettings.framingSettings] The EDIFACT * framing settings. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] * The service code list directory version. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.framingSettings.characterEncoding] * The character encoding. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.framingSettings.protocolVersion] * The protocol version. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.framingSettings.componentSeparator] * The component separator. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.framingSettings.segmentTerminator] * The segment terminator. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.framingSettings.releaseIndicator] * The release indicator. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.framingSettings.repetitionSeparator] * The repetition separator. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.framingSettings.characterSet] * The EDIFACT frame setting characterSet. Possible values include: * 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', * 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.framingSettings.decimalPointIndicator] * The EDIFACT frame setting decimal indicator. Possible values include: * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The EDIFACT frame setting segment terminator suffix. Possible values * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} + * @property {object} * [edifact.receiveAgreement.protocolSettings.envelopeSettings] The EDIFACT * envelope settings. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] * The group association assigned code. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.communicationAgreementId] * The communication agreement id. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] * The value indicating whether to apply delimiter string advice. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.createGroupingSegments] * The value indicating whether to create grouping segments. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] * The recipient reference password value. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] * The recipient reference password qualifier. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.applicationReferenceId] * The application reference id. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.processingPriorityCode] * The processing priority code. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] * The interchange control number prefix. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] * The interchange control number suffix. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] * The sender reverse routing address. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] * The receiver reverse routing address. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] * The functional group id. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] * The group controlling agency code. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupMessageVersion] * The group message version. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupMessageRelease] * The group message release. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] * The group control number prefix. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] * The group control number suffix. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] * The group application receiver qualifier. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] * The group application receiver id. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] * The group application sender qualifier. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] * The group application sender id. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] * The group application password. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.isTestInterchange] * The value indicating whether the message is a test interchange. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] * The sender internal identification. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] * The sender internal sub identification. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] * The receiver internal identification. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] * The receiver internal sub identification. - * @member {object} + * @property {object} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings] The * EDIFACT acknowledgement settings. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} [edifact.receiveAgreement.protocolSettings.messageFilter] - * The EDIFACT message filter. - * @member {string} + * @property {object} + * [edifact.receiveAgreement.protocolSettings.messageFilter] The EDIFACT + * message filter. + * @property {string} * [edifact.receiveAgreement.protocolSettings.messageFilter.messageFilterType] * The message filter type. Possible values include: 'NotSpecified', * 'Include', 'Exclude' - * @member {object} + * @property {object} * [edifact.receiveAgreement.protocolSettings.processingSettings] The EDIFACT * processing Settings. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [edifact.receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} + * @property {array} * [edifact.receiveAgreement.protocolSettings.envelopeOverrides] The EDIFACT * envelope override settings. - * @member {array} + * @property {array} * [edifact.receiveAgreement.protocolSettings.messageFilterList] The EDIFACT * message filter list. - * @member {array} + * @property {array} * [edifact.receiveAgreement.protocolSettings.schemaReferences] The EDIFACT * schema references. - * @member {array} + * @property {array} * [edifact.receiveAgreement.protocolSettings.validationOverrides] The * EDIFACT validation override settings. - * @member {array} + * @property {array} * [edifact.receiveAgreement.protocolSettings.edifactDelimiterOverrides] The * EDIFACT delimiter override settings. - * @member {object} [edifact.sendAgreement] The EDIFACT one-way send + * @property {object} [edifact.sendAgreement] The EDIFACT one-way send * agreement. - * @member {object} [edifact.sendAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [edifact.sendAgreement.senderBusinessIdentity.qualifier] - * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [edifact.sendAgreement.senderBusinessIdentity.value] The - * user defined business identity value. - * @member {object} [edifact.sendAgreement.receiverBusinessIdentity] The + * @property {object} [edifact.sendAgreement.senderBusinessIdentity] The + * sender business identity + * @property {string} + * [edifact.sendAgreement.senderBusinessIdentity.qualifier] The business + * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [edifact.sendAgreement.senderBusinessIdentity.value] + * The user defined business identity value. + * @property {object} [edifact.sendAgreement.receiverBusinessIdentity] The * receiver business identity - * @member {string} + * @property {string} * [edifact.sendAgreement.receiverBusinessIdentity.qualifier] The business * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [edifact.sendAgreement.receiverBusinessIdentity.value] + * @property {string} [edifact.sendAgreement.receiverBusinessIdentity.value] * The user defined business identity value. - * @member {object} [edifact.sendAgreement.protocolSettings] The EDIFACT + * @property {object} [edifact.sendAgreement.protocolSettings] The EDIFACT * protocol settings. - * @member {object} + * @property {object} * [edifact.sendAgreement.protocolSettings.validationSettings] The EDIFACT * validation settings. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [edifact.sendAgreement.protocolSettings.framingSettings] - * The EDIFACT framing settings. - * @member {string} + * @property {object} + * [edifact.sendAgreement.protocolSettings.framingSettings] The EDIFACT + * framing settings. + * @property {string} * [edifact.sendAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] * The service code list directory version. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.framingSettings.characterEncoding] * The character encoding. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.framingSettings.protocolVersion] * The protocol version. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.framingSettings.componentSeparator] * The component separator. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.framingSettings.segmentTerminator] * The segment terminator. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.framingSettings.releaseIndicator] * The release indicator. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.framingSettings.repetitionSeparator] * The repetition separator. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.framingSettings.characterSet] The * EDIFACT frame setting characterSet. Possible values include: * 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', * 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.framingSettings.decimalPointIndicator] * The EDIFACT frame setting decimal indicator. Possible values include: * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The EDIFACT frame setting segment terminator suffix. Possible values * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} [edifact.sendAgreement.protocolSettings.envelopeSettings] - * The EDIFACT envelope settings. - * @member {string} + * @property {object} + * [edifact.sendAgreement.protocolSettings.envelopeSettings] The EDIFACT + * envelope settings. + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] * The group association assigned code. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.communicationAgreementId] * The communication agreement id. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] * The value indicating whether to apply delimiter string advice. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.envelopeSettings.createGroupingSegments] * The value indicating whether to create grouping segments. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] * The recipient reference password value. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] * The recipient reference password qualifier. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.applicationReferenceId] * The application reference id. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.processingPriorityCode] * The processing priority code. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] * The interchange control number prefix. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] * The interchange control number suffix. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] * The sender reverse routing address. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] * The receiver reverse routing address. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] * The functional group id. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] * The group controlling agency code. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupMessageVersion] * The group message version. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupMessageRelease] * The group message release. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] * The group control number prefix. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] * The group control number suffix. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] * The group application receiver qualifier. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] * The group application receiver id. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] * The group application sender qualifier. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] * The group application sender id. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] * The group application password. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.envelopeSettings.isTestInterchange] * The value indicating whether the message is a test interchange. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] * The sender internal identification. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] * The sender internal sub identification. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] * The receiver internal identification. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] * The receiver internal sub identification. - * @member {object} + * @property {object} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings] The * EDIFACT acknowledgement settings. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} [edifact.sendAgreement.protocolSettings.messageFilter] + * @property {object} [edifact.sendAgreement.protocolSettings.messageFilter] * The EDIFACT message filter. - * @member {string} + * @property {string} * [edifact.sendAgreement.protocolSettings.messageFilter.messageFilterType] * The message filter type. Possible values include: 'NotSpecified', * 'Include', 'Exclude' - * @member {object} + * @property {object} * [edifact.sendAgreement.protocolSettings.processingSettings] The EDIFACT * processing Settings. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [edifact.sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} [edifact.sendAgreement.protocolSettings.envelopeOverrides] - * The EDIFACT envelope override settings. - * @member {array} [edifact.sendAgreement.protocolSettings.messageFilterList] - * The EDIFACT message filter list. - * @member {array} [edifact.sendAgreement.protocolSettings.schemaReferences] - * The EDIFACT schema references. - * @member {array} + * @property {array} + * [edifact.sendAgreement.protocolSettings.envelopeOverrides] The EDIFACT + * envelope override settings. + * @property {array} + * [edifact.sendAgreement.protocolSettings.messageFilterList] The EDIFACT + * message filter list. + * @property {array} + * [edifact.sendAgreement.protocolSettings.schemaReferences] The EDIFACT + * schema references. + * @property {array} * [edifact.sendAgreement.protocolSettings.validationOverrides] The EDIFACT * validation override settings. - * @member {array} + * @property {array} * [edifact.sendAgreement.protocolSettings.edifactDelimiterOverrides] The * EDIFACT delimiter override settings. */ diff --git a/lib/services/logicManagement/lib/models/artifactContentPropertiesDefinition.js b/lib/services/logicManagement/lib/models/artifactContentPropertiesDefinition.js index fdbf96fb93..daddb9f7ed 100644 --- a/lib/services/logicManagement/lib/models/artifactContentPropertiesDefinition.js +++ b/lib/services/logicManagement/lib/models/artifactContentPropertiesDefinition.js @@ -20,18 +20,18 @@ const models = require('./index'); class ArtifactContentPropertiesDefinition extends models['ArtifactProperties'] { /** * Create a ArtifactContentPropertiesDefinition. - * @member {object} [content] - * @member {string} [contentType] The content type. - * @member {object} [contentLink] The content link. - * @member {string} [contentLink.uri] The content link URI. - * @member {string} [contentLink.contentVersion] The content version. - * @member {number} [contentLink.contentSize] The content size. - * @member {object} [contentLink.contentHash] The content hash. - * @member {string} [contentLink.contentHash.algorithm] The algorithm of the + * @property {object} [content] + * @property {string} [contentType] The content type. + * @property {object} [contentLink] The content link. + * @property {string} [contentLink.uri] The content link URI. + * @property {string} [contentLink.contentVersion] The content version. + * @property {number} [contentLink.contentSize] The content size. + * @property {object} [contentLink.contentHash] The content hash. + * @property {string} [contentLink.contentHash.algorithm] The algorithm of + * the content hash. + * @property {string} [contentLink.contentHash.value] The value of the * content hash. - * @member {string} [contentLink.contentHash.value] The value of the content - * hash. - * @member {object} [contentLink.metadata] The metadata. + * @property {object} [contentLink.metadata] The metadata. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/artifactProperties.js b/lib/services/logicManagement/lib/models/artifactProperties.js index 9470a5c55d..ff7afeea72 100644 --- a/lib/services/logicManagement/lib/models/artifactProperties.js +++ b/lib/services/logicManagement/lib/models/artifactProperties.js @@ -17,9 +17,9 @@ class ArtifactProperties { /** * Create a ArtifactProperties. - * @member {date} [createdTime] The artifact creation time. - * @member {date} [changedTime] The artifact changed time. - * @member {object} [metadata] + * @property {date} [createdTime] The artifact creation time. + * @property {date} [changedTime] The artifact changed time. + * @property {object} [metadata] */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/assemblyDefinition.js b/lib/services/logicManagement/lib/models/assemblyDefinition.js index 28774b9f64..60f3227903 100644 --- a/lib/services/logicManagement/lib/models/assemblyDefinition.js +++ b/lib/services/logicManagement/lib/models/assemblyDefinition.js @@ -20,11 +20,11 @@ const models = require('./index'); class AssemblyDefinition extends models['Resource'] { /** * Create a AssemblyDefinition. - * @member {object} properties The assembly properties. - * @member {string} [properties.assemblyName] The assembly name. - * @member {string} [properties.assemblyVersion] The assembly version. - * @member {string} [properties.assemblyCulture] The assembly culture. - * @member {string} [properties.assemblyPublicKeyToken] The assembly public + * @property {object} properties The assembly properties. + * @property {string} [properties.assemblyName] The assembly name. + * @property {string} [properties.assemblyVersion] The assembly version. + * @property {string} [properties.assemblyCulture] The assembly culture. + * @property {string} [properties.assemblyPublicKeyToken] The assembly public * key token. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/assemblyProperties.js b/lib/services/logicManagement/lib/models/assemblyProperties.js index 96a0c07445..8fda4f7ea9 100644 --- a/lib/services/logicManagement/lib/models/assemblyProperties.js +++ b/lib/services/logicManagement/lib/models/assemblyProperties.js @@ -20,10 +20,10 @@ const models = require('./index'); class AssemblyProperties extends models['ArtifactContentPropertiesDefinition'] { /** * Create a AssemblyProperties. - * @member {string} assemblyName The assembly name. - * @member {string} [assemblyVersion] The assembly version. - * @member {string} [assemblyCulture] The assembly culture. - * @member {string} [assemblyPublicKeyToken] The assembly public key token. + * @property {string} assemblyName The assembly name. + * @property {string} [assemblyVersion] The assembly version. + * @property {string} [assemblyCulture] The assembly culture. + * @property {string} [assemblyPublicKeyToken] The assembly public key token. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/azureResourceErrorInfo.js b/lib/services/logicManagement/lib/models/azureResourceErrorInfo.js index eec422d28f..6e22b508ad 100644 --- a/lib/services/logicManagement/lib/models/azureResourceErrorInfo.js +++ b/lib/services/logicManagement/lib/models/azureResourceErrorInfo.js @@ -20,8 +20,8 @@ const models = require('./index'); class AzureResourceErrorInfo extends models['ErrorInfo'] { /** * Create a AzureResourceErrorInfo. - * @member {string} message The error message. - * @member {array} [details] The error details. + * @property {string} message The error message. + * @property {array} [details] The error details. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/b2BPartnerContent.js b/lib/services/logicManagement/lib/models/b2BPartnerContent.js index 96712a3a03..719e6a9814 100644 --- a/lib/services/logicManagement/lib/models/b2BPartnerContent.js +++ b/lib/services/logicManagement/lib/models/b2BPartnerContent.js @@ -17,7 +17,7 @@ class B2BPartnerContent { /** * Create a B2BPartnerContent. - * @member {array} [businessIdentities] The list of partner business + * @property {array} [businessIdentities] The list of partner business * identities. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/batchConfiguration.js b/lib/services/logicManagement/lib/models/batchConfiguration.js index 94496ca543..4af868571a 100644 --- a/lib/services/logicManagement/lib/models/batchConfiguration.js +++ b/lib/services/logicManagement/lib/models/batchConfiguration.js @@ -20,36 +20,39 @@ const models = require('./index'); class BatchConfiguration extends models['Resource'] { /** * Create a BatchConfiguration. - * @member {object} properties The batch configuration properties. - * @member {string} [properties.batchGroupName] The name of the batch group. - * @member {object} [properties.releaseCriteria] The batch release criteria. - * @member {number} [properties.releaseCriteria.messageCount] The message + * @property {object} properties The batch configuration properties. + * @property {string} [properties.batchGroupName] The name of the batch + * group. + * @property {object} [properties.releaseCriteria] The batch release + * criteria. + * @property {number} [properties.releaseCriteria.messageCount] The message * count. - * @member {number} [properties.releaseCriteria.batchSize] The batch size in - * bytes. - * @member {object} [properties.releaseCriteria.recurrence] The recurrence. - * @member {string} [properties.releaseCriteria.recurrence.frequency] The + * @property {number} [properties.releaseCriteria.batchSize] The batch size + * in bytes. + * @property {object} [properties.releaseCriteria.recurrence] The recurrence. + * @property {string} [properties.releaseCriteria.recurrence.frequency] The * frequency. Possible values include: 'NotSpecified', 'Second', 'Minute', * 'Hour', 'Day', 'Week', 'Month', 'Year' - * @member {number} [properties.releaseCriteria.recurrence.interval] The + * @property {number} [properties.releaseCriteria.recurrence.interval] The * interval. - * @member {string} [properties.releaseCriteria.recurrence.startTime] The + * @property {string} [properties.releaseCriteria.recurrence.startTime] The * start time. - * @member {string} [properties.releaseCriteria.recurrence.endTime] The end + * @property {string} [properties.releaseCriteria.recurrence.endTime] The end * time. - * @member {string} [properties.releaseCriteria.recurrence.timeZone] The time - * zone. - * @member {object} [properties.releaseCriteria.recurrence.schedule] The + * @property {string} [properties.releaseCriteria.recurrence.timeZone] The + * time zone. + * @property {object} [properties.releaseCriteria.recurrence.schedule] The * recurrence schedule. - * @member {array} [properties.releaseCriteria.recurrence.schedule.minutes] + * @property {array} [properties.releaseCriteria.recurrence.schedule.minutes] * The minutes. - * @member {array} [properties.releaseCriteria.recurrence.schedule.hours] The - * hours. - * @member {array} [properties.releaseCriteria.recurrence.schedule.weekDays] - * The days of the week. - * @member {array} [properties.releaseCriteria.recurrence.schedule.monthDays] - * The month days. - * @member {array} + * @property {array} [properties.releaseCriteria.recurrence.schedule.hours] + * The hours. + * @property {array} + * [properties.releaseCriteria.recurrence.schedule.weekDays] The days of the + * week. + * @property {array} + * [properties.releaseCriteria.recurrence.schedule.monthDays] The month days. + * @property {array} * [properties.releaseCriteria.recurrence.schedule.monthlyOccurrences] The * monthly occurrences. */ diff --git a/lib/services/logicManagement/lib/models/batchConfigurationProperties.js b/lib/services/logicManagement/lib/models/batchConfigurationProperties.js index 293bf38ca1..de474fd5a4 100644 --- a/lib/services/logicManagement/lib/models/batchConfigurationProperties.js +++ b/lib/services/logicManagement/lib/models/batchConfigurationProperties.js @@ -20,27 +20,28 @@ const models = require('./index'); class BatchConfigurationProperties extends models['ArtifactProperties'] { /** * Create a BatchConfigurationProperties. - * @member {string} batchGroupName The name of the batch group. - * @member {object} releaseCriteria The batch release criteria. - * @member {number} [releaseCriteria.messageCount] The message count. - * @member {number} [releaseCriteria.batchSize] The batch size in bytes. - * @member {object} [releaseCriteria.recurrence] The recurrence. - * @member {string} [releaseCriteria.recurrence.frequency] The frequency. + * @property {string} batchGroupName The name of the batch group. + * @property {object} releaseCriteria The batch release criteria. + * @property {number} [releaseCriteria.messageCount] The message count. + * @property {number} [releaseCriteria.batchSize] The batch size in bytes. + * @property {object} [releaseCriteria.recurrence] The recurrence. + * @property {string} [releaseCriteria.recurrence.frequency] The frequency. * Possible values include: 'NotSpecified', 'Second', 'Minute', 'Hour', * 'Day', 'Week', 'Month', 'Year' - * @member {number} [releaseCriteria.recurrence.interval] The interval. - * @member {string} [releaseCriteria.recurrence.startTime] The start time. - * @member {string} [releaseCriteria.recurrence.endTime] The end time. - * @member {string} [releaseCriteria.recurrence.timeZone] The time zone. - * @member {object} [releaseCriteria.recurrence.schedule] The recurrence + * @property {number} [releaseCriteria.recurrence.interval] The interval. + * @property {string} [releaseCriteria.recurrence.startTime] The start time. + * @property {string} [releaseCriteria.recurrence.endTime] The end time. + * @property {string} [releaseCriteria.recurrence.timeZone] The time zone. + * @property {object} [releaseCriteria.recurrence.schedule] The recurrence * schedule. - * @member {array} [releaseCriteria.recurrence.schedule.minutes] The minutes. - * @member {array} [releaseCriteria.recurrence.schedule.hours] The hours. - * @member {array} [releaseCriteria.recurrence.schedule.weekDays] The days of - * the week. - * @member {array} [releaseCriteria.recurrence.schedule.monthDays] The month - * days. - * @member {array} [releaseCriteria.recurrence.schedule.monthlyOccurrences] + * @property {array} [releaseCriteria.recurrence.schedule.minutes] The + * minutes. + * @property {array} [releaseCriteria.recurrence.schedule.hours] The hours. + * @property {array} [releaseCriteria.recurrence.schedule.weekDays] The days + * of the week. + * @property {array} [releaseCriteria.recurrence.schedule.monthDays] The + * month days. + * @property {array} [releaseCriteria.recurrence.schedule.monthlyOccurrences] * The monthly occurrences. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/batchReleaseCriteria.js b/lib/services/logicManagement/lib/models/batchReleaseCriteria.js index d6a56c1b02..baace77008 100644 --- a/lib/services/logicManagement/lib/models/batchReleaseCriteria.js +++ b/lib/services/logicManagement/lib/models/batchReleaseCriteria.js @@ -17,22 +17,22 @@ class BatchReleaseCriteria { /** * Create a BatchReleaseCriteria. - * @member {number} [messageCount] The message count. - * @member {number} [batchSize] The batch size in bytes. - * @member {object} [recurrence] The recurrence. - * @member {string} [recurrence.frequency] The frequency. Possible values + * @property {number} [messageCount] The message count. + * @property {number} [batchSize] The batch size in bytes. + * @property {object} [recurrence] The recurrence. + * @property {string} [recurrence.frequency] The frequency. Possible values * include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', * 'Month', 'Year' - * @member {number} [recurrence.interval] The interval. - * @member {string} [recurrence.startTime] The start time. - * @member {string} [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 {string} [recurrence.startTime] The start time. + * @property {string} [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/logicManagement/lib/models/businessIdentity.js b/lib/services/logicManagement/lib/models/businessIdentity.js index 71bb71a661..225a1aed0f 100644 --- a/lib/services/logicManagement/lib/models/businessIdentity.js +++ b/lib/services/logicManagement/lib/models/businessIdentity.js @@ -17,9 +17,9 @@ class BusinessIdentity { /** * Create a BusinessIdentity. - * @member {string} qualifier The business identity qualifier e.g. + * @property {string} qualifier The business identity qualifier e.g. * as2identity, ZZ, ZZZ, 31, 32 - * @member {string} value The user defined business identity value. + * @property {string} value The user defined business identity value. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/callbackUrl.js b/lib/services/logicManagement/lib/models/callbackUrl.js index 110e59caa5..59985815d3 100644 --- a/lib/services/logicManagement/lib/models/callbackUrl.js +++ b/lib/services/logicManagement/lib/models/callbackUrl.js @@ -17,7 +17,7 @@ class CallbackUrl { /** * Create a CallbackUrl. - * @member {string} [value] The URL value. + * @property {string} [value] The URL value. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/contentHash.js b/lib/services/logicManagement/lib/models/contentHash.js index 128f3038b0..b5d25a36a5 100644 --- a/lib/services/logicManagement/lib/models/contentHash.js +++ b/lib/services/logicManagement/lib/models/contentHash.js @@ -17,8 +17,8 @@ class ContentHash { /** * Create a ContentHash. - * @member {string} [algorithm] The algorithm of the content hash. - * @member {string} [value] The value of the content hash. + * @property {string} [algorithm] The algorithm of the content hash. + * @property {string} [value] The value of the content hash. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/contentLink.js b/lib/services/logicManagement/lib/models/contentLink.js index 2e2b5246a3..f39ea43a37 100644 --- a/lib/services/logicManagement/lib/models/contentLink.js +++ b/lib/services/logicManagement/lib/models/contentLink.js @@ -17,14 +17,14 @@ class ContentLink { /** * Create a ContentLink. - * @member {string} [uri] The content link URI. - * @member {string} [contentVersion] The content version. - * @member {number} [contentSize] The content size. - * @member {object} [contentHash] The content hash. - * @member {string} [contentHash.algorithm] The algorithm of the content + * @property {string} [uri] The content link URI. + * @property {string} [contentVersion] The content version. + * @property {number} [contentSize] The content size. + * @property {object} [contentHash] The content hash. + * @property {string} [contentHash.algorithm] The algorithm of the content * hash. - * @member {string} [contentHash.value] The value of the content hash. - * @member {object} [metadata] The metadata. + * @property {string} [contentHash.value] The value of the content hash. + * @property {object} [metadata] The metadata. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/correlation.js b/lib/services/logicManagement/lib/models/correlation.js index f4f788b804..e118dbf798 100644 --- a/lib/services/logicManagement/lib/models/correlation.js +++ b/lib/services/logicManagement/lib/models/correlation.js @@ -17,7 +17,7 @@ class Correlation { /** * Create a Correlation. - * @member {string} [clientTrackingId] The client tracking id. + * @property {string} [clientTrackingId] The client tracking id. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/edifactAcknowledgementSettings.js b/lib/services/logicManagement/lib/models/edifactAcknowledgementSettings.js index 904f9906b8..9d8c29144c 100644 --- a/lib/services/logicManagement/lib/models/edifactAcknowledgementSettings.js +++ b/lib/services/logicManagement/lib/models/edifactAcknowledgementSettings.js @@ -17,27 +17,27 @@ class EdifactAcknowledgementSettings { /** * Create a EdifactAcknowledgementSettings. - * @member {boolean} needTechnicalAcknowledgement The value indicating + * @property {boolean} needTechnicalAcknowledgement The value indicating * whether technical acknowledgement is needed. - * @member {boolean} batchTechnicalAcknowledgements The value indicating + * @property {boolean} batchTechnicalAcknowledgements The value indicating * whether to batch the technical acknowledgements. - * @member {boolean} needFunctionalAcknowledgement The value indicating + * @property {boolean} needFunctionalAcknowledgement The value indicating * whether functional acknowledgement is needed. - * @member {boolean} batchFunctionalAcknowledgements The value indicating + * @property {boolean} batchFunctionalAcknowledgements The value indicating * whether to batch functional acknowledgements. - * @member {boolean} needLoopForValidMessages The value indicating whether a - * loop is needed for valid messages. - * @member {boolean} sendSynchronousAcknowledgement The value indicating + * @property {boolean} needLoopForValidMessages The value indicating whether + * a loop is needed for valid messages. + * @property {boolean} sendSynchronousAcknowledgement The value indicating * whether to send synchronous acknowledgement. - * @member {string} [acknowledgementControlNumberPrefix] The acknowledgement - * control number prefix. - * @member {string} [acknowledgementControlNumberSuffix] The acknowledgement - * control number suffix. - * @member {number} acknowledgementControlNumberLowerBound The + * @property {string} [acknowledgementControlNumberPrefix] The + * acknowledgement control number prefix. + * @property {string} [acknowledgementControlNumberSuffix] The + * acknowledgement control number suffix. + * @property {number} acknowledgementControlNumberLowerBound The * acknowledgement control number lower bound. - * @member {number} acknowledgementControlNumberUpperBound The + * @property {number} acknowledgementControlNumberUpperBound The * acknowledgement control number upper bound. - * @member {boolean} rolloverAcknowledgementControlNumber The value + * @property {boolean} rolloverAcknowledgementControlNumber The value * indicating whether to rollover acknowledgement control number. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/edifactAgreementContent.js b/lib/services/logicManagement/lib/models/edifactAgreementContent.js index d5bf566457..1d2377db06 100644 --- a/lib/services/logicManagement/lib/models/edifactAgreementContent.js +++ b/lib/services/logicManagement/lib/models/edifactAgreementContent.js @@ -17,580 +17,582 @@ class EdifactAgreementContent { /** * Create a EdifactAgreementContent. - * @member {object} receiveAgreement The EDIFACT one-way receive agreement. - * @member {object} [receiveAgreement.senderBusinessIdentity] The sender + * @property {object} receiveAgreement The EDIFACT one-way receive agreement. + * @property {object} [receiveAgreement.senderBusinessIdentity] The sender * business identity - * @member {string} [receiveAgreement.senderBusinessIdentity.qualifier] The + * @property {string} [receiveAgreement.senderBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [receiveAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [receiveAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.receiverBusinessIdentity.value] The + * @property {string} [receiveAgreement.senderBusinessIdentity.value] The * user defined business identity value. - * @member {object} [receiveAgreement.protocolSettings] The EDIFACT protocol - * settings. - * @member {object} [receiveAgreement.protocolSettings.validationSettings] + * @property {object} [receiveAgreement.receiverBusinessIdentity] The + * receiver business identity + * @property {string} [receiveAgreement.receiverBusinessIdentity.qualifier] + * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [receiveAgreement.receiverBusinessIdentity.value] The + * user defined business identity value. + * @property {object} [receiveAgreement.protocolSettings] The EDIFACT + * protocol settings. + * @property {object} [receiveAgreement.protocolSettings.validationSettings] * The EDIFACT validation settings. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [receiveAgreement.protocolSettings.framingSettings] The + * @property {object} [receiveAgreement.protocolSettings.framingSettings] The * EDIFACT framing settings. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] * The service code list directory version. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.framingSettings.characterEncoding] The * character encoding. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.framingSettings.protocolVersion] The * protocol version. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.framingSettings.componentSeparator] The * component separator. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.framingSettings.segmentTerminator] The * segment terminator. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.framingSettings.releaseIndicator] The * release indicator. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.framingSettings.repetitionSeparator] * The repetition separator. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.framingSettings.characterSet] The * EDIFACT frame setting characterSet. Possible values include: * 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', * 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.framingSettings.decimalPointIndicator] * The EDIFACT frame setting decimal indicator. Possible values include: * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The EDIFACT frame setting segment terminator suffix. Possible values * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} [receiveAgreement.protocolSettings.envelopeSettings] The - * EDIFACT envelope settings. - * @member {string} + * @property {object} [receiveAgreement.protocolSettings.envelopeSettings] + * The EDIFACT envelope settings. + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] * The group association assigned code. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.communicationAgreementId] * The communication agreement id. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] * The value indicating whether to apply delimiter string advice. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.createGroupingSegments] * The value indicating whether to create grouping segments. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] * The recipient reference password value. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] * The recipient reference password qualifier. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.applicationReferenceId] * The application reference id. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.processingPriorityCode] * The processing priority code. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] * The interchange control number prefix. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] * The interchange control number suffix. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] * The sender reverse routing address. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] * The receiver reverse routing address. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] The * functional group id. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] * The group controlling agency code. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupMessageVersion] * The group message version. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupMessageRelease] * The group message release. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] * The group control number prefix. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] * The group control number suffix. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] * The group application receiver qualifier. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] * The group application receiver id. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] * The group application sender qualifier. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] * The group application sender id. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] * The group application password. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.isTestInterchange] The * value indicating whether the message is a test interchange. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] * The sender internal identification. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] * The sender internal sub identification. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] * The receiver internal identification. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] * The receiver internal sub identification. - * @member {object} + * @property {object} * [receiveAgreement.protocolSettings.acknowledgementSettings] The EDIFACT * acknowledgement settings. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} [receiveAgreement.protocolSettings.messageFilter] The + * @property {object} [receiveAgreement.protocolSettings.messageFilter] The * EDIFACT message filter. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.messageFilter.messageFilterType] The * message filter type. Possible values include: 'NotSpecified', 'Include', * 'Exclude' - * @member {object} [receiveAgreement.protocolSettings.processingSettings] + * @property {object} [receiveAgreement.protocolSettings.processingSettings] * The EDIFACT processing Settings. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} [receiveAgreement.protocolSettings.envelopeOverrides] The - * EDIFACT envelope override settings. - * @member {array} [receiveAgreement.protocolSettings.messageFilterList] The - * EDIFACT message filter list. - * @member {array} [receiveAgreement.protocolSettings.schemaReferences] The + * @property {array} [receiveAgreement.protocolSettings.envelopeOverrides] + * The EDIFACT envelope override settings. + * @property {array} [receiveAgreement.protocolSettings.messageFilterList] + * The EDIFACT message filter list. + * @property {array} [receiveAgreement.protocolSettings.schemaReferences] The * EDIFACT schema references. - * @member {array} [receiveAgreement.protocolSettings.validationOverrides] + * @property {array} [receiveAgreement.protocolSettings.validationOverrides] * The EDIFACT validation override settings. - * @member {array} + * @property {array} * [receiveAgreement.protocolSettings.edifactDelimiterOverrides] The EDIFACT * delimiter override settings. - * @member {object} sendAgreement The EDIFACT one-way send agreement. - * @member {object} [sendAgreement.senderBusinessIdentity] The sender + * @property {object} sendAgreement The EDIFACT one-way send agreement. + * @property {object} [sendAgreement.senderBusinessIdentity] The sender * business identity - * @member {string} [sendAgreement.senderBusinessIdentity.qualifier] The + * @property {string} [sendAgreement.senderBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.senderBusinessIdentity.value] The user + * @property {string} [sendAgreement.senderBusinessIdentity.value] The user * defined business identity value. - * @member {object} [sendAgreement.receiverBusinessIdentity] The receiver + * @property {object} [sendAgreement.receiverBusinessIdentity] The receiver * business identity - * @member {string} [sendAgreement.receiverBusinessIdentity.qualifier] The + * @property {string} [sendAgreement.receiverBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.receiverBusinessIdentity.value] The user + * @property {string} [sendAgreement.receiverBusinessIdentity.value] The user * defined business identity value. - * @member {object} [sendAgreement.protocolSettings] The EDIFACT protocol + * @property {object} [sendAgreement.protocolSettings] The EDIFACT protocol * settings. - * @member {object} [sendAgreement.protocolSettings.validationSettings] The + * @property {object} [sendAgreement.protocolSettings.validationSettings] The * EDIFACT validation settings. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.validateEdiTypes] The * value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.validateXsdTypes] The * value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [sendAgreement.protocolSettings.framingSettings] The + * @property {object} [sendAgreement.protocolSettings.framingSettings] The * EDIFACT framing settings. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] * The service code list directory version. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.framingSettings.characterEncoding] The * character encoding. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.framingSettings.protocolVersion] The * protocol version. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.framingSettings.dataElementSeparator] The * data element separator. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.framingSettings.componentSeparator] The * component separator. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.framingSettings.segmentTerminator] The * segment terminator. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.framingSettings.releaseIndicator] The * release indicator. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.framingSettings.repetitionSeparator] The * repetition separator. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.framingSettings.characterSet] The EDIFACT * frame setting characterSet. Possible values include: 'NotSpecified', * 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', * 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.framingSettings.decimalPointIndicator] The * EDIFACT frame setting decimal indicator. Possible values include: * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The EDIFACT frame setting segment terminator suffix. Possible values * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} [sendAgreement.protocolSettings.envelopeSettings] The + * @property {object} [sendAgreement.protocolSettings.envelopeSettings] The * EDIFACT envelope settings. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] * The group association assigned code. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.communicationAgreementId] * The communication agreement id. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] * The value indicating whether to apply delimiter string advice. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.createGroupingSegments] * The value indicating whether to create grouping segments. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] * The recipient reference password value. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] * The recipient reference password qualifier. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.applicationReferenceId] * The application reference id. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.processingPriorityCode] * The processing priority code. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] * The interchange control number prefix. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] * The interchange control number suffix. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] * The sender reverse routing address. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] * The receiver reverse routing address. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] The * functional group id. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] * The group controlling agency code. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupMessageVersion] The * group message version. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupMessageRelease] The * group message release. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] * The group control number prefix. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] * The group control number suffix. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] * The group application receiver qualifier. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] * The group application receiver id. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] * The group application sender qualifier. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] * The group application sender id. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] * The group application password. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.isTestInterchange] The * value indicating whether the message is a test interchange. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] * The sender internal identification. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] * The sender internal sub identification. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] * The receiver internal identification. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] * The receiver internal sub identification. - * @member {object} [sendAgreement.protocolSettings.acknowledgementSettings] - * The EDIFACT acknowledgement settings. - * @member {boolean} + * @property {object} + * [sendAgreement.protocolSettings.acknowledgementSettings] The EDIFACT + * acknowledgement settings. + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} [sendAgreement.protocolSettings.messageFilter] The + * @property {object} [sendAgreement.protocolSettings.messageFilter] The * EDIFACT message filter. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.messageFilter.messageFilterType] The * message filter type. Possible values include: 'NotSpecified', 'Include', * 'Exclude' - * @member {object} [sendAgreement.protocolSettings.processingSettings] The + * @property {object} [sendAgreement.protocolSettings.processingSettings] The * EDIFACT processing Settings. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] The * value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} [sendAgreement.protocolSettings.envelopeOverrides] The + * @property {array} [sendAgreement.protocolSettings.envelopeOverrides] The * EDIFACT envelope override settings. - * @member {array} [sendAgreement.protocolSettings.messageFilterList] The + * @property {array} [sendAgreement.protocolSettings.messageFilterList] The * EDIFACT message filter list. - * @member {array} [sendAgreement.protocolSettings.schemaReferences] The + * @property {array} [sendAgreement.protocolSettings.schemaReferences] The * EDIFACT schema references. - * @member {array} [sendAgreement.protocolSettings.validationOverrides] The + * @property {array} [sendAgreement.protocolSettings.validationOverrides] The * EDIFACT validation override settings. - * @member {array} [sendAgreement.protocolSettings.edifactDelimiterOverrides] - * The EDIFACT delimiter override settings. + * @property {array} + * [sendAgreement.protocolSettings.edifactDelimiterOverrides] The EDIFACT + * delimiter override settings. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/edifactDelimiterOverride.js b/lib/services/logicManagement/lib/models/edifactDelimiterOverride.js index 964455ae94..4d8405efa5 100644 --- a/lib/services/logicManagement/lib/models/edifactDelimiterOverride.js +++ b/lib/services/logicManagement/lib/models/edifactDelimiterOverride.js @@ -17,21 +17,21 @@ class EdifactDelimiterOverride { /** * Create a EdifactDelimiterOverride. - * @member {string} [messageId] The message id. - * @member {string} [messageVersion] The message version. - * @member {string} [messageRelease] The message release. - * @member {number} dataElementSeparator The data element separator. - * @member {number} componentSeparator The component separator. - * @member {number} segmentTerminator The segment terminator. - * @member {number} repetitionSeparator The repetition separator. - * @member {string} segmentTerminatorSuffix The segment terminator suffix. + * @property {string} [messageId] The message id. + * @property {string} [messageVersion] The message version. + * @property {string} [messageRelease] The message release. + * @property {number} dataElementSeparator The data element separator. + * @property {number} componentSeparator The component separator. + * @property {number} segmentTerminator The segment terminator. + * @property {number} repetitionSeparator The repetition separator. + * @property {string} segmentTerminatorSuffix The segment terminator suffix. * Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {string} decimalPointIndicator The decimal point indicator. + * @property {string} decimalPointIndicator The decimal point indicator. * Possible values include: 'NotSpecified', 'Comma', 'Decimal' - * @member {number} releaseIndicator The release indicator. - * @member {string} [messageAssociationAssignedCode] The message association - * assigned code. - * @member {string} [targetNamespace] The target namespace on which this + * @property {number} releaseIndicator The release indicator. + * @property {string} [messageAssociationAssignedCode] The message + * association assigned code. + * @property {string} [targetNamespace] The target namespace on which this * delimiter settings has to be applied. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/edifactEnvelopeOverride.js b/lib/services/logicManagement/lib/models/edifactEnvelopeOverride.js index 008890156f..69113c6402 100644 --- a/lib/services/logicManagement/lib/models/edifactEnvelopeOverride.js +++ b/lib/services/logicManagement/lib/models/edifactEnvelopeOverride.js @@ -17,30 +17,31 @@ class EdifactEnvelopeOverride { /** * Create a EdifactEnvelopeOverride. - * @member {string} [messageId] The message id on which this envelope + * @property {string} [messageId] The message id on which this envelope * settings has to be applied. - * @member {string} [messageVersion] The message version on which this + * @property {string} [messageVersion] The message version on which this * envelope settings has to be applied. - * @member {string} [messageRelease] The message release version on which + * @property {string} [messageRelease] The message release version on which * this envelope settings has to be applied. - * @member {string} [messageAssociationAssignedCode] The message association - * assigned code. - * @member {string} [targetNamespace] The target namespace on which this + * @property {string} [messageAssociationAssignedCode] The message + * association assigned code. + * @property {string} [targetNamespace] The target namespace on which this * envelope settings has to be applied. - * @member {string} [functionalGroupId] The functional group id. - * @member {string} [senderApplicationQualifier] The sender application + * @property {string} [functionalGroupId] The functional group id. + * @property {string} [senderApplicationQualifier] The sender application * qualifier. - * @member {string} [senderApplicationId] The sender application id. - * @member {string} [receiverApplicationQualifier] The receiver application + * @property {string} [senderApplicationId] The sender application id. + * @property {string} [receiverApplicationQualifier] The receiver application * qualifier. - * @member {string} [receiverApplicationId] The receiver application id. - * @member {string} [controllingAgencyCode] The controlling agency code. - * @member {string} [groupHeaderMessageVersion] The group header message + * @property {string} [receiverApplicationId] The receiver application id. + * @property {string} [controllingAgencyCode] The controlling agency code. + * @property {string} [groupHeaderMessageVersion] The group header message * version. - * @member {string} [groupHeaderMessageRelease] The group header message + * @property {string} [groupHeaderMessageRelease] The group header message * release. - * @member {string} [associationAssignedCode] The association assigned code. - * @member {string} [applicationPassword] The application password. + * @property {string} [associationAssignedCode] The association assigned + * code. + * @property {string} [applicationPassword] The application password. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/edifactEnvelopeSettings.js b/lib/services/logicManagement/lib/models/edifactEnvelopeSettings.js index 5c2a90dea7..b3bfe2e500 100644 --- a/lib/services/logicManagement/lib/models/edifactEnvelopeSettings.js +++ b/lib/services/logicManagement/lib/models/edifactEnvelopeSettings.js @@ -17,83 +17,83 @@ class EdifactEnvelopeSettings { /** * Create a EdifactEnvelopeSettings. - * @member {string} [groupAssociationAssignedCode] The group association + * @property {string} [groupAssociationAssignedCode] The group association * assigned code. - * @member {string} [communicationAgreementId] The communication agreement + * @property {string} [communicationAgreementId] The communication agreement * id. - * @member {boolean} applyDelimiterStringAdvice The value indicating whether - * to apply delimiter string advice. - * @member {boolean} createGroupingSegments The value indicating whether to + * @property {boolean} applyDelimiterStringAdvice The value indicating + * whether to apply delimiter string advice. + * @property {boolean} createGroupingSegments The value indicating whether to * create grouping segments. - * @member {boolean} enableDefaultGroupHeaders The value indicating whether + * @property {boolean} enableDefaultGroupHeaders The value indicating whether * to enable default group headers. - * @member {string} [recipientReferencePasswordValue] The recipient reference - * password value. - * @member {string} [recipientReferencePasswordQualifier] The recipient + * @property {string} [recipientReferencePasswordValue] The recipient + * reference password value. + * @property {string} [recipientReferencePasswordQualifier] The recipient * reference password qualifier. - * @member {string} [applicationReferenceId] The application reference id. - * @member {string} [processingPriorityCode] The processing priority code. - * @member {number} interchangeControlNumberLowerBound The interchange + * @property {string} [applicationReferenceId] The application reference id. + * @property {string} [processingPriorityCode] The processing priority code. + * @property {number} interchangeControlNumberLowerBound The interchange * control number lower bound. - * @member {number} interchangeControlNumberUpperBound The interchange + * @property {number} interchangeControlNumberUpperBound The interchange * control number upper bound. - * @member {boolean} rolloverInterchangeControlNumber The value indicating + * @property {boolean} rolloverInterchangeControlNumber The value indicating * whether to rollover interchange control number. - * @member {string} [interchangeControlNumberPrefix] The interchange control - * number prefix. - * @member {string} [interchangeControlNumberSuffix] The interchange control - * number suffix. - * @member {string} [senderReverseRoutingAddress] The sender reverse routing - * address. - * @member {string} [receiverReverseRoutingAddress] The receiver reverse + * @property {string} [interchangeControlNumberPrefix] The interchange + * control number prefix. + * @property {string} [interchangeControlNumberSuffix] The interchange + * control number suffix. + * @property {string} [senderReverseRoutingAddress] The sender reverse * routing address. - * @member {string} [functionalGroupId] The functional group id. - * @member {string} [groupControllingAgencyCode] The group controlling agency - * code. - * @member {string} [groupMessageVersion] The group message version. - * @member {string} [groupMessageRelease] The group message release. - * @member {number} groupControlNumberLowerBound The group control number + * @property {string} [receiverReverseRoutingAddress] The receiver reverse + * routing address. + * @property {string} [functionalGroupId] The functional group id. + * @property {string} [groupControllingAgencyCode] The group controlling + * agency code. + * @property {string} [groupMessageVersion] The group message version. + * @property {string} [groupMessageRelease] The group message release. + * @property {number} groupControlNumberLowerBound The group control number * lower bound. - * @member {number} groupControlNumberUpperBound The group control number + * @property {number} groupControlNumberUpperBound The group control number * upper bound. - * @member {boolean} rolloverGroupControlNumber The value indicating whether - * to rollover group control number. - * @member {string} [groupControlNumberPrefix] The group control number + * @property {boolean} rolloverGroupControlNumber The value indicating + * whether to rollover group control number. + * @property {string} [groupControlNumberPrefix] The group control number * prefix. - * @member {string} [groupControlNumberSuffix] The group control number + * @property {string} [groupControlNumberSuffix] The group control number * suffix. - * @member {string} [groupApplicationReceiverQualifier] The group application - * receiver qualifier. - * @member {string} [groupApplicationReceiverId] The group application + * @property {string} [groupApplicationReceiverQualifier] The group + * application receiver qualifier. + * @property {string} [groupApplicationReceiverId] The group application * receiver id. - * @member {string} [groupApplicationSenderQualifier] The group application + * @property {string} [groupApplicationSenderQualifier] The group application * sender qualifier. - * @member {string} [groupApplicationSenderId] The group application sender + * @property {string} [groupApplicationSenderId] The group application sender * id. - * @member {string} [groupApplicationPassword] The group application + * @property {string} [groupApplicationPassword] The group application * password. - * @member {boolean} overwriteExistingTransactionSetControlNumber The value + * @property {boolean} overwriteExistingTransactionSetControlNumber The value * indicating whether to overwrite existing transaction set control number. - * @member {string} [transactionSetControlNumberPrefix] The transaction set + * @property {string} [transactionSetControlNumberPrefix] The transaction set * control number prefix. - * @member {string} [transactionSetControlNumberSuffix] The transaction set + * @property {string} [transactionSetControlNumberSuffix] The transaction set * control number suffix. - * @member {number} transactionSetControlNumberLowerBound The transaction set - * control number lower bound. - * @member {number} transactionSetControlNumberUpperBound The transaction set - * control number upper bound. - * @member {boolean} rolloverTransactionSetControlNumber The value indicating - * whether to rollover transaction set control number. - * @member {boolean} isTestInterchange The value indicating whether the + * @property {number} transactionSetControlNumberLowerBound The transaction + * set control number lower bound. + * @property {number} transactionSetControlNumberUpperBound The transaction + * set control number upper bound. + * @property {boolean} rolloverTransactionSetControlNumber The value + * indicating whether to rollover transaction set control number. + * @property {boolean} isTestInterchange The value indicating whether the * message is a test interchange. - * @member {string} [senderInternalIdentification] The sender internal - * identification. - * @member {string} [senderInternalSubIdentification] The sender internal sub + * @property {string} [senderInternalIdentification] The sender internal * identification. - * @member {string} [receiverInternalIdentification] The receiver internal - * identification. - * @member {string} [receiverInternalSubIdentification] The receiver internal + * @property {string} [senderInternalSubIdentification] The sender internal * sub identification. + * @property {string} [receiverInternalIdentification] The receiver internal + * identification. + * @property {string} [receiverInternalSubIdentification] The receiver + * internal sub identification. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/edifactFramingSettings.js b/lib/services/logicManagement/lib/models/edifactFramingSettings.js index 57f9d9b279..60eb384e9f 100644 --- a/lib/services/logicManagement/lib/models/edifactFramingSettings.js +++ b/lib/services/logicManagement/lib/models/edifactFramingSettings.js @@ -17,24 +17,24 @@ class EdifactFramingSettings { /** * Create a EdifactFramingSettings. - * @member {string} [serviceCodeListDirectoryVersion] The service code list + * @property {string} [serviceCodeListDirectoryVersion] The service code list * directory version. - * @member {string} [characterEncoding] The character encoding. - * @member {number} protocolVersion The protocol version. - * @member {number} dataElementSeparator The data element separator. - * @member {number} componentSeparator The component separator. - * @member {number} segmentTerminator The segment terminator. - * @member {number} releaseIndicator The release indicator. - * @member {number} repetitionSeparator The repetition separator. - * @member {string} characterSet The EDIFACT frame setting characterSet. + * @property {string} [characterEncoding] The character encoding. + * @property {number} protocolVersion The protocol version. + * @property {number} dataElementSeparator The data element separator. + * @property {number} componentSeparator The component separator. + * @property {number} segmentTerminator The segment terminator. + * @property {number} releaseIndicator The release indicator. + * @property {number} repetitionSeparator The repetition separator. + * @property {string} characterSet The EDIFACT frame setting characterSet. * Possible values include: 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', * 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', * 'KECA' - * @member {string} decimalPointIndicator The EDIFACT frame setting decimal + * @property {string} decimalPointIndicator The EDIFACT frame setting decimal * indicator. Possible values include: 'NotSpecified', 'Comma', 'Decimal' - * @member {string} segmentTerminatorSuffix The EDIFACT frame setting segment - * terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', - * 'LF', 'CRLF' + * @property {string} segmentTerminatorSuffix The EDIFACT frame setting + * segment terminator suffix. Possible values include: 'NotSpecified', + * 'None', 'CR', 'LF', 'CRLF' */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/edifactMessageFilter.js b/lib/services/logicManagement/lib/models/edifactMessageFilter.js index 37f1f2c92c..7578631204 100644 --- a/lib/services/logicManagement/lib/models/edifactMessageFilter.js +++ b/lib/services/logicManagement/lib/models/edifactMessageFilter.js @@ -17,7 +17,7 @@ class EdifactMessageFilter { /** * Create a EdifactMessageFilter. - * @member {string} messageFilterType The message filter type. Possible + * @property {string} messageFilterType The message filter type. Possible * values include: 'NotSpecified', 'Include', 'Exclude' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/edifactMessageIdentifier.js b/lib/services/logicManagement/lib/models/edifactMessageIdentifier.js index 9d2ca40a79..00b2b72b09 100644 --- a/lib/services/logicManagement/lib/models/edifactMessageIdentifier.js +++ b/lib/services/logicManagement/lib/models/edifactMessageIdentifier.js @@ -17,8 +17,8 @@ class EdifactMessageIdentifier { /** * Create a EdifactMessageIdentifier. - * @member {string} messageId The message id on which this envelope settings - * has to be applied. + * @property {string} messageId The message id on which this envelope + * settings has to be applied. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/edifactOneWayAgreement.js b/lib/services/logicManagement/lib/models/edifactOneWayAgreement.js index d86d7f6a06..75e5727f49 100644 --- a/lib/services/logicManagement/lib/models/edifactOneWayAgreement.js +++ b/lib/services/logicManagement/lib/models/edifactOneWayAgreement.js @@ -17,270 +17,271 @@ class EdifactOneWayAgreement { /** * Create a EdifactOneWayAgreement. - * @member {object} senderBusinessIdentity The sender business identity - * @member {string} [senderBusinessIdentity.qualifier] The business identity - * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [senderBusinessIdentity.value] The user defined business - * identity value. - * @member {object} receiverBusinessIdentity The receiver business identity - * @member {string} [receiverBusinessIdentity.qualifier] The business + * @property {object} senderBusinessIdentity The sender business identity + * @property {string} [senderBusinessIdentity.qualifier] The business * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiverBusinessIdentity.value] The user defined + * @property {string} [senderBusinessIdentity.value] The user defined * business identity value. - * @member {object} protocolSettings The EDIFACT protocol settings. - * @member {object} [protocolSettings.validationSettings] The EDIFACT + * @property {object} receiverBusinessIdentity The receiver business identity + * @property {string} [receiverBusinessIdentity.qualifier] The business + * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [receiverBusinessIdentity.value] The user defined + * business identity value. + * @property {object} protocolSettings The EDIFACT protocol settings. + * @property {object} [protocolSettings.validationSettings] The EDIFACT * validation settings. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.validateCharacterSet] The value * indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.checkDuplicateGroupControlNumber] The * value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} [protocolSettings.validationSettings.validateEdiTypes] + * @property {boolean} [protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} [protocolSettings.validationSettings.validateXsdTypes] + * @property {boolean} [protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [protocolSettings.validationSettings.trailingSeparatorPolicy] The trailing * separator policy. Possible values include: 'NotSpecified', 'NotAllowed', * 'Optional', 'Mandatory' - * @member {object} [protocolSettings.framingSettings] The EDIFACT framing + * @property {object} [protocolSettings.framingSettings] The EDIFACT framing * settings. - * @member {string} + * @property {string} * [protocolSettings.framingSettings.serviceCodeListDirectoryVersion] The * service code list directory version. - * @member {string} [protocolSettings.framingSettings.characterEncoding] The - * character encoding. - * @member {number} [protocolSettings.framingSettings.protocolVersion] The + * @property {string} [protocolSettings.framingSettings.characterEncoding] + * The character encoding. + * @property {number} [protocolSettings.framingSettings.protocolVersion] The * protocol version. - * @member {number} [protocolSettings.framingSettings.dataElementSeparator] + * @property {number} [protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} [protocolSettings.framingSettings.componentSeparator] The - * component separator. - * @member {number} [protocolSettings.framingSettings.segmentTerminator] The - * segment terminator. - * @member {number} [protocolSettings.framingSettings.releaseIndicator] The + * @property {number} [protocolSettings.framingSettings.componentSeparator] + * The component separator. + * @property {number} [protocolSettings.framingSettings.segmentTerminator] + * The segment terminator. + * @property {number} [protocolSettings.framingSettings.releaseIndicator] The * release indicator. - * @member {number} [protocolSettings.framingSettings.repetitionSeparator] + * @property {number} [protocolSettings.framingSettings.repetitionSeparator] * The repetition separator. - * @member {string} [protocolSettings.framingSettings.characterSet] The + * @property {string} [protocolSettings.framingSettings.characterSet] The * EDIFACT frame setting characterSet. Possible values include: * 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', * 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} [protocolSettings.framingSettings.decimalPointIndicator] - * The EDIFACT frame setting decimal indicator. Possible values include: - * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} + * @property {string} + * [protocolSettings.framingSettings.decimalPointIndicator] The EDIFACT frame + * setting decimal indicator. Possible values include: 'NotSpecified', + * 'Comma', 'Decimal' + * @property {string} * [protocolSettings.framingSettings.segmentTerminatorSuffix] The EDIFACT * frame setting segment terminator suffix. Possible values include: * 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} [protocolSettings.envelopeSettings] The EDIFACT envelope - * settings. - * @member {string} + * @property {object} [protocolSettings.envelopeSettings] The EDIFACT + * envelope settings. + * @property {string} * [protocolSettings.envelopeSettings.groupAssociationAssignedCode] The group * association assigned code. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.communicationAgreementId] The * communication agreement id. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.applyDelimiterStringAdvice] The value * indicating whether to apply delimiter string advice. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.createGroupingSegments] The value * indicating whether to create grouping segments. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.enableDefaultGroupHeaders] The value * indicating whether to enable default group headers. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.recipientReferencePasswordValue] The * recipient reference password value. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] * The recipient reference password qualifier. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.applicationReferenceId] The application * reference id. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.processingPriorityCode] The processing * priority code. - * @member {number} + * @property {number} * [protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] The * interchange control number lower bound. - * @member {number} + * @property {number} * [protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] The * interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] The * value indicating whether to rollover interchange control number. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.interchangeControlNumberPrefix] The * interchange control number prefix. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.interchangeControlNumberSuffix] The * interchange control number suffix. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.senderReverseRoutingAddress] The sender * reverse routing address. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.receiverReverseRoutingAddress] The * receiver reverse routing address. - * @member {string} [protocolSettings.envelopeSettings.functionalGroupId] The - * functional group id. - * @member {string} + * @property {string} [protocolSettings.envelopeSettings.functionalGroupId] + * The functional group id. + * @property {string} * [protocolSettings.envelopeSettings.groupControllingAgencyCode] The group * controlling agency code. - * @member {string} [protocolSettings.envelopeSettings.groupMessageVersion] + * @property {string} [protocolSettings.envelopeSettings.groupMessageVersion] * The group message version. - * @member {string} [protocolSettings.envelopeSettings.groupMessageRelease] + * @property {string} [protocolSettings.envelopeSettings.groupMessageRelease] * The group message release. - * @member {number} + * @property {number} * [protocolSettings.envelopeSettings.groupControlNumberLowerBound] The group * control number lower bound. - * @member {number} + * @property {number} * [protocolSettings.envelopeSettings.groupControlNumberUpperBound] The group * control number upper bound. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.rolloverGroupControlNumber] The value * indicating whether to rollover group control number. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.groupControlNumberPrefix] The group * control number prefix. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.groupControlNumberSuffix] The group * control number suffix. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] The * group application receiver qualifier. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.groupApplicationReceiverId] The group * application receiver id. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.groupApplicationSenderQualifier] The * group application sender qualifier. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.groupApplicationSenderId] The group * application sender id. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.groupApplicationPassword] The group * application password. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] The * transaction set control number prefix. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] The * transaction set control number suffix. - * @member {number} + * @property {number} * [protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {boolean} [protocolSettings.envelopeSettings.isTestInterchange] + * @property {boolean} [protocolSettings.envelopeSettings.isTestInterchange] * The value indicating whether the message is a test interchange. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.senderInternalIdentification] The * sender internal identification. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.senderInternalSubIdentification] The * sender internal sub identification. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.receiverInternalIdentification] The * receiver internal identification. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.receiverInternalSubIdentification] The * receiver internal sub identification. - * @member {object} [protocolSettings.acknowledgementSettings] The EDIFACT + * @property {object} [protocolSettings.acknowledgementSettings] The EDIFACT * acknowledgement settings. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.needLoopForValidMessages] The * value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} [protocolSettings.messageFilter] The EDIFACT message + * @property {object} [protocolSettings.messageFilter] The EDIFACT message * filter. - * @member {string} [protocolSettings.messageFilter.messageFilterType] The + * @property {string} [protocolSettings.messageFilter.messageFilterType] The * message filter type. Possible values include: 'NotSpecified', 'Include', * 'Exclude' - * @member {object} [protocolSettings.processingSettings] The EDIFACT + * @property {object} [protocolSettings.processingSettings] The EDIFACT * processing Settings. - * @member {boolean} [protocolSettings.processingSettings.maskSecurityInfo] + * @property {boolean} [protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [protocolSettings.processingSettings.preserveInterchange] The value * indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [protocolSettings.processingSettings.suspendInterchangeOnError] The value * indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [protocolSettings.processingSettings.useDotAsDecimalSeparator] The value * indicating whether to use dot as decimal separator. - * @member {array} [protocolSettings.envelopeOverrides] The EDIFACT envelope - * override settings. - * @member {array} [protocolSettings.messageFilterList] The EDIFACT message + * @property {array} [protocolSettings.envelopeOverrides] The EDIFACT + * envelope override settings. + * @property {array} [protocolSettings.messageFilterList] The EDIFACT message * filter list. - * @member {array} [protocolSettings.schemaReferences] The EDIFACT schema + * @property {array} [protocolSettings.schemaReferences] The EDIFACT schema * references. - * @member {array} [protocolSettings.validationOverrides] The EDIFACT + * @property {array} [protocolSettings.validationOverrides] The EDIFACT * validation override settings. - * @member {array} [protocolSettings.edifactDelimiterOverrides] The EDIFACT + * @property {array} [protocolSettings.edifactDelimiterOverrides] The EDIFACT * delimiter override settings. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/edifactProcessingSettings.js b/lib/services/logicManagement/lib/models/edifactProcessingSettings.js index dec6068a20..6f42d16c8f 100644 --- a/lib/services/logicManagement/lib/models/edifactProcessingSettings.js +++ b/lib/services/logicManagement/lib/models/edifactProcessingSettings.js @@ -17,16 +17,16 @@ class EdifactProcessingSettings { /** * Create a EdifactProcessingSettings. - * @member {boolean} maskSecurityInfo The value indicating whether to mask + * @property {boolean} maskSecurityInfo The value indicating whether to mask * security information. - * @member {boolean} preserveInterchange The value indicating whether to + * @property {boolean} preserveInterchange The value indicating whether to * preserve interchange. - * @member {boolean} suspendInterchangeOnError The value indicating whether + * @property {boolean} suspendInterchangeOnError The value indicating whether * to suspend interchange on error. - * @member {boolean} createEmptyXmlTagsForTrailingSeparators The value + * @property {boolean} createEmptyXmlTagsForTrailingSeparators The value * indicating whether to create empty xml tags for trailing separators. - * @member {boolean} useDotAsDecimalSeparator The value indicating whether to - * use dot as decimal separator. + * @property {boolean} useDotAsDecimalSeparator The value indicating whether + * to use dot as decimal separator. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/edifactProtocolSettings.js b/lib/services/logicManagement/lib/models/edifactProtocolSettings.js index b2a08f99a8..af7c6a3542 100644 --- a/lib/services/logicManagement/lib/models/edifactProtocolSettings.js +++ b/lib/services/logicManagement/lib/models/edifactProtocolSettings.js @@ -17,194 +17,201 @@ class EdifactProtocolSettings { /** * Create a EdifactProtocolSettings. - * @member {object} validationSettings The EDIFACT validation settings. - * @member {boolean} [validationSettings.validateCharacterSet] The value + * @property {object} validationSettings The EDIFACT validation settings. + * @property {boolean} [validationSettings.validateCharacterSet] The value * indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [validationSettings.checkDuplicateInterchangeControlNumber] The value * indicating whether to check for duplicate interchange control number. - * @member {number} [validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} [validationSettings.checkDuplicateGroupControlNumber] + * @property {number} + * [validationSettings.interchangeControlNumberValidityDays] The validity + * period of interchange control number. + * @property {boolean} [validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [validationSettings.checkDuplicateTransactionSetControlNumber] The value * indicating whether to check for duplicate transaction set control number. - * @member {boolean} [validationSettings.validateEdiTypes] The value + * @property {boolean} [validationSettings.validateEdiTypes] The value * indicating whether to Whether to validate EDI types. - * @member {boolean} [validationSettings.validateXsdTypes] The value + * @property {boolean} [validationSettings.validateXsdTypes] The value * indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [validationSettings.allowLeadingAndTrailingSpacesAndZeroes] The value * indicating whether to allow leading and trailing spaces and zeroes. - * @member {boolean} + * @property {boolean} * [validationSettings.trimLeadingAndTrailingSpacesAndZeroes] The value * indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} [validationSettings.trailingSeparatorPolicy] The trailing - * separator policy. Possible values include: 'NotSpecified', 'NotAllowed', - * 'Optional', 'Mandatory' - * @member {object} framingSettings The EDIFACT framing settings. - * @member {string} [framingSettings.serviceCodeListDirectoryVersion] The + * @property {string} [validationSettings.trailingSeparatorPolicy] The + * trailing separator policy. Possible values include: 'NotSpecified', + * 'NotAllowed', 'Optional', 'Mandatory' + * @property {object} framingSettings The EDIFACT framing settings. + * @property {string} [framingSettings.serviceCodeListDirectoryVersion] The * service code list directory version. - * @member {string} [framingSettings.characterEncoding] The character + * @property {string} [framingSettings.characterEncoding] The character * encoding. - * @member {number} [framingSettings.protocolVersion] The protocol version. - * @member {number} [framingSettings.dataElementSeparator] The data element + * @property {number} [framingSettings.protocolVersion] The protocol version. + * @property {number} [framingSettings.dataElementSeparator] The data element * separator. - * @member {number} [framingSettings.componentSeparator] The component + * @property {number} [framingSettings.componentSeparator] The component * separator. - * @member {number} [framingSettings.segmentTerminator] The segment + * @property {number} [framingSettings.segmentTerminator] The segment * terminator. - * @member {number} [framingSettings.releaseIndicator] The release indicator. - * @member {number} [framingSettings.repetitionSeparator] The repetition + * @property {number} [framingSettings.releaseIndicator] The release + * indicator. + * @property {number} [framingSettings.repetitionSeparator] The repetition * separator. - * @member {string} [framingSettings.characterSet] The EDIFACT frame setting - * characterSet. Possible values include: 'NotSpecified', 'UNOB', 'UNOA', - * 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', 'UNOK', - * 'UNOX', 'UNOY', 'KECA' - * @member {string} [framingSettings.decimalPointIndicator] The EDIFACT frame - * setting decimal indicator. Possible values include: 'NotSpecified', + * @property {string} [framingSettings.characterSet] The EDIFACT frame + * setting characterSet. Possible values include: 'NotSpecified', 'UNOB', + * 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', + * 'UNOK', 'UNOX', 'UNOY', 'KECA' + * @property {string} [framingSettings.decimalPointIndicator] The EDIFACT + * frame setting decimal indicator. Possible values include: 'NotSpecified', * 'Comma', 'Decimal' - * @member {string} [framingSettings.segmentTerminatorSuffix] The EDIFACT + * @property {string} [framingSettings.segmentTerminatorSuffix] The EDIFACT * frame setting segment terminator suffix. Possible values include: * 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} envelopeSettings The EDIFACT envelope settings. - * @member {string} [envelopeSettings.groupAssociationAssignedCode] The group - * association assigned code. - * @member {string} [envelopeSettings.communicationAgreementId] The + * @property {object} envelopeSettings The EDIFACT envelope settings. + * @property {string} [envelopeSettings.groupAssociationAssignedCode] The + * group association assigned code. + * @property {string} [envelopeSettings.communicationAgreementId] The * communication agreement id. - * @member {boolean} [envelopeSettings.applyDelimiterStringAdvice] The value - * indicating whether to apply delimiter string advice. - * @member {boolean} [envelopeSettings.createGroupingSegments] The value + * @property {boolean} [envelopeSettings.applyDelimiterStringAdvice] The + * value indicating whether to apply delimiter string advice. + * @property {boolean} [envelopeSettings.createGroupingSegments] The value * indicating whether to create grouping segments. - * @member {boolean} [envelopeSettings.enableDefaultGroupHeaders] The value + * @property {boolean} [envelopeSettings.enableDefaultGroupHeaders] The value * indicating whether to enable default group headers. - * @member {string} [envelopeSettings.recipientReferencePasswordValue] The + * @property {string} [envelopeSettings.recipientReferencePasswordValue] The * recipient reference password value. - * @member {string} [envelopeSettings.recipientReferencePasswordQualifier] + * @property {string} [envelopeSettings.recipientReferencePasswordQualifier] * The recipient reference password qualifier. - * @member {string} [envelopeSettings.applicationReferenceId] The application - * reference id. - * @member {string} [envelopeSettings.processingPriorityCode] The processing - * priority code. - * @member {number} [envelopeSettings.interchangeControlNumberLowerBound] The - * interchange control number lower bound. - * @member {number} [envelopeSettings.interchangeControlNumberUpperBound] The - * interchange control number upper bound. - * @member {boolean} [envelopeSettings.rolloverInterchangeControlNumber] The - * value indicating whether to rollover interchange control number. - * @member {string} [envelopeSettings.interchangeControlNumberPrefix] The + * @property {string} [envelopeSettings.applicationReferenceId] The + * application reference id. + * @property {string} [envelopeSettings.processingPriorityCode] The + * processing priority code. + * @property {number} [envelopeSettings.interchangeControlNumberLowerBound] + * The interchange control number lower bound. + * @property {number} [envelopeSettings.interchangeControlNumberUpperBound] + * The interchange control number upper bound. + * @property {boolean} [envelopeSettings.rolloverInterchangeControlNumber] + * The value indicating whether to rollover interchange control number. + * @property {string} [envelopeSettings.interchangeControlNumberPrefix] The * interchange control number prefix. - * @member {string} [envelopeSettings.interchangeControlNumberSuffix] The + * @property {string} [envelopeSettings.interchangeControlNumberSuffix] The * interchange control number suffix. - * @member {string} [envelopeSettings.senderReverseRoutingAddress] The sender - * reverse routing address. - * @member {string} [envelopeSettings.receiverReverseRoutingAddress] The + * @property {string} [envelopeSettings.senderReverseRoutingAddress] The + * sender reverse routing address. + * @property {string} [envelopeSettings.receiverReverseRoutingAddress] The * receiver reverse routing address. - * @member {string} [envelopeSettings.functionalGroupId] The functional group - * id. - * @member {string} [envelopeSettings.groupControllingAgencyCode] The group + * @property {string} [envelopeSettings.functionalGroupId] The functional + * group id. + * @property {string} [envelopeSettings.groupControllingAgencyCode] The group * controlling agency code. - * @member {string} [envelopeSettings.groupMessageVersion] The group message - * version. - * @member {string} [envelopeSettings.groupMessageRelease] The group message - * release. - * @member {number} [envelopeSettings.groupControlNumberLowerBound] The group - * control number lower bound. - * @member {number} [envelopeSettings.groupControlNumberUpperBound] The group - * control number upper bound. - * @member {boolean} [envelopeSettings.rolloverGroupControlNumber] The value - * indicating whether to rollover group control number. - * @member {string} [envelopeSettings.groupControlNumberPrefix] The group + * @property {string} [envelopeSettings.groupMessageVersion] The group + * message version. + * @property {string} [envelopeSettings.groupMessageRelease] The group + * message release. + * @property {number} [envelopeSettings.groupControlNumberLowerBound] The + * group control number lower bound. + * @property {number} [envelopeSettings.groupControlNumberUpperBound] The + * group control number upper bound. + * @property {boolean} [envelopeSettings.rolloverGroupControlNumber] The + * value indicating whether to rollover group control number. + * @property {string} [envelopeSettings.groupControlNumberPrefix] The group * control number prefix. - * @member {string} [envelopeSettings.groupControlNumberSuffix] The group + * @property {string} [envelopeSettings.groupControlNumberSuffix] The group * control number suffix. - * @member {string} [envelopeSettings.groupApplicationReceiverQualifier] The - * group application receiver qualifier. - * @member {string} [envelopeSettings.groupApplicationReceiverId] The group + * @property {string} [envelopeSettings.groupApplicationReceiverQualifier] + * The group application receiver qualifier. + * @property {string} [envelopeSettings.groupApplicationReceiverId] The group * application receiver id. - * @member {string} [envelopeSettings.groupApplicationSenderQualifier] The + * @property {string} [envelopeSettings.groupApplicationSenderQualifier] The * group application sender qualifier. - * @member {string} [envelopeSettings.groupApplicationSenderId] The group + * @property {string} [envelopeSettings.groupApplicationSenderId] The group * application sender id. - * @member {string} [envelopeSettings.groupApplicationPassword] The group + * @property {string} [envelopeSettings.groupApplicationPassword] The group * application password. - * @member {boolean} + * @property {boolean} * [envelopeSettings.overwriteExistingTransactionSetControlNumber] The value * indicating whether to overwrite existing transaction set control number. - * @member {string} [envelopeSettings.transactionSetControlNumberPrefix] The - * transaction set control number prefix. - * @member {string} [envelopeSettings.transactionSetControlNumberSuffix] The - * transaction set control number suffix. - * @member {number} [envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} [envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} [envelopeSettings.rolloverTransactionSetControlNumber] + * @property {string} [envelopeSettings.transactionSetControlNumberPrefix] + * The transaction set control number prefix. + * @property {string} [envelopeSettings.transactionSetControlNumberSuffix] + * The transaction set control number suffix. + * @property {number} + * [envelopeSettings.transactionSetControlNumberLowerBound] The transaction + * set control number lower bound. + * @property {number} + * [envelopeSettings.transactionSetControlNumberUpperBound] The transaction + * set control number upper bound. + * @property {boolean} [envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {boolean} [envelopeSettings.isTestInterchange] The value + * @property {boolean} [envelopeSettings.isTestInterchange] The value * indicating whether the message is a test interchange. - * @member {string} [envelopeSettings.senderInternalIdentification] The + * @property {string} [envelopeSettings.senderInternalIdentification] The * sender internal identification. - * @member {string} [envelopeSettings.senderInternalSubIdentification] The + * @property {string} [envelopeSettings.senderInternalSubIdentification] The * sender internal sub identification. - * @member {string} [envelopeSettings.receiverInternalIdentification] The + * @property {string} [envelopeSettings.receiverInternalIdentification] The * receiver internal identification. - * @member {string} [envelopeSettings.receiverInternalSubIdentification] The - * receiver internal sub identification. - * @member {object} acknowledgementSettings The EDIFACT acknowledgement + * @property {string} [envelopeSettings.receiverInternalSubIdentification] + * The receiver internal sub identification. + * @property {object} acknowledgementSettings The EDIFACT acknowledgement * settings. - * @member {boolean} [acknowledgementSettings.needTechnicalAcknowledgement] + * @property {boolean} [acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} [acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} [acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {boolean} + * @property {boolean} + * [acknowledgementSettings.batchTechnicalAcknowledgements] The value + * indicating whether to batch the technical acknowledgements. + * @property {boolean} + * [acknowledgementSettings.needFunctionalAcknowledgement] The value + * indicating whether functional acknowledgement is needed. + * @property {boolean} * [acknowledgementSettings.batchFunctionalAcknowledgements] The value * indicating whether to batch functional acknowledgements. - * @member {boolean} [acknowledgementSettings.needLoopForValidMessages] The + * @property {boolean} [acknowledgementSettings.needLoopForValidMessages] The * value indicating whether a loop is needed for valid messages. - * @member {boolean} [acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {boolean} + * [acknowledgementSettings.sendSynchronousAcknowledgement] The value + * indicating whether to send synchronous acknowledgement. + * @property {string} * [acknowledgementSettings.acknowledgementControlNumberPrefix] The * acknowledgement control number prefix. - * @member {string} + * @property {string} * [acknowledgementSettings.acknowledgementControlNumberSuffix] The * acknowledgement control number suffix. - * @member {number} + * @property {number} * [acknowledgementSettings.acknowledgementControlNumberLowerBound] The * acknowledgement control number lower bound. - * @member {number} + * @property {number} * [acknowledgementSettings.acknowledgementControlNumberUpperBound] The * acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [acknowledgementSettings.rolloverAcknowledgementControlNumber] The value * indicating whether to rollover acknowledgement control number. - * @member {object} messageFilter The EDIFACT message filter. - * @member {string} [messageFilter.messageFilterType] The message filter + * @property {object} messageFilter The EDIFACT message filter. + * @property {string} [messageFilter.messageFilterType] The message filter * type. Possible values include: 'NotSpecified', 'Include', 'Exclude' - * @member {object} processingSettings The EDIFACT processing Settings. - * @member {boolean} [processingSettings.maskSecurityInfo] The value + * @property {object} processingSettings The EDIFACT processing Settings. + * @property {boolean} [processingSettings.maskSecurityInfo] The value * indicating whether to mask security information. - * @member {boolean} [processingSettings.preserveInterchange] The value + * @property {boolean} [processingSettings.preserveInterchange] The value * indicating whether to preserve interchange. - * @member {boolean} [processingSettings.suspendInterchangeOnError] The value - * indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} [processingSettings.suspendInterchangeOnError] The + * value indicating whether to suspend interchange on error. + * @property {boolean} * [processingSettings.createEmptyXmlTagsForTrailingSeparators] The value * indicating whether to create empty xml tags for trailing separators. - * @member {boolean} [processingSettings.useDotAsDecimalSeparator] The value - * indicating whether to use dot as decimal separator. - * @member {array} [envelopeOverrides] The EDIFACT envelope override + * @property {boolean} [processingSettings.useDotAsDecimalSeparator] The + * value indicating whether to use dot as decimal separator. + * @property {array} [envelopeOverrides] The EDIFACT envelope override * settings. - * @member {array} [messageFilterList] The EDIFACT message filter list. - * @member {array} schemaReferences The EDIFACT schema references. - * @member {array} [validationOverrides] The EDIFACT validation override - * settings. - * @member {array} [edifactDelimiterOverrides] The EDIFACT delimiter override + * @property {array} [messageFilterList] The EDIFACT message filter list. + * @property {array} schemaReferences The EDIFACT schema references. + * @property {array} [validationOverrides] The EDIFACT validation override * settings. + * @property {array} [edifactDelimiterOverrides] The EDIFACT delimiter + * override settings. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/edifactSchemaReference.js b/lib/services/logicManagement/lib/models/edifactSchemaReference.js index d3906b7dc7..05f8f51bf7 100644 --- a/lib/services/logicManagement/lib/models/edifactSchemaReference.js +++ b/lib/services/logicManagement/lib/models/edifactSchemaReference.js @@ -17,14 +17,15 @@ class EdifactSchemaReference { /** * Create a EdifactSchemaReference. - * @member {string} messageId The message id. - * @member {string} messageVersion The message version. - * @member {string} messageRelease The message release version. - * @member {string} [senderApplicationId] The sender application id. - * @member {string} [senderApplicationQualifier] The sender application + * @property {string} messageId The message id. + * @property {string} messageVersion The message version. + * @property {string} messageRelease The message release version. + * @property {string} [senderApplicationId] The sender application id. + * @property {string} [senderApplicationQualifier] The sender application * qualifier. - * @member {string} [associationAssignedCode] The association assigned code. - * @member {string} schemaName The schema name. + * @property {string} [associationAssignedCode] The association assigned + * code. + * @property {string} schemaName The schema name. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/edifactValidationOverride.js b/lib/services/logicManagement/lib/models/edifactValidationOverride.js index 9474a59be7..c7237798cd 100644 --- a/lib/services/logicManagement/lib/models/edifactValidationOverride.js +++ b/lib/services/logicManagement/lib/models/edifactValidationOverride.js @@ -17,20 +17,20 @@ class EdifactValidationOverride { /** * Create a EdifactValidationOverride. - * @member {string} messageId The message id on which the validation settings - * has to be applied. - * @member {boolean} enforceCharacterSet The value indicating whether to + * @property {string} messageId The message id on which the validation + * settings has to be applied. + * @property {boolean} enforceCharacterSet The value indicating whether to * validate character Set. - * @member {boolean} validateEdiTypes The value indicating whether to + * @property {boolean} validateEdiTypes The value indicating whether to * validate EDI types. - * @member {boolean} validateXsdTypes The value indicating whether to + * @property {boolean} validateXsdTypes The value indicating whether to * validate XSD types. - * @member {boolean} allowLeadingAndTrailingSpacesAndZeroes The value + * @property {boolean} allowLeadingAndTrailingSpacesAndZeroes The value * indicating whether to allow leading and trailing spaces and zeroes. - * @member {string} trailingSeparatorPolicy The trailing separator policy. + * @property {string} trailingSeparatorPolicy The trailing separator policy. * Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', * 'Mandatory' - * @member {boolean} trimLeadingAndTrailingSpacesAndZeroes The value + * @property {boolean} trimLeadingAndTrailingSpacesAndZeroes The value * indicating whether to trim leading and trailing spaces and zeroes. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/edifactValidationSettings.js b/lib/services/logicManagement/lib/models/edifactValidationSettings.js index d199a25248..602c217cec 100644 --- a/lib/services/logicManagement/lib/models/edifactValidationSettings.js +++ b/lib/services/logicManagement/lib/models/edifactValidationSettings.js @@ -17,25 +17,25 @@ class EdifactValidationSettings { /** * Create a EdifactValidationSettings. - * @member {boolean} validateCharacterSet The value indicating whether to + * @property {boolean} validateCharacterSet The value indicating whether to * validate character set in the message. - * @member {boolean} checkDuplicateInterchangeControlNumber The value + * @property {boolean} checkDuplicateInterchangeControlNumber The value * indicating whether to check for duplicate interchange control number. - * @member {number} interchangeControlNumberValidityDays The validity period - * of interchange control number. - * @member {boolean} checkDuplicateGroupControlNumber The value indicating + * @property {number} interchangeControlNumberValidityDays The validity + * period of interchange control number. + * @property {boolean} checkDuplicateGroupControlNumber The value indicating * whether to check for duplicate group control number. - * @member {boolean} checkDuplicateTransactionSetControlNumber The value + * @property {boolean} checkDuplicateTransactionSetControlNumber The value * indicating whether to check for duplicate transaction set control number. - * @member {boolean} validateEdiTypes The value indicating whether to Whether - * to validate EDI types. - * @member {boolean} validateXsdTypes The value indicating whether to Whether - * to validate XSD types. - * @member {boolean} allowLeadingAndTrailingSpacesAndZeroes The value + * @property {boolean} validateEdiTypes The value indicating whether to + * Whether to validate EDI types. + * @property {boolean} validateXsdTypes The value indicating whether to + * Whether to validate XSD types. + * @property {boolean} allowLeadingAndTrailingSpacesAndZeroes The value * indicating whether to allow leading and trailing spaces and zeroes. - * @member {boolean} trimLeadingAndTrailingSpacesAndZeroes The value + * @property {boolean} trimLeadingAndTrailingSpacesAndZeroes The value * indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} trailingSeparatorPolicy The trailing separator policy. + * @property {string} trailingSeparatorPolicy The trailing separator policy. * Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', * 'Mandatory' */ diff --git a/lib/services/logicManagement/lib/models/errorInfo.js b/lib/services/logicManagement/lib/models/errorInfo.js index 441a6d7c45..2f1ab4c503 100644 --- a/lib/services/logicManagement/lib/models/errorInfo.js +++ b/lib/services/logicManagement/lib/models/errorInfo.js @@ -17,7 +17,7 @@ class ErrorInfo { /** * Create a ErrorInfo. - * @member {string} code The error code. + * @property {string} code The error code. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/errorProperties.js b/lib/services/logicManagement/lib/models/errorProperties.js index dc7d907230..742fb05211 100644 --- a/lib/services/logicManagement/lib/models/errorProperties.js +++ b/lib/services/logicManagement/lib/models/errorProperties.js @@ -18,8 +18,8 @@ class ErrorProperties { /** * Create a ErrorProperties. - * @member {string} [code] Error code. - * @member {string} [message] Error message indicating why the operation + * @property {string} [code] Error code. + * @property {string} [message] Error message indicating why the operation * failed. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/errorResponse.js b/lib/services/logicManagement/lib/models/errorResponse.js index 4237e9f11c..99717e581e 100644 --- a/lib/services/logicManagement/lib/models/errorResponse.js +++ b/lib/services/logicManagement/lib/models/errorResponse.js @@ -18,9 +18,9 @@ class ErrorResponse { /** * Create a ErrorResponse. - * @member {object} [error] The error properties. - * @member {string} [error.code] Error code. - * @member {string} [error.message] Error message indicating why the + * @property {object} [error] The error properties. + * @property {string} [error.code] Error code. + * @property {string} [error.message] Error message indicating why the * operation failed. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/expression.js b/lib/services/logicManagement/lib/models/expression.js index 98fdbfb6d2..a75ab40ad8 100644 --- a/lib/services/logicManagement/lib/models/expression.js +++ b/lib/services/logicManagement/lib/models/expression.js @@ -16,12 +16,12 @@ class Expression { /** * Create a Expression. - * @member {string} [text] - * @member {object} [value] - * @member {array} [subexpressions] - * @member {object} [error] - * @member {string} [error.message] The error message. - * @member {array} [error.details] The error details. + * @property {string} [text] + * @property {object} [value] + * @property {array} [subexpressions] + * @property {object} [error] + * @property {string} [error.message] The error message. + * @property {array} [error.details] The error details. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/expressionRoot.js b/lib/services/logicManagement/lib/models/expressionRoot.js index 6d24d0396b..6357fb6743 100644 --- a/lib/services/logicManagement/lib/models/expressionRoot.js +++ b/lib/services/logicManagement/lib/models/expressionRoot.js @@ -19,7 +19,7 @@ const models = require('./index'); class ExpressionRoot extends models['Expression'] { /** * Create a ExpressionRoot. - * @member {string} [path] The path. + * @property {string} [path] The path. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/expressionTraces.js b/lib/services/logicManagement/lib/models/expressionTraces.js index 4159b8fcda..acb740499d 100644 --- a/lib/services/logicManagement/lib/models/expressionTraces.js +++ b/lib/services/logicManagement/lib/models/expressionTraces.js @@ -16,7 +16,7 @@ class ExpressionTraces extends Array { /** * Create a ExpressionTraces. - * @member {array} [inputs] + * @property {array} [inputs] */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/generateUpgradedDefinitionParameters.js b/lib/services/logicManagement/lib/models/generateUpgradedDefinitionParameters.js index 5661de518c..df2f728342 100644 --- a/lib/services/logicManagement/lib/models/generateUpgradedDefinitionParameters.js +++ b/lib/services/logicManagement/lib/models/generateUpgradedDefinitionParameters.js @@ -17,7 +17,7 @@ class GenerateUpgradedDefinitionParameters { /** * Create a GenerateUpgradedDefinitionParameters. - * @member {string} [targetSchemaVersion] The target schema version. + * @property {string} [targetSchemaVersion] The target schema version. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/getCallbackUrlParameters.js b/lib/services/logicManagement/lib/models/getCallbackUrlParameters.js index 885a74e49a..2027398dfa 100644 --- a/lib/services/logicManagement/lib/models/getCallbackUrlParameters.js +++ b/lib/services/logicManagement/lib/models/getCallbackUrlParameters.js @@ -17,8 +17,8 @@ class GetCallbackUrlParameters { /** * Create a GetCallbackUrlParameters. - * @member {date} [notAfter] The expiry time. - * @member {string} [keyType] The key type. Possible values include: + * @property {date} [notAfter] The expiry time. + * @property {string} [keyType] The key type. Possible values include: * 'NotSpecified', 'Primary', 'Secondary' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/index.d.ts b/lib/services/logicManagement/lib/models/index.d.ts index 111214b220..3890f4e527 100644 --- a/lib/services/logicManagement/lib/models/index.d.ts +++ b/lib/services/logicManagement/lib/models/index.d.ts @@ -1,8045 +1,2830 @@ /* * 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 * The base resource type. - * - * @member {string} [id] The resource id. - * @member {string} [name] Gets the resource name. - * @member {string} [type] Gets the resource type. - * @member {string} [location] The resource location. - * @member {object} [tags] The resource tags. */ export interface Resource extends BaseResource { + /** + * The resource id. + */ readonly id?: string; + /** + * Gets the resource name. + */ readonly name?: string; + /** + * Gets the resource type. + */ readonly type?: string; + /** + * The resource location. + */ location?: string; + /** + * The resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the SubResource class. - * @constructor * The sub resource type. - * - * @member {string} [id] The resource id. */ export interface SubResource extends BaseResource { + /** + * The resource id. + */ readonly id?: string; } /** - * @class - * Initializes a new instance of the ResourceReference class. - * @constructor * The resource reference. - * - * @member {string} [id] The resource id. - * @member {string} [name] Gets the resource name. - * @member {string} [type] Gets the resource type. */ export interface ResourceReference { - readonly id?: string; + /** + * The resource id. + */ + id?: string; + /** + * Gets the resource name. + */ readonly name?: string; + /** + * Gets the resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the Sku class. - * @constructor * The sku type. - * - * @member {string} name The name. Possible values include: 'NotSpecified', - * 'Free', 'Shared', 'Basic', 'Standard', 'Premium' - * @member {object} [plan] The reference to plan. - * @member {string} [plan.id] The resource id. - * @member {string} [plan.name] Gets the resource name. - * @member {string} [plan.type] Gets the resource type. */ export interface Sku { + /** + * The name. Possible values include: 'NotSpecified', 'Free', 'Shared', 'Basic', 'Standard', + * 'Premium' + */ name: string; + /** + * The reference to plan. + */ plan?: ResourceReference; } /** - * @class - * Initializes a new instance of the WorkflowParameter class. - * @constructor * The workflow parameters. - * - * @member {string} [type] The type. Possible values include: 'NotSpecified', - * 'String', 'SecureString', 'Int', 'Float', 'Bool', 'Array', 'Object', - * 'SecureObject' - * @member {object} [value] The value. - * @member {object} [metadata] The metadata. - * @member {string} [description] The description. */ export interface WorkflowParameter { + /** + * The type. Possible values include: 'NotSpecified', 'String', 'SecureString', 'Int', 'Float', + * 'Bool', 'Array', 'Object', 'SecureObject' + */ type?: string; + /** + * The value. + */ value?: any; + /** + * The metadata. + */ metadata?: any; + /** + * The description. + */ description?: string; } /** - * @class - * Initializes a new instance of the Workflow class. - * @constructor * The workflow type. - * - * @member {string} [provisioningState] Gets the provisioning state. Possible - * values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', 'Creating', - * 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', 'Succeeded', - * 'Moving', 'Updating', 'Registering', 'Registered', 'Unregistering', - * 'Unregistered', 'Completed' - * @member {date} [createdTime] Gets the created time. - * @member {date} [changedTime] Gets the changed time. - * @member {string} [state] The state. Possible values include: 'NotSpecified', - * 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' - * @member {string} [version] Gets the version. - * @member {string} [accessEndpoint] Gets the access endpoint. - * @member {object} [sku] The sku. - * @member {string} [sku.name] The name. Possible values include: - * 'NotSpecified', 'Free', 'Shared', 'Basic', 'Standard', 'Premium' - * @member {object} [sku.plan] The reference to plan. - * @member {string} [sku.plan.id] The resource id. - * @member {string} [sku.plan.name] Gets the resource name. - * @member {string} [sku.plan.type] Gets the resource type. - * @member {object} [integrationAccount] The integration account. - * @member {string} [integrationAccount.id] The resource id. - * @member {string} [integrationAccount.name] Gets the resource name. - * @member {string} [integrationAccount.type] Gets the resource type. - * @member {object} [definition] The definition. - * @member {object} [parameters] The parameters. */ export interface Workflow extends Resource { + /** + * Gets the provisioning state. Possible values include: 'NotSpecified', 'Accepted', 'Running', + * 'Ready', 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', 'Succeeded', + * 'Moving', 'Updating', 'Registering', 'Registered', 'Unregistering', 'Unregistered', + * 'Completed' + */ readonly provisioningState?: string; + /** + * Gets the created time. + */ readonly createdTime?: Date; + /** + * Gets the changed time. + */ readonly changedTime?: Date; + /** + * The state. Possible values include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', + * 'Deleted', 'Suspended' + */ state?: string; + /** + * Gets the version. + */ readonly version?: string; + /** + * Gets the access endpoint. + */ readonly accessEndpoint?: string; + /** + * The sku. + */ sku?: Sku; + /** + * The integration account. + */ integrationAccount?: ResourceReference; + /** + * The definition. + */ definition?: any; + /** + * The parameters. + */ parameters?: { [propertyName: string]: WorkflowParameter }; } /** - * @class - * Initializes a new instance of the WorkflowFilter class. - * @constructor * The workflow filter. - * - * @member {string} [state] The state of workflows. Possible values include: - * 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' */ export interface WorkflowFilter { + /** + * The state of workflows. Possible values include: 'NotSpecified', 'Completed', 'Enabled', + * 'Disabled', 'Deleted', 'Suspended' + */ state?: string; } /** - * @class - * Initializes a new instance of the WorkflowVersion class. - * @constructor * The workflow version. - * - * @member {date} [createdTime] Gets the created time. - * @member {date} [changedTime] Gets the changed time. - * @member {string} [state] The state. Possible values include: 'NotSpecified', - * 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' - * @member {string} [version] Gets the version. - * @member {string} [accessEndpoint] Gets the access endpoint. - * @member {object} [sku] The sku. - * @member {string} [sku.name] The name. Possible values include: - * 'NotSpecified', 'Free', 'Shared', 'Basic', 'Standard', 'Premium' - * @member {object} [sku.plan] The reference to plan. - * @member {string} [sku.plan.id] The resource id. - * @member {string} [sku.plan.name] Gets the resource name. - * @member {string} [sku.plan.type] Gets the resource type. - * @member {object} [integrationAccount] The integration account. - * @member {string} [integrationAccount.id] The resource id. - * @member {string} [integrationAccount.name] Gets the resource name. - * @member {string} [integrationAccount.type] Gets the resource type. - * @member {object} [definition] The definition. - * @member {object} [parameters] The parameters. */ export interface WorkflowVersion extends Resource { + /** + * Gets the created time. + */ readonly createdTime?: Date; + /** + * Gets the changed time. + */ readonly changedTime?: Date; + /** + * The state. Possible values include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', + * 'Deleted', 'Suspended' + */ state?: string; + /** + * Gets the version. + */ readonly version?: string; + /** + * Gets the access endpoint. + */ readonly accessEndpoint?: string; + /** + * The sku. + */ sku?: Sku; + /** + * The integration account. + */ integrationAccount?: ResourceReference; + /** + * The definition. + */ definition?: any; + /** + * The parameters. + */ parameters?: { [propertyName: string]: WorkflowParameter }; } /** - * @class - * Initializes a new instance of the RecurrenceScheduleOccurrence class. - * @constructor * The recurrence schedule occurrence. - * - * @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; } /** - * @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[]; } /** - * @class - * Initializes a new instance of the WorkflowTriggerRecurrence class. - * @constructor * The workflow trigger recurrence. - * - * @member {string} [frequency] The frequency. Possible values include: - * 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year' - * @member {number} [interval] The interval. - * @member {string} [startTime] The start time. - * @member {string} [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 WorkflowTriggerRecurrence { + /** + * The frequency. Possible values include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', + * 'Week', 'Month', 'Year' + */ frequency?: string; + /** + * The interval. + */ interval?: number; + /** + * The start time. + */ startTime?: string; + /** + * The end time. + */ endTime?: string; + /** + * The time zone. + */ timeZone?: string; + /** + * The recurrence schedule. + */ schedule?: RecurrenceSchedule; } /** - * @class - * Initializes a new instance of the WorkflowTrigger class. - * @constructor * The workflow trigger. - * - * @member {string} [provisioningState] Gets the provisioning state. Possible - * values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', 'Creating', - * 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', 'Succeeded', - * 'Moving', 'Updating', 'Registering', 'Registered', 'Unregistering', - * 'Unregistered', 'Completed' - * @member {date} [createdTime] Gets the created time. - * @member {date} [changedTime] Gets the changed time. - * @member {string} [state] Gets the state. Possible values include: - * 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' - * @member {string} [status] Gets the status. Possible values include: - * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', - * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', - * 'Ignored' - * @member {date} [lastExecutionTime] Gets the last execution time. - * @member {date} [nextExecutionTime] Gets the next execution time. - * @member {object} [recurrence] Gets the workflow trigger recurrence. - * @member {string} [recurrence.frequency] The frequency. Possible values - * include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', 'Month', - * 'Year' - * @member {number} [recurrence.interval] The interval. - * @member {string} [recurrence.startTime] The start time. - * @member {string} [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. - * @member {object} [workflow] Gets the reference to workflow. - * @member {string} [workflow.id] The resource id. - * @member {string} [workflow.name] Gets the resource name. - * @member {string} [workflow.type] Gets the resource type. - * @member {string} [name] Gets the workflow trigger name. - * @member {string} [type] Gets the workflow trigger type. */ export interface WorkflowTrigger extends SubResource { + /** + * Gets the provisioning state. Possible values include: 'NotSpecified', 'Accepted', 'Running', + * 'Ready', 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', 'Succeeded', + * 'Moving', 'Updating', 'Registering', 'Registered', 'Unregistering', 'Unregistered', + * 'Completed' + */ readonly provisioningState?: string; + /** + * Gets the created time. + */ readonly createdTime?: Date; + /** + * Gets the changed time. + */ readonly changedTime?: Date; + /** + * Gets the state. Possible values include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', + * 'Deleted', 'Suspended' + */ readonly state?: string; + /** + * Gets the status. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', + * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', + * 'Ignored' + */ readonly status?: string; + /** + * Gets the last execution time. + */ readonly lastExecutionTime?: Date; + /** + * Gets the next execution time. + */ readonly nextExecutionTime?: Date; + /** + * Gets the workflow trigger recurrence. + */ readonly recurrence?: WorkflowTriggerRecurrence; + /** + * Gets the reference to workflow. + */ readonly workflow?: ResourceReference; + /** + * Gets the workflow trigger name. + */ readonly name?: string; + /** + * Gets the workflow trigger type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the WorkflowTriggerFilter class. - * @constructor * The workflow trigger filter. - * - * @member {string} [state] The state of workflow trigger. Possible values - * include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', - * 'Suspended' */ export interface WorkflowTriggerFilter { + /** + * The state of workflow trigger. Possible values include: 'NotSpecified', 'Completed', + * 'Enabled', 'Disabled', 'Deleted', 'Suspended' + */ state?: string; } /** - * @class - * Initializes a new instance of the WorkflowTriggerListCallbackUrlQueries class. - * @constructor * Gets the workflow trigger callback URL query parameters. - * - * @member {string} [apiVersion] The api version. - * @member {string} [sp] The SAS permissions. - * @member {string} [sv] The SAS version. - * @member {string} [sig] The SAS signature. - * @member {string} [se] The SAS timestamp. */ export interface WorkflowTriggerListCallbackUrlQueries { + /** + * The api version. + */ apiVersion?: string; + /** + * The SAS permissions. + */ sp?: string; + /** + * The SAS version. + */ sv?: string; + /** + * The SAS signature. + */ sig?: string; + /** + * The SAS timestamp. + */ se?: string; } /** - * @class - * Initializes a new instance of the WorkflowTriggerCallbackUrl class. - * @constructor * The workflow trigger callback URL. - * - * @member {string} [value] Gets the workflow trigger callback URL. - * @member {string} [method] Gets the workflow trigger callback URL HTTP - * method. - * @member {string} [basePath] Gets the workflow trigger callback URL base - * path. - * @member {string} [relativePath] Gets the workflow trigger callback URL - * relative path. - * @member {array} [relativePathParameters] Gets the workflow trigger callback - * URL relative path parameters. - * @member {object} [queries] Gets the workflow trigger callback URL query - * parameters. - * @member {string} [queries.apiVersion] The api version. - * @member {string} [queries.sp] The SAS permissions. - * @member {string} [queries.sv] The SAS version. - * @member {string} [queries.sig] The SAS signature. - * @member {string} [queries.se] The SAS timestamp. */ export interface WorkflowTriggerCallbackUrl { + /** + * Gets the workflow trigger callback URL. + */ readonly value?: string; + /** + * Gets the workflow trigger callback URL HTTP method. + */ readonly method?: string; + /** + * Gets the workflow trigger callback URL base path. + */ readonly basePath?: string; + /** + * Gets the workflow trigger callback URL relative path. + */ readonly relativePath?: string; + /** + * Gets the workflow trigger callback URL relative path parameters. + */ relativePathParameters?: string[]; + /** + * Gets the workflow trigger callback URL query parameters. + */ queries?: WorkflowTriggerListCallbackUrlQueries; } /** - * @class - * Initializes a new instance of the Correlation class. - * @constructor * The correlation property. - * - * @member {string} [clientTrackingId] The client tracking id. */ export interface Correlation { + /** + * The client tracking id. + */ clientTrackingId?: string; } /** - * @class - * Initializes a new instance of the ContentHash class. - * @constructor * The content hash. - * - * @member {string} [algorithm] The algorithm of the content hash. - * @member {string} [value] The value of the content hash. */ export interface ContentHash { + /** + * The algorithm of the content hash. + */ algorithm?: string; + /** + * The value of the content hash. + */ value?: string; } /** - * @class - * Initializes a new instance of the ContentLink class. - * @constructor * The content link. - * - * @member {string} [uri] The content link URI. - * @member {string} [contentVersion] The content version. - * @member {number} [contentSize] The content size. - * @member {object} [contentHash] The content hash. - * @member {string} [contentHash.algorithm] The algorithm of the content hash. - * @member {string} [contentHash.value] The value of the content hash. - * @member {object} [metadata] The metadata. */ export interface ContentLink { + /** + * The content link URI. + */ uri?: string; + /** + * The content version. + */ contentVersion?: string; + /** + * The content size. + */ contentSize?: number; + /** + * The content hash. + */ contentHash?: ContentHash; + /** + * The metadata. + */ metadata?: any; } /** - * @class - * Initializes a new instance of the WorkflowTriggerHistory class. - * @constructor * The workflow trigger history. - * - * @member {date} [startTime] Gets the start time. - * @member {date} [endTime] Gets the end time. - * @member {string} [status] Gets the status. Possible values include: - * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', - * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', - * 'Ignored' - * @member {string} [code] Gets the code. - * @member {object} [error] Gets the error. - * @member {string} [trackingId] Gets the tracking id. - * @member {object} [correlation] The run correlation. - * @member {string} [correlation.clientTrackingId] The client tracking id. - * @member {object} [inputsLink] Gets the link to input parameters. - * @member {string} [inputsLink.uri] The content link URI. - * @member {string} [inputsLink.contentVersion] The content version. - * @member {number} [inputsLink.contentSize] The content size. - * @member {object} [inputsLink.contentHash] The content hash. - * @member {string} [inputsLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [inputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [inputsLink.metadata] The metadata. - * @member {object} [outputsLink] Gets the link to output parameters. - * @member {string} [outputsLink.uri] The content link URI. - * @member {string} [outputsLink.contentVersion] The content version. - * @member {number} [outputsLink.contentSize] The content size. - * @member {object} [outputsLink.contentHash] The content hash. - * @member {string} [outputsLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [outputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [outputsLink.metadata] The metadata. - * @member {boolean} [fired] Gets a value indicating whether trigger was fired. - * @member {object} [run] Gets the reference to workflow run. - * @member {string} [run.id] The resource id. - * @member {string} [run.name] Gets the resource name. - * @member {string} [run.type] Gets the resource type. - * @member {string} [name] Gets the workflow trigger history name. - * @member {string} [type] Gets the workflow trigger history type. */ export interface WorkflowTriggerHistory extends SubResource { + /** + * Gets the start time. + */ readonly startTime?: Date; + /** + * Gets the end time. + */ readonly endTime?: Date; + /** + * Gets the status. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', + * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', + * 'Ignored' + */ readonly status?: string; + /** + * Gets the code. + */ readonly code?: string; + /** + * Gets the error. + */ readonly error?: any; + /** + * Gets the tracking id. + */ readonly trackingId?: string; + /** + * The run correlation. + */ correlation?: Correlation; + /** + * Gets the link to input parameters. + */ readonly inputsLink?: ContentLink; + /** + * Gets the link to output parameters. + */ readonly outputsLink?: ContentLink; + /** + * Gets a value indicating whether trigger was fired. + */ readonly fired?: boolean; + /** + * Gets the reference to workflow run. + */ readonly run?: ResourceReference; + /** + * Gets the workflow trigger history name. + */ readonly name?: string; + /** + * Gets the workflow trigger history type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the WorkflowTriggerHistoryFilter class. - * @constructor * The workflow trigger history filter. - * - * @member {string} [status] The status of workflow trigger history. Possible - * values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', - * 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', - * 'Aborted', 'Ignored' */ export interface WorkflowTriggerHistoryFilter { + /** + * The status of workflow trigger history. Possible values include: 'NotSpecified', 'Paused', + * 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', + * 'TimedOut', 'Aborted', 'Ignored' + */ status?: string; } /** - * @class - * Initializes a new instance of the WorkflowRunTrigger class. - * @constructor * The workflow run trigger. - * - * @member {string} [name] Gets the name. - * @member {object} [inputs] Gets the inputs. - * @member {object} [inputsLink] Gets the link to inputs. - * @member {string} [inputsLink.uri] The content link URI. - * @member {string} [inputsLink.contentVersion] The content version. - * @member {number} [inputsLink.contentSize] The content size. - * @member {object} [inputsLink.contentHash] The content hash. - * @member {string} [inputsLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [inputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [inputsLink.metadata] The metadata. - * @member {object} [outputs] Gets the outputs. - * @member {object} [outputsLink] Gets the link to outputs. - * @member {string} [outputsLink.uri] The content link URI. - * @member {string} [outputsLink.contentVersion] The content version. - * @member {number} [outputsLink.contentSize] The content size. - * @member {object} [outputsLink.contentHash] The content hash. - * @member {string} [outputsLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [outputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [outputsLink.metadata] The metadata. - * @member {date} [scheduledTime] Gets the scheduled time. - * @member {date} [startTime] Gets the start time. - * @member {date} [endTime] Gets the end time. - * @member {string} [trackingId] Gets the tracking id. - * @member {object} [correlation] The run correlation. - * @member {string} [correlation.clientTrackingId] The client tracking id. - * @member {string} [code] Gets the code. - * @member {string} [status] Gets the status. Possible values include: - * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', - * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', - * 'Ignored' - * @member {object} [error] Gets the error. - * @member {object} [trackedProperties] Gets the tracked properties. */ export interface WorkflowRunTrigger { + /** + * Gets the name. + */ readonly name?: string; + /** + * Gets the inputs. + */ readonly inputs?: any; + /** + * Gets the link to inputs. + */ readonly inputsLink?: ContentLink; + /** + * Gets the outputs. + */ readonly outputs?: any; + /** + * Gets the link to outputs. + */ readonly outputsLink?: ContentLink; + /** + * Gets the scheduled time. + */ readonly scheduledTime?: Date; + /** + * Gets the start time. + */ readonly startTime?: Date; + /** + * Gets the end time. + */ readonly endTime?: Date; + /** + * Gets the tracking id. + */ readonly trackingId?: string; + /** + * The run correlation. + */ correlation?: Correlation; + /** + * Gets the code. + */ readonly code?: string; + /** + * Gets the status. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', + * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', + * 'Ignored' + */ readonly status?: string; + /** + * Gets the error. + */ readonly error?: any; + /** + * Gets the tracked properties. + */ readonly trackedProperties?: any; } /** - * @class - * Initializes a new instance of the WorkflowOutputParameter class. - * @constructor * The workflow output parameter. - * - * @member {object} [error] Gets the error. */ export interface WorkflowOutputParameter extends WorkflowParameter { + /** + * Gets the error. + */ readonly error?: any; } /** - * @class - * Initializes a new instance of the WorkflowRun class. - * @constructor * The workflow run. - * - * @member {date} [waitEndTime] Gets the wait end time. - * @member {date} [startTime] Gets the start time. - * @member {date} [endTime] Gets the end time. - * @member {string} [status] Gets the status. Possible values include: - * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', - * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', - * 'Ignored' - * @member {string} [code] Gets the code. - * @member {object} [error] Gets the error. - * @member {string} [correlationId] Gets the correlation id. - * @member {object} [correlation] The run correlation. - * @member {string} [correlation.clientTrackingId] The client tracking id. - * @member {object} [workflow] Gets the reference to workflow version. - * @member {string} [workflow.id] The resource id. - * @member {string} [workflow.name] Gets the resource name. - * @member {string} [workflow.type] Gets the resource type. - * @member {object} [trigger] Gets the fired trigger. - * @member {string} [trigger.name] Gets the name. - * @member {object} [trigger.inputs] Gets the inputs. - * @member {object} [trigger.inputsLink] Gets the link to inputs. - * @member {string} [trigger.inputsLink.uri] The content link URI. - * @member {string} [trigger.inputsLink.contentVersion] The content version. - * @member {number} [trigger.inputsLink.contentSize] The content size. - * @member {object} [trigger.inputsLink.contentHash] The content hash. - * @member {string} [trigger.inputsLink.contentHash.algorithm] The algorithm of - * the content hash. - * @member {string} [trigger.inputsLink.contentHash.value] The value of the - * content hash. - * @member {object} [trigger.inputsLink.metadata] The metadata. - * @member {object} [trigger.outputs] Gets the outputs. - * @member {object} [trigger.outputsLink] Gets the link to outputs. - * @member {string} [trigger.outputsLink.uri] The content link URI. - * @member {string} [trigger.outputsLink.contentVersion] The content version. - * @member {number} [trigger.outputsLink.contentSize] The content size. - * @member {object} [trigger.outputsLink.contentHash] The content hash. - * @member {string} [trigger.outputsLink.contentHash.algorithm] The algorithm - * of the content hash. - * @member {string} [trigger.outputsLink.contentHash.value] The value of the - * content hash. - * @member {object} [trigger.outputsLink.metadata] The metadata. - * @member {date} [trigger.scheduledTime] Gets the scheduled time. - * @member {date} [trigger.startTime] Gets the start time. - * @member {date} [trigger.endTime] Gets the end time. - * @member {string} [trigger.trackingId] Gets the tracking id. - * @member {object} [trigger.correlation] The run correlation. - * @member {string} [trigger.correlation.clientTrackingId] The client tracking - * id. - * @member {string} [trigger.code] Gets the code. - * @member {string} [trigger.status] Gets the status. Possible values include: - * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', - * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', - * 'Ignored' - * @member {object} [trigger.error] Gets the error. - * @member {object} [trigger.trackedProperties] Gets the tracked properties. - * @member {object} [outputs] Gets the outputs. - * @member {object} [response] Gets the response of the flow run. - * @member {string} [response.name] Gets the name. - * @member {object} [response.inputs] Gets the inputs. - * @member {object} [response.inputsLink] Gets the link to inputs. - * @member {string} [response.inputsLink.uri] The content link URI. - * @member {string} [response.inputsLink.contentVersion] The content version. - * @member {number} [response.inputsLink.contentSize] The content size. - * @member {object} [response.inputsLink.contentHash] The content hash. - * @member {string} [response.inputsLink.contentHash.algorithm] The algorithm - * of the content hash. - * @member {string} [response.inputsLink.contentHash.value] The value of the - * content hash. - * @member {object} [response.inputsLink.metadata] The metadata. - * @member {object} [response.outputs] Gets the outputs. - * @member {object} [response.outputsLink] Gets the link to outputs. - * @member {string} [response.outputsLink.uri] The content link URI. - * @member {string} [response.outputsLink.contentVersion] The content version. - * @member {number} [response.outputsLink.contentSize] The content size. - * @member {object} [response.outputsLink.contentHash] The content hash. - * @member {string} [response.outputsLink.contentHash.algorithm] The algorithm - * of the content hash. - * @member {string} [response.outputsLink.contentHash.value] The value of the - * content hash. - * @member {object} [response.outputsLink.metadata] The metadata. - * @member {date} [response.scheduledTime] Gets the scheduled time. - * @member {date} [response.startTime] Gets the start time. - * @member {date} [response.endTime] Gets the end time. - * @member {string} [response.trackingId] Gets the tracking id. - * @member {object} [response.correlation] The run correlation. - * @member {string} [response.correlation.clientTrackingId] The client tracking - * id. - * @member {string} [response.code] Gets the code. - * @member {string} [response.status] Gets the status. Possible values include: - * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', - * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', - * 'Ignored' - * @member {object} [response.error] Gets the error. - * @member {object} [response.trackedProperties] Gets the tracked properties. - * @member {string} [name] Gets the workflow run name. - * @member {string} [type] Gets the workflow run type. */ export interface WorkflowRun extends SubResource { + /** + * Gets the wait end time. + */ readonly waitEndTime?: Date; + /** + * Gets the start time. + */ readonly startTime?: Date; + /** + * Gets the end time. + */ readonly endTime?: Date; + /** + * Gets the status. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', + * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', + * 'Ignored' + */ readonly status?: string; + /** + * Gets the code. + */ readonly code?: string; + /** + * Gets the error. + */ readonly error?: any; + /** + * Gets the correlation id. + */ readonly correlationId?: string; + /** + * The run correlation. + */ correlation?: Correlation; + /** + * Gets the reference to workflow version. + */ readonly workflow?: ResourceReference; + /** + * Gets the fired trigger. + */ readonly trigger?: WorkflowRunTrigger; + /** + * Gets the outputs. + */ readonly outputs?: { [propertyName: string]: WorkflowOutputParameter }; + /** + * Gets the response of the flow run. + */ readonly response?: WorkflowRunTrigger; + /** + * Gets the workflow run name. + */ readonly name?: string; + /** + * Gets the workflow run type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the WorkflowRunFilter class. - * @constructor * The workflow run filter. - * - * @member {string} [status] The status of workflow run. Possible values - * include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', - * 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', - * 'Aborted', 'Ignored' */ export interface WorkflowRunFilter { + /** + * The status of workflow run. Possible values include: 'NotSpecified', 'Paused', 'Running', + * 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', + * 'Aborted', 'Ignored' + */ status?: string; } /** - * @class - * Initializes a new instance of the ErrorProperties class. - * @constructor - * Error properties indicate why the Logic service was not able to process the - * incoming request. The reason is provided in the error message. - * - * @member {string} [code] Error code. - * @member {string} [message] Error message indicating why the operation - * failed. + * Error properties indicate why the Logic service was not able to process the incoming request. + * The reason is provided in the error message. */ export interface ErrorProperties { + /** + * Error code. + */ code?: string; + /** + * Error message indicating why the operation failed. + */ message?: string; } /** - * @class - * Initializes a new instance of the ErrorResponse class. - * @constructor - * Error response indicates Logic service is not able to process the incoming - * request. The error property contains the error details. - * - * @member {object} [error] The error properties. - * @member {string} [error.code] Error code. - * @member {string} [error.message] Error message indicating why the operation - * failed. + * Error response indicates Logic service is not able to process the incoming request. The error + * property contains the error details. */ export interface ErrorResponse { + /** + * The error properties. + */ error?: ErrorProperties; } /** - * @class - * Initializes a new instance of the RetryHistory class. - * @constructor * The retry history. - * - * @member {date} [startTime] Gets the start time. - * @member {date} [endTime] Gets the end time. - * @member {string} [code] Gets the status code. - * @member {string} [clientRequestId] Gets the client request Id. - * @member {string} [serviceRequestId] Gets the service request Id. - * @member {object} [error] Gets the error response. - * @member {object} [error.error] The error properties. - * @member {string} [error.error.code] Error code. - * @member {string} [error.error.message] Error message indicating why the - * operation failed. */ export interface RetryHistory { + /** + * Gets the start time. + */ startTime?: Date; + /** + * Gets the end time. + */ endTime?: Date; + /** + * Gets the status code. + */ code?: string; + /** + * Gets the client request Id. + */ clientRequestId?: string; + /** + * Gets the service request Id. + */ serviceRequestId?: string; + /** + * Gets the error response. + */ error?: ErrorResponse; } /** - * @class - * Initializes a new instance of the WorkflowRunAction class. - * @constructor * The workflow run action. - * - * @member {date} [startTime] Gets the start time. - * @member {date} [endTime] Gets the end time. - * @member {string} [status] Gets the status. Possible values include: - * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', - * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', - * 'Ignored' - * @member {string} [code] Gets the code. - * @member {object} [error] Gets the error. - * @member {string} [trackingId] Gets the tracking id. - * @member {object} [correlation] The correlation properties. - * @member {string} [correlation.clientTrackingId] The client tracking id. - * @member {object} [inputsLink] Gets the link to inputs. - * @member {string} [inputsLink.uri] The content link URI. - * @member {string} [inputsLink.contentVersion] The content version. - * @member {number} [inputsLink.contentSize] The content size. - * @member {object} [inputsLink.contentHash] The content hash. - * @member {string} [inputsLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [inputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [inputsLink.metadata] The metadata. - * @member {object} [outputsLink] Gets the link to outputs. - * @member {string} [outputsLink.uri] The content link URI. - * @member {string} [outputsLink.contentVersion] The content version. - * @member {number} [outputsLink.contentSize] The content size. - * @member {object} [outputsLink.contentHash] The content hash. - * @member {string} [outputsLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [outputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [outputsLink.metadata] The metadata. - * @member {object} [trackedProperties] Gets the tracked properties. - * @member {array} [retryHistory] Gets the retry histories. - * @member {string} [name] Gets the workflow run action name. - * @member {string} [type] Gets the workflow run action type. */ export interface WorkflowRunAction extends SubResource { + /** + * Gets the start time. + */ readonly startTime?: Date; + /** + * Gets the end time. + */ readonly endTime?: Date; + /** + * Gets the status. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', + * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', + * 'Ignored' + */ readonly status?: string; + /** + * Gets the code. + */ readonly code?: string; + /** + * Gets the error. + */ readonly error?: any; + /** + * Gets the tracking id. + */ readonly trackingId?: string; + /** + * The correlation properties. + */ correlation?: Correlation; + /** + * Gets the link to inputs. + */ readonly inputsLink?: ContentLink; + /** + * Gets the link to outputs. + */ readonly outputsLink?: ContentLink; + /** + * Gets the tracked properties. + */ readonly trackedProperties?: any; + /** + * Gets the retry histories. + */ retryHistory?: RetryHistory[]; + /** + * Gets the workflow run action name. + */ readonly name?: string; + /** + * Gets the workflow run action type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the WorkflowRunActionFilter class. - * @constructor * The workflow run action filter. - * - * @member {string} [status] The status of workflow run action. Possible values - * include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', - * 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', - * 'Aborted', 'Ignored' */ export interface WorkflowRunActionFilter { + /** + * The status of workflow run action. Possible values include: 'NotSpecified', 'Paused', + * 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', + * 'TimedOut', 'Aborted', 'Ignored' + */ status?: string; } /** - * @class - * Initializes a new instance of the RegenerateActionParameter class. - * @constructor * The access key regenerate action content. - * - * @member {string} [keyType] The key type. Possible values include: - * 'NotSpecified', 'Primary', 'Secondary' */ export interface RegenerateActionParameter { + /** + * The key type. Possible values include: 'NotSpecified', 'Primary', 'Secondary' + */ keyType?: string; } /** - * @class - * Initializes a new instance of the GenerateUpgradedDefinitionParameters class. - * @constructor * The parameters to generate upgraded definition. - * - * @member {string} [targetSchemaVersion] The target schema version. */ export interface GenerateUpgradedDefinitionParameters { + /** + * The target schema version. + */ targetSchemaVersion?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountSku class. - * @constructor * The integration account sku. - * - * @member {string} name The sku name. Possible values include: 'NotSpecified', - * 'Free', 'Basic', 'Standard' */ export interface IntegrationAccountSku { + /** + * The sku name. Possible values include: 'NotSpecified', 'Free', 'Basic', 'Standard' + */ name: string; } /** - * @class - * Initializes a new instance of the IntegrationAccount class. - * @constructor * The integration account. - * - * @member {object} [properties] The integration account properties. - * @member {object} [sku] The sku. - * @member {string} [sku.name] The sku name. Possible values include: - * 'NotSpecified', 'Free', 'Basic', 'Standard' */ export interface IntegrationAccount extends Resource { + /** + * The integration account properties. + */ properties?: any; + /** + * The sku. + */ sku?: IntegrationAccountSku; } /** - * @class - * Initializes a new instance of the GetCallbackUrlParameters class. - * @constructor * The callback url parameters. - * - * @member {date} [notAfter] The expiry time. - * @member {string} [keyType] The key type. Possible values include: - * 'NotSpecified', 'Primary', 'Secondary' */ export interface GetCallbackUrlParameters { + /** + * The expiry time. + */ notAfter?: Date; + /** + * The key type. Possible values include: 'NotSpecified', 'Primary', 'Secondary' + */ keyType?: string; } /** - * @class - * Initializes a new instance of the CallbackUrl class. - * @constructor * The callback url. - * - * @member {string} [value] The URL value. */ export interface CallbackUrl { + /** + * The URL value. + */ value?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountSchema class. - * @constructor * The integration account schema. - * - * @member {string} schemaType The schema type. Possible values include: - * 'NotSpecified', 'Xml' - * @member {string} [targetNamespace] The target namespace of the schema. - * @member {string} [documentName] The document name. - * @member {string} [fileName] The file name. - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {object} [metadata] The metadata. - * @member {string} [content] The content. - * @member {string} [contentType] The content type. - * @member {object} [contentLink] The content link. - * @member {string} [contentLink.uri] The content link URI. - * @member {string} [contentLink.contentVersion] The content version. - * @member {number} [contentLink.contentSize] The content size. - * @member {object} [contentLink.contentHash] The content hash. - * @member {string} [contentLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [contentLink.contentHash.value] The value of the content - * hash. - * @member {object} [contentLink.metadata] The metadata. */ export interface IntegrationAccountSchema extends Resource { + /** + * The schema type. Possible values include: 'NotSpecified', 'Xml' + */ schemaType: string; + /** + * The target namespace of the schema. + */ targetNamespace?: string; + /** + * The document name. + */ documentName?: string; + /** + * The file name. + */ fileName?: string; + /** + * The created time. + */ readonly createdTime?: Date; + /** + * The changed time. + */ readonly changedTime?: Date; + /** + * The metadata. + */ metadata?: any; + /** + * The content. + */ content?: string; + /** + * The content type. + */ contentType?: string; + /** + * The content link. + */ readonly contentLink?: ContentLink; } /** - * @class - * Initializes a new instance of the IntegrationAccountSchemaFilter class. - * @constructor * The integration account schema filter for odata query. - * - * @member {string} schemaType The schema type of integration account schema. - * Possible values include: 'NotSpecified', 'Xml' */ export interface IntegrationAccountSchemaFilter { + /** + * The schema type of integration account schema. Possible values include: 'NotSpecified', 'Xml' + */ schemaType: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountMapPropertiesParametersSchema class. - * @constructor * The parameters schema of integration account map. - * - * @member {string} [ref] The reference name. */ export interface IntegrationAccountMapPropertiesParametersSchema { + /** + * The reference name. + */ ref?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountMap class. - * @constructor * The integration account map. - * - * @member {string} mapType The map type. Possible values include: - * 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid' - * @member {object} [parametersSchema] The parameters schema of integration - * account map. - * @member {string} [parametersSchema.ref] The reference name. - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {string} [content] The content. - * @member {string} [contentType] The content type. - * @member {object} [contentLink] The content link. - * @member {string} [contentLink.uri] The content link URI. - * @member {string} [contentLink.contentVersion] The content version. - * @member {number} [contentLink.contentSize] The content size. - * @member {object} [contentLink.contentHash] The content hash. - * @member {string} [contentLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [contentLink.contentHash.value] The value of the content - * hash. - * @member {object} [contentLink.metadata] The metadata. - * @member {object} [metadata] The metadata. */ export interface IntegrationAccountMap extends Resource { + /** + * The map type. Possible values include: 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid' + */ mapType: string; + /** + * The parameters schema of integration account map. + */ parametersSchema?: IntegrationAccountMapPropertiesParametersSchema; + /** + * The created time. + */ readonly createdTime?: Date; + /** + * The changed time. + */ readonly changedTime?: Date; + /** + * The content. + */ content?: string; + /** + * The content type. + */ contentType?: string; + /** + * The content link. + */ readonly contentLink?: ContentLink; + /** + * The metadata. + */ metadata?: any; } /** - * @class - * Initializes a new instance of the IntegrationAccountMapFilter class. - * @constructor * The integration account map filter for odata query. - * - * @member {string} mapType The map type of integration account map. Possible - * values include: 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid' */ export interface IntegrationAccountMapFilter { + /** + * The map type of integration account map. Possible values include: 'NotSpecified', 'Xslt', + * 'Xslt20', 'Xslt30', 'Liquid' + */ mapType: string; } /** - * @class - * Initializes a new instance of the BusinessIdentity class. - * @constructor * The integration account partner's business identity. - * - * @member {string} qualifier The business identity qualifier e.g. as2identity, - * ZZ, ZZZ, 31, 32 - * @member {string} value The user defined business identity value. */ export interface BusinessIdentity { + /** + * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + */ qualifier: string; + /** + * The user defined business identity value. + */ value: string; } /** - * @class - * Initializes a new instance of the B2BPartnerContent class. - * @constructor * The B2B partner content. - * - * @member {array} [businessIdentities] The list of partner business - * identities. */ export interface B2BPartnerContent { + /** + * The list of partner business identities. + */ businessIdentities?: BusinessIdentity[]; } /** - * @class - * Initializes a new instance of the PartnerContent class. - * @constructor * The integration account partner content. - * - * @member {object} [b2b] The B2B partner content. - * @member {array} [b2b.businessIdentities] The list of partner business - * identities. */ export interface PartnerContent { + /** + * The B2B partner content. + */ b2b?: B2BPartnerContent; } /** - * @class - * Initializes a new instance of the IntegrationAccountPartner class. - * @constructor * The integration account partner. - * - * @member {string} partnerType The partner type. Possible values include: - * 'NotSpecified', 'B2B' - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {object} [metadata] The metadata. - * @member {object} content The partner content. - * @member {object} [content.b2b] The B2B partner content. - * @member {array} [content.b2b.businessIdentities] The list of partner - * business identities. */ export interface IntegrationAccountPartner extends Resource { + /** + * The partner type. Possible values include: 'NotSpecified', 'B2B' + */ partnerType: string; + /** + * The created time. + */ readonly createdTime?: Date; + /** + * The changed time. + */ readonly changedTime?: Date; + /** + * The metadata. + */ metadata?: any; + /** + * The partner content. + */ content: PartnerContent; } /** - * @class - * Initializes a new instance of the IntegrationAccountPartnerFilter class. - * @constructor * The integration account partner filter for odata query. - * - * @member {string} partnerType The partner type of integration account - * partner. Possible values include: 'NotSpecified', 'B2B' */ export interface IntegrationAccountPartnerFilter { + /** + * The partner type of integration account partner. Possible values include: 'NotSpecified', + * 'B2B' + */ partnerType: string; } /** - * @class - * Initializes a new instance of the AS2MessageConnectionSettings class. - * @constructor * The AS2 agreement message connection settings. - * - * @member {boolean} ignoreCertificateNameMismatch The value indicating whether - * to ignore mismatch in certificate name. - * @member {boolean} supportHttpStatusCodeContinue The value indicating whether - * to support HTTP status code 'CONTINUE'. - * @member {boolean} keepHttpConnectionAlive The value indicating whether to - * keep the connection alive. - * @member {boolean} unfoldHttpHeaders The value indicating whether to unfold - * the HTTP headers. */ export interface AS2MessageConnectionSettings { + /** + * The value indicating whether to ignore mismatch in certificate name. + */ ignoreCertificateNameMismatch: boolean; + /** + * The value indicating whether to support HTTP status code 'CONTINUE'. + */ supportHttpStatusCodeContinue: boolean; + /** + * The value indicating whether to keep the connection alive. + */ keepHttpConnectionAlive: boolean; + /** + * The value indicating whether to unfold the HTTP headers. + */ unfoldHttpHeaders: boolean; } /** - * @class - * Initializes a new instance of the AS2AcknowledgementConnectionSettings class. - * @constructor * The AS2 agreement acknowledgement connection settings. - * - * @member {boolean} ignoreCertificateNameMismatch The value indicating whether - * to ignore mismatch in certificate name. - * @member {boolean} supportHttpStatusCodeContinue The value indicating whether - * to support HTTP status code 'CONTINUE'. - * @member {boolean} keepHttpConnectionAlive The value indicating whether to - * keep the connection alive. - * @member {boolean} unfoldHttpHeaders The value indicating whether to unfold - * the HTTP headers. */ export interface AS2AcknowledgementConnectionSettings { + /** + * The value indicating whether to ignore mismatch in certificate name. + */ ignoreCertificateNameMismatch: boolean; + /** + * The value indicating whether to support HTTP status code 'CONTINUE'. + */ supportHttpStatusCodeContinue: boolean; + /** + * The value indicating whether to keep the connection alive. + */ keepHttpConnectionAlive: boolean; + /** + * The value indicating whether to unfold the HTTP headers. + */ unfoldHttpHeaders: boolean; } /** - * @class - * Initializes a new instance of the AS2MdnSettings class. - * @constructor * The AS2 agreement mdn settings. - * - * @member {boolean} needMdn The value indicating whether to send or request a - * MDN. - * @member {boolean} signMdn The value indicating whether the MDN needs to be - * signed or not. - * @member {boolean} sendMdnAsynchronously The value indicating whether to send - * the asynchronous MDN. - * @member {string} [receiptDeliveryUrl] The receipt delivery URL. - * @member {string} [dispositionNotificationTo] The disposition notification to - * header value. - * @member {boolean} signOutboundMdnIfOptional The value indicating whether to - * sign the outbound MDN if optional. - * @member {string} [mdnText] The MDN text. - * @member {boolean} sendInboundMdnToMessageBox The value indicating whether to - * send inbound MDN to message box. - * @member {string} micHashingAlgorithm The signing or hashing algorithm. - * Possible values include: 'NotSpecified', 'None', 'MD5', 'SHA1', 'SHA2256', - * 'SHA2384', 'SHA2512' */ export interface AS2MdnSettings { + /** + * The value indicating whether to send or request a MDN. + */ needMdn: boolean; + /** + * The value indicating whether the MDN needs to be signed or not. + */ signMdn: boolean; + /** + * The value indicating whether to send the asynchronous MDN. + */ sendMdnAsynchronously: boolean; + /** + * The receipt delivery URL. + */ receiptDeliveryUrl?: string; + /** + * The disposition notification to header value. + */ dispositionNotificationTo?: string; + /** + * The value indicating whether to sign the outbound MDN if optional. + */ signOutboundMdnIfOptional: boolean; + /** + * The MDN text. + */ mdnText?: string; + /** + * The value indicating whether to send inbound MDN to message box. + */ sendInboundMdnToMessageBox: boolean; + /** + * The signing or hashing algorithm. Possible values include: 'NotSpecified', 'None', 'MD5', + * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' + */ micHashingAlgorithm: string; } /** - * @class - * Initializes a new instance of the AS2SecuritySettings class. - * @constructor * The AS2 agreement security settings. - * - * @member {boolean} overrideGroupSigningCertificate The value indicating - * whether to send or request a MDN. - * @member {string} [signingCertificateName] The name of the signing - * certificate. - * @member {string} [encryptionCertificateName] The name of the encryption - * certificate. - * @member {boolean} enableNrrForInboundEncodedMessages The value indicating - * whether to enable NRR for inbound encoded messages. - * @member {boolean} enableNrrForInboundDecodedMessages The value indicating - * whether to enable NRR for inbound decoded messages. - * @member {boolean} enableNrrForOutboundMdn The value indicating whether to - * enable NRR for outbound MDN. - * @member {boolean} enableNrrForOutboundEncodedMessages The value indicating - * whether to enable NRR for outbound encoded messages. - * @member {boolean} enableNrrForOutboundDecodedMessages The value indicating - * whether to enable NRR for outbound decoded messages. - * @member {boolean} enableNrrForInboundMdn The value indicating whether to - * enable NRR for inbound MDN. - * @member {string} [sha2AlgorithmFormat] The Sha2 algorithm format. Valid - * values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. */ export interface AS2SecuritySettings { + /** + * The value indicating whether to send or request a MDN. + */ overrideGroupSigningCertificate: boolean; + /** + * The name of the signing certificate. + */ signingCertificateName?: string; + /** + * The name of the encryption certificate. + */ encryptionCertificateName?: string; + /** + * The value indicating whether to enable NRR for inbound encoded messages. + */ enableNrrForInboundEncodedMessages: boolean; + /** + * The value indicating whether to enable NRR for inbound decoded messages. + */ enableNrrForInboundDecodedMessages: boolean; + /** + * The value indicating whether to enable NRR for outbound MDN. + */ enableNrrForOutboundMdn: boolean; + /** + * The value indicating whether to enable NRR for outbound encoded messages. + */ enableNrrForOutboundEncodedMessages: boolean; + /** + * The value indicating whether to enable NRR for outbound decoded messages. + */ enableNrrForOutboundDecodedMessages: boolean; + /** + * The value indicating whether to enable NRR for inbound MDN. + */ enableNrrForInboundMdn: boolean; + /** + * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, + * Sha2UnderscoreHashSize. + */ sha2AlgorithmFormat?: string; } /** - * @class - * Initializes a new instance of the AS2ValidationSettings class. - * @constructor * The AS2 agreement validation settings. - * - * @member {boolean} overrideMessageProperties The value indicating whether to - * override incoming message properties with those in agreement. - * @member {boolean} encryptMessage The value indicating whether the message - * has to be encrypted. - * @member {boolean} signMessage The value indicating whether the message has - * to be signed. - * @member {boolean} compressMessage The value indicating whether the message - * has to be compressed. - * @member {boolean} checkDuplicateMessage The value indicating whether to - * check for duplicate message. - * @member {number} interchangeDuplicatesValidityDays The number of days to - * look back for duplicate interchange. - * @member {boolean} checkCertificateRevocationListOnSend The value indicating - * whether to check for certificate revocation list on send. - * @member {boolean} checkCertificateRevocationListOnReceive The value - * indicating whether to check for certificate revocation list on receive. - * @member {string} encryptionAlgorithm The encryption algorithm. Possible - * values include: 'NotSpecified', 'None', 'DES3', 'RC2', 'AES128', 'AES192', - * 'AES256' - * @member {string} [signingAlgorithm] The signing algorithm. Possible values - * include: 'NotSpecified', 'Default', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' */ export interface AS2ValidationSettings { + /** + * The value indicating whether to override incoming message properties with those in agreement. + */ overrideMessageProperties: boolean; + /** + * The value indicating whether the message has to be encrypted. + */ encryptMessage: boolean; + /** + * The value indicating whether the message has to be signed. + */ signMessage: boolean; + /** + * The value indicating whether the message has to be compressed. + */ compressMessage: boolean; + /** + * The value indicating whether to check for duplicate message. + */ checkDuplicateMessage: boolean; + /** + * The number of days to look back for duplicate interchange. + */ interchangeDuplicatesValidityDays: number; + /** + * The value indicating whether to check for certificate revocation list on send. + */ checkCertificateRevocationListOnSend: boolean; + /** + * The value indicating whether to check for certificate revocation list on receive. + */ checkCertificateRevocationListOnReceive: boolean; + /** + * The encryption algorithm. Possible values include: 'NotSpecified', 'None', 'DES3', 'RC2', + * 'AES128', 'AES192', 'AES256' + */ encryptionAlgorithm: string; + /** + * The signing algorithm. Possible values include: 'NotSpecified', 'Default', 'SHA1', 'SHA2256', + * 'SHA2384', 'SHA2512' + */ signingAlgorithm?: string; } /** - * @class - * Initializes a new instance of the AS2EnvelopeSettings class. - * @constructor * The AS2 agreement envelope settings. - * - * @member {string} messageContentType The message content type. - * @member {boolean} transmitFileNameInMimeHeader The value indicating whether - * to transmit file name in mime header. - * @member {string} fileNameTemplate The template for file name. - * @member {boolean} suspendMessageOnFileNameGenerationError The value - * indicating whether to suspend message on file name generation error. - * @member {boolean} autogenerateFileName The value indicating whether to auto - * generate file name. */ export interface AS2EnvelopeSettings { + /** + * The message content type. + */ messageContentType: string; + /** + * The value indicating whether to transmit file name in mime header. + */ transmitFileNameInMimeHeader: boolean; + /** + * The template for file name. + */ fileNameTemplate: string; + /** + * The value indicating whether to suspend message on file name generation error. + */ suspendMessageOnFileNameGenerationError: boolean; + /** + * The value indicating whether to auto generate file name. + */ autogenerateFileName: boolean; } /** - * @class - * Initializes a new instance of the AS2ErrorSettings class. - * @constructor * The AS2 agreement error settings. - * - * @member {boolean} suspendDuplicateMessage The value indicating whether to - * suspend duplicate message. - * @member {boolean} resendIfMdnNotReceived The value indicating whether to - * resend message If MDN is not received. */ export interface AS2ErrorSettings { + /** + * The value indicating whether to suspend duplicate message. + */ suspendDuplicateMessage: boolean; + /** + * The value indicating whether to resend message If MDN is not received. + */ resendIfMdnNotReceived: boolean; } /** - * @class - * Initializes a new instance of the AS2ProtocolSettings class. - * @constructor * The AS2 agreement protocol settings. - * - * @member {object} messageConnectionSettings The message connection settings. - * @member {boolean} [messageConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} [messageConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} [messageConnectionSettings.keepHttpConnectionAlive] The - * value indicating whether to keep the connection alive. - * @member {boolean} [messageConnectionSettings.unfoldHttpHeaders] The value - * indicating whether to unfold the HTTP headers. - * @member {object} acknowledgementConnectionSettings The acknowledgement - * connection settings. - * @member {boolean} - * [acknowledgementConnectionSettings.ignoreCertificateNameMismatch] The value - * indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [acknowledgementConnectionSettings.supportHttpStatusCodeContinue] The value - * indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [acknowledgementConnectionSettings.keepHttpConnectionAlive] The value - * indicating whether to keep the connection alive. - * @member {boolean} [acknowledgementConnectionSettings.unfoldHttpHeaders] The - * value indicating whether to unfold the HTTP headers. - * @member {object} mdnSettings The MDN settings. - * @member {boolean} [mdnSettings.needMdn] The value indicating whether to send - * or request a MDN. - * @member {boolean} [mdnSettings.signMdn] The value indicating whether the MDN - * needs to be signed or not. - * @member {boolean} [mdnSettings.sendMdnAsynchronously] The value indicating - * whether to send the asynchronous MDN. - * @member {string} [mdnSettings.receiptDeliveryUrl] The receipt delivery URL. - * @member {string} [mdnSettings.dispositionNotificationTo] The disposition - * notification to header value. - * @member {boolean} [mdnSettings.signOutboundMdnIfOptional] The value - * indicating whether to sign the outbound MDN if optional. - * @member {string} [mdnSettings.mdnText] The MDN text. - * @member {boolean} [mdnSettings.sendInboundMdnToMessageBox] The value - * indicating whether to send inbound MDN to message box. - * @member {string} [mdnSettings.micHashingAlgorithm] The signing or hashing - * algorithm. Possible values include: 'NotSpecified', 'None', 'MD5', 'SHA1', - * 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} securitySettings The security settings. - * @member {boolean} [securitySettings.overrideGroupSigningCertificate] The - * value indicating whether to send or request a MDN. - * @member {string} [securitySettings.signingCertificateName] The name of the - * signing certificate. - * @member {string} [securitySettings.encryptionCertificateName] The name of - * the encryption certificate. - * @member {boolean} [securitySettings.enableNrrForInboundEncodedMessages] The - * value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} [securitySettings.enableNrrForInboundDecodedMessages] The - * value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} [securitySettings.enableNrrForOutboundMdn] The value - * indicating whether to enable NRR for outbound MDN. - * @member {boolean} [securitySettings.enableNrrForOutboundEncodedMessages] The - * value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} [securitySettings.enableNrrForOutboundDecodedMessages] The - * value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} [securitySettings.enableNrrForInboundMdn] The value - * indicating whether to enable NRR for inbound MDN. - * @member {string} [securitySettings.sha2AlgorithmFormat] The Sha2 algorithm - * format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, - * Sha2UnderscoreHashSize. - * @member {object} validationSettings The validation settings. - * @member {boolean} [validationSettings.overrideMessageProperties] The value - * indicating whether to override incoming message properties with those in - * agreement. - * @member {boolean} [validationSettings.encryptMessage] The value indicating - * whether the message has to be encrypted. - * @member {boolean} [validationSettings.signMessage] The value indicating - * whether the message has to be signed. - * @member {boolean} [validationSettings.compressMessage] The value indicating - * whether the message has to be compressed. - * @member {boolean} [validationSettings.checkDuplicateMessage] The value - * indicating whether to check for duplicate message. - * @member {number} [validationSettings.interchangeDuplicatesValidityDays] The - * number of days to look back for duplicate interchange. - * @member {boolean} [validationSettings.checkCertificateRevocationListOnSend] - * The value indicating whether to check for certificate revocation list on - * send. - * @member {boolean} - * [validationSettings.checkCertificateRevocationListOnReceive] The value - * indicating whether to check for certificate revocation list on receive. - * @member {string} [validationSettings.encryptionAlgorithm] The encryption - * algorithm. Possible values include: 'NotSpecified', 'None', 'DES3', 'RC2', - * 'AES128', 'AES192', 'AES256' - * @member {string} [validationSettings.signingAlgorithm] The signing - * algorithm. Possible values include: 'NotSpecified', 'Default', 'SHA1', - * 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} envelopeSettings The envelope settings. - * @member {string} [envelopeSettings.messageContentType] The message content - * type. - * @member {boolean} [envelopeSettings.transmitFileNameInMimeHeader] The value - * indicating whether to transmit file name in mime header. - * @member {string} [envelopeSettings.fileNameTemplate] The template for file - * name. - * @member {boolean} [envelopeSettings.suspendMessageOnFileNameGenerationError] - * The value indicating whether to suspend message on file name generation - * error. - * @member {boolean} [envelopeSettings.autogenerateFileName] The value - * indicating whether to auto generate file name. - * @member {object} errorSettings The error settings. - * @member {boolean} [errorSettings.suspendDuplicateMessage] The value - * indicating whether to suspend duplicate message. - * @member {boolean} [errorSettings.resendIfMdnNotReceived] The value - * indicating whether to resend message If MDN is not received. */ export interface AS2ProtocolSettings { + /** + * The message connection settings. + */ messageConnectionSettings: AS2MessageConnectionSettings; + /** + * The acknowledgement connection settings. + */ acknowledgementConnectionSettings: AS2AcknowledgementConnectionSettings; + /** + * The MDN settings. + */ mdnSettings: AS2MdnSettings; + /** + * The security settings. + */ securitySettings: AS2SecuritySettings; + /** + * The validation settings. + */ validationSettings: AS2ValidationSettings; + /** + * The envelope settings. + */ envelopeSettings: AS2EnvelopeSettings; + /** + * The error settings. + */ errorSettings: AS2ErrorSettings; } /** - * @class - * Initializes a new instance of the AS2OneWayAgreement class. - * @constructor * The integration account AS2 one-way agreement. - * - * @member {object} senderBusinessIdentity The sender business identity - * @member {string} [senderBusinessIdentity.qualifier] The business identity - * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [senderBusinessIdentity.value] The user defined business - * identity value. - * @member {object} receiverBusinessIdentity The receiver business identity - * @member {string} [receiverBusinessIdentity.qualifier] The business identity - * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiverBusinessIdentity.value] The user defined business - * identity value. - * @member {object} protocolSettings The AS2 protocol settings. - * @member {object} [protocolSettings.messageConnectionSettings] The message - * connection settings. - * @member {boolean} - * [protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] The - * value indicating whether to keep the connection alive. - * @member {boolean} - * [protocolSettings.messageConnectionSettings.unfoldHttpHeaders] The value - * indicating whether to unfold the HTTP headers. - * @member {object} [protocolSettings.acknowledgementConnectionSettings] The - * acknowledgement connection settings. - * @member {boolean} - * [protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] The - * value indicating whether to unfold the HTTP headers. - * @member {object} [protocolSettings.mdnSettings] The MDN settings. - * @member {boolean} [protocolSettings.mdnSettings.needMdn] The value - * indicating whether to send or request a MDN. - * @member {boolean} [protocolSettings.mdnSettings.signMdn] The value - * indicating whether the MDN needs to be signed or not. - * @member {boolean} [protocolSettings.mdnSettings.sendMdnAsynchronously] The - * value indicating whether to send the asynchronous MDN. - * @member {string} [protocolSettings.mdnSettings.receiptDeliveryUrl] The - * receipt delivery URL. - * @member {string} [protocolSettings.mdnSettings.dispositionNotificationTo] - * The disposition notification to header value. - * @member {boolean} [protocolSettings.mdnSettings.signOutboundMdnIfOptional] - * The value indicating whether to sign the outbound MDN if optional. - * @member {string} [protocolSettings.mdnSettings.mdnText] The MDN text. - * @member {boolean} [protocolSettings.mdnSettings.sendInboundMdnToMessageBox] - * The value indicating whether to send inbound MDN to message box. - * @member {string} [protocolSettings.mdnSettings.micHashingAlgorithm] The - * signing or hashing algorithm. Possible values include: 'NotSpecified', - * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [protocolSettings.securitySettings] The security settings. - * @member {boolean} - * [protocolSettings.securitySettings.overrideGroupSigningCertificate] The - * value indicating whether to send or request a MDN. - * @member {string} [protocolSettings.securitySettings.signingCertificateName] - * The name of the signing certificate. - * @member {string} - * [protocolSettings.securitySettings.encryptionCertificateName] The name of - * the encryption certificate. - * @member {boolean} - * [protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] The - * value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} - * [protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] The - * value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} - * [protocolSettings.securitySettings.enableNrrForOutboundMdn] The value - * indicating whether to enable NRR for outbound MDN. - * @member {boolean} - * [protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] The - * value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} - * [protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] The - * value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} [protocolSettings.securitySettings.enableNrrForInboundMdn] - * The value indicating whether to enable NRR for inbound MDN. - * @member {string} [protocolSettings.securitySettings.sha2AlgorithmFormat] The - * Sha2 algorithm format. Valid values are Sha2, ShaHashSize, - * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} [protocolSettings.validationSettings] The validation - * settings. - * @member {boolean} - * [protocolSettings.validationSettings.overrideMessageProperties] The value - * indicating whether to override incoming message properties with those in - * agreement. - * @member {boolean} [protocolSettings.validationSettings.encryptMessage] The - * value indicating whether the message has to be encrypted. - * @member {boolean} [protocolSettings.validationSettings.signMessage] The - * value indicating whether the message has to be signed. - * @member {boolean} [protocolSettings.validationSettings.compressMessage] The - * value indicating whether the message has to be compressed. - * @member {boolean} - * [protocolSettings.validationSettings.checkDuplicateMessage] The value - * indicating whether to check for duplicate message. - * @member {number} - * [protocolSettings.validationSettings.interchangeDuplicatesValidityDays] The - * number of days to look back for duplicate interchange. - * @member {boolean} - * [protocolSettings.validationSettings.checkCertificateRevocationListOnSend] - * The value indicating whether to check for certificate revocation list on - * send. - * @member {boolean} - * [protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] - * The value indicating whether to check for certificate revocation list on - * receive. - * @member {string} [protocolSettings.validationSettings.encryptionAlgorithm] - * The encryption algorithm. Possible values include: 'NotSpecified', 'None', - * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} [protocolSettings.validationSettings.signingAlgorithm] The - * signing algorithm. Possible values include: 'NotSpecified', 'Default', - * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [protocolSettings.envelopeSettings] The envelope settings. - * @member {string} [protocolSettings.envelopeSettings.messageContentType] The - * message content type. - * @member {boolean} - * [protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] The value - * indicating whether to transmit file name in mime header. - * @member {string} [protocolSettings.envelopeSettings.fileNameTemplate] The - * template for file name. - * @member {boolean} - * [protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] - * The value indicating whether to suspend message on file name generation - * error. - * @member {boolean} [protocolSettings.envelopeSettings.autogenerateFileName] - * The value indicating whether to auto generate file name. - * @member {object} [protocolSettings.errorSettings] The error settings. - * @member {boolean} [protocolSettings.errorSettings.suspendDuplicateMessage] - * The value indicating whether to suspend duplicate message. - * @member {boolean} [protocolSettings.errorSettings.resendIfMdnNotReceived] - * The value indicating whether to resend message If MDN is not received. */ export interface AS2OneWayAgreement { + /** + * The sender business identity + */ senderBusinessIdentity: BusinessIdentity; + /** + * The receiver business identity + */ receiverBusinessIdentity: BusinessIdentity; + /** + * The AS2 protocol settings. + */ protocolSettings: AS2ProtocolSettings; } /** - * @class - * Initializes a new instance of the AS2AgreementContent class. - * @constructor * The integration account AS2 agreement content. - * - * @member {object} receiveAgreement The AS2 one-way receive agreement. - * @member {object} [receiveAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [receiveAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [receiveAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [receiveAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [receiveAgreement.protocolSettings] The AS2 protocol - * settings. - * @member {object} - * [receiveAgreement.protocolSettings.messageConnectionSettings] The message - * connection settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [receiveAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [receiveAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [receiveAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} - * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings] The - * acknowledgement connection settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} [receiveAgreement.protocolSettings.mdnSettings] The MDN - * settings. - * @member {boolean} [receiveAgreement.protocolSettings.mdnSettings.needMdn] - * The value indicating whether to send or request a MDN. - * @member {boolean} [receiveAgreement.protocolSettings.mdnSettings.signMdn] - * The value indicating whether the MDN needs to be signed or not. - * @member {boolean} - * [receiveAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] The - * value indicating whether to send the asynchronous MDN. - * @member {string} - * [receiveAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The - * receipt delivery URL. - * @member {string} - * [receiveAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] - * The disposition notification to header value. - * @member {boolean} - * [receiveAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] - * The value indicating whether to sign the outbound MDN if optional. - * @member {string} [receiveAgreement.protocolSettings.mdnSettings.mdnText] The - * MDN text. - * @member {boolean} - * [receiveAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] - * The value indicating whether to send inbound MDN to message box. - * @member {string} - * [receiveAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The - * signing or hashing algorithm. Possible values include: 'NotSpecified', - * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [receiveAgreement.protocolSettings.securitySettings] The - * security settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] - * The value indicating whether to send or request a MDN. - * @member {string} - * [receiveAgreement.protocolSettings.securitySettings.signingCertificateName] - * The name of the signing certificate. - * @member {string} - * [receiveAgreement.protocolSettings.securitySettings.encryptionCertificateName] - * The name of the encryption certificate. - * @member {boolean} - * [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] - * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} - * [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] - * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} - * [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] - * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} - * [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] - * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} - * [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] - * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} - * [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] - * The value indicating whether to enable NRR for inbound MDN. - * @member {string} - * [receiveAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] The - * Sha2 algorithm format. Valid values are Sha2, ShaHashSize, - * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} [receiveAgreement.protocolSettings.validationSettings] The - * validation settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.overrideMessageProperties] - * The value indicating whether to override incoming message properties with - * those in agreement. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.encryptMessage] The - * value indicating whether the message has to be encrypted. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.signMessage] The value - * indicating whether the message has to be signed. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.compressMessage] The - * value indicating whether the message has to be compressed. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateMessage] - * The value indicating whether to check for duplicate message. - * @member {number} - * [receiveAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] - * The number of days to look back for duplicate interchange. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] - * The value indicating whether to check for certificate revocation list on - * send. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] - * The value indicating whether to check for certificate revocation list on - * receive. - * @member {string} - * [receiveAgreement.protocolSettings.validationSettings.encryptionAlgorithm] - * The encryption algorithm. Possible values include: 'NotSpecified', 'None', - * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} - * [receiveAgreement.protocolSettings.validationSettings.signingAlgorithm] The - * signing algorithm. Possible values include: 'NotSpecified', 'Default', - * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [receiveAgreement.protocolSettings.envelopeSettings] The - * envelope settings. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.messageContentType] The - * message content type. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] - * The value indicating whether to transmit file name in mime header. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.fileNameTemplate] The - * template for file name. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] - * The value indicating whether to suspend message on file name generation - * error. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.autogenerateFileName] - * The value indicating whether to auto generate file name. - * @member {object} [receiveAgreement.protocolSettings.errorSettings] The error - * settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] - * The value indicating whether to suspend duplicate message. - * @member {boolean} - * [receiveAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] The - * value indicating whether to resend message If MDN is not received. - * @member {object} sendAgreement The AS2 one-way send agreement. - * @member {object} [sendAgreement.senderBusinessIdentity] The sender business - * identity - * @member {string} [sendAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [sendAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [sendAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [sendAgreement.protocolSettings] The AS2 protocol settings. - * @member {object} [sendAgreement.protocolSettings.messageConnectionSettings] - * The message connection settings. - * @member {boolean} - * [sendAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [sendAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [sendAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [sendAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} - * [sendAgreement.protocolSettings.acknowledgementConnectionSettings] The - * acknowledgement connection settings. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} [sendAgreement.protocolSettings.mdnSettings] The MDN - * settings. - * @member {boolean} [sendAgreement.protocolSettings.mdnSettings.needMdn] The - * value indicating whether to send or request a MDN. - * @member {boolean} [sendAgreement.protocolSettings.mdnSettings.signMdn] The - * value indicating whether the MDN needs to be signed or not. - * @member {boolean} - * [sendAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] The value - * indicating whether to send the asynchronous MDN. - * @member {string} - * [sendAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The receipt - * delivery URL. - * @member {string} - * [sendAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] The - * disposition notification to header value. - * @member {boolean} - * [sendAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] The - * value indicating whether to sign the outbound MDN if optional. - * @member {string} [sendAgreement.protocolSettings.mdnSettings.mdnText] The - * MDN text. - * @member {boolean} - * [sendAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] The - * value indicating whether to send inbound MDN to message box. - * @member {string} - * [sendAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The signing - * or hashing algorithm. Possible values include: 'NotSpecified', 'None', - * 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [sendAgreement.protocolSettings.securitySettings] The - * security settings. - * @member {boolean} - * [sendAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] - * The value indicating whether to send or request a MDN. - * @member {string} - * [sendAgreement.protocolSettings.securitySettings.signingCertificateName] The - * name of the signing certificate. - * @member {string} - * [sendAgreement.protocolSettings.securitySettings.encryptionCertificateName] - * The name of the encryption certificate. - * @member {boolean} - * [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] - * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} - * [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] - * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} - * [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] - * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} - * [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] - * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} - * [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] - * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} - * [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] The - * value indicating whether to enable NRR for inbound MDN. - * @member {string} - * [sendAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] The - * Sha2 algorithm format. Valid values are Sha2, ShaHashSize, - * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} [sendAgreement.protocolSettings.validationSettings] The - * validation settings. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.overrideMessageProperties] - * The value indicating whether to override incoming message properties with - * those in agreement. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.encryptMessage] The value - * indicating whether the message has to be encrypted. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.signMessage] The value - * indicating whether the message has to be signed. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.compressMessage] The - * value indicating whether the message has to be compressed. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.checkDuplicateMessage] - * The value indicating whether to check for duplicate message. - * @member {number} - * [sendAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] - * The number of days to look back for duplicate interchange. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] - * The value indicating whether to check for certificate revocation list on - * send. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] - * The value indicating whether to check for certificate revocation list on - * receive. - * @member {string} - * [sendAgreement.protocolSettings.validationSettings.encryptionAlgorithm] The - * encryption algorithm. Possible values include: 'NotSpecified', 'None', - * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} - * [sendAgreement.protocolSettings.validationSettings.signingAlgorithm] The - * signing algorithm. Possible values include: 'NotSpecified', 'Default', - * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [sendAgreement.protocolSettings.envelopeSettings] The - * envelope settings. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.messageContentType] The - * message content type. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] - * The value indicating whether to transmit file name in mime header. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.fileNameTemplate] The - * template for file name. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] - * The value indicating whether to suspend message on file name generation - * error. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.autogenerateFileName] The - * value indicating whether to auto generate file name. - * @member {object} [sendAgreement.protocolSettings.errorSettings] The error - * settings. - * @member {boolean} - * [sendAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] The - * value indicating whether to suspend duplicate message. - * @member {boolean} - * [sendAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] The - * value indicating whether to resend message If MDN is not received. */ export interface AS2AgreementContent { + /** + * The AS2 one-way receive agreement. + */ receiveAgreement: AS2OneWayAgreement; + /** + * The AS2 one-way send agreement. + */ sendAgreement: AS2OneWayAgreement; } /** - * @class - * Initializes a new instance of the X12ValidationSettings class. - * @constructor * The X12 agreement validation settings. - * - * @member {boolean} validateCharacterSet The value indicating whether to - * validate character set in the message. - * @member {boolean} checkDuplicateInterchangeControlNumber The value - * indicating whether to check for duplicate interchange control number. - * @member {number} interchangeControlNumberValidityDays The validity period of - * interchange control number. - * @member {boolean} checkDuplicateGroupControlNumber The value indicating - * whether to check for duplicate group control number. - * @member {boolean} checkDuplicateTransactionSetControlNumber The value - * indicating whether to check for duplicate transaction set control number. - * @member {boolean} validateEdiTypes The value indicating whether to Whether - * to validate EDI types. - * @member {boolean} validateXsdTypes The value indicating whether to Whether - * to validate XSD types. - * @member {boolean} allowLeadingAndTrailingSpacesAndZeroes The value - * indicating whether to allow leading and trailing spaces and zeroes. - * @member {boolean} trimLeadingAndTrailingSpacesAndZeroes The value indicating - * whether to trim leading and trailing spaces and zeroes. - * @member {string} trailingSeparatorPolicy The trailing separator policy. - * Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', - * 'Mandatory' */ export interface X12ValidationSettings { + /** + * The value indicating whether to validate character set in the message. + */ validateCharacterSet: boolean; + /** + * The value indicating whether to check for duplicate interchange control number. + */ checkDuplicateInterchangeControlNumber: boolean; + /** + * The validity period of interchange control number. + */ interchangeControlNumberValidityDays: number; + /** + * The value indicating whether to check for duplicate group control number. + */ checkDuplicateGroupControlNumber: boolean; + /** + * The value indicating whether to check for duplicate transaction set control number. + */ checkDuplicateTransactionSetControlNumber: boolean; + /** + * The value indicating whether to Whether to validate EDI types. + */ validateEdiTypes: boolean; + /** + * The value indicating whether to Whether to validate XSD types. + */ validateXsdTypes: boolean; + /** + * The value indicating whether to allow leading and trailing spaces and zeroes. + */ allowLeadingAndTrailingSpacesAndZeroes: boolean; + /** + * The value indicating whether to trim leading and trailing spaces and zeroes. + */ trimLeadingAndTrailingSpacesAndZeroes: boolean; + /** + * The trailing separator policy. Possible values include: 'NotSpecified', 'NotAllowed', + * 'Optional', 'Mandatory' + */ trailingSeparatorPolicy: string; } /** - * @class - * Initializes a new instance of the X12FramingSettings class. - * @constructor * The X12 agreement framing settings. - * - * @member {number} dataElementSeparator The data element separator. - * @member {number} componentSeparator The component separator. - * @member {boolean} replaceSeparatorsInPayload The value indicating whether to - * replace separators in payload. - * @member {number} replaceCharacter The replacement character. - * @member {number} segmentTerminator The segment terminator. - * @member {string} characterSet The X12 character set. Possible values - * include: 'NotSpecified', 'Basic', 'Extended', 'UTF8' - * @member {string} segmentTerminatorSuffix The segment terminator suffix. - * Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' */ export interface X12FramingSettings { + /** + * The data element separator. + */ dataElementSeparator: number; + /** + * The component separator. + */ componentSeparator: number; + /** + * The value indicating whether to replace separators in payload. + */ replaceSeparatorsInPayload: boolean; + /** + * The replacement character. + */ replaceCharacter: number; + /** + * The segment terminator. + */ segmentTerminator: number; + /** + * The X12 character set. Possible values include: 'NotSpecified', 'Basic', 'Extended', 'UTF8' + */ characterSet: string; + /** + * The segment terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', 'LF', + * 'CRLF' + */ segmentTerminatorSuffix: string; } /** - * @class - * Initializes a new instance of the X12EnvelopeSettings class. - * @constructor * The X12 agreement envelope settings. - * - * @member {number} controlStandardsId The controls standards id. - * @member {boolean} useControlStandardsIdAsRepetitionCharacter The value - * indicating whether to use control standards id as repetition character. - * @member {string} senderApplicationId The sender application id. - * @member {string} receiverApplicationId The receiver application id. - * @member {string} controlVersionNumber The control version number. - * @member {number} interchangeControlNumberLowerBound The interchange control - * number lower bound. - * @member {number} interchangeControlNumberUpperBound The interchange control - * number upper bound. - * @member {boolean} rolloverInterchangeControlNumber The value indicating - * whether to rollover interchange control number. - * @member {boolean} enableDefaultGroupHeaders The value indicating whether to - * enable default group headers. - * @member {string} [functionalGroupId] The functional group id. - * @member {number} groupControlNumberLowerBound The group control number lower - * bound. - * @member {number} groupControlNumberUpperBound The group control number upper - * bound. - * @member {boolean} rolloverGroupControlNumber The value indicating whether to - * rollover group control number. - * @member {string} groupHeaderAgencyCode The group header agency code. - * @member {string} groupHeaderVersion The group header version. - * @member {number} transactionSetControlNumberLowerBound The transaction set - * control number lower bound. - * @member {number} transactionSetControlNumberUpperBound The transaction set - * control number upper bound. - * @member {boolean} rolloverTransactionSetControlNumber The value indicating - * whether to rollover transaction set control number. - * @member {string} [transactionSetControlNumberPrefix] The transaction set - * control number prefix. - * @member {string} [transactionSetControlNumberSuffix] The transaction set - * control number suffix. - * @member {boolean} overwriteExistingTransactionSetControlNumber The value - * indicating whether to overwrite existing transaction set control number. - * @member {string} groupHeaderDateFormat The group header date format. - * Possible values include: 'NotSpecified', 'CCYYMMDD', 'YYMMDD' - * @member {string} groupHeaderTimeFormat The group header time format. - * Possible values include: 'NotSpecified', 'HHMM', 'HHMMSS', 'HHMMSSdd', - * 'HHMMSSd' - * @member {string} usageIndicator The usage indicator. Possible values - * include: 'NotSpecified', 'Test', 'Information', 'Production' */ export interface X12EnvelopeSettings { + /** + * The controls standards id. + */ controlStandardsId: number; + /** + * The value indicating whether to use control standards id as repetition character. + */ useControlStandardsIdAsRepetitionCharacter: boolean; + /** + * The sender application id. + */ senderApplicationId: string; + /** + * The receiver application id. + */ receiverApplicationId: string; + /** + * The control version number. + */ controlVersionNumber: string; + /** + * The interchange control number lower bound. + */ interchangeControlNumberLowerBound: number; + /** + * The interchange control number upper bound. + */ interchangeControlNumberUpperBound: number; + /** + * The value indicating whether to rollover interchange control number. + */ rolloverInterchangeControlNumber: boolean; + /** + * The value indicating whether to enable default group headers. + */ enableDefaultGroupHeaders: boolean; + /** + * The functional group id. + */ functionalGroupId?: string; + /** + * The group control number lower bound. + */ groupControlNumberLowerBound: number; + /** + * The group control number upper bound. + */ groupControlNumberUpperBound: number; + /** + * The value indicating whether to rollover group control number. + */ rolloverGroupControlNumber: boolean; + /** + * The group header agency code. + */ groupHeaderAgencyCode: string; + /** + * The group header version. + */ groupHeaderVersion: string; + /** + * The transaction set control number lower bound. + */ transactionSetControlNumberLowerBound: number; + /** + * The transaction set control number upper bound. + */ transactionSetControlNumberUpperBound: number; + /** + * The value indicating whether to rollover transaction set control number. + */ rolloverTransactionSetControlNumber: boolean; + /** + * The transaction set control number prefix. + */ transactionSetControlNumberPrefix?: string; + /** + * The transaction set control number suffix. + */ transactionSetControlNumberSuffix?: string; + /** + * The value indicating whether to overwrite existing transaction set control number. + */ overwriteExistingTransactionSetControlNumber: boolean; + /** + * The group header date format. Possible values include: 'NotSpecified', 'CCYYMMDD', 'YYMMDD' + */ groupHeaderDateFormat: string; + /** + * The group header time format. Possible values include: 'NotSpecified', 'HHMM', 'HHMMSS', + * 'HHMMSSdd', 'HHMMSSd' + */ groupHeaderTimeFormat: string; + /** + * The usage indicator. Possible values include: 'NotSpecified', 'Test', 'Information', + * 'Production' + */ usageIndicator: string; } /** - * @class - * Initializes a new instance of the X12AcknowledgementSettings class. - * @constructor * The X12 agreement acknowledgement settings. - * - * @member {boolean} needTechnicalAcknowledgement The value indicating whether - * technical acknowledgement is needed. - * @member {boolean} batchTechnicalAcknowledgements The value indicating - * whether to batch the technical acknowledgements. - * @member {boolean} needFunctionalAcknowledgement The value indicating whether - * functional acknowledgement is needed. - * @member {string} [functionalAcknowledgementVersion] The functional - * acknowledgement version. - * @member {boolean} batchFunctionalAcknowledgements The value indicating - * whether to batch functional acknowledgements. - * @member {boolean} needImplementationAcknowledgement The value indicating - * whether implementation acknowledgement is needed. - * @member {string} [implementationAcknowledgementVersion] The implementation - * acknowledgement version. - * @member {boolean} batchImplementationAcknowledgements The value indicating - * whether to batch implementation acknowledgements. - * @member {boolean} needLoopForValidMessages The value indicating whether a - * loop is needed for valid messages. - * @member {boolean} sendSynchronousAcknowledgement The value indicating - * whether to send synchronous acknowledgement. - * @member {string} [acknowledgementControlNumberPrefix] The acknowledgement - * control number prefix. - * @member {string} [acknowledgementControlNumberSuffix] The acknowledgement - * control number suffix. - * @member {number} acknowledgementControlNumberLowerBound The acknowledgement - * control number lower bound. - * @member {number} acknowledgementControlNumberUpperBound The acknowledgement - * control number upper bound. - * @member {boolean} rolloverAcknowledgementControlNumber The value indicating - * whether to rollover acknowledgement control number. */ export interface X12AcknowledgementSettings { + /** + * The value indicating whether technical acknowledgement is needed. + */ needTechnicalAcknowledgement: boolean; + /** + * The value indicating whether to batch the technical acknowledgements. + */ batchTechnicalAcknowledgements: boolean; + /** + * The value indicating whether functional acknowledgement is needed. + */ needFunctionalAcknowledgement: boolean; + /** + * The functional acknowledgement version. + */ functionalAcknowledgementVersion?: string; + /** + * The value indicating whether to batch functional acknowledgements. + */ batchFunctionalAcknowledgements: boolean; + /** + * The value indicating whether implementation acknowledgement is needed. + */ needImplementationAcknowledgement: boolean; + /** + * The implementation acknowledgement version. + */ implementationAcknowledgementVersion?: string; + /** + * The value indicating whether to batch implementation acknowledgements. + */ batchImplementationAcknowledgements: boolean; + /** + * The value indicating whether a loop is needed for valid messages. + */ needLoopForValidMessages: boolean; + /** + * The value indicating whether to send synchronous acknowledgement. + */ sendSynchronousAcknowledgement: boolean; + /** + * The acknowledgement control number prefix. + */ acknowledgementControlNumberPrefix?: string; + /** + * The acknowledgement control number suffix. + */ acknowledgementControlNumberSuffix?: string; + /** + * The acknowledgement control number lower bound. + */ acknowledgementControlNumberLowerBound: number; + /** + * The acknowledgement control number upper bound. + */ acknowledgementControlNumberUpperBound: number; + /** + * The value indicating whether to rollover acknowledgement control number. + */ rolloverAcknowledgementControlNumber: boolean; } /** - * @class - * Initializes a new instance of the X12MessageFilter class. - * @constructor * The X12 message filter for odata query. - * - * @member {string} messageFilterType The message filter type. Possible values - * include: 'NotSpecified', 'Include', 'Exclude' */ export interface X12MessageFilter { + /** + * The message filter type. Possible values include: 'NotSpecified', 'Include', 'Exclude' + */ messageFilterType: string; } /** - * @class - * Initializes a new instance of the X12SecuritySettings class. - * @constructor * The X12 agreement security settings. - * - * @member {string} authorizationQualifier The authorization qualifier. - * @member {string} [authorizationValue] The authorization value. - * @member {string} securityQualifier The security qualifier. - * @member {string} [passwordValue] The password value. */ export interface X12SecuritySettings { + /** + * The authorization qualifier. + */ authorizationQualifier: string; + /** + * The authorization value. + */ authorizationValue?: string; + /** + * The security qualifier. + */ securityQualifier: string; + /** + * The password value. + */ passwordValue?: string; } /** - * @class - * Initializes a new instance of the X12ProcessingSettings class. - * @constructor * The X12 processing settings. - * - * @member {boolean} maskSecurityInfo The value indicating whether to mask - * security information. - * @member {boolean} convertImpliedDecimal The value indicating whether to - * convert numerical type to implied decimal. - * @member {boolean} preserveInterchange The value indicating whether to - * preserve interchange. - * @member {boolean} suspendInterchangeOnError The value indicating whether to - * suspend interchange on error. - * @member {boolean} createEmptyXmlTagsForTrailingSeparators The value - * indicating whether to create empty xml tags for trailing separators. - * @member {boolean} useDotAsDecimalSeparator The value indicating whether to - * use dot as decimal separator. */ export interface X12ProcessingSettings { + /** + * The value indicating whether to mask security information. + */ maskSecurityInfo: boolean; + /** + * The value indicating whether to convert numerical type to implied decimal. + */ convertImpliedDecimal: boolean; + /** + * The value indicating whether to preserve interchange. + */ preserveInterchange: boolean; + /** + * The value indicating whether to suspend interchange on error. + */ suspendInterchangeOnError: boolean; + /** + * The value indicating whether to create empty xml tags for trailing separators. + */ createEmptyXmlTagsForTrailingSeparators: boolean; + /** + * The value indicating whether to use dot as decimal separator. + */ useDotAsDecimalSeparator: boolean; } /** - * @class - * Initializes a new instance of the X12EnvelopeOverride class. - * @constructor * The X12 envelope override settings. - * - * @member {string} targetNamespace The target namespace on which this envelope - * settings has to be applied. - * @member {string} protocolVersion The protocol version on which this envelope - * settings has to be applied. - * @member {string} messageId The message id on which this envelope settings - * has to be applied. - * @member {string} responsibleAgencyCode The responsible agency code. - * @member {string} headerVersion The header version. - * @member {string} senderApplicationId The sender application id. - * @member {string} receiverApplicationId The receiver application id. - * @member {string} [functionalIdentifierCode] The functional identifier code. - * @member {string} dateFormat The date format. Possible values include: - * 'NotSpecified', 'CCYYMMDD', 'YYMMDD' - * @member {string} timeFormat The time format. Possible values include: - * 'NotSpecified', 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' */ export interface X12EnvelopeOverride { + /** + * The target namespace on which this envelope settings has to be applied. + */ targetNamespace: string; + /** + * The protocol version on which this envelope settings has to be applied. + */ protocolVersion: string; + /** + * The message id on which this envelope settings has to be applied. + */ messageId: string; + /** + * The responsible agency code. + */ responsibleAgencyCode: string; + /** + * The header version. + */ headerVersion: string; + /** + * The sender application id. + */ senderApplicationId: string; + /** + * The receiver application id. + */ receiverApplicationId: string; + /** + * The functional identifier code. + */ functionalIdentifierCode?: string; + /** + * The date format. Possible values include: 'NotSpecified', 'CCYYMMDD', 'YYMMDD' + */ dateFormat: string; + /** + * The time format. Possible values include: 'NotSpecified', 'HHMM', 'HHMMSS', 'HHMMSSdd', + * 'HHMMSSd' + */ timeFormat: string; } /** - * @class - * Initializes a new instance of the X12ValidationOverride class. - * @constructor * The X12 validation override settings. - * - * @member {string} messageId The message id on which the validation settings - * has to be applied. - * @member {boolean} validateEdiTypes The value indicating whether to validate - * EDI types. - * @member {boolean} validateXsdTypes The value indicating whether to validate - * XSD types. - * @member {boolean} allowLeadingAndTrailingSpacesAndZeroes The value - * indicating whether to allow leading and trailing spaces and zeroes. - * @member {boolean} validateCharacterSet The value indicating whether to - * validate character Set. - * @member {boolean} trimLeadingAndTrailingSpacesAndZeroes The value indicating - * whether to trim leading and trailing spaces and zeroes. - * @member {string} trailingSeparatorPolicy The trailing separator policy. - * Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', - * 'Mandatory' */ export interface X12ValidationOverride { + /** + * The message id on which the validation settings has to be applied. + */ messageId: string; + /** + * The value indicating whether to validate EDI types. + */ validateEdiTypes: boolean; + /** + * The value indicating whether to validate XSD types. + */ validateXsdTypes: boolean; + /** + * The value indicating whether to allow leading and trailing spaces and zeroes. + */ allowLeadingAndTrailingSpacesAndZeroes: boolean; + /** + * The value indicating whether to validate character Set. + */ validateCharacterSet: boolean; + /** + * The value indicating whether to trim leading and trailing spaces and zeroes. + */ trimLeadingAndTrailingSpacesAndZeroes: boolean; + /** + * The trailing separator policy. Possible values include: 'NotSpecified', 'NotAllowed', + * 'Optional', 'Mandatory' + */ trailingSeparatorPolicy: string; } /** - * @class - * Initializes a new instance of the X12MessageIdentifier class. - * @constructor * The X12 message identifier. - * - * @member {string} messageId The message id. */ export interface X12MessageIdentifier { + /** + * The message id. + */ messageId: string; } /** - * @class - * Initializes a new instance of the X12SchemaReference class. - * @constructor * The X12 schema reference. - * - * @member {string} messageId The message id. - * @member {string} [senderApplicationId] The sender application id. - * @member {string} schemaVersion The schema version. - * @member {string} schemaName The schema name. */ export interface X12SchemaReference { + /** + * The message id. + */ messageId: string; + /** + * The sender application id. + */ senderApplicationId?: string; + /** + * The schema version. + */ schemaVersion: string; + /** + * The schema name. + */ schemaName: string; } /** - * @class - * Initializes a new instance of the X12DelimiterOverrides class. - * @constructor * The X12 delimiter override settings. - * - * @member {string} [protocolVersion] The protocol version. - * @member {string} [messageId] The message id. - * @member {number} dataElementSeparator The data element separator. - * @member {number} componentSeparator The component separator. - * @member {number} segmentTerminator The segment terminator. - * @member {string} segmentTerminatorSuffix The segment terminator suffix. - * Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {number} replaceCharacter The replacement character. - * @member {boolean} replaceSeparatorsInPayload The value indicating whether to - * replace separators in payload. - * @member {string} [targetNamespace] The target namespace on which this - * delimiter settings has to be applied. */ export interface X12DelimiterOverrides { + /** + * The protocol version. + */ protocolVersion?: string; + /** + * The message id. + */ messageId?: string; + /** + * The data element separator. + */ dataElementSeparator: number; + /** + * The component separator. + */ componentSeparator: number; + /** + * The segment terminator. + */ segmentTerminator: number; + /** + * The segment terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', 'LF', + * 'CRLF' + */ segmentTerminatorSuffix: string; + /** + * The replacement character. + */ replaceCharacter: number; + /** + * The value indicating whether to replace separators in payload. + */ replaceSeparatorsInPayload: boolean; + /** + * The target namespace on which this delimiter settings has to be applied. + */ targetNamespace?: string; } /** - * @class - * Initializes a new instance of the X12ProtocolSettings class. - * @constructor * The X12 agreement protocol settings. - * - * @member {object} validationSettings The X12 validation settings. - * @member {boolean} [validationSettings.validateCharacterSet] The value - * indicating whether to validate character set in the message. - * @member {boolean} - * [validationSettings.checkDuplicateInterchangeControlNumber] The value - * indicating whether to check for duplicate interchange control number. - * @member {number} [validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} [validationSettings.checkDuplicateGroupControlNumber] The - * value indicating whether to check for duplicate group control number. - * @member {boolean} - * [validationSettings.checkDuplicateTransactionSetControlNumber] The value - * indicating whether to check for duplicate transaction set control number. - * @member {boolean} [validationSettings.validateEdiTypes] The value indicating - * whether to Whether to validate EDI types. - * @member {boolean} [validationSettings.validateXsdTypes] The value indicating - * whether to Whether to validate XSD types. - * @member {boolean} - * [validationSettings.allowLeadingAndTrailingSpacesAndZeroes] The value - * indicating whether to allow leading and trailing spaces and zeroes. - * @member {boolean} [validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} [validationSettings.trailingSeparatorPolicy] The trailing - * separator policy. Possible values include: 'NotSpecified', 'NotAllowed', - * 'Optional', 'Mandatory' - * @member {object} framingSettings The X12 framing settings. - * @member {number} [framingSettings.dataElementSeparator] The data element - * separator. - * @member {number} [framingSettings.componentSeparator] The component - * separator. - * @member {boolean} [framingSettings.replaceSeparatorsInPayload] The value - * indicating whether to replace separators in payload. - * @member {number} [framingSettings.replaceCharacter] The replacement - * character. - * @member {number} [framingSettings.segmentTerminator] The segment terminator. - * @member {string} [framingSettings.characterSet] The X12 character set. - * Possible values include: 'NotSpecified', 'Basic', 'Extended', 'UTF8' - * @member {string} [framingSettings.segmentTerminatorSuffix] The segment - * terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', - * 'LF', 'CRLF' - * @member {object} envelopeSettings The X12 envelope settings. - * @member {number} [envelopeSettings.controlStandardsId] The controls - * standards id. - * @member {boolean} - * [envelopeSettings.useControlStandardsIdAsRepetitionCharacter] The value - * indicating whether to use control standards id as repetition character. - * @member {string} [envelopeSettings.senderApplicationId] The sender - * application id. - * @member {string} [envelopeSettings.receiverApplicationId] The receiver - * application id. - * @member {string} [envelopeSettings.controlVersionNumber] The control version - * number. - * @member {number} [envelopeSettings.interchangeControlNumberLowerBound] The - * interchange control number lower bound. - * @member {number} [envelopeSettings.interchangeControlNumberUpperBound] The - * interchange control number upper bound. - * @member {boolean} [envelopeSettings.rolloverInterchangeControlNumber] The - * value indicating whether to rollover interchange control number. - * @member {boolean} [envelopeSettings.enableDefaultGroupHeaders] The value - * indicating whether to enable default group headers. - * @member {string} [envelopeSettings.functionalGroupId] The functional group - * id. - * @member {number} [envelopeSettings.groupControlNumberLowerBound] The group - * control number lower bound. - * @member {number} [envelopeSettings.groupControlNumberUpperBound] The group - * control number upper bound. - * @member {boolean} [envelopeSettings.rolloverGroupControlNumber] The value - * indicating whether to rollover group control number. - * @member {string} [envelopeSettings.groupHeaderAgencyCode] The group header - * agency code. - * @member {string} [envelopeSettings.groupHeaderVersion] The group header - * version. - * @member {number} [envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} [envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} [envelopeSettings.rolloverTransactionSetControlNumber] The - * value indicating whether to rollover transaction set control number. - * @member {string} [envelopeSettings.transactionSetControlNumberPrefix] The - * transaction set control number prefix. - * @member {string} [envelopeSettings.transactionSetControlNumberSuffix] The - * transaction set control number suffix. - * @member {boolean} - * [envelopeSettings.overwriteExistingTransactionSetControlNumber] The value - * indicating whether to overwrite existing transaction set control number. - * @member {string} [envelopeSettings.groupHeaderDateFormat] The group header - * date format. Possible values include: 'NotSpecified', 'CCYYMMDD', 'YYMMDD' - * @member {string} [envelopeSettings.groupHeaderTimeFormat] The group header - * time format. Possible values include: 'NotSpecified', 'HHMM', 'HHMMSS', - * 'HHMMSSdd', 'HHMMSSd' - * @member {string} [envelopeSettings.usageIndicator] The usage indicator. - * Possible values include: 'NotSpecified', 'Test', 'Information', 'Production' - * @member {object} acknowledgementSettings The X12 acknowledgment settings. - * @member {boolean} [acknowledgementSettings.needTechnicalAcknowledgement] The - * value indicating whether technical acknowledgement is needed. - * @member {boolean} [acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} [acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {string} [acknowledgementSettings.functionalAcknowledgementVersion] - * The functional acknowledgement version. - * @member {boolean} [acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [acknowledgementSettings.needImplementationAcknowledgement] The value - * indicating whether implementation acknowledgement is needed. - * @member {string} - * [acknowledgementSettings.implementationAcknowledgementVersion] The - * implementation acknowledgement version. - * @member {boolean} - * [acknowledgementSettings.batchImplementationAcknowledgements] The value - * indicating whether to batch implementation acknowledgements. - * @member {boolean} [acknowledgementSettings.needLoopForValidMessages] The - * value indicating whether a loop is needed for valid messages. - * @member {boolean} [acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [acknowledgementSettings.acknowledgementControlNumberPrefix] The - * acknowledgement control number prefix. - * @member {string} - * [acknowledgementSettings.acknowledgementControlNumberSuffix] The - * acknowledgement control number suffix. - * @member {number} - * [acknowledgementSettings.acknowledgementControlNumberLowerBound] The - * acknowledgement control number lower bound. - * @member {number} - * [acknowledgementSettings.acknowledgementControlNumberUpperBound] The - * acknowledgement control number upper bound. - * @member {boolean} - * [acknowledgementSettings.rolloverAcknowledgementControlNumber] The value - * indicating whether to rollover acknowledgement control number. - * @member {object} messageFilter The X12 message filter. - * @member {string} [messageFilter.messageFilterType] The message filter type. - * Possible values include: 'NotSpecified', 'Include', 'Exclude' - * @member {object} securitySettings The X12 security settings. - * @member {string} [securitySettings.authorizationQualifier] The authorization - * qualifier. - * @member {string} [securitySettings.authorizationValue] The authorization - * value. - * @member {string} [securitySettings.securityQualifier] The security - * qualifier. - * @member {string} [securitySettings.passwordValue] The password value. - * @member {object} processingSettings The X12 processing settings. - * @member {boolean} [processingSettings.maskSecurityInfo] The value indicating - * whether to mask security information. - * @member {boolean} [processingSettings.convertImpliedDecimal] The value - * indicating whether to convert numerical type to implied decimal. - * @member {boolean} [processingSettings.preserveInterchange] The value - * indicating whether to preserve interchange. - * @member {boolean} [processingSettings.suspendInterchangeOnError] The value - * indicating whether to suspend interchange on error. - * @member {boolean} - * [processingSettings.createEmptyXmlTagsForTrailingSeparators] The value - * indicating whether to create empty xml tags for trailing separators. - * @member {boolean} [processingSettings.useDotAsDecimalSeparator] The value - * indicating whether to use dot as decimal separator. - * @member {array} [envelopeOverrides] The X12 envelope override settings. - * @member {array} [validationOverrides] The X12 validation override settings. - * @member {array} [messageFilterList] The X12 message filter list. - * @member {array} schemaReferences The X12 schema references. - * @member {array} [x12DelimiterOverrides] The X12 delimiter override settings. */ export interface X12ProtocolSettings { + /** + * The X12 validation settings. + */ validationSettings: X12ValidationSettings; + /** + * The X12 framing settings. + */ framingSettings: X12FramingSettings; + /** + * The X12 envelope settings. + */ envelopeSettings: X12EnvelopeSettings; + /** + * The X12 acknowledgment settings. + */ acknowledgementSettings: X12AcknowledgementSettings; + /** + * The X12 message filter. + */ messageFilter: X12MessageFilter; + /** + * The X12 security settings. + */ securitySettings: X12SecuritySettings; + /** + * The X12 processing settings. + */ processingSettings: X12ProcessingSettings; + /** + * The X12 envelope override settings. + */ envelopeOverrides?: X12EnvelopeOverride[]; + /** + * The X12 validation override settings. + */ validationOverrides?: X12ValidationOverride[]; + /** + * The X12 message filter list. + */ messageFilterList?: X12MessageIdentifier[]; + /** + * The X12 schema references. + */ schemaReferences: X12SchemaReference[]; + /** + * The X12 delimiter override settings. + */ x12DelimiterOverrides?: X12DelimiterOverrides[]; } /** - * @class - * Initializes a new instance of the X12OneWayAgreement class. - * @constructor * The X12 one-way agreement. - * - * @member {object} senderBusinessIdentity The sender business identity - * @member {string} [senderBusinessIdentity.qualifier] The business identity - * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [senderBusinessIdentity.value] The user defined business - * identity value. - * @member {object} receiverBusinessIdentity The receiver business identity - * @member {string} [receiverBusinessIdentity.qualifier] The business identity - * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiverBusinessIdentity.value] The user defined business - * identity value. - * @member {object} protocolSettings The X12 protocol settings. - * @member {object} [protocolSettings.validationSettings] The X12 validation - * settings. - * @member {boolean} [protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [protocolSettings.validationSettings.checkDuplicateGroupControlNumber] The - * value indicating whether to check for duplicate group control number. - * @member {boolean} - * [protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} [protocolSettings.validationSettings.validateEdiTypes] The - * value indicating whether to Whether to validate EDI types. - * @member {boolean} [protocolSettings.validationSettings.validateXsdTypes] The - * value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [protocolSettings.validationSettings.trailingSeparatorPolicy] The trailing - * separator policy. Possible values include: 'NotSpecified', 'NotAllowed', - * 'Optional', 'Mandatory' - * @member {object} [protocolSettings.framingSettings] The X12 framing - * settings. - * @member {number} [protocolSettings.framingSettings.dataElementSeparator] The - * data element separator. - * @member {number} [protocolSettings.framingSettings.componentSeparator] The - * component separator. - * @member {boolean} - * [protocolSettings.framingSettings.replaceSeparatorsInPayload] The value - * indicating whether to replace separators in payload. - * @member {number} [protocolSettings.framingSettings.replaceCharacter] The - * replacement character. - * @member {number} [protocolSettings.framingSettings.segmentTerminator] The - * segment terminator. - * @member {string} [protocolSettings.framingSettings.characterSet] The X12 - * character set. Possible values include: 'NotSpecified', 'Basic', 'Extended', - * 'UTF8' - * @member {string} [protocolSettings.framingSettings.segmentTerminatorSuffix] - * The segment terminator suffix. Possible values include: 'NotSpecified', - * 'None', 'CR', 'LF', 'CRLF' - * @member {object} [protocolSettings.envelopeSettings] The X12 envelope - * settings. - * @member {number} [protocolSettings.envelopeSettings.controlStandardsId] The - * controls standards id. - * @member {boolean} - * [protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] - * The value indicating whether to use control standards id as repetition - * character. - * @member {string} [protocolSettings.envelopeSettings.senderApplicationId] The - * sender application id. - * @member {string} [protocolSettings.envelopeSettings.receiverApplicationId] - * The receiver application id. - * @member {string} [protocolSettings.envelopeSettings.controlVersionNumber] - * The control version number. - * @member {number} - * [protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] The - * interchange control number lower bound. - * @member {number} - * [protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] The - * interchange control number upper bound. - * @member {boolean} - * [protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] The - * value indicating whether to rollover interchange control number. - * @member {boolean} - * [protocolSettings.envelopeSettings.enableDefaultGroupHeaders] The value - * indicating whether to enable default group headers. - * @member {string} [protocolSettings.envelopeSettings.functionalGroupId] The - * functional group id. - * @member {number} - * [protocolSettings.envelopeSettings.groupControlNumberLowerBound] The group - * control number lower bound. - * @member {number} - * [protocolSettings.envelopeSettings.groupControlNumberUpperBound] The group - * control number upper bound. - * @member {boolean} - * [protocolSettings.envelopeSettings.rolloverGroupControlNumber] The value - * indicating whether to rollover group control number. - * @member {string} [protocolSettings.envelopeSettings.groupHeaderAgencyCode] - * The group header agency code. - * @member {string} [protocolSettings.envelopeSettings.groupHeaderVersion] The - * group header version. - * @member {number} - * [protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] The - * value indicating whether to rollover transaction set control number. - * @member {string} - * [protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] The - * transaction set control number prefix. - * @member {string} - * [protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] The - * transaction set control number suffix. - * @member {boolean} - * [protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} [protocolSettings.envelopeSettings.groupHeaderDateFormat] - * The group header date format. Possible values include: 'NotSpecified', - * 'CCYYMMDD', 'YYMMDD' - * @member {string} [protocolSettings.envelopeSettings.groupHeaderTimeFormat] - * The group header time format. Possible values include: 'NotSpecified', - * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} [protocolSettings.envelopeSettings.usageIndicator] The - * usage indicator. Possible values include: 'NotSpecified', 'Test', - * 'Information', 'Production' - * @member {object} [protocolSettings.acknowledgementSettings] The X12 - * acknowledgment settings. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] The - * value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] The - * value indicating whether functional acknowledgement is needed. - * @member {string} - * [protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] - * The functional acknowledgement version. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] - * The value indicating whether implementation acknowledgement is needed. - * @member {string} - * [protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] - * The implementation acknowledgement version. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] - * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.needLoopForValidMessages] The - * value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [protocolSettings.messageFilter] The X12 message filter. - * @member {string} [protocolSettings.messageFilter.messageFilterType] The - * message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} [protocolSettings.securitySettings] The X12 security - * settings. - * @member {string} [protocolSettings.securitySettings.authorizationQualifier] - * The authorization qualifier. - * @member {string} [protocolSettings.securitySettings.authorizationValue] The - * authorization value. - * @member {string} [protocolSettings.securitySettings.securityQualifier] The - * security qualifier. - * @member {string} [protocolSettings.securitySettings.passwordValue] The - * password value. - * @member {object} [protocolSettings.processingSettings] The X12 processing - * settings. - * @member {boolean} [protocolSettings.processingSettings.maskSecurityInfo] The - * value indicating whether to mask security information. - * @member {boolean} - * [protocolSettings.processingSettings.convertImpliedDecimal] The value - * indicating whether to convert numerical type to implied decimal. - * @member {boolean} [protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [protocolSettings.processingSettings.suspendInterchangeOnError] The value - * indicating whether to suspend interchange on error. - * @member {boolean} - * [protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [protocolSettings.processingSettings.useDotAsDecimalSeparator] The value - * indicating whether to use dot as decimal separator. - * @member {array} [protocolSettings.envelopeOverrides] The X12 envelope - * override settings. - * @member {array} [protocolSettings.validationOverrides] The X12 validation - * override settings. - * @member {array} [protocolSettings.messageFilterList] The X12 message filter - * list. - * @member {array} [protocolSettings.schemaReferences] The X12 schema - * references. - * @member {array} [protocolSettings.x12DelimiterOverrides] The X12 delimiter - * override settings. */ export interface X12OneWayAgreement { + /** + * The sender business identity + */ senderBusinessIdentity: BusinessIdentity; + /** + * The receiver business identity + */ receiverBusinessIdentity: BusinessIdentity; + /** + * The X12 protocol settings. + */ protocolSettings: X12ProtocolSettings; } /** - * @class - * Initializes a new instance of the X12AgreementContent class. - * @constructor * The X12 agreement content. - * - * @member {object} receiveAgreement The X12 one-way receive agreement. - * @member {object} [receiveAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [receiveAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [receiveAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [receiveAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [receiveAgreement.protocolSettings] The X12 protocol - * settings. - * @member {object} [receiveAgreement.protocolSettings.validationSettings] The - * X12 validation settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] The - * value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] The - * value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [receiveAgreement.protocolSettings.framingSettings] The X12 - * framing settings. - * @member {number} - * [receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] The - * data element separator. - * @member {number} - * [receiveAgreement.protocolSettings.framingSettings.componentSeparator] The - * component separator. - * @member {boolean} - * [receiveAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] - * The value indicating whether to replace separators in payload. - * @member {number} - * [receiveAgreement.protocolSettings.framingSettings.replaceCharacter] The - * replacement character. - * @member {number} - * [receiveAgreement.protocolSettings.framingSettings.segmentTerminator] The - * segment terminator. - * @member {string} - * [receiveAgreement.protocolSettings.framingSettings.characterSet] The X12 - * character set. Possible values include: 'NotSpecified', 'Basic', 'Extended', - * 'UTF8' - * @member {string} - * [receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] - * The segment terminator suffix. Possible values include: 'NotSpecified', - * 'None', 'CR', 'LF', 'CRLF' - * @member {object} [receiveAgreement.protocolSettings.envelopeSettings] The - * X12 envelope settings. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.controlStandardsId] The - * controls standards id. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] - * The value indicating whether to use control standards id as repetition - * character. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.senderApplicationId] The - * sender application id. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.receiverApplicationId] - * The receiver application id. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.controlVersionNumber] - * The control version number. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] The - * functional group id. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] - * The group header agency code. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] The - * group header version. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] - * The group header date format. Possible values include: 'NotSpecified', - * 'CCYYMMDD', 'YYMMDD' - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] - * The group header time format. Possible values include: 'NotSpecified', - * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.usageIndicator] The - * usage indicator. Possible values include: 'NotSpecified', 'Test', - * 'Information', 'Production' - * @member {object} [receiveAgreement.protocolSettings.acknowledgementSettings] - * The X12 acknowledgment settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {string} - * [receiveAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] - * The functional acknowledgement version. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] - * The value indicating whether implementation acknowledgement is needed. - * @member {string} - * [receiveAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] - * The implementation acknowledgement version. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] - * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [receiveAgreement.protocolSettings.messageFilter] The X12 - * message filter. - * @member {string} - * [receiveAgreement.protocolSettings.messageFilter.messageFilterType] The - * message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} [receiveAgreement.protocolSettings.securitySettings] The - * X12 security settings. - * @member {string} - * [receiveAgreement.protocolSettings.securitySettings.authorizationQualifier] - * The authorization qualifier. - * @member {string} - * [receiveAgreement.protocolSettings.securitySettings.authorizationValue] The - * authorization value. - * @member {string} - * [receiveAgreement.protocolSettings.securitySettings.securityQualifier] The - * security qualifier. - * @member {string} - * [receiveAgreement.protocolSettings.securitySettings.passwordValue] The - * password value. - * @member {object} [receiveAgreement.protocolSettings.processingSettings] The - * X12 processing settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] The - * value indicating whether to mask security information. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.convertImpliedDecimal] - * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} [receiveAgreement.protocolSettings.envelopeOverrides] The - * X12 envelope override settings. - * @member {array} [receiveAgreement.protocolSettings.validationOverrides] The - * X12 validation override settings. - * @member {array} [receiveAgreement.protocolSettings.messageFilterList] The - * X12 message filter list. - * @member {array} [receiveAgreement.protocolSettings.schemaReferences] The X12 - * schema references. - * @member {array} [receiveAgreement.protocolSettings.x12DelimiterOverrides] - * The X12 delimiter override settings. - * @member {object} sendAgreement The X12 one-way send agreement. - * @member {object} [sendAgreement.senderBusinessIdentity] The sender business - * identity - * @member {string} [sendAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [sendAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [sendAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [sendAgreement.protocolSettings] The X12 protocol settings. - * @member {object} [sendAgreement.protocolSettings.validationSettings] The X12 - * validation settings. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.validateCharacterSet] The - * value indicating whether to validate character set in the message. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.validateEdiTypes] The - * value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.validateXsdTypes] The - * value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [sendAgreement.protocolSettings.framingSettings] The X12 - * framing settings. - * @member {number} - * [sendAgreement.protocolSettings.framingSettings.dataElementSeparator] The - * data element separator. - * @member {number} - * [sendAgreement.protocolSettings.framingSettings.componentSeparator] The - * component separator. - * @member {boolean} - * [sendAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] - * The value indicating whether to replace separators in payload. - * @member {number} - * [sendAgreement.protocolSettings.framingSettings.replaceCharacter] The - * replacement character. - * @member {number} - * [sendAgreement.protocolSettings.framingSettings.segmentTerminator] The - * segment terminator. - * @member {string} - * [sendAgreement.protocolSettings.framingSettings.characterSet] The X12 - * character set. Possible values include: 'NotSpecified', 'Basic', 'Extended', - * 'UTF8' - * @member {string} - * [sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] The - * segment terminator suffix. Possible values include: 'NotSpecified', 'None', - * 'CR', 'LF', 'CRLF' - * @member {object} [sendAgreement.protocolSettings.envelopeSettings] The X12 - * envelope settings. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.controlStandardsId] The - * controls standards id. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] - * The value indicating whether to use control standards id as repetition - * character. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.senderApplicationId] The - * sender application id. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.receiverApplicationId] The - * receiver application id. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.controlVersionNumber] The - * control version number. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] The - * functional group id. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] The - * group header agency code. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] The - * group header version. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] The - * group header date format. Possible values include: 'NotSpecified', - * 'CCYYMMDD', 'YYMMDD' - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] The - * group header time format. Possible values include: 'NotSpecified', 'HHMM', - * 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.usageIndicator] The usage - * indicator. Possible values include: 'NotSpecified', 'Test', 'Information', - * 'Production' - * @member {object} [sendAgreement.protocolSettings.acknowledgementSettings] - * The X12 acknowledgment settings. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {string} - * [sendAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] - * The functional acknowledgement version. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] - * The value indicating whether implementation acknowledgement is needed. - * @member {string} - * [sendAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] - * The implementation acknowledgement version. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] - * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [sendAgreement.protocolSettings.messageFilter] The X12 - * message filter. - * @member {string} - * [sendAgreement.protocolSettings.messageFilter.messageFilterType] The message - * filter type. Possible values include: 'NotSpecified', 'Include', 'Exclude' - * @member {object} [sendAgreement.protocolSettings.securitySettings] The X12 - * security settings. - * @member {string} - * [sendAgreement.protocolSettings.securitySettings.authorizationQualifier] The - * authorization qualifier. - * @member {string} - * [sendAgreement.protocolSettings.securitySettings.authorizationValue] The - * authorization value. - * @member {string} - * [sendAgreement.protocolSettings.securitySettings.securityQualifier] The - * security qualifier. - * @member {string} - * [sendAgreement.protocolSettings.securitySettings.passwordValue] The password - * value. - * @member {object} [sendAgreement.protocolSettings.processingSettings] The X12 - * processing settings. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] The - * value indicating whether to mask security information. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.convertImpliedDecimal] - * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.preserveInterchange] The - * value indicating whether to preserve interchange. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} [sendAgreement.protocolSettings.envelopeOverrides] The X12 - * envelope override settings. - * @member {array} [sendAgreement.protocolSettings.validationOverrides] The X12 - * validation override settings. - * @member {array} [sendAgreement.protocolSettings.messageFilterList] The X12 - * message filter list. - * @member {array} [sendAgreement.protocolSettings.schemaReferences] The X12 - * schema references. - * @member {array} [sendAgreement.protocolSettings.x12DelimiterOverrides] The - * X12 delimiter override settings. */ export interface X12AgreementContent { + /** + * The X12 one-way receive agreement. + */ receiveAgreement: X12OneWayAgreement; + /** + * The X12 one-way send agreement. + */ sendAgreement: X12OneWayAgreement; } /** - * @class - * Initializes a new instance of the EdifactValidationSettings class. - * @constructor * The Edifact agreement validation settings. - * - * @member {boolean} validateCharacterSet The value indicating whether to - * validate character set in the message. - * @member {boolean} checkDuplicateInterchangeControlNumber The value - * indicating whether to check for duplicate interchange control number. - * @member {number} interchangeControlNumberValidityDays The validity period of - * interchange control number. - * @member {boolean} checkDuplicateGroupControlNumber The value indicating - * whether to check for duplicate group control number. - * @member {boolean} checkDuplicateTransactionSetControlNumber The value - * indicating whether to check for duplicate transaction set control number. - * @member {boolean} validateEdiTypes The value indicating whether to Whether - * to validate EDI types. - * @member {boolean} validateXsdTypes The value indicating whether to Whether - * to validate XSD types. - * @member {boolean} allowLeadingAndTrailingSpacesAndZeroes The value - * indicating whether to allow leading and trailing spaces and zeroes. - * @member {boolean} trimLeadingAndTrailingSpacesAndZeroes The value indicating - * whether to trim leading and trailing spaces and zeroes. - * @member {string} trailingSeparatorPolicy The trailing separator policy. - * Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', - * 'Mandatory' */ export interface EdifactValidationSettings { + /** + * The value indicating whether to validate character set in the message. + */ validateCharacterSet: boolean; + /** + * The value indicating whether to check for duplicate interchange control number. + */ checkDuplicateInterchangeControlNumber: boolean; + /** + * The validity period of interchange control number. + */ interchangeControlNumberValidityDays: number; + /** + * The value indicating whether to check for duplicate group control number. + */ checkDuplicateGroupControlNumber: boolean; + /** + * The value indicating whether to check for duplicate transaction set control number. + */ checkDuplicateTransactionSetControlNumber: boolean; + /** + * The value indicating whether to Whether to validate EDI types. + */ validateEdiTypes: boolean; + /** + * The value indicating whether to Whether to validate XSD types. + */ validateXsdTypes: boolean; + /** + * The value indicating whether to allow leading and trailing spaces and zeroes. + */ allowLeadingAndTrailingSpacesAndZeroes: boolean; + /** + * The value indicating whether to trim leading and trailing spaces and zeroes. + */ trimLeadingAndTrailingSpacesAndZeroes: boolean; + /** + * The trailing separator policy. Possible values include: 'NotSpecified', 'NotAllowed', + * 'Optional', 'Mandatory' + */ trailingSeparatorPolicy: string; } /** - * @class - * Initializes a new instance of the EdifactFramingSettings class. - * @constructor * The Edifact agreement framing settings. - * - * @member {string} [serviceCodeListDirectoryVersion] The service code list - * directory version. - * @member {string} [characterEncoding] The character encoding. - * @member {number} protocolVersion The protocol version. - * @member {number} dataElementSeparator The data element separator. - * @member {number} componentSeparator The component separator. - * @member {number} segmentTerminator The segment terminator. - * @member {number} releaseIndicator The release indicator. - * @member {number} repetitionSeparator The repetition separator. - * @member {string} characterSet The EDIFACT frame setting characterSet. - * Possible values include: 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', - * 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', - * 'KECA' - * @member {string} decimalPointIndicator The EDIFACT frame setting decimal - * indicator. Possible values include: 'NotSpecified', 'Comma', 'Decimal' - * @member {string} segmentTerminatorSuffix The EDIFACT frame setting segment - * terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', - * 'LF', 'CRLF' */ export interface EdifactFramingSettings { + /** + * The service code list directory version. + */ serviceCodeListDirectoryVersion?: string; + /** + * The character encoding. + */ characterEncoding?: string; + /** + * The protocol version. + */ protocolVersion: number; + /** + * The data element separator. + */ dataElementSeparator: number; + /** + * The component separator. + */ componentSeparator: number; + /** + * The segment terminator. + */ segmentTerminator: number; + /** + * The release indicator. + */ releaseIndicator: number; + /** + * The repetition separator. + */ repetitionSeparator: number; + /** + * The EDIFACT frame setting characterSet. Possible values include: 'NotSpecified', 'UNOB', + * 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', + * 'UNOY', 'KECA' + */ characterSet: string; + /** + * The EDIFACT frame setting decimal indicator. Possible values include: 'NotSpecified', 'Comma', + * 'Decimal' + */ decimalPointIndicator: string; + /** + * The EDIFACT frame setting segment terminator suffix. Possible values include: 'NotSpecified', + * 'None', 'CR', 'LF', 'CRLF' + */ segmentTerminatorSuffix: string; } /** - * @class - * Initializes a new instance of the EdifactEnvelopeSettings class. - * @constructor * The Edifact agreement envelope settings. - * - * @member {string} [groupAssociationAssignedCode] The group association - * assigned code. - * @member {string} [communicationAgreementId] The communication agreement id. - * @member {boolean} applyDelimiterStringAdvice The value indicating whether to - * apply delimiter string advice. - * @member {boolean} createGroupingSegments The value indicating whether to - * create grouping segments. - * @member {boolean} enableDefaultGroupHeaders The value indicating whether to - * enable default group headers. - * @member {string} [recipientReferencePasswordValue] The recipient reference - * password value. - * @member {string} [recipientReferencePasswordQualifier] The recipient - * reference password qualifier. - * @member {string} [applicationReferenceId] The application reference id. - * @member {string} [processingPriorityCode] The processing priority code. - * @member {number} interchangeControlNumberLowerBound The interchange control - * number lower bound. - * @member {number} interchangeControlNumberUpperBound The interchange control - * number upper bound. - * @member {boolean} rolloverInterchangeControlNumber The value indicating - * whether to rollover interchange control number. - * @member {string} [interchangeControlNumberPrefix] The interchange control - * number prefix. - * @member {string} [interchangeControlNumberSuffix] The interchange control - * number suffix. - * @member {string} [senderReverseRoutingAddress] The sender reverse routing - * address. - * @member {string} [receiverReverseRoutingAddress] The receiver reverse - * routing address. - * @member {string} [functionalGroupId] The functional group id. - * @member {string} [groupControllingAgencyCode] The group controlling agency - * code. - * @member {string} [groupMessageVersion] The group message version. - * @member {string} [groupMessageRelease] The group message release. - * @member {number} groupControlNumberLowerBound The group control number lower - * bound. - * @member {number} groupControlNumberUpperBound The group control number upper - * bound. - * @member {boolean} rolloverGroupControlNumber The value indicating whether to - * rollover group control number. - * @member {string} [groupControlNumberPrefix] The group control number prefix. - * @member {string} [groupControlNumberSuffix] The group control number suffix. - * @member {string} [groupApplicationReceiverQualifier] The group application - * receiver qualifier. - * @member {string} [groupApplicationReceiverId] The group application receiver - * id. - * @member {string} [groupApplicationSenderQualifier] The group application - * sender qualifier. - * @member {string} [groupApplicationSenderId] The group application sender id. - * @member {string} [groupApplicationPassword] The group application password. - * @member {boolean} overwriteExistingTransactionSetControlNumber The value - * indicating whether to overwrite existing transaction set control number. - * @member {string} [transactionSetControlNumberPrefix] The transaction set - * control number prefix. - * @member {string} [transactionSetControlNumberSuffix] The transaction set - * control number suffix. - * @member {number} transactionSetControlNumberLowerBound The transaction set - * control number lower bound. - * @member {number} transactionSetControlNumberUpperBound The transaction set - * control number upper bound. - * @member {boolean} rolloverTransactionSetControlNumber The value indicating - * whether to rollover transaction set control number. - * @member {boolean} isTestInterchange The value indicating whether the message - * is a test interchange. - * @member {string} [senderInternalIdentification] The sender internal - * identification. - * @member {string} [senderInternalSubIdentification] The sender internal sub - * identification. - * @member {string} [receiverInternalIdentification] The receiver internal - * identification. - * @member {string} [receiverInternalSubIdentification] The receiver internal - * sub identification. */ export interface EdifactEnvelopeSettings { + /** + * The group association assigned code. + */ groupAssociationAssignedCode?: string; + /** + * The communication agreement id. + */ communicationAgreementId?: string; + /** + * The value indicating whether to apply delimiter string advice. + */ applyDelimiterStringAdvice: boolean; + /** + * The value indicating whether to create grouping segments. + */ createGroupingSegments: boolean; + /** + * The value indicating whether to enable default group headers. + */ enableDefaultGroupHeaders: boolean; + /** + * The recipient reference password value. + */ recipientReferencePasswordValue?: string; + /** + * The recipient reference password qualifier. + */ recipientReferencePasswordQualifier?: string; + /** + * The application reference id. + */ applicationReferenceId?: string; + /** + * The processing priority code. + */ processingPriorityCode?: string; + /** + * The interchange control number lower bound. + */ interchangeControlNumberLowerBound: number; + /** + * The interchange control number upper bound. + */ interchangeControlNumberUpperBound: number; + /** + * The value indicating whether to rollover interchange control number. + */ rolloverInterchangeControlNumber: boolean; + /** + * The interchange control number prefix. + */ interchangeControlNumberPrefix?: string; + /** + * The interchange control number suffix. + */ interchangeControlNumberSuffix?: string; + /** + * The sender reverse routing address. + */ senderReverseRoutingAddress?: string; + /** + * The receiver reverse routing address. + */ receiverReverseRoutingAddress?: string; + /** + * The functional group id. + */ functionalGroupId?: string; + /** + * The group controlling agency code. + */ groupControllingAgencyCode?: string; + /** + * The group message version. + */ groupMessageVersion?: string; + /** + * The group message release. + */ groupMessageRelease?: string; + /** + * The group control number lower bound. + */ groupControlNumberLowerBound: number; + /** + * The group control number upper bound. + */ groupControlNumberUpperBound: number; + /** + * The value indicating whether to rollover group control number. + */ rolloverGroupControlNumber: boolean; + /** + * The group control number prefix. + */ groupControlNumberPrefix?: string; + /** + * The group control number suffix. + */ groupControlNumberSuffix?: string; + /** + * The group application receiver qualifier. + */ groupApplicationReceiverQualifier?: string; + /** + * The group application receiver id. + */ groupApplicationReceiverId?: string; + /** + * The group application sender qualifier. + */ groupApplicationSenderQualifier?: string; + /** + * The group application sender id. + */ groupApplicationSenderId?: string; + /** + * The group application password. + */ groupApplicationPassword?: string; + /** + * The value indicating whether to overwrite existing transaction set control number. + */ overwriteExistingTransactionSetControlNumber: boolean; + /** + * The transaction set control number prefix. + */ transactionSetControlNumberPrefix?: string; + /** + * The transaction set control number suffix. + */ transactionSetControlNumberSuffix?: string; + /** + * The transaction set control number lower bound. + */ transactionSetControlNumberLowerBound: number; + /** + * The transaction set control number upper bound. + */ transactionSetControlNumberUpperBound: number; + /** + * The value indicating whether to rollover transaction set control number. + */ rolloverTransactionSetControlNumber: boolean; + /** + * The value indicating whether the message is a test interchange. + */ isTestInterchange: boolean; + /** + * The sender internal identification. + */ senderInternalIdentification?: string; + /** + * The sender internal sub identification. + */ senderInternalSubIdentification?: string; + /** + * The receiver internal identification. + */ receiverInternalIdentification?: string; + /** + * The receiver internal sub identification. + */ receiverInternalSubIdentification?: string; } /** - * @class - * Initializes a new instance of the EdifactAcknowledgementSettings class. - * @constructor * The Edifact agreement acknowledgement settings. - * - * @member {boolean} needTechnicalAcknowledgement The value indicating whether - * technical acknowledgement is needed. - * @member {boolean} batchTechnicalAcknowledgements The value indicating - * whether to batch the technical acknowledgements. - * @member {boolean} needFunctionalAcknowledgement The value indicating whether - * functional acknowledgement is needed. - * @member {boolean} batchFunctionalAcknowledgements The value indicating - * whether to batch functional acknowledgements. - * @member {boolean} needLoopForValidMessages The value indicating whether a - * loop is needed for valid messages. - * @member {boolean} sendSynchronousAcknowledgement The value indicating - * whether to send synchronous acknowledgement. - * @member {string} [acknowledgementControlNumberPrefix] The acknowledgement - * control number prefix. - * @member {string} [acknowledgementControlNumberSuffix] The acknowledgement - * control number suffix. - * @member {number} acknowledgementControlNumberLowerBound The acknowledgement - * control number lower bound. - * @member {number} acknowledgementControlNumberUpperBound The acknowledgement - * control number upper bound. - * @member {boolean} rolloverAcknowledgementControlNumber The value indicating - * whether to rollover acknowledgement control number. */ export interface EdifactAcknowledgementSettings { + /** + * The value indicating whether technical acknowledgement is needed. + */ needTechnicalAcknowledgement: boolean; + /** + * The value indicating whether to batch the technical acknowledgements. + */ batchTechnicalAcknowledgements: boolean; + /** + * The value indicating whether functional acknowledgement is needed. + */ needFunctionalAcknowledgement: boolean; + /** + * The value indicating whether to batch functional acknowledgements. + */ batchFunctionalAcknowledgements: boolean; + /** + * The value indicating whether a loop is needed for valid messages. + */ needLoopForValidMessages: boolean; + /** + * The value indicating whether to send synchronous acknowledgement. + */ sendSynchronousAcknowledgement: boolean; + /** + * The acknowledgement control number prefix. + */ acknowledgementControlNumberPrefix?: string; + /** + * The acknowledgement control number suffix. + */ acknowledgementControlNumberSuffix?: string; + /** + * The acknowledgement control number lower bound. + */ acknowledgementControlNumberLowerBound: number; + /** + * The acknowledgement control number upper bound. + */ acknowledgementControlNumberUpperBound: number; + /** + * The value indicating whether to rollover acknowledgement control number. + */ rolloverAcknowledgementControlNumber: boolean; } /** - * @class - * Initializes a new instance of the EdifactMessageFilter class. - * @constructor * The Edifact message filter for odata query. - * - * @member {string} messageFilterType The message filter type. Possible values - * include: 'NotSpecified', 'Include', 'Exclude' */ export interface EdifactMessageFilter { + /** + * The message filter type. Possible values include: 'NotSpecified', 'Include', 'Exclude' + */ messageFilterType: string; } /** - * @class - * Initializes a new instance of the EdifactProcessingSettings class. - * @constructor * The Edifact agreement protocol settings. - * - * @member {boolean} maskSecurityInfo The value indicating whether to mask - * security information. - * @member {boolean} preserveInterchange The value indicating whether to - * preserve interchange. - * @member {boolean} suspendInterchangeOnError The value indicating whether to - * suspend interchange on error. - * @member {boolean} createEmptyXmlTagsForTrailingSeparators The value - * indicating whether to create empty xml tags for trailing separators. - * @member {boolean} useDotAsDecimalSeparator The value indicating whether to - * use dot as decimal separator. */ export interface EdifactProcessingSettings { + /** + * The value indicating whether to mask security information. + */ maskSecurityInfo: boolean; + /** + * The value indicating whether to preserve interchange. + */ preserveInterchange: boolean; + /** + * The value indicating whether to suspend interchange on error. + */ suspendInterchangeOnError: boolean; + /** + * The value indicating whether to create empty xml tags for trailing separators. + */ createEmptyXmlTagsForTrailingSeparators: boolean; + /** + * The value indicating whether to use dot as decimal separator. + */ useDotAsDecimalSeparator: boolean; } /** - * @class - * Initializes a new instance of the EdifactEnvelopeOverride class. - * @constructor * The Edifact envelope override settings. - * - * @member {string} [messageId] The message id on which this envelope settings - * has to be applied. - * @member {string} [messageVersion] The message version on which this envelope - * settings has to be applied. - * @member {string} [messageRelease] The message release version on which this - * envelope settings has to be applied. - * @member {string} [messageAssociationAssignedCode] The message association - * assigned code. - * @member {string} [targetNamespace] The target namespace on which this - * envelope settings has to be applied. - * @member {string} [functionalGroupId] The functional group id. - * @member {string} [senderApplicationQualifier] The sender application - * qualifier. - * @member {string} [senderApplicationId] The sender application id. - * @member {string} [receiverApplicationQualifier] The receiver application - * qualifier. - * @member {string} [receiverApplicationId] The receiver application id. - * @member {string} [controllingAgencyCode] The controlling agency code. - * @member {string} [groupHeaderMessageVersion] The group header message - * version. - * @member {string} [groupHeaderMessageRelease] The group header message - * release. - * @member {string} [associationAssignedCode] The association assigned code. - * @member {string} [applicationPassword] The application password. */ export interface EdifactEnvelopeOverride { + /** + * The message id on which this envelope settings has to be applied. + */ messageId?: string; + /** + * The message version on which this envelope settings has to be applied. + */ messageVersion?: string; + /** + * The message release version on which this envelope settings has to be applied. + */ messageRelease?: string; + /** + * The message association assigned code. + */ messageAssociationAssignedCode?: string; + /** + * The target namespace on which this envelope settings has to be applied. + */ targetNamespace?: string; + /** + * The functional group id. + */ functionalGroupId?: string; + /** + * The sender application qualifier. + */ senderApplicationQualifier?: string; + /** + * The sender application id. + */ senderApplicationId?: string; + /** + * The receiver application qualifier. + */ receiverApplicationQualifier?: string; + /** + * The receiver application id. + */ receiverApplicationId?: string; + /** + * The controlling agency code. + */ controllingAgencyCode?: string; + /** + * The group header message version. + */ groupHeaderMessageVersion?: string; + /** + * The group header message release. + */ groupHeaderMessageRelease?: string; + /** + * The association assigned code. + */ associationAssignedCode?: string; + /** + * The application password. + */ applicationPassword?: string; } /** - * @class - * Initializes a new instance of the EdifactMessageIdentifier class. - * @constructor * The Edifact message identifier. - * - * @member {string} messageId The message id on which this envelope settings - * has to be applied. */ export interface EdifactMessageIdentifier { + /** + * The message id on which this envelope settings has to be applied. + */ messageId: string; } /** - * @class - * Initializes a new instance of the EdifactSchemaReference class. - * @constructor * The Edifact schema reference. - * - * @member {string} messageId The message id. - * @member {string} messageVersion The message version. - * @member {string} messageRelease The message release version. - * @member {string} [senderApplicationId] The sender application id. - * @member {string} [senderApplicationQualifier] The sender application - * qualifier. - * @member {string} [associationAssignedCode] The association assigned code. - * @member {string} schemaName The schema name. */ export interface EdifactSchemaReference { + /** + * The message id. + */ messageId: string; + /** + * The message version. + */ messageVersion: string; + /** + * The message release version. + */ messageRelease: string; + /** + * The sender application id. + */ senderApplicationId?: string; + /** + * The sender application qualifier. + */ senderApplicationQualifier?: string; + /** + * The association assigned code. + */ associationAssignedCode?: string; + /** + * The schema name. + */ schemaName: string; } /** - * @class - * Initializes a new instance of the EdifactValidationOverride class. - * @constructor * The Edifact validation override settings. - * - * @member {string} messageId The message id on which the validation settings - * has to be applied. - * @member {boolean} enforceCharacterSet The value indicating whether to - * validate character Set. - * @member {boolean} validateEdiTypes The value indicating whether to validate - * EDI types. - * @member {boolean} validateXsdTypes The value indicating whether to validate - * XSD types. - * @member {boolean} allowLeadingAndTrailingSpacesAndZeroes The value - * indicating whether to allow leading and trailing spaces and zeroes. - * @member {string} trailingSeparatorPolicy The trailing separator policy. - * Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', - * 'Mandatory' - * @member {boolean} trimLeadingAndTrailingSpacesAndZeroes The value indicating - * whether to trim leading and trailing spaces and zeroes. */ export interface EdifactValidationOverride { + /** + * The message id on which the validation settings has to be applied. + */ messageId: string; + /** + * The value indicating whether to validate character Set. + */ enforceCharacterSet: boolean; + /** + * The value indicating whether to validate EDI types. + */ validateEdiTypes: boolean; + /** + * The value indicating whether to validate XSD types. + */ validateXsdTypes: boolean; + /** + * The value indicating whether to allow leading and trailing spaces and zeroes. + */ allowLeadingAndTrailingSpacesAndZeroes: boolean; + /** + * The trailing separator policy. Possible values include: 'NotSpecified', 'NotAllowed', + * 'Optional', 'Mandatory' + */ trailingSeparatorPolicy: string; + /** + * The value indicating whether to trim leading and trailing spaces and zeroes. + */ trimLeadingAndTrailingSpacesAndZeroes: boolean; } /** - * @class - * Initializes a new instance of the EdifactDelimiterOverride class. - * @constructor * The Edifact delimiter override settings. - * - * @member {string} [messageId] The message id. - * @member {string} [messageVersion] The message version. - * @member {string} [messageRelease] The message release. - * @member {number} dataElementSeparator The data element separator. - * @member {number} componentSeparator The component separator. - * @member {number} segmentTerminator The segment terminator. - * @member {number} repetitionSeparator The repetition separator. - * @member {string} segmentTerminatorSuffix The segment terminator suffix. - * Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {string} decimalPointIndicator The decimal point indicator. Possible - * values include: 'NotSpecified', 'Comma', 'Decimal' - * @member {number} releaseIndicator The release indicator. - * @member {string} [messageAssociationAssignedCode] The message association - * assigned code. - * @member {string} [targetNamespace] The target namespace on which this - * delimiter settings has to be applied. */ export interface EdifactDelimiterOverride { + /** + * The message id. + */ messageId?: string; + /** + * The message version. + */ messageVersion?: string; + /** + * The message release. + */ messageRelease?: string; + /** + * The data element separator. + */ dataElementSeparator: number; + /** + * The component separator. + */ componentSeparator: number; + /** + * The segment terminator. + */ segmentTerminator: number; + /** + * The repetition separator. + */ repetitionSeparator: number; + /** + * The segment terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', 'LF', + * 'CRLF' + */ segmentTerminatorSuffix: string; + /** + * The decimal point indicator. Possible values include: 'NotSpecified', 'Comma', 'Decimal' + */ decimalPointIndicator: string; + /** + * The release indicator. + */ releaseIndicator: number; + /** + * The message association assigned code. + */ messageAssociationAssignedCode?: string; + /** + * The target namespace on which this delimiter settings has to be applied. + */ targetNamespace?: string; } /** - * @class - * Initializes a new instance of the EdifactProtocolSettings class. - * @constructor * The Edifact agreement protocol settings. - * - * @member {object} validationSettings The EDIFACT validation settings. - * @member {boolean} [validationSettings.validateCharacterSet] The value - * indicating whether to validate character set in the message. - * @member {boolean} - * [validationSettings.checkDuplicateInterchangeControlNumber] The value - * indicating whether to check for duplicate interchange control number. - * @member {number} [validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} [validationSettings.checkDuplicateGroupControlNumber] The - * value indicating whether to check for duplicate group control number. - * @member {boolean} - * [validationSettings.checkDuplicateTransactionSetControlNumber] The value - * indicating whether to check for duplicate transaction set control number. - * @member {boolean} [validationSettings.validateEdiTypes] The value indicating - * whether to Whether to validate EDI types. - * @member {boolean} [validationSettings.validateXsdTypes] The value indicating - * whether to Whether to validate XSD types. - * @member {boolean} - * [validationSettings.allowLeadingAndTrailingSpacesAndZeroes] The value - * indicating whether to allow leading and trailing spaces and zeroes. - * @member {boolean} [validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} [validationSettings.trailingSeparatorPolicy] The trailing - * separator policy. Possible values include: 'NotSpecified', 'NotAllowed', - * 'Optional', 'Mandatory' - * @member {object} framingSettings The EDIFACT framing settings. - * @member {string} [framingSettings.serviceCodeListDirectoryVersion] The - * service code list directory version. - * @member {string} [framingSettings.characterEncoding] The character encoding. - * @member {number} [framingSettings.protocolVersion] The protocol version. - * @member {number} [framingSettings.dataElementSeparator] The data element - * separator. - * @member {number} [framingSettings.componentSeparator] The component - * separator. - * @member {number} [framingSettings.segmentTerminator] The segment terminator. - * @member {number} [framingSettings.releaseIndicator] The release indicator. - * @member {number} [framingSettings.repetitionSeparator] The repetition - * separator. - * @member {string} [framingSettings.characterSet] The EDIFACT frame setting - * characterSet. Possible values include: 'NotSpecified', 'UNOB', 'UNOA', - * 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', 'UNOK', - * 'UNOX', 'UNOY', 'KECA' - * @member {string} [framingSettings.decimalPointIndicator] The EDIFACT frame - * setting decimal indicator. Possible values include: 'NotSpecified', 'Comma', - * 'Decimal' - * @member {string} [framingSettings.segmentTerminatorSuffix] The EDIFACT frame - * setting segment terminator suffix. Possible values include: 'NotSpecified', - * 'None', 'CR', 'LF', 'CRLF' - * @member {object} envelopeSettings The EDIFACT envelope settings. - * @member {string} [envelopeSettings.groupAssociationAssignedCode] The group - * association assigned code. - * @member {string} [envelopeSettings.communicationAgreementId] The - * communication agreement id. - * @member {boolean} [envelopeSettings.applyDelimiterStringAdvice] The value - * indicating whether to apply delimiter string advice. - * @member {boolean} [envelopeSettings.createGroupingSegments] The value - * indicating whether to create grouping segments. - * @member {boolean} [envelopeSettings.enableDefaultGroupHeaders] The value - * indicating whether to enable default group headers. - * @member {string} [envelopeSettings.recipientReferencePasswordValue] The - * recipient reference password value. - * @member {string} [envelopeSettings.recipientReferencePasswordQualifier] The - * recipient reference password qualifier. - * @member {string} [envelopeSettings.applicationReferenceId] The application - * reference id. - * @member {string} [envelopeSettings.processingPriorityCode] The processing - * priority code. - * @member {number} [envelopeSettings.interchangeControlNumberLowerBound] The - * interchange control number lower bound. - * @member {number} [envelopeSettings.interchangeControlNumberUpperBound] The - * interchange control number upper bound. - * @member {boolean} [envelopeSettings.rolloverInterchangeControlNumber] The - * value indicating whether to rollover interchange control number. - * @member {string} [envelopeSettings.interchangeControlNumberPrefix] The - * interchange control number prefix. - * @member {string} [envelopeSettings.interchangeControlNumberSuffix] The - * interchange control number suffix. - * @member {string} [envelopeSettings.senderReverseRoutingAddress] The sender - * reverse routing address. - * @member {string} [envelopeSettings.receiverReverseRoutingAddress] The - * receiver reverse routing address. - * @member {string} [envelopeSettings.functionalGroupId] The functional group - * id. - * @member {string} [envelopeSettings.groupControllingAgencyCode] The group - * controlling agency code. - * @member {string} [envelopeSettings.groupMessageVersion] The group message - * version. - * @member {string} [envelopeSettings.groupMessageRelease] The group message - * release. - * @member {number} [envelopeSettings.groupControlNumberLowerBound] The group - * control number lower bound. - * @member {number} [envelopeSettings.groupControlNumberUpperBound] The group - * control number upper bound. - * @member {boolean} [envelopeSettings.rolloverGroupControlNumber] The value - * indicating whether to rollover group control number. - * @member {string} [envelopeSettings.groupControlNumberPrefix] The group - * control number prefix. - * @member {string} [envelopeSettings.groupControlNumberSuffix] The group - * control number suffix. - * @member {string} [envelopeSettings.groupApplicationReceiverQualifier] The - * group application receiver qualifier. - * @member {string} [envelopeSettings.groupApplicationReceiverId] The group - * application receiver id. - * @member {string} [envelopeSettings.groupApplicationSenderQualifier] The - * group application sender qualifier. - * @member {string} [envelopeSettings.groupApplicationSenderId] The group - * application sender id. - * @member {string} [envelopeSettings.groupApplicationPassword] The group - * application password. - * @member {boolean} - * [envelopeSettings.overwriteExistingTransactionSetControlNumber] The value - * indicating whether to overwrite existing transaction set control number. - * @member {string} [envelopeSettings.transactionSetControlNumberPrefix] The - * transaction set control number prefix. - * @member {string} [envelopeSettings.transactionSetControlNumberSuffix] The - * transaction set control number suffix. - * @member {number} [envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} [envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} [envelopeSettings.rolloverTransactionSetControlNumber] The - * value indicating whether to rollover transaction set control number. - * @member {boolean} [envelopeSettings.isTestInterchange] The value indicating - * whether the message is a test interchange. - * @member {string} [envelopeSettings.senderInternalIdentification] The sender - * internal identification. - * @member {string} [envelopeSettings.senderInternalSubIdentification] The - * sender internal sub identification. - * @member {string} [envelopeSettings.receiverInternalIdentification] The - * receiver internal identification. - * @member {string} [envelopeSettings.receiverInternalSubIdentification] The - * receiver internal sub identification. - * @member {object} acknowledgementSettings The EDIFACT acknowledgement - * settings. - * @member {boolean} [acknowledgementSettings.needTechnicalAcknowledgement] The - * value indicating whether technical acknowledgement is needed. - * @member {boolean} [acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} [acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {boolean} [acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} [acknowledgementSettings.needLoopForValidMessages] The - * value indicating whether a loop is needed for valid messages. - * @member {boolean} [acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [acknowledgementSettings.acknowledgementControlNumberPrefix] The - * acknowledgement control number prefix. - * @member {string} - * [acknowledgementSettings.acknowledgementControlNumberSuffix] The - * acknowledgement control number suffix. - * @member {number} - * [acknowledgementSettings.acknowledgementControlNumberLowerBound] The - * acknowledgement control number lower bound. - * @member {number} - * [acknowledgementSettings.acknowledgementControlNumberUpperBound] The - * acknowledgement control number upper bound. - * @member {boolean} - * [acknowledgementSettings.rolloverAcknowledgementControlNumber] The value - * indicating whether to rollover acknowledgement control number. - * @member {object} messageFilter The EDIFACT message filter. - * @member {string} [messageFilter.messageFilterType] The message filter type. - * Possible values include: 'NotSpecified', 'Include', 'Exclude' - * @member {object} processingSettings The EDIFACT processing Settings. - * @member {boolean} [processingSettings.maskSecurityInfo] The value indicating - * whether to mask security information. - * @member {boolean} [processingSettings.preserveInterchange] The value - * indicating whether to preserve interchange. - * @member {boolean} [processingSettings.suspendInterchangeOnError] The value - * indicating whether to suspend interchange on error. - * @member {boolean} - * [processingSettings.createEmptyXmlTagsForTrailingSeparators] The value - * indicating whether to create empty xml tags for trailing separators. - * @member {boolean} [processingSettings.useDotAsDecimalSeparator] The value - * indicating whether to use dot as decimal separator. - * @member {array} [envelopeOverrides] The EDIFACT envelope override settings. - * @member {array} [messageFilterList] The EDIFACT message filter list. - * @member {array} schemaReferences The EDIFACT schema references. - * @member {array} [validationOverrides] The EDIFACT validation override - * settings. - * @member {array} [edifactDelimiterOverrides] The EDIFACT delimiter override - * settings. */ export interface EdifactProtocolSettings { + /** + * The EDIFACT validation settings. + */ validationSettings: EdifactValidationSettings; + /** + * The EDIFACT framing settings. + */ framingSettings: EdifactFramingSettings; + /** + * The EDIFACT envelope settings. + */ envelopeSettings: EdifactEnvelopeSettings; + /** + * The EDIFACT acknowledgement settings. + */ acknowledgementSettings: EdifactAcknowledgementSettings; + /** + * The EDIFACT message filter. + */ messageFilter: EdifactMessageFilter; + /** + * The EDIFACT processing Settings. + */ processingSettings: EdifactProcessingSettings; + /** + * The EDIFACT envelope override settings. + */ envelopeOverrides?: EdifactEnvelopeOverride[]; + /** + * The EDIFACT message filter list. + */ messageFilterList?: EdifactMessageIdentifier[]; + /** + * The EDIFACT schema references. + */ schemaReferences: EdifactSchemaReference[]; + /** + * The EDIFACT validation override settings. + */ validationOverrides?: EdifactValidationOverride[]; + /** + * The EDIFACT delimiter override settings. + */ edifactDelimiterOverrides?: EdifactDelimiterOverride[]; } /** - * @class - * Initializes a new instance of the EdifactOneWayAgreement class. - * @constructor * The Edifact one way agreement. - * - * @member {object} senderBusinessIdentity The sender business identity - * @member {string} [senderBusinessIdentity.qualifier] The business identity - * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [senderBusinessIdentity.value] The user defined business - * identity value. - * @member {object} receiverBusinessIdentity The receiver business identity - * @member {string} [receiverBusinessIdentity.qualifier] The business identity - * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiverBusinessIdentity.value] The user defined business - * identity value. - * @member {object} protocolSettings The EDIFACT protocol settings. - * @member {object} [protocolSettings.validationSettings] The EDIFACT - * validation settings. - * @member {boolean} [protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [protocolSettings.validationSettings.checkDuplicateGroupControlNumber] The - * value indicating whether to check for duplicate group control number. - * @member {boolean} - * [protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} [protocolSettings.validationSettings.validateEdiTypes] The - * value indicating whether to Whether to validate EDI types. - * @member {boolean} [protocolSettings.validationSettings.validateXsdTypes] The - * value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [protocolSettings.validationSettings.trailingSeparatorPolicy] The trailing - * separator policy. Possible values include: 'NotSpecified', 'NotAllowed', - * 'Optional', 'Mandatory' - * @member {object} [protocolSettings.framingSettings] The EDIFACT framing - * settings. - * @member {string} - * [protocolSettings.framingSettings.serviceCodeListDirectoryVersion] The - * service code list directory version. - * @member {string} [protocolSettings.framingSettings.characterEncoding] The - * character encoding. - * @member {number} [protocolSettings.framingSettings.protocolVersion] The - * protocol version. - * @member {number} [protocolSettings.framingSettings.dataElementSeparator] The - * data element separator. - * @member {number} [protocolSettings.framingSettings.componentSeparator] The - * component separator. - * @member {number} [protocolSettings.framingSettings.segmentTerminator] The - * segment terminator. - * @member {number} [protocolSettings.framingSettings.releaseIndicator] The - * release indicator. - * @member {number} [protocolSettings.framingSettings.repetitionSeparator] The - * repetition separator. - * @member {string} [protocolSettings.framingSettings.characterSet] The EDIFACT - * frame setting characterSet. Possible values include: 'NotSpecified', 'UNOB', - * 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', - * 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} [protocolSettings.framingSettings.decimalPointIndicator] - * The EDIFACT frame setting decimal indicator. Possible values include: - * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} [protocolSettings.framingSettings.segmentTerminatorSuffix] - * The EDIFACT frame setting segment terminator suffix. Possible values - * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} [protocolSettings.envelopeSettings] The EDIFACT envelope - * settings. - * @member {string} - * [protocolSettings.envelopeSettings.groupAssociationAssignedCode] The group - * association assigned code. - * @member {string} - * [protocolSettings.envelopeSettings.communicationAgreementId] The - * communication agreement id. - * @member {boolean} - * [protocolSettings.envelopeSettings.applyDelimiterStringAdvice] The value - * indicating whether to apply delimiter string advice. - * @member {boolean} [protocolSettings.envelopeSettings.createGroupingSegments] - * The value indicating whether to create grouping segments. - * @member {boolean} - * [protocolSettings.envelopeSettings.enableDefaultGroupHeaders] The value - * indicating whether to enable default group headers. - * @member {string} - * [protocolSettings.envelopeSettings.recipientReferencePasswordValue] The - * recipient reference password value. - * @member {string} - * [protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] The - * recipient reference password qualifier. - * @member {string} [protocolSettings.envelopeSettings.applicationReferenceId] - * The application reference id. - * @member {string} [protocolSettings.envelopeSettings.processingPriorityCode] - * The processing priority code. - * @member {number} - * [protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] The - * interchange control number lower bound. - * @member {number} - * [protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] The - * interchange control number upper bound. - * @member {boolean} - * [protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] The - * value indicating whether to rollover interchange control number. - * @member {string} - * [protocolSettings.envelopeSettings.interchangeControlNumberPrefix] The - * interchange control number prefix. - * @member {string} - * [protocolSettings.envelopeSettings.interchangeControlNumberSuffix] The - * interchange control number suffix. - * @member {string} - * [protocolSettings.envelopeSettings.senderReverseRoutingAddress] The sender - * reverse routing address. - * @member {string} - * [protocolSettings.envelopeSettings.receiverReverseRoutingAddress] The - * receiver reverse routing address. - * @member {string} [protocolSettings.envelopeSettings.functionalGroupId] The - * functional group id. - * @member {string} - * [protocolSettings.envelopeSettings.groupControllingAgencyCode] The group - * controlling agency code. - * @member {string} [protocolSettings.envelopeSettings.groupMessageVersion] The - * group message version. - * @member {string} [protocolSettings.envelopeSettings.groupMessageRelease] The - * group message release. - * @member {number} - * [protocolSettings.envelopeSettings.groupControlNumberLowerBound] The group - * control number lower bound. - * @member {number} - * [protocolSettings.envelopeSettings.groupControlNumberUpperBound] The group - * control number upper bound. - * @member {boolean} - * [protocolSettings.envelopeSettings.rolloverGroupControlNumber] The value - * indicating whether to rollover group control number. - * @member {string} - * [protocolSettings.envelopeSettings.groupControlNumberPrefix] The group - * control number prefix. - * @member {string} - * [protocolSettings.envelopeSettings.groupControlNumberSuffix] The group - * control number suffix. - * @member {string} - * [protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] The - * group application receiver qualifier. - * @member {string} - * [protocolSettings.envelopeSettings.groupApplicationReceiverId] The group - * application receiver id. - * @member {string} - * [protocolSettings.envelopeSettings.groupApplicationSenderQualifier] The - * group application sender qualifier. - * @member {string} - * [protocolSettings.envelopeSettings.groupApplicationSenderId] The group - * application sender id. - * @member {string} - * [protocolSettings.envelopeSettings.groupApplicationPassword] The group - * application password. - * @member {boolean} - * [protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] The - * transaction set control number prefix. - * @member {string} - * [protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] The - * transaction set control number suffix. - * @member {number} - * [protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] The - * value indicating whether to rollover transaction set control number. - * @member {boolean} [protocolSettings.envelopeSettings.isTestInterchange] The - * value indicating whether the message is a test interchange. - * @member {string} - * [protocolSettings.envelopeSettings.senderInternalIdentification] The sender - * internal identification. - * @member {string} - * [protocolSettings.envelopeSettings.senderInternalSubIdentification] The - * sender internal sub identification. - * @member {string} - * [protocolSettings.envelopeSettings.receiverInternalIdentification] The - * receiver internal identification. - * @member {string} - * [protocolSettings.envelopeSettings.receiverInternalSubIdentification] The - * receiver internal sub identification. - * @member {object} [protocolSettings.acknowledgementSettings] The EDIFACT - * acknowledgement settings. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] The - * value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] The - * value indicating whether functional acknowledgement is needed. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.needLoopForValidMessages] The - * value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [protocolSettings.messageFilter] The EDIFACT message - * filter. - * @member {string} [protocolSettings.messageFilter.messageFilterType] The - * message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} [protocolSettings.processingSettings] The EDIFACT - * processing Settings. - * @member {boolean} [protocolSettings.processingSettings.maskSecurityInfo] The - * value indicating whether to mask security information. - * @member {boolean} [protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [protocolSettings.processingSettings.suspendInterchangeOnError] The value - * indicating whether to suspend interchange on error. - * @member {boolean} - * [protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [protocolSettings.processingSettings.useDotAsDecimalSeparator] The value - * indicating whether to use dot as decimal separator. - * @member {array} [protocolSettings.envelopeOverrides] The EDIFACT envelope - * override settings. - * @member {array} [protocolSettings.messageFilterList] The EDIFACT message - * filter list. - * @member {array} [protocolSettings.schemaReferences] The EDIFACT schema - * references. - * @member {array} [protocolSettings.validationOverrides] The EDIFACT - * validation override settings. - * @member {array} [protocolSettings.edifactDelimiterOverrides] The EDIFACT - * delimiter override settings. */ export interface EdifactOneWayAgreement { + /** + * The sender business identity + */ senderBusinessIdentity: BusinessIdentity; + /** + * The receiver business identity + */ receiverBusinessIdentity: BusinessIdentity; + /** + * The EDIFACT protocol settings. + */ protocolSettings: EdifactProtocolSettings; } /** - * @class - * Initializes a new instance of the EdifactAgreementContent class. - * @constructor * The Edifact agreement content. - * - * @member {object} receiveAgreement The EDIFACT one-way receive agreement. - * @member {object} [receiveAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [receiveAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [receiveAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [receiveAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [receiveAgreement.protocolSettings] The EDIFACT protocol - * settings. - * @member {object} [receiveAgreement.protocolSettings.validationSettings] The - * EDIFACT validation settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] The - * value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] The - * value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [receiveAgreement.protocolSettings.framingSettings] The - * EDIFACT framing settings. - * @member {string} - * [receiveAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] - * The service code list directory version. - * @member {string} - * [receiveAgreement.protocolSettings.framingSettings.characterEncoding] The - * character encoding. - * @member {number} - * [receiveAgreement.protocolSettings.framingSettings.protocolVersion] The - * protocol version. - * @member {number} - * [receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] The - * data element separator. - * @member {number} - * [receiveAgreement.protocolSettings.framingSettings.componentSeparator] The - * component separator. - * @member {number} - * [receiveAgreement.protocolSettings.framingSettings.segmentTerminator] The - * segment terminator. - * @member {number} - * [receiveAgreement.protocolSettings.framingSettings.releaseIndicator] The - * release indicator. - * @member {number} - * [receiveAgreement.protocolSettings.framingSettings.repetitionSeparator] The - * repetition separator. - * @member {string} - * [receiveAgreement.protocolSettings.framingSettings.characterSet] The EDIFACT - * frame setting characterSet. Possible values include: 'NotSpecified', 'UNOB', - * 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', - * 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} - * [receiveAgreement.protocolSettings.framingSettings.decimalPointIndicator] - * The EDIFACT frame setting decimal indicator. Possible values include: - * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} - * [receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] - * The EDIFACT frame setting segment terminator suffix. Possible values - * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} [receiveAgreement.protocolSettings.envelopeSettings] The - * EDIFACT envelope settings. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] - * The group association assigned code. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.communicationAgreementId] - * The communication agreement id. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] - * The value indicating whether to apply delimiter string advice. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.createGroupingSegments] - * The value indicating whether to create grouping segments. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] - * The recipient reference password value. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] - * The recipient reference password qualifier. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.applicationReferenceId] - * The application reference id. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.processingPriorityCode] - * The processing priority code. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] - * The interchange control number prefix. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] - * The interchange control number suffix. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] - * The sender reverse routing address. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] - * The receiver reverse routing address. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] The - * functional group id. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] - * The group controlling agency code. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupMessageVersion] The - * group message version. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupMessageRelease] The - * group message release. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] - * The group control number prefix. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] - * The group control number suffix. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] - * The group application receiver qualifier. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] - * The group application receiver id. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] - * The group application sender qualifier. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] - * The group application sender id. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] - * The group application password. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {boolean} - * [receiveAgreement.protocolSettings.envelopeSettings.isTestInterchange] The - * value indicating whether the message is a test interchange. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] - * The sender internal identification. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] - * The sender internal sub identification. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] - * The receiver internal identification. - * @member {string} - * [receiveAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] - * The receiver internal sub identification. - * @member {object} [receiveAgreement.protocolSettings.acknowledgementSettings] - * The EDIFACT acknowledgement settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [receiveAgreement.protocolSettings.messageFilter] The - * EDIFACT message filter. - * @member {string} - * [receiveAgreement.protocolSettings.messageFilter.messageFilterType] The - * message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} [receiveAgreement.protocolSettings.processingSettings] The - * EDIFACT processing Settings. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] The - * value indicating whether to mask security information. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} [receiveAgreement.protocolSettings.envelopeOverrides] The - * EDIFACT envelope override settings. - * @member {array} [receiveAgreement.protocolSettings.messageFilterList] The - * EDIFACT message filter list. - * @member {array} [receiveAgreement.protocolSettings.schemaReferences] The - * EDIFACT schema references. - * @member {array} [receiveAgreement.protocolSettings.validationOverrides] The - * EDIFACT validation override settings. - * @member {array} - * [receiveAgreement.protocolSettings.edifactDelimiterOverrides] The EDIFACT - * delimiter override settings. - * @member {object} sendAgreement The EDIFACT one-way send agreement. - * @member {object} [sendAgreement.senderBusinessIdentity] The sender business - * identity - * @member {string} [sendAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [sendAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [sendAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [sendAgreement.protocolSettings] The EDIFACT protocol - * settings. - * @member {object} [sendAgreement.protocolSettings.validationSettings] The - * EDIFACT validation settings. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.validateCharacterSet] The - * value indicating whether to validate character set in the message. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.validateEdiTypes] The - * value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.validateXsdTypes] The - * value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [sendAgreement.protocolSettings.framingSettings] The - * EDIFACT framing settings. - * @member {string} - * [sendAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] - * The service code list directory version. - * @member {string} - * [sendAgreement.protocolSettings.framingSettings.characterEncoding] The - * character encoding. - * @member {number} - * [sendAgreement.protocolSettings.framingSettings.protocolVersion] The - * protocol version. - * @member {number} - * [sendAgreement.protocolSettings.framingSettings.dataElementSeparator] The - * data element separator. - * @member {number} - * [sendAgreement.protocolSettings.framingSettings.componentSeparator] The - * component separator. - * @member {number} - * [sendAgreement.protocolSettings.framingSettings.segmentTerminator] The - * segment terminator. - * @member {number} - * [sendAgreement.protocolSettings.framingSettings.releaseIndicator] The - * release indicator. - * @member {number} - * [sendAgreement.protocolSettings.framingSettings.repetitionSeparator] The - * repetition separator. - * @member {string} - * [sendAgreement.protocolSettings.framingSettings.characterSet] The EDIFACT - * frame setting characterSet. Possible values include: 'NotSpecified', 'UNOB', - * 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', - * 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} - * [sendAgreement.protocolSettings.framingSettings.decimalPointIndicator] The - * EDIFACT frame setting decimal indicator. Possible values include: - * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} - * [sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] The - * EDIFACT frame setting segment terminator suffix. Possible values include: - * 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} [sendAgreement.protocolSettings.envelopeSettings] The - * EDIFACT envelope settings. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] - * The group association assigned code. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.communicationAgreementId] - * The communication agreement id. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] - * The value indicating whether to apply delimiter string advice. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.createGroupingSegments] The - * value indicating whether to create grouping segments. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] - * The recipient reference password value. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] - * The recipient reference password qualifier. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.applicationReferenceId] The - * application reference id. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.processingPriorityCode] The - * processing priority code. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] - * The interchange control number prefix. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] - * The interchange control number suffix. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] - * The sender reverse routing address. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] - * The receiver reverse routing address. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] The - * functional group id. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] - * The group controlling agency code. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupMessageVersion] The - * group message version. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupMessageRelease] The - * group message release. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] - * The group control number prefix. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] - * The group control number suffix. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] - * The group application receiver qualifier. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] - * The group application receiver id. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] - * The group application sender qualifier. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] - * The group application sender id. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] - * The group application password. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {boolean} - * [sendAgreement.protocolSettings.envelopeSettings.isTestInterchange] The - * value indicating whether the message is a test interchange. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] - * The sender internal identification. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] - * The sender internal sub identification. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] - * The receiver internal identification. - * @member {string} - * [sendAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] - * The receiver internal sub identification. - * @member {object} [sendAgreement.protocolSettings.acknowledgementSettings] - * The EDIFACT acknowledgement settings. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [sendAgreement.protocolSettings.messageFilter] The EDIFACT - * message filter. - * @member {string} - * [sendAgreement.protocolSettings.messageFilter.messageFilterType] The message - * filter type. Possible values include: 'NotSpecified', 'Include', 'Exclude' - * @member {object} [sendAgreement.protocolSettings.processingSettings] The - * EDIFACT processing Settings. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] The - * value indicating whether to mask security information. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.preserveInterchange] The - * value indicating whether to preserve interchange. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} [sendAgreement.protocolSettings.envelopeOverrides] The - * EDIFACT envelope override settings. - * @member {array} [sendAgreement.protocolSettings.messageFilterList] The - * EDIFACT message filter list. - * @member {array} [sendAgreement.protocolSettings.schemaReferences] The - * EDIFACT schema references. - * @member {array} [sendAgreement.protocolSettings.validationOverrides] The - * EDIFACT validation override settings. - * @member {array} [sendAgreement.protocolSettings.edifactDelimiterOverrides] - * The EDIFACT delimiter override settings. */ export interface EdifactAgreementContent { + /** + * The EDIFACT one-way receive agreement. + */ receiveAgreement: EdifactOneWayAgreement; + /** + * The EDIFACT one-way send agreement. + */ sendAgreement: EdifactOneWayAgreement; } /** - * @class - * Initializes a new instance of the AgreementContent class. - * @constructor * The integration account agreement content. - * - * @member {object} [aS2] The AS2 agreement content. - * @member {object} [aS2.receiveAgreement] The AS2 one-way receive agreement. - * @member {object} [aS2.receiveAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [aS2.receiveAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [aS2.receiveAgreement.senderBusinessIdentity.value] The - * user defined business identity value. - * @member {object} [aS2.receiveAgreement.receiverBusinessIdentity] The - * receiver business identity - * @member {string} [aS2.receiveAgreement.receiverBusinessIdentity.qualifier] - * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [aS2.receiveAgreement.receiverBusinessIdentity.value] The - * user defined business identity value. - * @member {object} [aS2.receiveAgreement.protocolSettings] The AS2 protocol - * settings. - * @member {object} - * [aS2.receiveAgreement.protocolSettings.messageConnectionSettings] The - * message connection settings. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} - * [aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings] - * The acknowledgement connection settings. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} [aS2.receiveAgreement.protocolSettings.mdnSettings] The MDN - * settings. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.mdnSettings.needMdn] The value - * indicating whether to send or request a MDN. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.mdnSettings.signMdn] The value - * indicating whether the MDN needs to be signed or not. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] - * The value indicating whether to send the asynchronous MDN. - * @member {string} - * [aS2.receiveAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The - * receipt delivery URL. - * @member {string} - * [aS2.receiveAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] - * The disposition notification to header value. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] - * The value indicating whether to sign the outbound MDN if optional. - * @member {string} [aS2.receiveAgreement.protocolSettings.mdnSettings.mdnText] - * The MDN text. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] - * The value indicating whether to send inbound MDN to message box. - * @member {string} - * [aS2.receiveAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The - * signing or hashing algorithm. Possible values include: 'NotSpecified', - * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [aS2.receiveAgreement.protocolSettings.securitySettings] - * The security settings. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] - * The value indicating whether to send or request a MDN. - * @member {string} - * [aS2.receiveAgreement.protocolSettings.securitySettings.signingCertificateName] - * The name of the signing certificate. - * @member {string} - * [aS2.receiveAgreement.protocolSettings.securitySettings.encryptionCertificateName] - * The name of the encryption certificate. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] - * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] - * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] - * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] - * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] - * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] - * The value indicating whether to enable NRR for inbound MDN. - * @member {string} - * [aS2.receiveAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] - * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, - * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} [aS2.receiveAgreement.protocolSettings.validationSettings] - * The validation settings. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.validationSettings.overrideMessageProperties] - * The value indicating whether to override incoming message properties with - * those in agreement. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.validationSettings.encryptMessage] - * The value indicating whether the message has to be encrypted. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.validationSettings.signMessage] The - * value indicating whether the message has to be signed. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.validationSettings.compressMessage] - * The value indicating whether the message has to be compressed. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.validationSettings.checkDuplicateMessage] - * The value indicating whether to check for duplicate message. - * @member {number} - * [aS2.receiveAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] - * The number of days to look back for duplicate interchange. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] - * The value indicating whether to check for certificate revocation list on - * send. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] - * The value indicating whether to check for certificate revocation list on - * receive. - * @member {string} - * [aS2.receiveAgreement.protocolSettings.validationSettings.encryptionAlgorithm] - * The encryption algorithm. Possible values include: 'NotSpecified', 'None', - * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} - * [aS2.receiveAgreement.protocolSettings.validationSettings.signingAlgorithm] - * The signing algorithm. Possible values include: 'NotSpecified', 'Default', - * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [aS2.receiveAgreement.protocolSettings.envelopeSettings] - * The envelope settings. - * @member {string} - * [aS2.receiveAgreement.protocolSettings.envelopeSettings.messageContentType] - * The message content type. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] - * The value indicating whether to transmit file name in mime header. - * @member {string} - * [aS2.receiveAgreement.protocolSettings.envelopeSettings.fileNameTemplate] - * The template for file name. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] - * The value indicating whether to suspend message on file name generation - * error. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.envelopeSettings.autogenerateFileName] - * The value indicating whether to auto generate file name. - * @member {object} [aS2.receiveAgreement.protocolSettings.errorSettings] The - * error settings. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] - * The value indicating whether to suspend duplicate message. - * @member {boolean} - * [aS2.receiveAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] - * The value indicating whether to resend message If MDN is not received. - * @member {object} [aS2.sendAgreement] The AS2 one-way send agreement. - * @member {object} [aS2.sendAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [aS2.sendAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [aS2.sendAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [aS2.sendAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [aS2.sendAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [aS2.sendAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [aS2.sendAgreement.protocolSettings] The AS2 protocol - * settings. - * @member {object} - * [aS2.sendAgreement.protocolSettings.messageConnectionSettings] The message - * connection settings. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} - * [aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings] The - * acknowledgement connection settings. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} [aS2.sendAgreement.protocolSettings.mdnSettings] The MDN - * settings. - * @member {boolean} [aS2.sendAgreement.protocolSettings.mdnSettings.needMdn] - * The value indicating whether to send or request a MDN. - * @member {boolean} [aS2.sendAgreement.protocolSettings.mdnSettings.signMdn] - * The value indicating whether the MDN needs to be signed or not. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] The - * value indicating whether to send the asynchronous MDN. - * @member {string} - * [aS2.sendAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The - * receipt delivery URL. - * @member {string} - * [aS2.sendAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] - * The disposition notification to header value. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] - * The value indicating whether to sign the outbound MDN if optional. - * @member {string} [aS2.sendAgreement.protocolSettings.mdnSettings.mdnText] - * The MDN text. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] - * The value indicating whether to send inbound MDN to message box. - * @member {string} - * [aS2.sendAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The - * signing or hashing algorithm. Possible values include: 'NotSpecified', - * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [aS2.sendAgreement.protocolSettings.securitySettings] The - * security settings. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] - * The value indicating whether to send or request a MDN. - * @member {string} - * [aS2.sendAgreement.protocolSettings.securitySettings.signingCertificateName] - * The name of the signing certificate. - * @member {string} - * [aS2.sendAgreement.protocolSettings.securitySettings.encryptionCertificateName] - * The name of the encryption certificate. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] - * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] - * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] - * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] - * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] - * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] - * The value indicating whether to enable NRR for inbound MDN. - * @member {string} - * [aS2.sendAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] - * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, - * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} [aS2.sendAgreement.protocolSettings.validationSettings] The - * validation settings. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.validationSettings.overrideMessageProperties] - * The value indicating whether to override incoming message properties with - * those in agreement. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.validationSettings.encryptMessage] The - * value indicating whether the message has to be encrypted. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.validationSettings.signMessage] The - * value indicating whether the message has to be signed. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.validationSettings.compressMessage] The - * value indicating whether the message has to be compressed. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.validationSettings.checkDuplicateMessage] - * The value indicating whether to check for duplicate message. - * @member {number} - * [aS2.sendAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] - * The number of days to look back for duplicate interchange. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] - * The value indicating whether to check for certificate revocation list on - * send. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] - * The value indicating whether to check for certificate revocation list on - * receive. - * @member {string} - * [aS2.sendAgreement.protocolSettings.validationSettings.encryptionAlgorithm] - * The encryption algorithm. Possible values include: 'NotSpecified', 'None', - * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} - * [aS2.sendAgreement.protocolSettings.validationSettings.signingAlgorithm] The - * signing algorithm. Possible values include: 'NotSpecified', 'Default', - * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} [aS2.sendAgreement.protocolSettings.envelopeSettings] The - * envelope settings. - * @member {string} - * [aS2.sendAgreement.protocolSettings.envelopeSettings.messageContentType] The - * message content type. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] - * The value indicating whether to transmit file name in mime header. - * @member {string} - * [aS2.sendAgreement.protocolSettings.envelopeSettings.fileNameTemplate] The - * template for file name. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] - * The value indicating whether to suspend message on file name generation - * error. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.envelopeSettings.autogenerateFileName] - * The value indicating whether to auto generate file name. - * @member {object} [aS2.sendAgreement.protocolSettings.errorSettings] The - * error settings. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] - * The value indicating whether to suspend duplicate message. - * @member {boolean} - * [aS2.sendAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] - * The value indicating whether to resend message If MDN is not received. - * @member {object} [x12] The X12 agreement content. - * @member {object} [x12.receiveAgreement] The X12 one-way receive agreement. - * @member {object} [x12.receiveAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [x12.receiveAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [x12.receiveAgreement.senderBusinessIdentity.value] The - * user defined business identity value. - * @member {object} [x12.receiveAgreement.receiverBusinessIdentity] The - * receiver business identity - * @member {string} [x12.receiveAgreement.receiverBusinessIdentity.qualifier] - * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [x12.receiveAgreement.receiverBusinessIdentity.value] The - * user defined business identity value. - * @member {object} [x12.receiveAgreement.protocolSettings] The X12 protocol - * settings. - * @member {object} [x12.receiveAgreement.protocolSettings.validationSettings] - * The X12 validation settings. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [x12.receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] - * The value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] - * The value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [x12.receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [x12.receiveAgreement.protocolSettings.framingSettings] The - * X12 framing settings. - * @member {number} - * [x12.receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] - * The data element separator. - * @member {number} - * [x12.receiveAgreement.protocolSettings.framingSettings.componentSeparator] - * The component separator. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] - * The value indicating whether to replace separators in payload. - * @member {number} - * [x12.receiveAgreement.protocolSettings.framingSettings.replaceCharacter] The - * replacement character. - * @member {number} - * [x12.receiveAgreement.protocolSettings.framingSettings.segmentTerminator] - * The segment terminator. - * @member {string} - * [x12.receiveAgreement.protocolSettings.framingSettings.characterSet] The X12 - * character set. Possible values include: 'NotSpecified', 'Basic', 'Extended', - * 'UTF8' - * @member {string} - * [x12.receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] - * The segment terminator suffix. Possible values include: 'NotSpecified', - * 'None', 'CR', 'LF', 'CRLF' - * @member {object} [x12.receiveAgreement.protocolSettings.envelopeSettings] - * The X12 envelope settings. - * @member {number} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.controlStandardsId] - * The controls standards id. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] - * The value indicating whether to use control standards id as repetition - * character. - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.senderApplicationId] - * The sender application id. - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.receiverApplicationId] - * The receiver application id. - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.controlVersionNumber] - * The control version number. - * @member {number} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] - * The functional group id. - * @member {number} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] - * The group header agency code. - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] - * The group header version. - * @member {number} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] - * The group header date format. Possible values include: 'NotSpecified', - * 'CCYYMMDD', 'YYMMDD' - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] - * The group header time format. Possible values include: 'NotSpecified', - * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} - * [x12.receiveAgreement.protocolSettings.envelopeSettings.usageIndicator] The - * usage indicator. Possible values include: 'NotSpecified', 'Test', - * 'Information', 'Production' - * @member {object} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings] The X12 - * acknowledgment settings. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {string} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] - * The functional acknowledgement version. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] - * The value indicating whether implementation acknowledgement is needed. - * @member {string} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] - * The implementation acknowledgement version. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] - * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [x12.receiveAgreement.protocolSettings.messageFilter] The - * X12 message filter. - * @member {string} - * [x12.receiveAgreement.protocolSettings.messageFilter.messageFilterType] The - * message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} [x12.receiveAgreement.protocolSettings.securitySettings] - * The X12 security settings. - * @member {string} - * [x12.receiveAgreement.protocolSettings.securitySettings.authorizationQualifier] - * The authorization qualifier. - * @member {string} - * [x12.receiveAgreement.protocolSettings.securitySettings.authorizationValue] - * The authorization value. - * @member {string} - * [x12.receiveAgreement.protocolSettings.securitySettings.securityQualifier] - * The security qualifier. - * @member {string} - * [x12.receiveAgreement.protocolSettings.securitySettings.passwordValue] The - * password value. - * @member {object} [x12.receiveAgreement.protocolSettings.processingSettings] - * The X12 processing settings. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] - * The value indicating whether to mask security information. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.processingSettings.convertImpliedDecimal] - * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [x12.receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} [x12.receiveAgreement.protocolSettings.envelopeOverrides] - * The X12 envelope override settings. - * @member {array} [x12.receiveAgreement.protocolSettings.validationOverrides] - * The X12 validation override settings. - * @member {array} [x12.receiveAgreement.protocolSettings.messageFilterList] - * The X12 message filter list. - * @member {array} [x12.receiveAgreement.protocolSettings.schemaReferences] The - * X12 schema references. - * @member {array} - * [x12.receiveAgreement.protocolSettings.x12DelimiterOverrides] The X12 - * delimiter override settings. - * @member {object} [x12.sendAgreement] The X12 one-way send agreement. - * @member {object} [x12.sendAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [x12.sendAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [x12.sendAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [x12.sendAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [x12.sendAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [x12.sendAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [x12.sendAgreement.protocolSettings] The X12 protocol - * settings. - * @member {object} [x12.sendAgreement.protocolSettings.validationSettings] The - * X12 validation settings. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [x12.sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.validationSettings.validateEdiTypes] The - * value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.validationSettings.validateXsdTypes] The - * value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [x12.sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [x12.sendAgreement.protocolSettings.framingSettings] The - * X12 framing settings. - * @member {number} - * [x12.sendAgreement.protocolSettings.framingSettings.dataElementSeparator] - * The data element separator. - * @member {number} - * [x12.sendAgreement.protocolSettings.framingSettings.componentSeparator] The - * component separator. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] - * The value indicating whether to replace separators in payload. - * @member {number} - * [x12.sendAgreement.protocolSettings.framingSettings.replaceCharacter] The - * replacement character. - * @member {number} - * [x12.sendAgreement.protocolSettings.framingSettings.segmentTerminator] The - * segment terminator. - * @member {string} - * [x12.sendAgreement.protocolSettings.framingSettings.characterSet] The X12 - * character set. Possible values include: 'NotSpecified', 'Basic', 'Extended', - * 'UTF8' - * @member {string} - * [x12.sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] - * The segment terminator suffix. Possible values include: 'NotSpecified', - * 'None', 'CR', 'LF', 'CRLF' - * @member {object} [x12.sendAgreement.protocolSettings.envelopeSettings] The - * X12 envelope settings. - * @member {number} - * [x12.sendAgreement.protocolSettings.envelopeSettings.controlStandardsId] The - * controls standards id. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] - * The value indicating whether to use control standards id as repetition - * character. - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.senderApplicationId] - * The sender application id. - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.receiverApplicationId] - * The receiver application id. - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.controlVersionNumber] - * The control version number. - * @member {number} - * [x12.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [x12.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] The - * functional group id. - * @member {number} - * [x12.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [x12.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] - * The group header agency code. - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] The - * group header version. - * @member {number} - * [x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] - * The group header date format. Possible values include: 'NotSpecified', - * 'CCYYMMDD', 'YYMMDD' - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] - * The group header time format. Possible values include: 'NotSpecified', - * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} - * [x12.sendAgreement.protocolSettings.envelopeSettings.usageIndicator] The - * usage indicator. Possible values include: 'NotSpecified', 'Test', - * 'Information', 'Production' - * @member {object} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings] The X12 - * acknowledgment settings. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {string} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] - * The functional acknowledgement version. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] - * The value indicating whether implementation acknowledgement is needed. - * @member {string} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] - * The implementation acknowledgement version. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] - * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [x12.sendAgreement.protocolSettings.messageFilter] The X12 - * message filter. - * @member {string} - * [x12.sendAgreement.protocolSettings.messageFilter.messageFilterType] The - * message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} [x12.sendAgreement.protocolSettings.securitySettings] The - * X12 security settings. - * @member {string} - * [x12.sendAgreement.protocolSettings.securitySettings.authorizationQualifier] - * The authorization qualifier. - * @member {string} - * [x12.sendAgreement.protocolSettings.securitySettings.authorizationValue] The - * authorization value. - * @member {string} - * [x12.sendAgreement.protocolSettings.securitySettings.securityQualifier] The - * security qualifier. - * @member {string} - * [x12.sendAgreement.protocolSettings.securitySettings.passwordValue] The - * password value. - * @member {object} [x12.sendAgreement.protocolSettings.processingSettings] The - * X12 processing settings. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] The - * value indicating whether to mask security information. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.processingSettings.convertImpliedDecimal] - * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [x12.sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} [x12.sendAgreement.protocolSettings.envelopeOverrides] The - * X12 envelope override settings. - * @member {array} [x12.sendAgreement.protocolSettings.validationOverrides] The - * X12 validation override settings. - * @member {array} [x12.sendAgreement.protocolSettings.messageFilterList] The - * X12 message filter list. - * @member {array} [x12.sendAgreement.protocolSettings.schemaReferences] The - * X12 schema references. - * @member {array} [x12.sendAgreement.protocolSettings.x12DelimiterOverrides] - * The X12 delimiter override settings. - * @member {object} [edifact] The EDIFACT agreement content. - * @member {object} [edifact.receiveAgreement] The EDIFACT one-way receive - * agreement. - * @member {object} [edifact.receiveAgreement.senderBusinessIdentity] The - * sender business identity - * @member {string} [edifact.receiveAgreement.senderBusinessIdentity.qualifier] - * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [edifact.receiveAgreement.senderBusinessIdentity.value] The - * user defined business identity value. - * @member {object} [edifact.receiveAgreement.receiverBusinessIdentity] The - * receiver business identity - * @member {string} - * [edifact.receiveAgreement.receiverBusinessIdentity.qualifier] The business - * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [edifact.receiveAgreement.receiverBusinessIdentity.value] - * The user defined business identity value. - * @member {object} [edifact.receiveAgreement.protocolSettings] The EDIFACT - * protocol settings. - * @member {object} - * [edifact.receiveAgreement.protocolSettings.validationSettings] The EDIFACT - * validation settings. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] - * The value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] - * The value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [edifact.receiveAgreement.protocolSettings.framingSettings] - * The EDIFACT framing settings. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] - * The service code list directory version. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.framingSettings.characterEncoding] - * The character encoding. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.framingSettings.protocolVersion] - * The protocol version. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] - * The data element separator. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.framingSettings.componentSeparator] - * The component separator. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.framingSettings.segmentTerminator] - * The segment terminator. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.framingSettings.releaseIndicator] - * The release indicator. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.framingSettings.repetitionSeparator] - * The repetition separator. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.framingSettings.characterSet] The - * EDIFACT frame setting characterSet. Possible values include: 'NotSpecified', - * 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', - * 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} - * [edifact.receiveAgreement.protocolSettings.framingSettings.decimalPointIndicator] - * The EDIFACT frame setting decimal indicator. Possible values include: - * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} - * [edifact.receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] - * The EDIFACT frame setting segment terminator suffix. Possible values - * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings] The EDIFACT - * envelope settings. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] - * The group association assigned code. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.communicationAgreementId] - * The communication agreement id. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] - * The value indicating whether to apply delimiter string advice. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.createGroupingSegments] - * The value indicating whether to create grouping segments. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] - * The recipient reference password value. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] - * The recipient reference password qualifier. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.applicationReferenceId] - * The application reference id. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.processingPriorityCode] - * The processing priority code. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] - * The interchange control number prefix. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] - * The interchange control number suffix. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] - * The sender reverse routing address. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] - * The receiver reverse routing address. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] - * The functional group id. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] - * The group controlling agency code. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupMessageVersion] - * The group message version. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupMessageRelease] - * The group message release. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] - * The group control number prefix. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] - * The group control number suffix. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] - * The group application receiver qualifier. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] - * The group application receiver id. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] - * The group application sender qualifier. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] - * The group application sender id. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] - * The group application password. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.isTestInterchange] - * The value indicating whether the message is a test interchange. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] - * The sender internal identification. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] - * The sender internal sub identification. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] - * The receiver internal identification. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] - * The receiver internal sub identification. - * @member {object} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings] The - * EDIFACT acknowledgement settings. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [edifact.receiveAgreement.protocolSettings.messageFilter] - * The EDIFACT message filter. - * @member {string} - * [edifact.receiveAgreement.protocolSettings.messageFilter.messageFilterType] - * The message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} - * [edifact.receiveAgreement.protocolSettings.processingSettings] The EDIFACT - * processing Settings. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] - * The value indicating whether to mask security information. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [edifact.receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} - * [edifact.receiveAgreement.protocolSettings.envelopeOverrides] The EDIFACT - * envelope override settings. - * @member {array} - * [edifact.receiveAgreement.protocolSettings.messageFilterList] The EDIFACT - * message filter list. - * @member {array} [edifact.receiveAgreement.protocolSettings.schemaReferences] - * The EDIFACT schema references. - * @member {array} - * [edifact.receiveAgreement.protocolSettings.validationOverrides] The EDIFACT - * validation override settings. - * @member {array} - * [edifact.receiveAgreement.protocolSettings.edifactDelimiterOverrides] The - * EDIFACT delimiter override settings. - * @member {object} [edifact.sendAgreement] The EDIFACT one-way send agreement. - * @member {object} [edifact.sendAgreement.senderBusinessIdentity] The sender - * business identity - * @member {string} [edifact.sendAgreement.senderBusinessIdentity.qualifier] - * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [edifact.sendAgreement.senderBusinessIdentity.value] The - * user defined business identity value. - * @member {object} [edifact.sendAgreement.receiverBusinessIdentity] The - * receiver business identity - * @member {string} [edifact.sendAgreement.receiverBusinessIdentity.qualifier] - * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [edifact.sendAgreement.receiverBusinessIdentity.value] The - * user defined business identity value. - * @member {object} [edifact.sendAgreement.protocolSettings] The EDIFACT - * protocol settings. - * @member {object} [edifact.sendAgreement.protocolSettings.validationSettings] - * The EDIFACT validation settings. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [edifact.sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.validationSettings.validateEdiTypes] - * The value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.validationSettings.validateXsdTypes] - * The value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [edifact.sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [edifact.sendAgreement.protocolSettings.framingSettings] - * The EDIFACT framing settings. - * @member {string} - * [edifact.sendAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] - * The service code list directory version. - * @member {string} - * [edifact.sendAgreement.protocolSettings.framingSettings.characterEncoding] - * The character encoding. - * @member {number} - * [edifact.sendAgreement.protocolSettings.framingSettings.protocolVersion] The - * protocol version. - * @member {number} - * [edifact.sendAgreement.protocolSettings.framingSettings.dataElementSeparator] - * The data element separator. - * @member {number} - * [edifact.sendAgreement.protocolSettings.framingSettings.componentSeparator] - * The component separator. - * @member {number} - * [edifact.sendAgreement.protocolSettings.framingSettings.segmentTerminator] - * The segment terminator. - * @member {number} - * [edifact.sendAgreement.protocolSettings.framingSettings.releaseIndicator] - * The release indicator. - * @member {number} - * [edifact.sendAgreement.protocolSettings.framingSettings.repetitionSeparator] - * The repetition separator. - * @member {string} - * [edifact.sendAgreement.protocolSettings.framingSettings.characterSet] The - * EDIFACT frame setting characterSet. Possible values include: 'NotSpecified', - * 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', - * 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} - * [edifact.sendAgreement.protocolSettings.framingSettings.decimalPointIndicator] - * The EDIFACT frame setting decimal indicator. Possible values include: - * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} - * [edifact.sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] - * The EDIFACT frame setting segment terminator suffix. Possible values - * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} [edifact.sendAgreement.protocolSettings.envelopeSettings] - * The EDIFACT envelope settings. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] - * The group association assigned code. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.communicationAgreementId] - * The communication agreement id. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] - * The value indicating whether to apply delimiter string advice. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.createGroupingSegments] - * The value indicating whether to create grouping segments. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] - * The recipient reference password value. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] - * The recipient reference password qualifier. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.applicationReferenceId] - * The application reference id. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.processingPriorityCode] - * The processing priority code. - * @member {number} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] - * The interchange control number prefix. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] - * The interchange control number suffix. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] - * The sender reverse routing address. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] - * The receiver reverse routing address. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] - * The functional group id. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] - * The group controlling agency code. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupMessageVersion] - * The group message version. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupMessageRelease] - * The group message release. - * @member {number} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] - * The group control number prefix. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] - * The group control number suffix. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] - * The group application receiver qualifier. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] - * The group application receiver id. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] - * The group application sender qualifier. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] - * The group application sender id. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] - * The group application password. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {number} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.isTestInterchange] - * The value indicating whether the message is a test interchange. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] - * The sender internal identification. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] - * The sender internal sub identification. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] - * The receiver internal identification. - * @member {string} - * [edifact.sendAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] - * The receiver internal sub identification. - * @member {object} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings] The EDIFACT - * acknowledgement settings. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [edifact.sendAgreement.protocolSettings.messageFilter] The - * EDIFACT message filter. - * @member {string} - * [edifact.sendAgreement.protocolSettings.messageFilter.messageFilterType] The - * message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} [edifact.sendAgreement.protocolSettings.processingSettings] - * The EDIFACT processing Settings. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] - * The value indicating whether to mask security information. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [edifact.sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} [edifact.sendAgreement.protocolSettings.envelopeOverrides] - * The EDIFACT envelope override settings. - * @member {array} [edifact.sendAgreement.protocolSettings.messageFilterList] - * The EDIFACT message filter list. - * @member {array} [edifact.sendAgreement.protocolSettings.schemaReferences] - * The EDIFACT schema references. - * @member {array} [edifact.sendAgreement.protocolSettings.validationOverrides] - * The EDIFACT validation override settings. - * @member {array} - * [edifact.sendAgreement.protocolSettings.edifactDelimiterOverrides] The - * EDIFACT delimiter override settings. */ export interface AgreementContent { + /** + * The AS2 agreement content. + */ aS2?: AS2AgreementContent; + /** + * The X12 agreement content. + */ x12?: X12AgreementContent; + /** + * The EDIFACT agreement content. + */ edifact?: EdifactAgreementContent; } /** - * @class - * Initializes a new instance of the IntegrationAccountAgreement class. - * @constructor * The integration account agreement. - * - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {object} [metadata] The metadata. - * @member {string} agreementType The agreement type. Possible values include: - * 'NotSpecified', 'AS2', 'X12', 'Edifact' - * @member {string} hostPartner The integration account partner that is set as - * host partner for this agreement. - * @member {string} guestPartner The integration account partner that is set as - * guest partner for this agreement. - * @member {object} hostIdentity The business identity of the host partner. - * @member {string} [hostIdentity.qualifier] The business identity qualifier - * e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [hostIdentity.value] The user defined business identity - * value. - * @member {object} guestIdentity The business identity of the guest partner. - * @member {string} [guestIdentity.qualifier] The business identity qualifier - * e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [guestIdentity.value] The user defined business identity - * value. - * @member {object} content The agreement content. - * @member {object} [content.aS2] The AS2 agreement content. - * @member {object} [content.aS2.receiveAgreement] The AS2 one-way receive - * agreement. - * @member {object} [content.aS2.receiveAgreement.senderBusinessIdentity] The - * sender business identity - * @member {string} - * [content.aS2.receiveAgreement.senderBusinessIdentity.qualifier] The business - * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [content.aS2.receiveAgreement.senderBusinessIdentity.value] - * The user defined business identity value. - * @member {object} [content.aS2.receiveAgreement.receiverBusinessIdentity] The - * receiver business identity - * @member {string} - * [content.aS2.receiveAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} - * [content.aS2.receiveAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [content.aS2.receiveAgreement.protocolSettings] The AS2 - * protocol settings. - * @member {object} - * [content.aS2.receiveAgreement.protocolSettings.messageConnectionSettings] - * The message connection settings. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} - * [content.aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings] - * The acknowledgement connection settings. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} [content.aS2.receiveAgreement.protocolSettings.mdnSettings] - * The MDN settings. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.needMdn] The - * value indicating whether to send or request a MDN. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.signMdn] The - * value indicating whether the MDN needs to be signed or not. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] - * The value indicating whether to send the asynchronous MDN. - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] - * The receipt delivery URL. - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] - * The disposition notification to header value. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] - * The value indicating whether to sign the outbound MDN if optional. - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.mdnText] The MDN - * text. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] - * The value indicating whether to send inbound MDN to message box. - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] - * The signing or hashing algorithm. Possible values include: 'NotSpecified', - * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings] The - * security settings. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] - * The value indicating whether to send or request a MDN. - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings.signingCertificateName] - * The name of the signing certificate. - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings.encryptionCertificateName] - * The name of the encryption certificate. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] - * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] - * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] - * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] - * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] - * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] - * The value indicating whether to enable NRR for inbound MDN. - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] - * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, - * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings] The - * validation settings. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings.overrideMessageProperties] - * The value indicating whether to override incoming message properties with - * those in agreement. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings.encryptMessage] - * The value indicating whether the message has to be encrypted. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings.signMessage] - * The value indicating whether the message has to be signed. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings.compressMessage] - * The value indicating whether the message has to be compressed. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings.checkDuplicateMessage] - * The value indicating whether to check for duplicate message. - * @member {number} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] - * The number of days to look back for duplicate interchange. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] - * The value indicating whether to check for certificate revocation list on - * send. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] - * The value indicating whether to check for certificate revocation list on - * receive. - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings.encryptionAlgorithm] - * The encryption algorithm. Possible values include: 'NotSpecified', 'None', - * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.validationSettings.signingAlgorithm] - * The signing algorithm. Possible values include: 'NotSpecified', 'Default', - * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} - * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings] The - * envelope settings. - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings.messageContentType] - * The message content type. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] - * The value indicating whether to transmit file name in mime header. - * @member {string} - * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings.fileNameTemplate] - * The template for file name. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] - * The value indicating whether to suspend message on file name generation - * error. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings.autogenerateFileName] - * The value indicating whether to auto generate file name. - * @member {object} - * [content.aS2.receiveAgreement.protocolSettings.errorSettings] The error - * settings. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] - * The value indicating whether to suspend duplicate message. - * @member {boolean} - * [content.aS2.receiveAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] - * The value indicating whether to resend message If MDN is not received. - * @member {object} [content.aS2.sendAgreement] The AS2 one-way send agreement. - * @member {object} [content.aS2.sendAgreement.senderBusinessIdentity] The - * sender business identity - * @member {string} - * [content.aS2.sendAgreement.senderBusinessIdentity.qualifier] The business - * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [content.aS2.sendAgreement.senderBusinessIdentity.value] - * The user defined business identity value. - * @member {object} [content.aS2.sendAgreement.receiverBusinessIdentity] The - * receiver business identity - * @member {string} - * [content.aS2.sendAgreement.receiverBusinessIdentity.qualifier] The business - * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [content.aS2.sendAgreement.receiverBusinessIdentity.value] - * The user defined business identity value. - * @member {object} [content.aS2.sendAgreement.protocolSettings] The AS2 - * protocol settings. - * @member {object} - * [content.aS2.sendAgreement.protocolSettings.messageConnectionSettings] The - * message connection settings. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} - * [content.aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings] - * The acknowledgement connection settings. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] - * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] - * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] - * The value indicating whether to keep the connection alive. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] - * The value indicating whether to unfold the HTTP headers. - * @member {object} [content.aS2.sendAgreement.protocolSettings.mdnSettings] - * The MDN settings. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.mdnSettings.needMdn] The value - * indicating whether to send or request a MDN. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.mdnSettings.signMdn] The value - * indicating whether the MDN needs to be signed or not. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] - * The value indicating whether to send the asynchronous MDN. - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] - * The receipt delivery URL. - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] - * The disposition notification to header value. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] - * The value indicating whether to sign the outbound MDN if optional. - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.mdnSettings.mdnText] The MDN - * text. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] - * The value indicating whether to send inbound MDN to message box. - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] - * The signing or hashing algorithm. Possible values include: 'NotSpecified', - * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} - * [content.aS2.sendAgreement.protocolSettings.securitySettings] The security - * settings. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] - * The value indicating whether to send or request a MDN. - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.securitySettings.signingCertificateName] - * The name of the signing certificate. - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.securitySettings.encryptionCertificateName] - * The name of the encryption certificate. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] - * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] - * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] - * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] - * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] - * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] - * The value indicating whether to enable NRR for inbound MDN. - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] - * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, - * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} - * [content.aS2.sendAgreement.protocolSettings.validationSettings] The - * validation settings. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.validationSettings.overrideMessageProperties] - * The value indicating whether to override incoming message properties with - * those in agreement. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.validationSettings.encryptMessage] - * The value indicating whether the message has to be encrypted. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.validationSettings.signMessage] - * The value indicating whether the message has to be signed. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.validationSettings.compressMessage] - * The value indicating whether the message has to be compressed. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.validationSettings.checkDuplicateMessage] - * The value indicating whether to check for duplicate message. - * @member {number} - * [content.aS2.sendAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] - * The number of days to look back for duplicate interchange. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] - * The value indicating whether to check for certificate revocation list on - * send. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] - * The value indicating whether to check for certificate revocation list on - * receive. - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.validationSettings.encryptionAlgorithm] - * The encryption algorithm. Possible values include: 'NotSpecified', 'None', - * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.validationSettings.signingAlgorithm] - * The signing algorithm. Possible values include: 'NotSpecified', 'Default', - * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} - * [content.aS2.sendAgreement.protocolSettings.envelopeSettings] The envelope - * settings. - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.envelopeSettings.messageContentType] - * The message content type. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] - * The value indicating whether to transmit file name in mime header. - * @member {string} - * [content.aS2.sendAgreement.protocolSettings.envelopeSettings.fileNameTemplate] - * The template for file name. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] - * The value indicating whether to suspend message on file name generation - * error. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.envelopeSettings.autogenerateFileName] - * The value indicating whether to auto generate file name. - * @member {object} [content.aS2.sendAgreement.protocolSettings.errorSettings] - * The error settings. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] - * The value indicating whether to suspend duplicate message. - * @member {boolean} - * [content.aS2.sendAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] - * The value indicating whether to resend message If MDN is not received. - * @member {object} [content.x12] The X12 agreement content. - * @member {object} [content.x12.receiveAgreement] The X12 one-way receive - * agreement. - * @member {object} [content.x12.receiveAgreement.senderBusinessIdentity] The - * sender business identity - * @member {string} - * [content.x12.receiveAgreement.senderBusinessIdentity.qualifier] The business - * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [content.x12.receiveAgreement.senderBusinessIdentity.value] - * The user defined business identity value. - * @member {object} [content.x12.receiveAgreement.receiverBusinessIdentity] The - * receiver business identity - * @member {string} - * [content.x12.receiveAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} - * [content.x12.receiveAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [content.x12.receiveAgreement.protocolSettings] The X12 - * protocol settings. - * @member {object} - * [content.x12.receiveAgreement.protocolSettings.validationSettings] The X12 - * validation settings. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] - * The value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] - * The value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} - * [content.x12.receiveAgreement.protocolSettings.framingSettings] The X12 - * framing settings. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] - * The data element separator. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.framingSettings.componentSeparator] - * The component separator. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] - * The value indicating whether to replace separators in payload. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.framingSettings.replaceCharacter] - * The replacement character. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.framingSettings.segmentTerminator] - * The segment terminator. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.framingSettings.characterSet] - * The X12 character set. Possible values include: 'NotSpecified', 'Basic', - * 'Extended', 'UTF8' - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] - * The segment terminator suffix. Possible values include: 'NotSpecified', - * 'None', 'CR', 'LF', 'CRLF' - * @member {object} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings] The X12 - * envelope settings. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.controlStandardsId] - * The controls standards id. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] - * The value indicating whether to use control standards id as repetition - * character. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.senderApplicationId] - * The sender application id. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.receiverApplicationId] - * The receiver application id. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.controlVersionNumber] - * The control version number. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] - * The functional group id. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] - * The group header agency code. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] - * The group header version. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] - * The group header date format. Possible values include: 'NotSpecified', - * 'CCYYMMDD', 'YYMMDD' - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] - * The group header time format. Possible values include: 'NotSpecified', - * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.usageIndicator] - * The usage indicator. Possible values include: 'NotSpecified', 'Test', - * 'Information', 'Production' - * @member {object} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings] The - * X12 acknowledgment settings. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] - * The functional acknowledgement version. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] - * The value indicating whether implementation acknowledgement is needed. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] - * The implementation acknowledgement version. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] - * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} - * [content.x12.receiveAgreement.protocolSettings.messageFilter] The X12 - * message filter. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.messageFilter.messageFilterType] - * The message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} - * [content.x12.receiveAgreement.protocolSettings.securitySettings] The X12 - * security settings. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.securitySettings.authorizationQualifier] - * The authorization qualifier. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.securitySettings.authorizationValue] - * The authorization value. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.securitySettings.securityQualifier] - * The security qualifier. - * @member {string} - * [content.x12.receiveAgreement.protocolSettings.securitySettings.passwordValue] - * The password value. - * @member {object} - * [content.x12.receiveAgreement.protocolSettings.processingSettings] The X12 - * processing settings. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] - * The value indicating whether to mask security information. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.processingSettings.convertImpliedDecimal] - * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [content.x12.receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} - * [content.x12.receiveAgreement.protocolSettings.envelopeOverrides] The X12 - * envelope override settings. - * @member {array} - * [content.x12.receiveAgreement.protocolSettings.validationOverrides] The X12 - * validation override settings. - * @member {array} - * [content.x12.receiveAgreement.protocolSettings.messageFilterList] The X12 - * message filter list. - * @member {array} - * [content.x12.receiveAgreement.protocolSettings.schemaReferences] The X12 - * schema references. - * @member {array} - * [content.x12.receiveAgreement.protocolSettings.x12DelimiterOverrides] The - * X12 delimiter override settings. - * @member {object} [content.x12.sendAgreement] The X12 one-way send agreement. - * @member {object} [content.x12.sendAgreement.senderBusinessIdentity] The - * sender business identity - * @member {string} - * [content.x12.sendAgreement.senderBusinessIdentity.qualifier] The business - * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [content.x12.sendAgreement.senderBusinessIdentity.value] - * The user defined business identity value. - * @member {object} [content.x12.sendAgreement.receiverBusinessIdentity] The - * receiver business identity - * @member {string} - * [content.x12.sendAgreement.receiverBusinessIdentity.qualifier] The business - * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [content.x12.sendAgreement.receiverBusinessIdentity.value] - * The user defined business identity value. - * @member {object} [content.x12.sendAgreement.protocolSettings] The X12 - * protocol settings. - * @member {object} - * [content.x12.sendAgreement.protocolSettings.validationSettings] The X12 - * validation settings. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.validationSettings.validateEdiTypes] - * The value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.validationSettings.validateXsdTypes] - * The value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} - * [content.x12.sendAgreement.protocolSettings.framingSettings] The X12 framing - * settings. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.framingSettings.dataElementSeparator] - * The data element separator. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.framingSettings.componentSeparator] - * The component separator. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] - * The value indicating whether to replace separators in payload. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.framingSettings.replaceCharacter] - * The replacement character. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.framingSettings.segmentTerminator] - * The segment terminator. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.framingSettings.characterSet] - * The X12 character set. Possible values include: 'NotSpecified', 'Basic', - * 'Extended', 'UTF8' - * @member {string} - * [content.x12.sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] - * The segment terminator suffix. Possible values include: 'NotSpecified', - * 'None', 'CR', 'LF', 'CRLF' - * @member {object} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings] The X12 - * envelope settings. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.controlStandardsId] - * The controls standards id. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] - * The value indicating whether to use control standards id as repetition - * character. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.senderApplicationId] - * The sender application id. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.receiverApplicationId] - * The receiver application id. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.controlVersionNumber] - * The control version number. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] - * The functional group id. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] - * The group header agency code. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] - * The group header version. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] - * The group header date format. Possible values include: 'NotSpecified', - * 'CCYYMMDD', 'YYMMDD' - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] - * The group header time format. Possible values include: 'NotSpecified', - * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} - * [content.x12.sendAgreement.protocolSettings.envelopeSettings.usageIndicator] - * The usage indicator. Possible values include: 'NotSpecified', 'Test', - * 'Information', 'Production' - * @member {object} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings] The X12 - * acknowledgment settings. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] - * The functional acknowledgement version. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] - * The value indicating whether implementation acknowledgement is needed. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] - * The implementation acknowledgement version. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] - * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} [content.x12.sendAgreement.protocolSettings.messageFilter] - * The X12 message filter. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.messageFilter.messageFilterType] - * The message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} - * [content.x12.sendAgreement.protocolSettings.securitySettings] The X12 - * security settings. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.securitySettings.authorizationQualifier] - * The authorization qualifier. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.securitySettings.authorizationValue] - * The authorization value. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.securitySettings.securityQualifier] - * The security qualifier. - * @member {string} - * [content.x12.sendAgreement.protocolSettings.securitySettings.passwordValue] - * The password value. - * @member {object} - * [content.x12.sendAgreement.protocolSettings.processingSettings] The X12 - * processing settings. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] - * The value indicating whether to mask security information. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.processingSettings.convertImpliedDecimal] - * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [content.x12.sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} - * [content.x12.sendAgreement.protocolSettings.envelopeOverrides] The X12 - * envelope override settings. - * @member {array} - * [content.x12.sendAgreement.protocolSettings.validationOverrides] The X12 - * validation override settings. - * @member {array} - * [content.x12.sendAgreement.protocolSettings.messageFilterList] The X12 - * message filter list. - * @member {array} - * [content.x12.sendAgreement.protocolSettings.schemaReferences] The X12 schema - * references. - * @member {array} - * [content.x12.sendAgreement.protocolSettings.x12DelimiterOverrides] The X12 - * delimiter override settings. - * @member {object} [content.edifact] The EDIFACT agreement content. - * @member {object} [content.edifact.receiveAgreement] The EDIFACT one-way - * receive agreement. - * @member {object} [content.edifact.receiveAgreement.senderBusinessIdentity] - * The sender business identity - * @member {string} - * [content.edifact.receiveAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} - * [content.edifact.receiveAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [content.edifact.receiveAgreement.receiverBusinessIdentity] - * The receiver business identity - * @member {string} - * [content.edifact.receiveAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} - * [content.edifact.receiveAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [content.edifact.receiveAgreement.protocolSettings] The - * EDIFACT protocol settings. - * @member {object} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings] The - * EDIFACT validation settings. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] - * The value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] - * The value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings] The - * EDIFACT framing settings. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] - * The service code list directory version. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.characterEncoding] - * The character encoding. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.protocolVersion] - * The protocol version. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] - * The data element separator. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.componentSeparator] - * The component separator. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.segmentTerminator] - * The segment terminator. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.releaseIndicator] - * The release indicator. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.repetitionSeparator] - * The repetition separator. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.characterSet] - * The EDIFACT frame setting characterSet. Possible values include: - * 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', - * 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.decimalPointIndicator] - * The EDIFACT frame setting decimal indicator. Possible values include: - * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] - * The EDIFACT frame setting segment terminator suffix. Possible values - * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings] The - * EDIFACT envelope settings. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] - * The group association assigned code. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.communicationAgreementId] - * The communication agreement id. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] - * The value indicating whether to apply delimiter string advice. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.createGroupingSegments] - * The value indicating whether to create grouping segments. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] - * The recipient reference password value. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] - * The recipient reference password qualifier. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.applicationReferenceId] - * The application reference id. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.processingPriorityCode] - * The processing priority code. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] - * The interchange control number prefix. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] - * The interchange control number suffix. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] - * The sender reverse routing address. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] - * The receiver reverse routing address. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] - * The functional group id. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] - * The group controlling agency code. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupMessageVersion] - * The group message version. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupMessageRelease] - * The group message release. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] - * The group control number prefix. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] - * The group control number suffix. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] - * The group application receiver qualifier. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] - * The group application receiver id. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] - * The group application sender qualifier. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] - * The group application sender id. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] - * The group application password. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.isTestInterchange] - * The value indicating whether the message is a test interchange. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] - * The sender internal identification. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] - * The sender internal sub identification. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] - * The receiver internal identification. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] - * The receiver internal sub identification. - * @member {object} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings] - * The EDIFACT acknowledgement settings. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} - * [content.edifact.receiveAgreement.protocolSettings.messageFilter] The - * EDIFACT message filter. - * @member {string} - * [content.edifact.receiveAgreement.protocolSettings.messageFilter.messageFilterType] - * The message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} - * [content.edifact.receiveAgreement.protocolSettings.processingSettings] The - * EDIFACT processing Settings. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] - * The value indicating whether to mask security information. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [content.edifact.receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} - * [content.edifact.receiveAgreement.protocolSettings.envelopeOverrides] The - * EDIFACT envelope override settings. - * @member {array} - * [content.edifact.receiveAgreement.protocolSettings.messageFilterList] The - * EDIFACT message filter list. - * @member {array} - * [content.edifact.receiveAgreement.protocolSettings.schemaReferences] The - * EDIFACT schema references. - * @member {array} - * [content.edifact.receiveAgreement.protocolSettings.validationOverrides] The - * EDIFACT validation override settings. - * @member {array} - * [content.edifact.receiveAgreement.protocolSettings.edifactDelimiterOverrides] - * The EDIFACT delimiter override settings. - * @member {object} [content.edifact.sendAgreement] The EDIFACT one-way send - * agreement. - * @member {object} [content.edifact.sendAgreement.senderBusinessIdentity] The - * sender business identity - * @member {string} - * [content.edifact.sendAgreement.senderBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} - * [content.edifact.sendAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [content.edifact.sendAgreement.receiverBusinessIdentity] - * The receiver business identity - * @member {string} - * [content.edifact.sendAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} - * [content.edifact.sendAgreement.receiverBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [content.edifact.sendAgreement.protocolSettings] The - * EDIFACT protocol settings. - * @member {object} - * [content.edifact.sendAgreement.protocolSettings.validationSettings] The - * EDIFACT validation settings. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.validationSettings.validateCharacterSet] - * The value indicating whether to validate character set in the message. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] - * The value indicating whether to check for duplicate interchange control - * number. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] - * The value indicating whether to check for duplicate group control number. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] - * The value indicating whether to check for duplicate transaction set control - * number. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.validationSettings.validateEdiTypes] - * The value indicating whether to Whether to validate EDI types. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.validationSettings.validateXsdTypes] - * The value indicating whether to Whether to validate XSD types. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to allow leading and trailing spaces and - * zeroes. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] - * The value indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] - * The trailing separator policy. Possible values include: 'NotSpecified', - * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} - * [content.edifact.sendAgreement.protocolSettings.framingSettings] The EDIFACT - * framing settings. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] - * The service code list directory version. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.characterEncoding] - * The character encoding. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.protocolVersion] - * The protocol version. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.dataElementSeparator] - * The data element separator. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.componentSeparator] - * The component separator. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.segmentTerminator] - * The segment terminator. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.releaseIndicator] - * The release indicator. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.repetitionSeparator] - * The repetition separator. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.characterSet] - * The EDIFACT frame setting characterSet. Possible values include: - * 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', - * 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.decimalPointIndicator] - * The EDIFACT frame setting decimal indicator. Possible values include: - * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] - * The EDIFACT frame setting segment terminator suffix. Possible values - * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings] The - * EDIFACT envelope settings. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] - * The group association assigned code. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.communicationAgreementId] - * The communication agreement id. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] - * The value indicating whether to apply delimiter string advice. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.createGroupingSegments] - * The value indicating whether to create grouping segments. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] - * The value indicating whether to enable default group headers. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] - * The recipient reference password value. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] - * The recipient reference password qualifier. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.applicationReferenceId] - * The application reference id. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.processingPriorityCode] - * The processing priority code. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] - * The interchange control number lower bound. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] - * The interchange control number upper bound. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] - * The value indicating whether to rollover interchange control number. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] - * The interchange control number prefix. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] - * The interchange control number suffix. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] - * The sender reverse routing address. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] - * The receiver reverse routing address. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] - * The functional group id. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] - * The group controlling agency code. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupMessageVersion] - * The group message version. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupMessageRelease] - * The group message release. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] - * The group control number lower bound. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] - * The group control number upper bound. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] - * The value indicating whether to rollover group control number. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] - * The group control number prefix. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] - * The group control number suffix. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] - * The group application receiver qualifier. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] - * The group application receiver id. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] - * The group application sender qualifier. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] - * The group application sender id. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] - * The group application password. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] - * The value indicating whether to overwrite existing transaction set control - * number. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] - * The transaction set control number prefix. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] - * The transaction set control number suffix. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] - * The value indicating whether to rollover transaction set control number. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.isTestInterchange] - * The value indicating whether the message is a test interchange. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] - * The sender internal identification. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] - * The sender internal sub identification. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] - * The receiver internal identification. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] - * The receiver internal sub identification. - * @member {object} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings] The - * EDIFACT acknowledgement settings. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] - * The value indicating whether technical acknowledgement is needed. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] - * The value indicating whether to batch functional acknowledgements. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] - * The value indicating whether a loop is needed for valid messages. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] - * The acknowledgement control number prefix. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] - * The acknowledgement control number suffix. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] - * The acknowledgement control number lower bound. - * @member {number} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] - * The acknowledgement control number upper bound. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] - * The value indicating whether to rollover acknowledgement control number. - * @member {object} - * [content.edifact.sendAgreement.protocolSettings.messageFilter] The EDIFACT - * message filter. - * @member {string} - * [content.edifact.sendAgreement.protocolSettings.messageFilter.messageFilterType] - * The message filter type. Possible values include: 'NotSpecified', 'Include', - * 'Exclude' - * @member {object} - * [content.edifact.sendAgreement.protocolSettings.processingSettings] The - * EDIFACT processing Settings. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] - * The value indicating whether to mask security information. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.processingSettings.preserveInterchange] - * The value indicating whether to preserve interchange. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] - * The value indicating whether to suspend interchange on error. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] - * The value indicating whether to create empty xml tags for trailing - * separators. - * @member {boolean} - * [content.edifact.sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] - * The value indicating whether to use dot as decimal separator. - * @member {array} - * [content.edifact.sendAgreement.protocolSettings.envelopeOverrides] The - * EDIFACT envelope override settings. - * @member {array} - * [content.edifact.sendAgreement.protocolSettings.messageFilterList] The - * EDIFACT message filter list. - * @member {array} - * [content.edifact.sendAgreement.protocolSettings.schemaReferences] The - * EDIFACT schema references. - * @member {array} - * [content.edifact.sendAgreement.protocolSettings.validationOverrides] The - * EDIFACT validation override settings. - * @member {array} - * [content.edifact.sendAgreement.protocolSettings.edifactDelimiterOverrides] - * The EDIFACT delimiter override settings. */ export interface IntegrationAccountAgreement extends Resource { + /** + * The created time. + */ readonly createdTime?: Date; + /** + * The changed time. + */ readonly changedTime?: Date; + /** + * The metadata. + */ metadata?: any; + /** + * The agreement type. Possible values include: 'NotSpecified', 'AS2', 'X12', 'Edifact' + */ agreementType: string; + /** + * The integration account partner that is set as host partner for this agreement. + */ hostPartner: string; + /** + * The integration account partner that is set as guest partner for this agreement. + */ guestPartner: string; + /** + * The business identity of the host partner. + */ hostIdentity: BusinessIdentity; + /** + * The business identity of the guest partner. + */ guestIdentity: BusinessIdentity; + /** + * The agreement content. + */ content: AgreementContent; } /** - * @class - * Initializes a new instance of the IntegrationAccountAgreementFilter class. - * @constructor * The integration account agreement filter for odata query. - * - * @member {string} agreementType The agreement type of integration account - * agreement. Possible values include: 'NotSpecified', 'AS2', 'X12', 'Edifact' */ export interface IntegrationAccountAgreementFilter { + /** + * The agreement type of integration account agreement. Possible values include: 'NotSpecified', + * 'AS2', 'X12', 'Edifact' + */ agreementType: string; } /** - * @class - * Initializes a new instance of the KeyVaultKeyReferenceKeyVault class. - * @constructor * The key vault reference. - * - * @member {string} [id] The resource id. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. */ export interface KeyVaultKeyReferenceKeyVault { + /** + * The resource id. + */ id?: string; + /** + * The resource name. + */ readonly name?: string; + /** + * The resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the KeyVaultKeyReference class. - * @constructor * The reference to the key vault key. - * - * @member {object} keyVault The key vault reference. - * @member {string} [keyVault.id] The resource id. - * @member {string} [keyVault.name] The resource name. - * @member {string} [keyVault.type] The resource type. - * @member {string} keyName The private key name in key vault. - * @member {string} [keyVersion] The private key version in key vault. */ export interface KeyVaultKeyReference { + /** + * The key vault reference. + */ keyVault: KeyVaultKeyReferenceKeyVault; + /** + * The private key name in key vault. + */ keyName: string; + /** + * The private key version in key vault. + */ keyVersion?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountCertificate class. - * @constructor * The integration account certificate. - * - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {object} [metadata] The metadata. - * @member {object} [key] The key details in the key vault. - * @member {object} [key.keyVault] The key vault reference. - * @member {string} [key.keyVault.id] The resource id. - * @member {string} [key.keyVault.name] The resource name. - * @member {string} [key.keyVault.type] The resource type. - * @member {string} [key.keyName] The private key name in key vault. - * @member {string} [key.keyVersion] The private key version in key vault. - * @member {string} [publicCertificate] The public certificate. */ export interface IntegrationAccountCertificate extends Resource { + /** + * The created time. + */ readonly createdTime?: Date; + /** + * The changed time. + */ readonly changedTime?: Date; + /** + * The metadata. + */ metadata?: any; + /** + * The key details in the key vault. + */ key?: KeyVaultKeyReference; + /** + * The public certificate. + */ publicCertificate?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountSessionFilter class. - * @constructor * The integration account session filter. - * - * @member {date} changedTime The changed time of integration account sessions. */ export interface IntegrationAccountSessionFilter { + /** + * The changed time of integration account sessions. + */ changedTime: Date; } /** - * @class - * Initializes a new instance of the IntegrationAccountSession class. - * @constructor * The integration account session. - * - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {object} [content] The session content. */ export interface IntegrationAccountSession extends Resource { + /** + * The created time. + */ readonly createdTime?: Date; + /** + * The changed time. + */ readonly changedTime?: Date; + /** + * The session content. + */ content?: any; } /** - * @class - * Initializes a new instance of the OperationDisplay class. - * @constructor * The object that represents the operation. - * - * @member {string} [provider] Service provider: Microsoft.Logic - * @member {string} [resource] Resource on which the operation is performed: - * Profile, endpoint, etc. - * @member {string} [operation] Operation type: Read, write, delete, etc. */ export interface OperationDisplay { + /** + * Service provider: Microsoft.Logic + */ provider?: string; + /** + * Resource on which the operation is performed: Profile, endpoint, etc. + */ resource?: string; + /** + * Operation type: Read, write, delete, etc. + */ operation?: string; } /** - * @class - * Initializes a new instance of the Operation class. - * @constructor * Logic REST API operation - * - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] The object that represents the operation. - * @member {string} [display.provider] Service provider: Microsoft.Logic - * @member {string} [display.resource] Resource on which the operation is - * performed: Profile, endpoint, etc. - * @member {string} [display.operation] Operation type: Read, write, delete, - * etc. */ export interface Operation { + /** + * Operation name: {provider}/{resource}/{operation} + */ name?: string; + /** + * The object that represents the operation. + */ display?: OperationDisplay; } /** - * @class - * Initializes a new instance of the KeyVaultReference class. - * @constructor * The key vault reference. - * */ export interface KeyVaultReference extends ResourceReference { } /** - * @class - * Initializes a new instance of the ListKeyVaultKeysDefinition class. - * @constructor * The list key vault keys definition. - * - * @member {object} keyVault The key vault reference. - * @member {string} [skipToken] The skip token. */ export interface ListKeyVaultKeysDefinition { + /** + * The key vault reference. + */ keyVault: KeyVaultReference; + /** + * The skip token. + */ skipToken?: string; } /** - * @class - * Initializes a new instance of the KeyVaultKeyAttributes class. - * @constructor * The key attributes. - * - * @member {boolean} [enabled] Whether the key is enabled or not. - * @member {number} [created] When the key was created. - * @member {number} [updated] When the key was updated. */ export interface KeyVaultKeyAttributes { + /** + * Whether the key is enabled or not. + */ enabled?: boolean; + /** + * When the key was created. + */ created?: number; + /** + * When the key was updated. + */ updated?: number; } /** - * @class - * Initializes a new instance of the KeyVaultKey class. - * @constructor * The key vault key. - * - * @member {string} [kid] The key id. - * @member {object} [attributes] The key attributes. - * @member {boolean} [attributes.enabled] Whether the key is enabled or not. - * @member {number} [attributes.created] When the key was created. - * @member {number} [attributes.updated] When the key was updated. */ export interface KeyVaultKey { + /** + * The key id. + */ kid?: string; + /** + * The key attributes. + */ attributes?: KeyVaultKeyAttributes; } -/** - * @class - * Initializes a new instance of the TrackingEventErrorInfo class. - * @constructor - * @member {string} [message] - * @member {string} [code] - */ export interface TrackingEventErrorInfo { message?: string; code?: string; } -/** - * @class - * Initializes a new instance of the TrackingEvent class. - * @constructor - * @member {string} eventLevel Possible values include: 'LogAlways', - * 'Critical', 'Error', 'Warning', 'Informational', 'Verbose' - * @member {date} eventTime - * @member {string} recordType Possible values include: 'NotSpecified', - * 'Custom', 'AS2Message', 'AS2MDN', 'X12Interchange', 'X12FunctionalGroup', - * 'X12TransactionSet', 'X12InterchangeAcknowledgment', - * 'X12FunctionalGroupAcknowledgment', 'X12TransactionSetAcknowledgment', - * 'EdifactInterchange', 'EdifactFunctionalGroup', 'EdifactTransactionSet', - * 'EdifactInterchangeAcknowledgment', 'EdifactFunctionalGroupAcknowledgment', - * 'EdifactTransactionSetAcknowledgment' - * @member {object} [error] - * @member {string} [error.message] - * @member {string} [error.code] - */ export interface TrackingEvent { + /** + * Possible values include: 'LogAlways', 'Critical', 'Error', 'Warning', 'Informational', + * 'Verbose' + */ eventLevel: string; eventTime: Date; + /** + * Possible values include: 'NotSpecified', 'Custom', 'AS2Message', 'AS2MDN', 'X12Interchange', + * 'X12FunctionalGroup', 'X12TransactionSet', 'X12InterchangeAcknowledgment', + * 'X12FunctionalGroupAcknowledgment', 'X12TransactionSetAcknowledgment', 'EdifactInterchange', + * 'EdifactFunctionalGroup', 'EdifactTransactionSet', 'EdifactInterchangeAcknowledgment', + * 'EdifactFunctionalGroupAcknowledgment', 'EdifactTransactionSetAcknowledgment' + */ recordType: string; error?: TrackingEventErrorInfo; } -/** - * @class - * Initializes a new instance of the TrackingEventsDefinition class. - * @constructor - * @member {string} sourceType - * @member {string} [trackEventsOptions] Possible values include: 'None', - * 'DisableSourceInfoEnrich' - * @member {array} events - */ export interface TrackingEventsDefinition { sourceType: string; + /** + * Possible values include: 'None', 'DisableSourceInfoEnrich' + */ trackEventsOptions?: string; events: TrackingEvent[]; } -/** - * @class - * Initializes a new instance of the SetTriggerStateActionDefinition class. - * @constructor - * @member {object} source - * @member {string} [source.provisioningState] Gets the provisioning state. - * Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', - * 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', - * 'Succeeded', 'Moving', 'Updating', 'Registering', 'Registered', - * 'Unregistering', 'Unregistered', 'Completed' - * @member {date} [source.createdTime] Gets the created time. - * @member {date} [source.changedTime] Gets the changed time. - * @member {string} [source.state] Gets the state. Possible values include: - * 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' - * @member {string} [source.status] Gets the status. Possible values include: - * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', - * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', - * 'Ignored' - * @member {date} [source.lastExecutionTime] Gets the last execution time. - * @member {date} [source.nextExecutionTime] Gets the next execution time. - * @member {object} [source.recurrence] Gets the workflow trigger recurrence. - * @member {string} [source.recurrence.frequency] The frequency. Possible - * values include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', - * 'Month', 'Year' - * @member {number} [source.recurrence.interval] The interval. - * @member {string} [source.recurrence.startTime] The start time. - * @member {string} [source.recurrence.endTime] The end time. - * @member {string} [source.recurrence.timeZone] The time zone. - * @member {object} [source.recurrence.schedule] The recurrence schedule. - * @member {array} [source.recurrence.schedule.minutes] The minutes. - * @member {array} [source.recurrence.schedule.hours] The hours. - * @member {array} [source.recurrence.schedule.weekDays] The days of the week. - * @member {array} [source.recurrence.schedule.monthDays] The month days. - * @member {array} [source.recurrence.schedule.monthlyOccurrences] The monthly - * occurrences. - * @member {object} [source.workflow] Gets the reference to workflow. - * @member {string} [source.workflow.id] The resource id. - * @member {string} [source.workflow.name] Gets the resource name. - * @member {string} [source.workflow.type] Gets the resource type. - * @member {string} [source.name] Gets the workflow trigger name. - * @member {string} [source.type] Gets the workflow trigger type. - */ export interface SetTriggerStateActionDefinition { source: WorkflowTrigger; } -/** - * @class - * Initializes a new instance of the Expression class. - * @constructor - * @member {string} [text] - * @member {object} [value] - * @member {array} [subexpressions] - * @member {object} [error] - * @member {string} [error.message] The error message. - * @member {array} [error.details] The error details. - */ export interface Expression { text?: string; value?: any; @@ -8047,630 +2832,563 @@ export interface Expression { error?: AzureResourceErrorInfo; } -/** - * @class - * Initializes a new instance of the ExpressionRoot class. - * @constructor - * @member {string} [path] The path. - */ export interface ExpressionRoot extends Expression { + /** + * The path. + */ path?: string; } /** - * @class - * Initializes a new instance of the ErrorInfo class. - * @constructor * The error info. - * - * @member {string} code The error code. - */ +*/ export interface ErrorInfo { + /** + * The error code. + */ code: string; } /** - * @class - * Initializes a new instance of the AzureResourceErrorInfo class. - * @constructor * The azure resource error info. - * - * @member {string} message The error message. - * @member {array} [details] The error details. - */ +*/ export interface AzureResourceErrorInfo extends ErrorInfo { + /** + * The error message. + */ message: string; + /** + * The error details. + */ details?: AzureResourceErrorInfo[]; } /** - * @class - * Initializes a new instance of the RepetitionIndex class. - * @constructor * The workflow run action repetition index. - * - * @member {string} [scopeName] The scope. - * @member {number} itemIndex The index. - */ +*/ export interface RepetitionIndex { + /** + * The scope. + */ scopeName?: string; + /** + * The index. + */ itemIndex: number; } /** - * @class - * Initializes a new instance of the WorkflowRunActionRepetitionDefinition class. - * @constructor * The workflow run action repetition definition. - * - * @member {date} [startTime] The start time of the workflow scope repetition. - * @member {date} [endTime] The end time of the workflow scope repetition. - * @member {object} [correlation] The correlation properties. - * @member {string} [correlation.actionTrackingId] The action tracking - * identifier. - * @member {string} [status] The status of the workflow scope repetition. - * Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', - * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', - * 'TimedOut', 'Aborted', 'Ignored' - * @member {string} [code] The workflow scope repetition code. - * @member {object} [error] - * @member {string} [trackingId] Gets the tracking id. - * @member {object} [inputs] Gets the inputs. - * @member {object} [inputsLink] Gets the link to inputs. - * @member {string} [inputsLink.uri] The content link URI. - * @member {string} [inputsLink.contentVersion] The content version. - * @member {number} [inputsLink.contentSize] The content size. - * @member {object} [inputsLink.contentHash] The content hash. - * @member {string} [inputsLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [inputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [inputsLink.metadata] The metadata. - * @member {object} [outputs] Gets the outputs. - * @member {object} [outputsLink] Gets the link to outputs. - * @member {string} [outputsLink.uri] The content link URI. - * @member {string} [outputsLink.contentVersion] The content version. - * @member {number} [outputsLink.contentSize] The content size. - * @member {object} [outputsLink.contentHash] The content hash. - * @member {string} [outputsLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [outputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [outputsLink.metadata] The metadata. - * @member {object} [trackedProperties] Gets the tracked properties. - * @member {array} [retryHistory] Gets the retry histories. - * @member {number} [iterationCount] - * @member {array} [repetitionIndexes] The repetition indexes. - */ +*/ export interface WorkflowRunActionRepetitionDefinition extends Resource { + /** + * The start time of the workflow scope repetition. + */ startTime?: Date; + /** + * The end time of the workflow scope repetition. + */ endTime?: Date; + /** + * The correlation properties. + */ correlation?: RunActionCorrelation; + /** + * The status of the workflow scope repetition. Possible values include: 'NotSpecified', + * 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', + * 'Faulted', 'TimedOut', 'Aborted', 'Ignored' + */ status?: string; + /** + * The workflow scope repetition code. + */ code?: string; error?: any; + /** + * Gets the tracking id. + */ readonly trackingId?: string; + /** + * Gets the inputs. + */ readonly inputs?: any; + /** + * Gets the link to inputs. + */ readonly inputsLink?: ContentLink; + /** + * Gets the outputs. + */ readonly outputs?: any; + /** + * Gets the link to outputs. + */ readonly outputsLink?: ContentLink; + /** + * Gets the tracked properties. + */ readonly trackedProperties?: any; + /** + * Gets the retry histories. + */ retryHistory?: RetryHistory[]; iterationCount?: number; + /** + * The repetition indexes. + */ repetitionIndexes?: RepetitionIndex[]; } /** - * @class - * Initializes a new instance of the OperationResultProperties class. - * @constructor * The run operation result properties. - * - * @member {date} [startTime] The start time of the workflow scope repetition. - * @member {date} [endTime] The end time of the workflow scope repetition. - * @member {object} [correlation] The correlation properties. - * @member {string} [correlation.actionTrackingId] The action tracking - * identifier. - * @member {string} [status] The status of the workflow scope repetition. - * Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', - * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', - * 'TimedOut', 'Aborted', 'Ignored' - * @member {string} [code] The workflow scope repetition code. - * @member {object} [error] - */ +*/ export interface OperationResultProperties { + /** + * The start time of the workflow scope repetition. + */ startTime?: Date; + /** + * The end time of the workflow scope repetition. + */ endTime?: Date; + /** + * The correlation properties. + */ correlation?: RunActionCorrelation; + /** + * The status of the workflow scope repetition. Possible values include: 'NotSpecified', + * 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', + * 'Faulted', 'TimedOut', 'Aborted', 'Ignored' + */ status?: string; + /** + * The workflow scope repetition code. + */ code?: string; error?: any; } /** - * @class - * Initializes a new instance of the OperationResult class. - * @constructor * The operation result definition. - * - * @member {string} [trackingId] Gets the tracking id. - * @member {object} [inputs] Gets the inputs. - * @member {object} [inputsLink] Gets the link to inputs. - * @member {string} [inputsLink.uri] The content link URI. - * @member {string} [inputsLink.contentVersion] The content version. - * @member {number} [inputsLink.contentSize] The content size. - * @member {object} [inputsLink.contentHash] The content hash. - * @member {string} [inputsLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [inputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [inputsLink.metadata] The metadata. - * @member {object} [outputs] Gets the outputs. - * @member {object} [outputsLink] Gets the link to outputs. - * @member {string} [outputsLink.uri] The content link URI. - * @member {string} [outputsLink.contentVersion] The content version. - * @member {number} [outputsLink.contentSize] The content size. - * @member {object} [outputsLink.contentHash] The content hash. - * @member {string} [outputsLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [outputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [outputsLink.metadata] The metadata. - * @member {object} [trackedProperties] Gets the tracked properties. - * @member {array} [retryHistory] Gets the retry histories. - * @member {number} [iterationCount] - */ +*/ export interface OperationResult extends OperationResultProperties { + /** + * Gets the tracking id. + */ readonly trackingId?: string; + /** + * Gets the inputs. + */ readonly inputs?: any; + /** + * Gets the link to inputs. + */ readonly inputsLink?: ContentLink; + /** + * Gets the outputs. + */ readonly outputs?: any; + /** + * Gets the link to outputs. + */ readonly outputsLink?: ContentLink; + /** + * Gets the tracked properties. + */ readonly trackedProperties?: any; + /** + * Gets the retry histories. + */ retryHistory?: RetryHistory[]; iterationCount?: number; } /** - * @class - * Initializes a new instance of the RunCorrelation class. - * @constructor * The correlation properties. - * - * @member {string} [clientTrackingId] The client tracking identifier. - * @member {array} [clientKeywords] The client keywords. - */ +*/ export interface RunCorrelation { + /** + * The client tracking identifier. + */ clientTrackingId?: string; + /** + * The client keywords. + */ clientKeywords?: string[]; } /** - * @class - * Initializes a new instance of the RunActionCorrelation class. - * @constructor * The workflow run action correlation properties. - * - * @member {string} [actionTrackingId] The action tracking identifier. - */ +*/ export interface RunActionCorrelation extends RunCorrelation { + /** + * The action tracking identifier. + */ actionTrackingId?: string; } /** - * @class - * Initializes a new instance of the JsonSchema class. - * @constructor * The JSON schema. - * - * @member {string} [title] The JSON title. - * @member {string} [content] The JSON content. - */ +*/ export interface JsonSchema { + /** + * The JSON title. + */ title?: string; + /** + * The JSON content. + */ content?: string; } /** - * @class - * Initializes a new instance of the ArtifactProperties class. - * @constructor * The artifact properties definition. - * - * @member {date} [createdTime] The artifact creation time. - * @member {date} [changedTime] The artifact changed time. - * @member {object} [metadata] - */ +*/ export interface ArtifactProperties { + /** + * The artifact creation time. + */ createdTime?: Date; + /** + * The artifact changed time. + */ changedTime?: Date; metadata?: any; } /** - * @class - * Initializes a new instance of the ArtifactContentPropertiesDefinition class. - * @constructor * The artifact content properties definition. - * - * @member {object} [content] - * @member {string} [contentType] The content type. - * @member {object} [contentLink] The content link. - * @member {string} [contentLink.uri] The content link URI. - * @member {string} [contentLink.contentVersion] The content version. - * @member {number} [contentLink.contentSize] The content size. - * @member {object} [contentLink.contentHash] The content hash. - * @member {string} [contentLink.contentHash.algorithm] The algorithm of the - * content hash. - * @member {string} [contentLink.contentHash.value] The value of the content - * hash. - * @member {object} [contentLink.metadata] The metadata. - */ +*/ export interface ArtifactContentPropertiesDefinition extends ArtifactProperties { content?: any; + /** + * The content type. + */ contentType?: string; + /** + * The content link. + */ contentLink?: ContentLink; } /** - * @class - * Initializes a new instance of the AssemblyProperties class. - * @constructor * The assembly properties definition. - * - * @member {string} assemblyName The assembly name. - * @member {string} [assemblyVersion] The assembly version. - * @member {string} [assemblyCulture] The assembly culture. - * @member {string} [assemblyPublicKeyToken] The assembly public key token. - */ +*/ export interface AssemblyProperties extends ArtifactContentPropertiesDefinition { + /** + * The assembly name. + */ assemblyName: string; + /** + * The assembly version. + */ assemblyVersion?: string; + /** + * The assembly culture. + */ assemblyCulture?: string; + /** + * The assembly public key token. + */ assemblyPublicKeyToken?: string; } /** - * @class - * Initializes a new instance of the AssemblyDefinition class. - * @constructor * The assembly definition. - * - * @member {object} properties The assembly properties. - * @member {string} [properties.assemblyName] The assembly name. - * @member {string} [properties.assemblyVersion] The assembly version. - * @member {string} [properties.assemblyCulture] The assembly culture. - * @member {string} [properties.assemblyPublicKeyToken] The assembly public key - * token. - */ +*/ export interface AssemblyDefinition extends Resource { + /** + * The assembly properties. + */ properties: AssemblyProperties; } /** - * @class - * Initializes a new instance of the BatchReleaseCriteria class. - * @constructor * The batch release criteria. - * - * @member {number} [messageCount] The message count. - * @member {number} [batchSize] The batch size in bytes. - * @member {object} [recurrence] The recurrence. - * @member {string} [recurrence.frequency] The frequency. Possible values - * include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', 'Month', - * 'Year' - * @member {number} [recurrence.interval] The interval. - * @member {string} [recurrence.startTime] The start time. - * @member {string} [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 BatchReleaseCriteria { + /** + * The message count. + */ messageCount?: number; + /** + * The batch size in bytes. + */ batchSize?: number; + /** + * The recurrence. + */ recurrence?: WorkflowTriggerRecurrence; } /** - * @class - * Initializes a new instance of the BatchConfigurationProperties class. - * @constructor * The batch configuration properties definition. - * - * @member {string} batchGroupName The name of the batch group. - * @member {object} releaseCriteria The batch release criteria. - * @member {number} [releaseCriteria.messageCount] The message count. - * @member {number} [releaseCriteria.batchSize] The batch size in bytes. - * @member {object} [releaseCriteria.recurrence] The recurrence. - * @member {string} [releaseCriteria.recurrence.frequency] The frequency. - * Possible values include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', - * 'Week', 'Month', 'Year' - * @member {number} [releaseCriteria.recurrence.interval] The interval. - * @member {string} [releaseCriteria.recurrence.startTime] The start time. - * @member {string} [releaseCriteria.recurrence.endTime] The end time. - * @member {string} [releaseCriteria.recurrence.timeZone] The time zone. - * @member {object} [releaseCriteria.recurrence.schedule] The recurrence - * schedule. - * @member {array} [releaseCriteria.recurrence.schedule.minutes] The minutes. - * @member {array} [releaseCriteria.recurrence.schedule.hours] The hours. - * @member {array} [releaseCriteria.recurrence.schedule.weekDays] The days of - * the week. - * @member {array} [releaseCriteria.recurrence.schedule.monthDays] The month - * days. - * @member {array} [releaseCriteria.recurrence.schedule.monthlyOccurrences] The - * monthly occurrences. - */ +*/ export interface BatchConfigurationProperties extends ArtifactProperties { + /** + * The name of the batch group. + */ batchGroupName: string; + /** + * The batch release criteria. + */ releaseCriteria: BatchReleaseCriteria; } /** - * @class - * Initializes a new instance of the BatchConfiguration class. - * @constructor * The batch configuration resource definition. - * - * @member {object} properties The batch configuration properties. - * @member {string} [properties.batchGroupName] The name of the batch group. - * @member {object} [properties.releaseCriteria] The batch release criteria. - * @member {number} [properties.releaseCriteria.messageCount] The message - * count. - * @member {number} [properties.releaseCriteria.batchSize] The batch size in - * bytes. - * @member {object} [properties.releaseCriteria.recurrence] The recurrence. - * @member {string} [properties.releaseCriteria.recurrence.frequency] The - * frequency. Possible values include: 'NotSpecified', 'Second', 'Minute', - * 'Hour', 'Day', 'Week', 'Month', 'Year' - * @member {number} [properties.releaseCriteria.recurrence.interval] The - * interval. - * @member {string} [properties.releaseCriteria.recurrence.startTime] The start - * time. - * @member {string} [properties.releaseCriteria.recurrence.endTime] The end - * time. - * @member {string} [properties.releaseCriteria.recurrence.timeZone] The time - * zone. - * @member {object} [properties.releaseCriteria.recurrence.schedule] The - * recurrence schedule. - * @member {array} [properties.releaseCriteria.recurrence.schedule.minutes] The - * minutes. - * @member {array} [properties.releaseCriteria.recurrence.schedule.hours] The - * hours. - * @member {array} [properties.releaseCriteria.recurrence.schedule.weekDays] - * The days of the week. - * @member {array} [properties.releaseCriteria.recurrence.schedule.monthDays] - * The month days. - * @member {array} - * [properties.releaseCriteria.recurrence.schedule.monthlyOccurrences] The - * monthly occurrences. - */ +*/ export interface BatchConfiguration extends Resource { + /** + * The batch configuration properties. + */ properties: BatchConfigurationProperties; } +/** + * A request. +*/ +export interface Request { + /** + * A list of all the headers attached to the request. + */ + headers?: any; + /** + * The destination for the request. + */ + uri?: string; + /** + * The HTTP method used for the request. + */ + method?: string; +} + +/** + * A response. +*/ +export interface Response { + /** + * A list of all the headers attached to the response. + */ + headers?: any; + /** + * The status code of the response. + */ + statusCode?: number; + /** + * Details on the location of the body content. + */ + bodyLink?: ContentLink; +} + +/** + * The request history. +*/ +export interface RequestHistoryProperties { + /** + * The time the request started. + */ + startTime?: Date; + /** + * The time the request ended. + */ + endTime?: Date; + /** + * The request. + */ + request?: Request; + /** + * The response. + */ + response?: Response; +} + +/** + * The request history. +*/ +export interface RequestHistory extends Resource { + /** + * The request history properties. + */ + properties?: RequestHistoryProperties; +} /** - * @class - * Initializes a new instance of the WorkflowListResult class. - * @constructor * The list of workflows. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface WorkflowListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the WorkflowVersionListResult class. - * @constructor * The list of workflow versions. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface WorkflowVersionListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the WorkflowTriggerListResult class. - * @constructor * The list of workflow triggers. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface WorkflowTriggerListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the WorkflowTriggerHistoryListResult class. - * @constructor * The list of workflow trigger histories. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface WorkflowTriggerHistoryListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the WorkflowRunListResult class. - * @constructor * The list of workflow runs. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface WorkflowRunListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the WorkflowRunActionListResult class. - * @constructor * The list of workflow run actions. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface WorkflowRunActionListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } -/** - * @class - * Initializes a new instance of the ExpressionTraces class. - * @constructor - * @member {array} [inputs] - */ export interface ExpressionTraces extends Array { } /** - * @class - * Initializes a new instance of the WorkflowRunActionRepetitionDefinitionCollection class. - * @constructor * A collection of workflow run action repetitions. - * - */ -export interface WorkflowRunActionRepetitionDefinitionCollection extends Array { +*/ +export interface WorkflowRunActionRepetitionDefinitionCollection extends +Array { +} + +/** + * The list of workflow request histories. +*/ +export interface RequestHistoryListResult extends Array { + /** + * The URL to get the next set of results. + */ + nextLink?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountListResult class. - * @constructor * The list of integration accounts. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface IntegrationAccountListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the KeyVaultKeyCollection class. - * @constructor * Collection of key vault keys. - * - * @member {string} [skipToken] The skip token. - */ +*/ export interface KeyVaultKeyCollection extends Array { } /** - * @class - * Initializes a new instance of the AssemblyCollection class. - * @constructor * A collection of assembly definitions. - * - */ +*/ export interface AssemblyCollection extends Array { } /** - * @class - * Initializes a new instance of the BatchConfigurationCollection class. - * @constructor * A collection of batch configurations. - * - */ +*/ export interface BatchConfigurationCollection extends Array { } /** - * @class - * Initializes a new instance of the IntegrationAccountSchemaListResult class. - * @constructor * The list of integration account schemas. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface IntegrationAccountSchemaListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountMapListResult class. - * @constructor * The list of integration account maps. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface IntegrationAccountMapListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountPartnerListResult class. - * @constructor * The list of integration account partners. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface IntegrationAccountPartnerListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountAgreementListResult class. - * @constructor * The list of integration account agreements. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface IntegrationAccountAgreementListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountCertificateListResult class. - * @constructor * The list of integration account certificates. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ -export interface IntegrationAccountCertificateListResult extends Array { +*/ +export interface IntegrationAccountCertificateListResult extends +Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the IntegrationAccountSessionListResult class. - * @constructor * The list of integration account sessions. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface IntegrationAccountSessionListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the OperationListResult class. - * @constructor - * Result of the request to list Logic operations. It contains a list of - * operations and a URL link to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * Result of the request to list Logic operations. It contains a list of operations and a URL link + * to get the next set of results. +*/ export interface OperationListResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ nextLink?: string; } diff --git a/lib/services/logicManagement/lib/models/index.js b/lib/services/logicManagement/lib/models/index.js index 10b110b832..ecbd10cfa4 100644 --- a/lib/services/logicManagement/lib/models/index.js +++ b/lib/services/logicManagement/lib/models/index.js @@ -138,6 +138,10 @@ exports.AssemblyDefinition = require('./assemblyDefinition'); exports.BatchReleaseCriteria = require('./batchReleaseCriteria'); exports.BatchConfigurationProperties = require('./batchConfigurationProperties'); exports.BatchConfiguration = require('./batchConfiguration'); +exports.Request = require('./request'); +exports.Response = require('./response'); +exports.RequestHistoryProperties = require('./requestHistoryProperties'); +exports.RequestHistory = require('./requestHistory'); exports.WorkflowListResult = require('./workflowListResult'); exports.WorkflowVersionListResult = require('./workflowVersionListResult'); exports.WorkflowTriggerListResult = require('./workflowTriggerListResult'); @@ -146,6 +150,7 @@ exports.WorkflowRunListResult = require('./workflowRunListResult'); exports.WorkflowRunActionListResult = require('./workflowRunActionListResult'); exports.ExpressionTraces = require('./expressionTraces'); exports.WorkflowRunActionRepetitionDefinitionCollection = require('./workflowRunActionRepetitionDefinitionCollection'); +exports.RequestHistoryListResult = require('./requestHistoryListResult'); exports.IntegrationAccountListResult = require('./integrationAccountListResult'); exports.KeyVaultKeyCollection = require('./keyVaultKeyCollection'); exports.AssemblyCollection = require('./assemblyCollection'); diff --git a/lib/services/logicManagement/lib/models/integrationAccount.js b/lib/services/logicManagement/lib/models/integrationAccount.js index 16c2621136..9808060c66 100644 --- a/lib/services/logicManagement/lib/models/integrationAccount.js +++ b/lib/services/logicManagement/lib/models/integrationAccount.js @@ -20,9 +20,9 @@ const models = require('./index'); class IntegrationAccount extends models['Resource'] { /** * Create a IntegrationAccount. - * @member {object} [properties] The integration account properties. - * @member {object} [sku] The sku. - * @member {string} [sku.name] The sku name. Possible values include: + * @property {object} [properties] The integration account properties. + * @property {object} [sku] The sku. + * @property {string} [sku.name] The sku name. Possible values include: * 'NotSpecified', 'Free', 'Basic', 'Standard' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/integrationAccountAgreement.js b/lib/services/logicManagement/lib/models/integrationAccountAgreement.js index 9d4151172d..22e4866d88 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountAgreement.js +++ b/lib/services/logicManagement/lib/models/integrationAccountAgreement.js @@ -20,1533 +20,1538 @@ const models = require('./index'); class IntegrationAccountAgreement extends models['Resource'] { /** * Create a IntegrationAccountAgreement. - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {object} [metadata] The metadata. - * @member {string} agreementType The agreement type. Possible values + * @property {date} [createdTime] The created time. + * @property {date} [changedTime] The changed time. + * @property {object} [metadata] The metadata. + * @property {string} agreementType The agreement type. Possible values * include: 'NotSpecified', 'AS2', 'X12', 'Edifact' - * @member {string} hostPartner The integration account partner that is set + * @property {string} hostPartner The integration account partner that is set * as host partner for this agreement. - * @member {string} guestPartner The integration account partner that is set - * as guest partner for this agreement. - * @member {object} hostIdentity The business identity of the host partner. - * @member {string} [hostIdentity.qualifier] The business identity qualifier - * e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [hostIdentity.value] The user defined business identity + * @property {string} guestPartner The integration account partner that is + * set as guest partner for this agreement. + * @property {object} hostIdentity The business identity of the host partner. + * @property {string} [hostIdentity.qualifier] The business identity + * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [hostIdentity.value] The user defined business identity * value. - * @member {object} guestIdentity The business identity of the guest partner. - * @member {string} [guestIdentity.qualifier] The business identity qualifier - * e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [guestIdentity.value] The user defined business identity - * value. - * @member {object} content The agreement content. - * @member {object} [content.aS2] The AS2 agreement content. - * @member {object} [content.aS2.receiveAgreement] The AS2 one-way receive + * @property {object} guestIdentity The business identity of the guest + * partner. + * @property {string} [guestIdentity.qualifier] The business identity + * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [guestIdentity.value] The user defined business + * identity value. + * @property {object} content The agreement content. + * @property {object} [content.aS2] The AS2 agreement content. + * @property {object} [content.aS2.receiveAgreement] The AS2 one-way receive * agreement. - * @member {object} [content.aS2.receiveAgreement.senderBusinessIdentity] The - * sender business identity - * @member {string} + * @property {object} [content.aS2.receiveAgreement.senderBusinessIdentity] + * The sender business identity + * @property {string} * [content.aS2.receiveAgreement.senderBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.senderBusinessIdentity.value] The user * defined business identity value. - * @member {object} [content.aS2.receiveAgreement.receiverBusinessIdentity] + * @property {object} [content.aS2.receiveAgreement.receiverBusinessIdentity] * The receiver business identity - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.receiverBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.receiverBusinessIdentity.value] The user * defined business identity value. - * @member {object} [content.aS2.receiveAgreement.protocolSettings] The AS2 + * @property {object} [content.aS2.receiveAgreement.protocolSettings] The AS2 * protocol settings. - * @member {object} + * @property {object} * [content.aS2.receiveAgreement.protocolSettings.messageConnectionSettings] * The message connection settings. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} + * @property {object} * [content.aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings] * The acknowledgement connection settings. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} + * @property {object} * [content.aS2.receiveAgreement.protocolSettings.mdnSettings] The MDN * settings. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.needMdn] The * value indicating whether to send or request a MDN. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.signMdn] The * value indicating whether the MDN needs to be signed or not. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] * The value indicating whether to send the asynchronous MDN. - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] * The receipt delivery URL. - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] * The disposition notification to header value. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] * The value indicating whether to sign the outbound MDN if optional. - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.mdnText] The * MDN text. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] * The value indicating whether to send inbound MDN to message box. - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] * The signing or hashing algorithm. Possible values include: 'NotSpecified', * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} + * @property {object} * [content.aS2.receiveAgreement.protocolSettings.securitySettings] The * security settings. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] * The value indicating whether to send or request a MDN. - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.securitySettings.signingCertificateName] * The name of the signing certificate. - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.securitySettings.encryptionCertificateName] * The name of the encryption certificate. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] * The value indicating whether to enable NRR for inbound MDN. - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} + * @property {object} * [content.aS2.receiveAgreement.protocolSettings.validationSettings] The * validation settings. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.validationSettings.overrideMessageProperties] * The value indicating whether to override incoming message properties with * those in agreement. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.validationSettings.encryptMessage] * The value indicating whether the message has to be encrypted. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.validationSettings.signMessage] * The value indicating whether the message has to be signed. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.validationSettings.compressMessage] * The value indicating whether the message has to be compressed. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.validationSettings.checkDuplicateMessage] * The value indicating whether to check for duplicate message. - * @member {number} + * @property {number} * [content.aS2.receiveAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] * The number of days to look back for duplicate interchange. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] * The value indicating whether to check for certificate revocation list on * send. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] * The value indicating whether to check for certificate revocation list on * receive. - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.validationSettings.encryptionAlgorithm] * The encryption algorithm. Possible values include: 'NotSpecified', 'None', * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.validationSettings.signingAlgorithm] * The signing algorithm. Possible values include: 'NotSpecified', 'Default', * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} + * @property {object} * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings] The * envelope settings. - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings.messageContentType] * The message content type. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] * The value indicating whether to transmit file name in mime header. - * @member {string} + * @property {string} * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings.fileNameTemplate] * The template for file name. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] * The value indicating whether to suspend message on file name generation * error. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.envelopeSettings.autogenerateFileName] * The value indicating whether to auto generate file name. - * @member {object} + * @property {object} * [content.aS2.receiveAgreement.protocolSettings.errorSettings] The error * settings. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] * The value indicating whether to suspend duplicate message. - * @member {boolean} + * @property {boolean} * [content.aS2.receiveAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] * The value indicating whether to resend message If MDN is not received. - * @member {object} [content.aS2.sendAgreement] The AS2 one-way send + * @property {object} [content.aS2.sendAgreement] The AS2 one-way send * agreement. - * @member {object} [content.aS2.sendAgreement.senderBusinessIdentity] The + * @property {object} [content.aS2.sendAgreement.senderBusinessIdentity] The * sender business identity - * @member {string} + * @property {string} * [content.aS2.sendAgreement.senderBusinessIdentity.qualifier] The business * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [content.aS2.sendAgreement.senderBusinessIdentity.value] - * The user defined business identity value. - * @member {object} [content.aS2.sendAgreement.receiverBusinessIdentity] The - * receiver business identity - * @member {string} + * @property {string} + * [content.aS2.sendAgreement.senderBusinessIdentity.value] The user defined + * business identity value. + * @property {object} [content.aS2.sendAgreement.receiverBusinessIdentity] + * The receiver business identity + * @property {string} * [content.aS2.sendAgreement.receiverBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} + * @property {string} * [content.aS2.sendAgreement.receiverBusinessIdentity.value] The user * defined business identity value. - * @member {object} [content.aS2.sendAgreement.protocolSettings] The AS2 + * @property {object} [content.aS2.sendAgreement.protocolSettings] The AS2 * protocol settings. - * @member {object} + * @property {object} * [content.aS2.sendAgreement.protocolSettings.messageConnectionSettings] The * message connection settings. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} + * @property {object} * [content.aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings] * The acknowledgement connection settings. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] * The value indicating whether to ignore mismatch in certificate name. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] * The value indicating whether to support HTTP status code 'CONTINUE'. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] * The value indicating whether to keep the connection alive. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] * The value indicating whether to unfold the HTTP headers. - * @member {object} [content.aS2.sendAgreement.protocolSettings.mdnSettings] - * The MDN settings. - * @member {boolean} + * @property {object} + * [content.aS2.sendAgreement.protocolSettings.mdnSettings] The MDN settings. + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.mdnSettings.needMdn] The value * indicating whether to send or request a MDN. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.mdnSettings.signMdn] The value * indicating whether the MDN needs to be signed or not. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] * The value indicating whether to send the asynchronous MDN. - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] * The receipt delivery URL. - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] * The disposition notification to header value. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] * The value indicating whether to sign the outbound MDN if optional. - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.mdnSettings.mdnText] The MDN * text. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] * The value indicating whether to send inbound MDN to message box. - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] * The signing or hashing algorithm. Possible values include: 'NotSpecified', * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} + * @property {object} * [content.aS2.sendAgreement.protocolSettings.securitySettings] The security * settings. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] * The value indicating whether to send or request a MDN. - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.securitySettings.signingCertificateName] * The name of the signing certificate. - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.securitySettings.encryptionCertificateName] * The name of the encryption certificate. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] * The value indicating whether to enable NRR for inbound encoded messages. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] * The value indicating whether to enable NRR for inbound decoded messages. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] * The value indicating whether to enable NRR for outbound MDN. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] * The value indicating whether to enable NRR for outbound encoded messages. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] * The value indicating whether to enable NRR for outbound decoded messages. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] * The value indicating whether to enable NRR for inbound MDN. - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, * ShaHyphenHashSize, Sha2UnderscoreHashSize. - * @member {object} + * @property {object} * [content.aS2.sendAgreement.protocolSettings.validationSettings] The * validation settings. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.validationSettings.overrideMessageProperties] * The value indicating whether to override incoming message properties with * those in agreement. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.validationSettings.encryptMessage] * The value indicating whether the message has to be encrypted. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.validationSettings.signMessage] * The value indicating whether the message has to be signed. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.validationSettings.compressMessage] * The value indicating whether the message has to be compressed. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.validationSettings.checkDuplicateMessage] * The value indicating whether to check for duplicate message. - * @member {number} + * @property {number} * [content.aS2.sendAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] * The number of days to look back for duplicate interchange. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] * The value indicating whether to check for certificate revocation list on * send. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] * The value indicating whether to check for certificate revocation list on * receive. - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.validationSettings.encryptionAlgorithm] * The encryption algorithm. Possible values include: 'NotSpecified', 'None', * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.validationSettings.signingAlgorithm] * The signing algorithm. Possible values include: 'NotSpecified', 'Default', * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' - * @member {object} + * @property {object} * [content.aS2.sendAgreement.protocolSettings.envelopeSettings] The envelope * settings. - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.envelopeSettings.messageContentType] * The message content type. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] * The value indicating whether to transmit file name in mime header. - * @member {string} + * @property {string} * [content.aS2.sendAgreement.protocolSettings.envelopeSettings.fileNameTemplate] * The template for file name. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] * The value indicating whether to suspend message on file name generation * error. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.envelopeSettings.autogenerateFileName] * The value indicating whether to auto generate file name. - * @member {object} + * @property {object} * [content.aS2.sendAgreement.protocolSettings.errorSettings] The error * settings. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] * The value indicating whether to suspend duplicate message. - * @member {boolean} + * @property {boolean} * [content.aS2.sendAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] * The value indicating whether to resend message If MDN is not received. - * @member {object} [content.x12] The X12 agreement content. - * @member {object} [content.x12.receiveAgreement] The X12 one-way receive + * @property {object} [content.x12] The X12 agreement content. + * @property {object} [content.x12.receiveAgreement] The X12 one-way receive * agreement. - * @member {object} [content.x12.receiveAgreement.senderBusinessIdentity] The - * sender business identity - * @member {string} + * @property {object} [content.x12.receiveAgreement.senderBusinessIdentity] + * The sender business identity + * @property {string} * [content.x12.receiveAgreement.senderBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} + * @property {string} * [content.x12.receiveAgreement.senderBusinessIdentity.value] The user * defined business identity value. - * @member {object} [content.x12.receiveAgreement.receiverBusinessIdentity] + * @property {object} [content.x12.receiveAgreement.receiverBusinessIdentity] * The receiver business identity - * @member {string} + * @property {string} * [content.x12.receiveAgreement.receiverBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} + * @property {string} * [content.x12.receiveAgreement.receiverBusinessIdentity.value] The user * defined business identity value. - * @member {object} [content.x12.receiveAgreement.protocolSettings] The X12 + * @property {object} [content.x12.receiveAgreement.protocolSettings] The X12 * protocol settings. - * @member {object} + * @property {object} * [content.x12.receiveAgreement.protocolSettings.validationSettings] The X12 * validation settings. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} + * @property {object} * [content.x12.receiveAgreement.protocolSettings.framingSettings] The X12 * framing settings. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.framingSettings.componentSeparator] * The component separator. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] * The value indicating whether to replace separators in payload. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.framingSettings.replaceCharacter] * The replacement character. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.framingSettings.segmentTerminator] * The segment terminator. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.framingSettings.characterSet] * The X12 character set. Possible values include: 'NotSpecified', 'Basic', * 'Extended', 'UTF8' - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The segment terminator suffix. Possible values include: 'NotSpecified', * 'None', 'CR', 'LF', 'CRLF' - * @member {object} + * @property {object} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings] The X12 * envelope settings. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.controlStandardsId] * The controls standards id. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] * The value indicating whether to use control standards id as repetition * character. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.senderApplicationId] * The sender application id. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.receiverApplicationId] * The receiver application id. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.controlVersionNumber] * The control version number. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] * The functional group id. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] * The group header agency code. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] * The group header version. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] * The group header date format. Possible values include: 'NotSpecified', * 'CCYYMMDD', 'YYMMDD' - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] * The group header time format. Possible values include: 'NotSpecified', * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.envelopeSettings.usageIndicator] * The usage indicator. Possible values include: 'NotSpecified', 'Test', * 'Information', 'Production' - * @member {object} + * @property {object} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings] * The X12 acknowledgment settings. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] * The functional acknowledgement version. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] * The value indicating whether implementation acknowledgement is needed. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] * The implementation acknowledgement version. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} + * @property {object} * [content.x12.receiveAgreement.protocolSettings.messageFilter] The X12 * message filter. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.messageFilter.messageFilterType] * The message filter type. Possible values include: 'NotSpecified', * 'Include', 'Exclude' - * @member {object} + * @property {object} * [content.x12.receiveAgreement.protocolSettings.securitySettings] The X12 * security settings. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.securitySettings.authorizationQualifier] * The authorization qualifier. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.securitySettings.authorizationValue] * The authorization value. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.securitySettings.securityQualifier] * The security qualifier. - * @member {string} + * @property {string} * [content.x12.receiveAgreement.protocolSettings.securitySettings.passwordValue] * The password value. - * @member {object} + * @property {object} * [content.x12.receiveAgreement.protocolSettings.processingSettings] The X12 * processing settings. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.processingSettings.convertImpliedDecimal] * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [content.x12.receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} + * @property {array} * [content.x12.receiveAgreement.protocolSettings.envelopeOverrides] The X12 * envelope override settings. - * @member {array} + * @property {array} * [content.x12.receiveAgreement.protocolSettings.validationOverrides] The * X12 validation override settings. - * @member {array} + * @property {array} * [content.x12.receiveAgreement.protocolSettings.messageFilterList] The X12 * message filter list. - * @member {array} + * @property {array} * [content.x12.receiveAgreement.protocolSettings.schemaReferences] The X12 * schema references. - * @member {array} + * @property {array} * [content.x12.receiveAgreement.protocolSettings.x12DelimiterOverrides] The * X12 delimiter override settings. - * @member {object} [content.x12.sendAgreement] The X12 one-way send + * @property {object} [content.x12.sendAgreement] The X12 one-way send * agreement. - * @member {object} [content.x12.sendAgreement.senderBusinessIdentity] The + * @property {object} [content.x12.sendAgreement.senderBusinessIdentity] The * sender business identity - * @member {string} + * @property {string} * [content.x12.sendAgreement.senderBusinessIdentity.qualifier] The business * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [content.x12.sendAgreement.senderBusinessIdentity.value] - * The user defined business identity value. - * @member {object} [content.x12.sendAgreement.receiverBusinessIdentity] The - * receiver business identity - * @member {string} + * @property {string} + * [content.x12.sendAgreement.senderBusinessIdentity.value] The user defined + * business identity value. + * @property {object} [content.x12.sendAgreement.receiverBusinessIdentity] + * The receiver business identity + * @property {string} * [content.x12.sendAgreement.receiverBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} + * @property {string} * [content.x12.sendAgreement.receiverBusinessIdentity.value] The user * defined business identity value. - * @member {object} [content.x12.sendAgreement.protocolSettings] The X12 + * @property {object} [content.x12.sendAgreement.protocolSettings] The X12 * protocol settings. - * @member {object} + * @property {object} * [content.x12.sendAgreement.protocolSettings.validationSettings] The X12 * validation settings. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} + * @property {object} * [content.x12.sendAgreement.protocolSettings.framingSettings] The X12 * framing settings. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.framingSettings.componentSeparator] * The component separator. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] * The value indicating whether to replace separators in payload. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.framingSettings.replaceCharacter] * The replacement character. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.framingSettings.segmentTerminator] * The segment terminator. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.framingSettings.characterSet] * The X12 character set. Possible values include: 'NotSpecified', 'Basic', * 'Extended', 'UTF8' - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The segment terminator suffix. Possible values include: 'NotSpecified', * 'None', 'CR', 'LF', 'CRLF' - * @member {object} + * @property {object} * [content.x12.sendAgreement.protocolSettings.envelopeSettings] The X12 * envelope settings. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.controlStandardsId] * The controls standards id. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] * The value indicating whether to use control standards id as repetition * character. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.senderApplicationId] * The sender application id. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.receiverApplicationId] * The receiver application id. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.controlVersionNumber] * The control version number. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] * The functional group id. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] * The group header agency code. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] * The group header version. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] * The group header date format. Possible values include: 'NotSpecified', * 'CCYYMMDD', 'YYMMDD' - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] * The group header time format. Possible values include: 'NotSpecified', * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.envelopeSettings.usageIndicator] * The usage indicator. Possible values include: 'NotSpecified', 'Test', * 'Information', 'Production' - * @member {object} + * @property {object} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings] The * X12 acknowledgment settings. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] * The functional acknowledgement version. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] * The value indicating whether implementation acknowledgement is needed. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] * The implementation acknowledgement version. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} + * @property {object} * [content.x12.sendAgreement.protocolSettings.messageFilter] The X12 message * filter. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.messageFilter.messageFilterType] * The message filter type. Possible values include: 'NotSpecified', * 'Include', 'Exclude' - * @member {object} + * @property {object} * [content.x12.sendAgreement.protocolSettings.securitySettings] The X12 * security settings. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.securitySettings.authorizationQualifier] * The authorization qualifier. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.securitySettings.authorizationValue] * The authorization value. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.securitySettings.securityQualifier] * The security qualifier. - * @member {string} + * @property {string} * [content.x12.sendAgreement.protocolSettings.securitySettings.passwordValue] * The password value. - * @member {object} + * @property {object} * [content.x12.sendAgreement.protocolSettings.processingSettings] The X12 * processing settings. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.processingSettings.convertImpliedDecimal] * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [content.x12.sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} + * @property {array} * [content.x12.sendAgreement.protocolSettings.envelopeOverrides] The X12 * envelope override settings. - * @member {array} + * @property {array} * [content.x12.sendAgreement.protocolSettings.validationOverrides] The X12 * validation override settings. - * @member {array} + * @property {array} * [content.x12.sendAgreement.protocolSettings.messageFilterList] The X12 * message filter list. - * @member {array} + * @property {array} * [content.x12.sendAgreement.protocolSettings.schemaReferences] The X12 * schema references. - * @member {array} + * @property {array} * [content.x12.sendAgreement.protocolSettings.x12DelimiterOverrides] The X12 * delimiter override settings. - * @member {object} [content.edifact] The EDIFACT agreement content. - * @member {object} [content.edifact.receiveAgreement] The EDIFACT one-way + * @property {object} [content.edifact] The EDIFACT agreement content. + * @property {object} [content.edifact.receiveAgreement] The EDIFACT one-way * receive agreement. - * @member {object} [content.edifact.receiveAgreement.senderBusinessIdentity] - * The sender business identity - * @member {string} + * @property {object} + * [content.edifact.receiveAgreement.senderBusinessIdentity] The sender + * business identity + * @property {string} * [content.edifact.receiveAgreement.senderBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.senderBusinessIdentity.value] The user * defined business identity value. - * @member {object} + * @property {object} * [content.edifact.receiveAgreement.receiverBusinessIdentity] The receiver * business identity - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.receiverBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.receiverBusinessIdentity.value] The user * defined business identity value. - * @member {object} [content.edifact.receiveAgreement.protocolSettings] The + * @property {object} [content.edifact.receiveAgreement.protocolSettings] The * EDIFACT protocol settings. - * @member {object} + * @property {object} * [content.edifact.receiveAgreement.protocolSettings.validationSettings] The * EDIFACT validation settings. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} + * @property {object} * [content.edifact.receiveAgreement.protocolSettings.framingSettings] The * EDIFACT framing settings. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] * The service code list directory version. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.characterEncoding] * The character encoding. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.protocolVersion] * The protocol version. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.componentSeparator] * The component separator. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.segmentTerminator] * The segment terminator. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.releaseIndicator] * The release indicator. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.repetitionSeparator] * The repetition separator. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.characterSet] * The EDIFACT frame setting characterSet. Possible values include: * 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', * 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.decimalPointIndicator] * The EDIFACT frame setting decimal indicator. Possible values include: * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The EDIFACT frame setting segment terminator suffix. Possible values * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} + * @property {object} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings] The * EDIFACT envelope settings. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] * The group association assigned code. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.communicationAgreementId] * The communication agreement id. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] * The value indicating whether to apply delimiter string advice. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.createGroupingSegments] * The value indicating whether to create grouping segments. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] * The recipient reference password value. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] * The recipient reference password qualifier. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.applicationReferenceId] * The application reference id. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.processingPriorityCode] * The processing priority code. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] * The interchange control number prefix. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] * The interchange control number suffix. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] * The sender reverse routing address. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] * The receiver reverse routing address. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] * The functional group id. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] * The group controlling agency code. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupMessageVersion] * The group message version. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupMessageRelease] * The group message release. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] * The group control number prefix. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] * The group control number suffix. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] * The group application receiver qualifier. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] * The group application receiver id. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] * The group application sender qualifier. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] * The group application sender id. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] * The group application password. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.isTestInterchange] * The value indicating whether the message is a test interchange. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] * The sender internal identification. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] * The sender internal sub identification. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] * The receiver internal identification. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] * The receiver internal sub identification. - * @member {object} + * @property {object} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings] * The EDIFACT acknowledgement settings. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} + * @property {object} * [content.edifact.receiveAgreement.protocolSettings.messageFilter] The * EDIFACT message filter. - * @member {string} + * @property {string} * [content.edifact.receiveAgreement.protocolSettings.messageFilter.messageFilterType] * The message filter type. Possible values include: 'NotSpecified', * 'Include', 'Exclude' - * @member {object} + * @property {object} * [content.edifact.receiveAgreement.protocolSettings.processingSettings] The * EDIFACT processing Settings. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [content.edifact.receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} + * @property {array} * [content.edifact.receiveAgreement.protocolSettings.envelopeOverrides] The * EDIFACT envelope override settings. - * @member {array} + * @property {array} * [content.edifact.receiveAgreement.protocolSettings.messageFilterList] The * EDIFACT message filter list. - * @member {array} + * @property {array} * [content.edifact.receiveAgreement.protocolSettings.schemaReferences] The * EDIFACT schema references. - * @member {array} + * @property {array} * [content.edifact.receiveAgreement.protocolSettings.validationOverrides] * The EDIFACT validation override settings. - * @member {array} + * @property {array} * [content.edifact.receiveAgreement.protocolSettings.edifactDelimiterOverrides] * The EDIFACT delimiter override settings. - * @member {object} [content.edifact.sendAgreement] The EDIFACT one-way send - * agreement. - * @member {object} [content.edifact.sendAgreement.senderBusinessIdentity] + * @property {object} [content.edifact.sendAgreement] The EDIFACT one-way + * send agreement. + * @property {object} [content.edifact.sendAgreement.senderBusinessIdentity] * The sender business identity - * @member {string} + * @property {string} * [content.edifact.sendAgreement.senderBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} + * @property {string} * [content.edifact.sendAgreement.senderBusinessIdentity.value] The user * defined business identity value. - * @member {object} [content.edifact.sendAgreement.receiverBusinessIdentity] - * The receiver business identity - * @member {string} + * @property {object} + * [content.edifact.sendAgreement.receiverBusinessIdentity] The receiver + * business identity + * @property {string} * [content.edifact.sendAgreement.receiverBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} + * @property {string} * [content.edifact.sendAgreement.receiverBusinessIdentity.value] The user * defined business identity value. - * @member {object} [content.edifact.sendAgreement.protocolSettings] The + * @property {object} [content.edifact.sendAgreement.protocolSettings] The * EDIFACT protocol settings. - * @member {object} + * @property {object} * [content.edifact.sendAgreement.protocolSettings.validationSettings] The * EDIFACT validation settings. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} + * @property {object} * [content.edifact.sendAgreement.protocolSettings.framingSettings] The * EDIFACT framing settings. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] * The service code list directory version. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.framingSettings.characterEncoding] * The character encoding. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.framingSettings.protocolVersion] * The protocol version. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.framingSettings.componentSeparator] * The component separator. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.framingSettings.segmentTerminator] * The segment terminator. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.framingSettings.releaseIndicator] * The release indicator. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.framingSettings.repetitionSeparator] * The repetition separator. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.framingSettings.characterSet] * The EDIFACT frame setting characterSet. Possible values include: * 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', * 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.framingSettings.decimalPointIndicator] * The EDIFACT frame setting decimal indicator. Possible values include: * 'NotSpecified', 'Comma', 'Decimal' - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The EDIFACT frame setting segment terminator suffix. Possible values * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {object} + * @property {object} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings] The * EDIFACT envelope settings. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] * The group association assigned code. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.communicationAgreementId] * The communication agreement id. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] * The value indicating whether to apply delimiter string advice. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.createGroupingSegments] * The value indicating whether to create grouping segments. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] * The recipient reference password value. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] * The recipient reference password qualifier. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.applicationReferenceId] * The application reference id. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.processingPriorityCode] * The processing priority code. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] * The interchange control number prefix. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] * The interchange control number suffix. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] * The sender reverse routing address. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] * The receiver reverse routing address. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] * The functional group id. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] * The group controlling agency code. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupMessageVersion] * The group message version. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupMessageRelease] * The group message release. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] * The group control number prefix. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] * The group control number suffix. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] * The group application receiver qualifier. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] * The group application receiver id. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] * The group application sender qualifier. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] * The group application sender id. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] * The group application password. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.isTestInterchange] * The value indicating whether the message is a test interchange. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] * The sender internal identification. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] * The sender internal sub identification. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] * The receiver internal identification. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] * The receiver internal sub identification. - * @member {object} + * @property {object} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings] * The EDIFACT acknowledgement settings. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} + * @property {object} * [content.edifact.sendAgreement.protocolSettings.messageFilter] The EDIFACT * message filter. - * @member {string} + * @property {string} * [content.edifact.sendAgreement.protocolSettings.messageFilter.messageFilterType] * The message filter type. Possible values include: 'NotSpecified', * 'Include', 'Exclude' - * @member {object} + * @property {object} * [content.edifact.sendAgreement.protocolSettings.processingSettings] The * EDIFACT processing Settings. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [content.edifact.sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} + * @property {array} * [content.edifact.sendAgreement.protocolSettings.envelopeOverrides] The * EDIFACT envelope override settings. - * @member {array} + * @property {array} * [content.edifact.sendAgreement.protocolSettings.messageFilterList] The * EDIFACT message filter list. - * @member {array} + * @property {array} * [content.edifact.sendAgreement.protocolSettings.schemaReferences] The * EDIFACT schema references. - * @member {array} + * @property {array} * [content.edifact.sendAgreement.protocolSettings.validationOverrides] The * EDIFACT validation override settings. - * @member {array} + * @property {array} * [content.edifact.sendAgreement.protocolSettings.edifactDelimiterOverrides] * The EDIFACT delimiter override settings. */ diff --git a/lib/services/logicManagement/lib/models/integrationAccountAgreementFilter.js b/lib/services/logicManagement/lib/models/integrationAccountAgreementFilter.js index b1cebe500f..ec5dd9ace9 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountAgreementFilter.js +++ b/lib/services/logicManagement/lib/models/integrationAccountAgreementFilter.js @@ -17,7 +17,7 @@ class IntegrationAccountAgreementFilter { /** * Create a IntegrationAccountAgreementFilter. - * @member {string} agreementType The agreement type of integration account + * @property {string} agreementType The agreement type of integration account * agreement. Possible values include: 'NotSpecified', 'AS2', 'X12', * 'Edifact' */ diff --git a/lib/services/logicManagement/lib/models/integrationAccountAgreementListResult.js b/lib/services/logicManagement/lib/models/integrationAccountAgreementListResult.js index 0322711ccb..c2ac638b9e 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountAgreementListResult.js +++ b/lib/services/logicManagement/lib/models/integrationAccountAgreementListResult.js @@ -16,7 +16,7 @@ class IntegrationAccountAgreementListResult extends Array { /** * Create a IntegrationAccountAgreementListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountCertificate.js b/lib/services/logicManagement/lib/models/integrationAccountCertificate.js index 147a02db4a..c681b99da8 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountCertificate.js +++ b/lib/services/logicManagement/lib/models/integrationAccountCertificate.js @@ -20,17 +20,17 @@ const models = require('./index'); class IntegrationAccountCertificate extends models['Resource'] { /** * Create a IntegrationAccountCertificate. - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {object} [metadata] The metadata. - * @member {object} [key] The key details in the key vault. - * @member {object} [key.keyVault] The key vault reference. - * @member {string} [key.keyVault.id] The resource id. - * @member {string} [key.keyVault.name] The resource name. - * @member {string} [key.keyVault.type] The resource type. - * @member {string} [key.keyName] The private key name in key vault. - * @member {string} [key.keyVersion] The private key version in key vault. - * @member {string} [publicCertificate] The public certificate. + * @property {date} [createdTime] The created time. + * @property {date} [changedTime] The changed time. + * @property {object} [metadata] The metadata. + * @property {object} [key] The key details in the key vault. + * @property {object} [key.keyVault] The key vault reference. + * @property {string} [key.keyVault.id] The resource id. + * @property {string} [key.keyVault.name] The resource name. + * @property {string} [key.keyVault.type] The resource type. + * @property {string} [key.keyName] The private key name in key vault. + * @property {string} [key.keyVersion] The private key version in key vault. + * @property {string} [publicCertificate] The public certificate. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountCertificateListResult.js b/lib/services/logicManagement/lib/models/integrationAccountCertificateListResult.js index f3e079d5cf..06a1eb8095 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountCertificateListResult.js +++ b/lib/services/logicManagement/lib/models/integrationAccountCertificateListResult.js @@ -16,7 +16,7 @@ class IntegrationAccountCertificateListResult extends Array { /** * Create a IntegrationAccountCertificateListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountListResult.js b/lib/services/logicManagement/lib/models/integrationAccountListResult.js index c1360033e7..d37251f824 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountListResult.js +++ b/lib/services/logicManagement/lib/models/integrationAccountListResult.js @@ -16,7 +16,7 @@ class IntegrationAccountListResult extends Array { /** * Create a IntegrationAccountListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountMap.js b/lib/services/logicManagement/lib/models/integrationAccountMap.js index 29aece5a98..72c7c00b38 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountMap.js +++ b/lib/services/logicManagement/lib/models/integrationAccountMap.js @@ -20,26 +20,26 @@ const models = require('./index'); class IntegrationAccountMap extends models['Resource'] { /** * Create a IntegrationAccountMap. - * @member {string} mapType The map type. Possible values include: + * @property {string} mapType The map type. Possible values include: * 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid' - * @member {object} [parametersSchema] The parameters schema of integration + * @property {object} [parametersSchema] The parameters schema of integration * account map. - * @member {string} [parametersSchema.ref] The reference name. - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {string} [content] The content. - * @member {string} [contentType] The content type. - * @member {object} [contentLink] The content link. - * @member {string} [contentLink.uri] The content link URI. - * @member {string} [contentLink.contentVersion] The content version. - * @member {number} [contentLink.contentSize] The content size. - * @member {object} [contentLink.contentHash] The content hash. - * @member {string} [contentLink.contentHash.algorithm] The algorithm of the + * @property {string} [parametersSchema.ref] The reference name. + * @property {date} [createdTime] The created time. + * @property {date} [changedTime] The changed time. + * @property {string} [content] The content. + * @property {string} [contentType] The content type. + * @property {object} [contentLink] The content link. + * @property {string} [contentLink.uri] The content link URI. + * @property {string} [contentLink.contentVersion] The content version. + * @property {number} [contentLink.contentSize] The content size. + * @property {object} [contentLink.contentHash] The content hash. + * @property {string} [contentLink.contentHash.algorithm] The algorithm of + * the content hash. + * @property {string} [contentLink.contentHash.value] The value of the * content hash. - * @member {string} [contentLink.contentHash.value] The value of the content - * hash. - * @member {object} [contentLink.metadata] The metadata. - * @member {object} [metadata] The metadata. + * @property {object} [contentLink.metadata] The metadata. + * @property {object} [metadata] The metadata. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountMapFilter.js b/lib/services/logicManagement/lib/models/integrationAccountMapFilter.js index 14b381aab3..8f60833ea2 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountMapFilter.js +++ b/lib/services/logicManagement/lib/models/integrationAccountMapFilter.js @@ -17,8 +17,9 @@ class IntegrationAccountMapFilter { /** * Create a IntegrationAccountMapFilter. - * @member {string} mapType The map type of integration account map. Possible - * values include: 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid' + * @property {string} mapType The map type of integration account map. + * Possible values include: 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', + * 'Liquid' */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/integrationAccountMapListResult.js b/lib/services/logicManagement/lib/models/integrationAccountMapListResult.js index 3b5540235c..94d1ab7391 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountMapListResult.js +++ b/lib/services/logicManagement/lib/models/integrationAccountMapListResult.js @@ -16,7 +16,7 @@ class IntegrationAccountMapListResult extends Array { /** * Create a IntegrationAccountMapListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountMapPropertiesParametersSchema.js b/lib/services/logicManagement/lib/models/integrationAccountMapPropertiesParametersSchema.js index 2f52cd188f..2c70918930 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountMapPropertiesParametersSchema.js +++ b/lib/services/logicManagement/lib/models/integrationAccountMapPropertiesParametersSchema.js @@ -17,7 +17,7 @@ class IntegrationAccountMapPropertiesParametersSchema { /** * Create a IntegrationAccountMapPropertiesParametersSchema. - * @member {string} [ref] The reference name. + * @property {string} [ref] The reference name. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/integrationAccountPartner.js b/lib/services/logicManagement/lib/models/integrationAccountPartner.js index f252522131..b934696e42 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountPartner.js +++ b/lib/services/logicManagement/lib/models/integrationAccountPartner.js @@ -20,14 +20,14 @@ const models = require('./index'); class IntegrationAccountPartner extends models['Resource'] { /** * Create a IntegrationAccountPartner. - * @member {string} partnerType The partner type. Possible values include: + * @property {string} partnerType The partner type. Possible values include: * 'NotSpecified', 'B2B' - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {object} [metadata] The metadata. - * @member {object} content The partner content. - * @member {object} [content.b2b] The B2B partner content. - * @member {array} [content.b2b.businessIdentities] The list of partner + * @property {date} [createdTime] The created time. + * @property {date} [changedTime] The changed time. + * @property {object} [metadata] The metadata. + * @property {object} content The partner content. + * @property {object} [content.b2b] The B2B partner content. + * @property {array} [content.b2b.businessIdentities] The list of partner * business identities. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/integrationAccountPartnerFilter.js b/lib/services/logicManagement/lib/models/integrationAccountPartnerFilter.js index 7c686a59f6..4303f4d112 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountPartnerFilter.js +++ b/lib/services/logicManagement/lib/models/integrationAccountPartnerFilter.js @@ -17,7 +17,7 @@ class IntegrationAccountPartnerFilter { /** * Create a IntegrationAccountPartnerFilter. - * @member {string} partnerType The partner type of integration account + * @property {string} partnerType The partner type of integration account * partner. Possible values include: 'NotSpecified', 'B2B' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/integrationAccountPartnerListResult.js b/lib/services/logicManagement/lib/models/integrationAccountPartnerListResult.js index 3e2e582d6a..58084f64d5 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountPartnerListResult.js +++ b/lib/services/logicManagement/lib/models/integrationAccountPartnerListResult.js @@ -16,7 +16,7 @@ class IntegrationAccountPartnerListResult extends Array { /** * Create a IntegrationAccountPartnerListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountSchema.js b/lib/services/logicManagement/lib/models/integrationAccountSchema.js index 9a93a98f35..a868565a19 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountSchema.js +++ b/lib/services/logicManagement/lib/models/integrationAccountSchema.js @@ -20,26 +20,26 @@ const models = require('./index'); class IntegrationAccountSchema extends models['Resource'] { /** * Create a IntegrationAccountSchema. - * @member {string} schemaType The schema type. Possible values include: + * @property {string} schemaType The schema type. Possible values include: * 'NotSpecified', 'Xml' - * @member {string} [targetNamespace] The target namespace of the schema. - * @member {string} [documentName] The document name. - * @member {string} [fileName] The file name. - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {object} [metadata] The metadata. - * @member {string} [content] The content. - * @member {string} [contentType] The content type. - * @member {object} [contentLink] The content link. - * @member {string} [contentLink.uri] The content link URI. - * @member {string} [contentLink.contentVersion] The content version. - * @member {number} [contentLink.contentSize] The content size. - * @member {object} [contentLink.contentHash] The content hash. - * @member {string} [contentLink.contentHash.algorithm] The algorithm of the + * @property {string} [targetNamespace] The target namespace of the schema. + * @property {string} [documentName] The document name. + * @property {string} [fileName] The file name. + * @property {date} [createdTime] The created time. + * @property {date} [changedTime] The changed time. + * @property {object} [metadata] The metadata. + * @property {string} [content] The content. + * @property {string} [contentType] The content type. + * @property {object} [contentLink] The content link. + * @property {string} [contentLink.uri] The content link URI. + * @property {string} [contentLink.contentVersion] The content version. + * @property {number} [contentLink.contentSize] The content size. + * @property {object} [contentLink.contentHash] The content hash. + * @property {string} [contentLink.contentHash.algorithm] The algorithm of + * the content hash. + * @property {string} [contentLink.contentHash.value] The value of the * content hash. - * @member {string} [contentLink.contentHash.value] The value of the content - * hash. - * @member {object} [contentLink.metadata] The metadata. + * @property {object} [contentLink.metadata] The metadata. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountSchemaFilter.js b/lib/services/logicManagement/lib/models/integrationAccountSchemaFilter.js index d0a454efc0..ad109790ed 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountSchemaFilter.js +++ b/lib/services/logicManagement/lib/models/integrationAccountSchemaFilter.js @@ -17,8 +17,8 @@ class IntegrationAccountSchemaFilter { /** * Create a IntegrationAccountSchemaFilter. - * @member {string} schemaType The schema type of integration account schema. - * Possible values include: 'NotSpecified', 'Xml' + * @property {string} schemaType The schema type of integration account + * schema. Possible values include: 'NotSpecified', 'Xml' */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/integrationAccountSchemaListResult.js b/lib/services/logicManagement/lib/models/integrationAccountSchemaListResult.js index ac045d7fb3..38c15c270e 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountSchemaListResult.js +++ b/lib/services/logicManagement/lib/models/integrationAccountSchemaListResult.js @@ -16,7 +16,7 @@ class IntegrationAccountSchemaListResult extends Array { /** * Create a IntegrationAccountSchemaListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountSession.js b/lib/services/logicManagement/lib/models/integrationAccountSession.js index a035f84298..a5a9953dae 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountSession.js +++ b/lib/services/logicManagement/lib/models/integrationAccountSession.js @@ -20,9 +20,9 @@ const models = require('./index'); class IntegrationAccountSession extends models['Resource'] { /** * Create a IntegrationAccountSession. - * @member {date} [createdTime] The created time. - * @member {date} [changedTime] The changed time. - * @member {object} [content] The session content. + * @property {date} [createdTime] The created time. + * @property {date} [changedTime] The changed time. + * @property {object} [content] The session content. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountSessionFilter.js b/lib/services/logicManagement/lib/models/integrationAccountSessionFilter.js index 5a5e8a5e54..57d8c9c71c 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountSessionFilter.js +++ b/lib/services/logicManagement/lib/models/integrationAccountSessionFilter.js @@ -17,7 +17,7 @@ class IntegrationAccountSessionFilter { /** * Create a IntegrationAccountSessionFilter. - * @member {date} changedTime The changed time of integration account + * @property {date} changedTime The changed time of integration account * sessions. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/integrationAccountSessionListResult.js b/lib/services/logicManagement/lib/models/integrationAccountSessionListResult.js index 37493ea4ba..72a6e7083f 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountSessionListResult.js +++ b/lib/services/logicManagement/lib/models/integrationAccountSessionListResult.js @@ -16,7 +16,7 @@ class IntegrationAccountSessionListResult extends Array { /** * Create a IntegrationAccountSessionListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/integrationAccountSku.js b/lib/services/logicManagement/lib/models/integrationAccountSku.js index cd6a1aee76..4a1fe02209 100644 --- a/lib/services/logicManagement/lib/models/integrationAccountSku.js +++ b/lib/services/logicManagement/lib/models/integrationAccountSku.js @@ -17,7 +17,7 @@ class IntegrationAccountSku { /** * Create a IntegrationAccountSku. - * @member {string} name The sku name. Possible values include: + * @property {string} name The sku name. Possible values include: * 'NotSpecified', 'Free', 'Basic', 'Standard' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/jsonSchema.js b/lib/services/logicManagement/lib/models/jsonSchema.js index e74da1917c..ae7a965eb5 100644 --- a/lib/services/logicManagement/lib/models/jsonSchema.js +++ b/lib/services/logicManagement/lib/models/jsonSchema.js @@ -17,8 +17,8 @@ class JsonSchema { /** * Create a JsonSchema. - * @member {string} [title] The JSON title. - * @member {string} [content] The JSON content. + * @property {string} [title] The JSON title. + * @property {string} [content] The JSON content. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/keyVaultKey.js b/lib/services/logicManagement/lib/models/keyVaultKey.js index 5fd09e1d50..8d94dab380 100644 --- a/lib/services/logicManagement/lib/models/keyVaultKey.js +++ b/lib/services/logicManagement/lib/models/keyVaultKey.js @@ -17,11 +17,12 @@ class KeyVaultKey { /** * Create a KeyVaultKey. - * @member {string} [kid] The key id. - * @member {object} [attributes] The key attributes. - * @member {boolean} [attributes.enabled] Whether the key is enabled or not. - * @member {number} [attributes.created] When the key was created. - * @member {number} [attributes.updated] When the key was updated. + * @property {string} [kid] The key id. + * @property {object} [attributes] The key attributes. + * @property {boolean} [attributes.enabled] Whether the key is enabled or + * not. + * @property {number} [attributes.created] When the key was created. + * @property {number} [attributes.updated] When the key was updated. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/keyVaultKeyAttributes.js b/lib/services/logicManagement/lib/models/keyVaultKeyAttributes.js index 275e76a65d..171ea443b0 100644 --- a/lib/services/logicManagement/lib/models/keyVaultKeyAttributes.js +++ b/lib/services/logicManagement/lib/models/keyVaultKeyAttributes.js @@ -17,9 +17,9 @@ class KeyVaultKeyAttributes { /** * Create a KeyVaultKeyAttributes. - * @member {boolean} [enabled] Whether the key is enabled or not. - * @member {number} [created] When the key was created. - * @member {number} [updated] When the key was updated. + * @property {boolean} [enabled] Whether the key is enabled or not. + * @property {number} [created] When the key was created. + * @property {number} [updated] When the key was updated. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/keyVaultKeyCollection.js b/lib/services/logicManagement/lib/models/keyVaultKeyCollection.js index 25897f7d35..b120fcb23f 100644 --- a/lib/services/logicManagement/lib/models/keyVaultKeyCollection.js +++ b/lib/services/logicManagement/lib/models/keyVaultKeyCollection.js @@ -16,7 +16,7 @@ class KeyVaultKeyCollection extends Array { /** * Create a KeyVaultKeyCollection. - * @member {string} [skipToken] The skip token. + * @property {string} [skipToken] The skip token. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/keyVaultKeyReference.js b/lib/services/logicManagement/lib/models/keyVaultKeyReference.js index c17885d879..7d6b2183a3 100644 --- a/lib/services/logicManagement/lib/models/keyVaultKeyReference.js +++ b/lib/services/logicManagement/lib/models/keyVaultKeyReference.js @@ -17,12 +17,12 @@ class KeyVaultKeyReference { /** * Create a KeyVaultKeyReference. - * @member {object} keyVault The key vault reference. - * @member {string} [keyVault.id] The resource id. - * @member {string} [keyVault.name] The resource name. - * @member {string} [keyVault.type] The resource type. - * @member {string} keyName The private key name in key vault. - * @member {string} [keyVersion] The private key version in key vault. + * @property {object} keyVault The key vault reference. + * @property {string} [keyVault.id] The resource id. + * @property {string} [keyVault.name] The resource name. + * @property {string} [keyVault.type] The resource type. + * @property {string} keyName The private key name in key vault. + * @property {string} [keyVersion] The private key version in key vault. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/keyVaultKeyReferenceKeyVault.js b/lib/services/logicManagement/lib/models/keyVaultKeyReferenceKeyVault.js index 390e94183c..d3ee2c43b9 100644 --- a/lib/services/logicManagement/lib/models/keyVaultKeyReferenceKeyVault.js +++ b/lib/services/logicManagement/lib/models/keyVaultKeyReferenceKeyVault.js @@ -17,9 +17,9 @@ class KeyVaultKeyReferenceKeyVault { /** * Create a KeyVaultKeyReferenceKeyVault. - * @member {string} [id] The resource id. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. + * @property {string} [id] The resource id. + * @property {string} [name] The resource name. + * @property {string} [type] The resource type. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/keyVaultReference.js b/lib/services/logicManagement/lib/models/keyVaultReference.js index cbcef6218c..ebe251af7d 100644 --- a/lib/services/logicManagement/lib/models/keyVaultReference.js +++ b/lib/services/logicManagement/lib/models/keyVaultReference.js @@ -41,7 +41,6 @@ class KeyVaultReference extends models['ResourceReference'] { modelProperties: { id: { required: false, - readOnly: true, serializedName: 'id', type: { name: 'String' diff --git a/lib/services/logicManagement/lib/models/listKeyVaultKeysDefinition.js b/lib/services/logicManagement/lib/models/listKeyVaultKeysDefinition.js index 51b2b633a2..45f317d7c3 100644 --- a/lib/services/logicManagement/lib/models/listKeyVaultKeysDefinition.js +++ b/lib/services/logicManagement/lib/models/listKeyVaultKeysDefinition.js @@ -17,8 +17,8 @@ class ListKeyVaultKeysDefinition { /** * Create a ListKeyVaultKeysDefinition. - * @member {object} keyVault The key vault reference. - * @member {string} [skipToken] The skip token. + * @property {object} keyVault The key vault reference. + * @property {string} [skipToken] The skip token. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/operation.js b/lib/services/logicManagement/lib/models/operation.js index 8f34d11df4..1ae01dd636 100644 --- a/lib/services/logicManagement/lib/models/operation.js +++ b/lib/services/logicManagement/lib/models/operation.js @@ -17,13 +17,14 @@ class Operation { /** * Create a Operation. - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] The object that represents the operation. - * @member {string} [display.provider] Service provider: Microsoft.Logic - * @member {string} [display.resource] Resource on which the operation is + * @property {string} [name] Operation name: + * {provider}/{resource}/{operation} + * @property {object} [display] The object that represents the operation. + * @property {string} [display.provider] Service provider: Microsoft.Logic + * @property {string} [display.resource] Resource on which the operation is * performed: Profile, endpoint, etc. - * @member {string} [display.operation] Operation type: Read, write, delete, - * etc. + * @property {string} [display.operation] Operation type: Read, write, + * delete, etc. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/operationDisplay.js b/lib/services/logicManagement/lib/models/operationDisplay.js index 8eba14eb9b..e2d238dca9 100644 --- a/lib/services/logicManagement/lib/models/operationDisplay.js +++ b/lib/services/logicManagement/lib/models/operationDisplay.js @@ -17,10 +17,10 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [provider] Service provider: Microsoft.Logic - * @member {string} [resource] Resource on which the operation is performed: - * Profile, endpoint, etc. - * @member {string} [operation] Operation type: Read, write, delete, etc. + * @property {string} [provider] Service provider: Microsoft.Logic + * @property {string} [resource] Resource on which the operation is + * performed: Profile, endpoint, etc. + * @property {string} [operation] Operation type: Read, write, delete, etc. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/operationListResult.js b/lib/services/logicManagement/lib/models/operationListResult.js index b63722f0cd..1daefb69c7 100644 --- a/lib/services/logicManagement/lib/models/operationListResult.js +++ b/lib/services/logicManagement/lib/models/operationListResult.js @@ -17,7 +17,7 @@ class OperationListResult extends Array { /** * Create a OperationListResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/operationResult.js b/lib/services/logicManagement/lib/models/operationResult.js index 027284d537..640fd2e347 100644 --- a/lib/services/logicManagement/lib/models/operationResult.js +++ b/lib/services/logicManagement/lib/models/operationResult.js @@ -20,32 +20,32 @@ const models = require('./index'); class OperationResult extends models['OperationResultProperties'] { /** * Create a OperationResult. - * @member {string} [trackingId] Gets the tracking id. - * @member {object} [inputs] Gets the inputs. - * @member {object} [inputsLink] Gets the link to inputs. - * @member {string} [inputsLink.uri] The content link URI. - * @member {string} [inputsLink.contentVersion] The content version. - * @member {number} [inputsLink.contentSize] The content size. - * @member {object} [inputsLink.contentHash] The content hash. - * @member {string} [inputsLink.contentHash.algorithm] The algorithm of the + * @property {string} [trackingId] Gets the tracking id. + * @property {object} [inputs] Gets the inputs. + * @property {object} [inputsLink] Gets the link to inputs. + * @property {string} [inputsLink.uri] The content link URI. + * @property {string} [inputsLink.contentVersion] The content version. + * @property {number} [inputsLink.contentSize] The content size. + * @property {object} [inputsLink.contentHash] The content hash. + * @property {string} [inputsLink.contentHash.algorithm] The algorithm of the * content hash. - * @member {string} [inputsLink.contentHash.value] The value of the content + * @property {string} [inputsLink.contentHash.value] The value of the content * hash. - * @member {object} [inputsLink.metadata] The metadata. - * @member {object} [outputs] Gets the outputs. - * @member {object} [outputsLink] Gets the link to outputs. - * @member {string} [outputsLink.uri] The content link URI. - * @member {string} [outputsLink.contentVersion] The content version. - * @member {number} [outputsLink.contentSize] The content size. - * @member {object} [outputsLink.contentHash] The content hash. - * @member {string} [outputsLink.contentHash.algorithm] The algorithm of the + * @property {object} [inputsLink.metadata] The metadata. + * @property {object} [outputs] Gets the outputs. + * @property {object} [outputsLink] Gets the link to outputs. + * @property {string} [outputsLink.uri] The content link URI. + * @property {string} [outputsLink.contentVersion] The content version. + * @property {number} [outputsLink.contentSize] The content size. + * @property {object} [outputsLink.contentHash] The content hash. + * @property {string} [outputsLink.contentHash.algorithm] The algorithm of + * the content hash. + * @property {string} [outputsLink.contentHash.value] The value of the * content hash. - * @member {string} [outputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [outputsLink.metadata] The metadata. - * @member {object} [trackedProperties] Gets the tracked properties. - * @member {array} [retryHistory] Gets the retry histories. - * @member {number} [iterationCount] + * @property {object} [outputsLink.metadata] The metadata. + * @property {object} [trackedProperties] Gets the tracked properties. + * @property {array} [retryHistory] Gets the retry histories. + * @property {number} [iterationCount] */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/operationResultProperties.js b/lib/services/logicManagement/lib/models/operationResultProperties.js index 89d493ca7d..1e9a987e7b 100644 --- a/lib/services/logicManagement/lib/models/operationResultProperties.js +++ b/lib/services/logicManagement/lib/models/operationResultProperties.js @@ -17,18 +17,18 @@ class OperationResultProperties { /** * Create a OperationResultProperties. - * @member {date} [startTime] The start time of the workflow scope + * @property {date} [startTime] The start time of the workflow scope * repetition. - * @member {date} [endTime] The end time of the workflow scope repetition. - * @member {object} [correlation] The correlation properties. - * @member {string} [correlation.actionTrackingId] The action tracking + * @property {date} [endTime] The end time of the workflow scope repetition. + * @property {object} [correlation] The correlation properties. + * @property {string} [correlation.actionTrackingId] The action tracking * identifier. - * @member {string} [status] The status of the workflow scope repetition. + * @property {string} [status] The status of the workflow scope repetition. * Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', * 'TimedOut', 'Aborted', 'Ignored' - * @member {string} [code] The workflow scope repetition code. - * @member {object} [error] + * @property {string} [code] The workflow scope repetition code. + * @property {object} [error] */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/partnerContent.js b/lib/services/logicManagement/lib/models/partnerContent.js index 592eea7020..f3a7655360 100644 --- a/lib/services/logicManagement/lib/models/partnerContent.js +++ b/lib/services/logicManagement/lib/models/partnerContent.js @@ -17,8 +17,8 @@ class PartnerContent { /** * Create a PartnerContent. - * @member {object} [b2b] The B2B partner content. - * @member {array} [b2b.businessIdentities] The list of partner business + * @property {object} [b2b] The B2B partner content. + * @property {array} [b2b.businessIdentities] The list of partner business * identities. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/recurrenceSchedule.js b/lib/services/logicManagement/lib/models/recurrenceSchedule.js index 230c1d64e5..f1c34e9a16 100644 --- a/lib/services/logicManagement/lib/models/recurrenceSchedule.js +++ b/lib/services/logicManagement/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/logicManagement/lib/models/recurrenceScheduleOccurrence.js b/lib/services/logicManagement/lib/models/recurrenceScheduleOccurrence.js index 7f5c6c4d67..71492f77b5 100644 --- a/lib/services/logicManagement/lib/models/recurrenceScheduleOccurrence.js +++ b/lib/services/logicManagement/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/logicManagement/lib/models/regenerateActionParameter.js b/lib/services/logicManagement/lib/models/regenerateActionParameter.js index f1129f5797..93642c85dd 100644 --- a/lib/services/logicManagement/lib/models/regenerateActionParameter.js +++ b/lib/services/logicManagement/lib/models/regenerateActionParameter.js @@ -17,7 +17,7 @@ class RegenerateActionParameter { /** * Create a RegenerateActionParameter. - * @member {string} [keyType] The key type. Possible values include: + * @property {string} [keyType] The key type. Possible values include: * 'NotSpecified', 'Primary', 'Secondary' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/repetitionIndex.js b/lib/services/logicManagement/lib/models/repetitionIndex.js index 0d48977b20..06cc80f0c3 100644 --- a/lib/services/logicManagement/lib/models/repetitionIndex.js +++ b/lib/services/logicManagement/lib/models/repetitionIndex.js @@ -17,8 +17,8 @@ class RepetitionIndex { /** * Create a RepetitionIndex. - * @member {string} [scopeName] The scope. - * @member {number} itemIndex The index. + * @property {string} [scopeName] The scope. + * @property {number} itemIndex The index. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/request.js b/lib/services/logicManagement/lib/models/request.js new file mode 100644 index 0000000000..a12117fcf5 --- /dev/null +++ b/lib/services/logicManagement/lib/models/request.js @@ -0,0 +1,69 @@ +/* + * 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'; + +/** + * A request. + * + */ +class Request { + /** + * Create a Request. + * @property {object} [headers] A list of all the headers attached to the + * request. + * @property {string} [uri] The destination for the request. + * @property {string} [method] The HTTP method used for the request. + */ + constructor() { + } + + /** + * Defines the metadata of Request + * + * @returns {object} metadata of Request + * + */ + mapper() { + return { + required: false, + serializedName: 'Request', + type: { + name: 'Composite', + className: 'Request', + modelProperties: { + headers: { + required: false, + serializedName: 'headers', + type: { + name: 'Object' + } + }, + uri: { + required: false, + serializedName: 'uri', + type: { + name: 'String' + } + }, + method: { + required: false, + serializedName: 'method', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = Request; diff --git a/lib/services/logicManagement/lib/models/requestHistory.js b/lib/services/logicManagement/lib/models/requestHistory.js new file mode 100644 index 0000000000..01c64dfec3 --- /dev/null +++ b/lib/services/logicManagement/lib/models/requestHistory.js @@ -0,0 +1,131 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * The request history. + * + * @extends models['Resource'] + */ +class RequestHistory extends models['Resource'] { + /** + * Create a RequestHistory. + * @property {object} [properties] The request history properties. + * @property {date} [properties.startTime] The time the request started. + * @property {date} [properties.endTime] The time the request ended. + * @property {object} [properties.request] The request. + * @property {object} [properties.request.headers] A list of all the headers + * attached to the request. + * @property {string} [properties.request.uri] The destination for the + * request. + * @property {string} [properties.request.method] The HTTP method used for + * the request. + * @property {object} [properties.response] The response. + * @property {object} [properties.response.headers] A list of all the headers + * attached to the response. + * @property {number} [properties.response.statusCode] The status code of the + * response. + * @property {object} [properties.response.bodyLink] Details on the location + * of the body content. + * @property {string} [properties.response.bodyLink.uri] The content link + * URI. + * @property {string} [properties.response.bodyLink.contentVersion] The + * content version. + * @property {number} [properties.response.bodyLink.contentSize] The content + * size. + * @property {object} [properties.response.bodyLink.contentHash] The content + * hash. + * @property {string} [properties.response.bodyLink.contentHash.algorithm] + * The algorithm of the content hash. + * @property {string} [properties.response.bodyLink.contentHash.value] The + * value of the content hash. + * @property {object} [properties.response.bodyLink.metadata] The metadata. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of RequestHistory + * + * @returns {object} metadata of RequestHistory + * + */ + mapper() { + return { + required: false, + serializedName: 'RequestHistory', + type: { + name: 'Composite', + className: 'RequestHistory', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + location: { + required: false, + serializedName: 'location', + type: { + name: 'String' + } + }, + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + properties: { + required: false, + serializedName: 'properties', + type: { + name: 'Composite', + className: 'RequestHistoryProperties' + } + } + } + } + }; + } +} + +module.exports = RequestHistory; diff --git a/lib/services/logicManagement/lib/models/requestHistoryListResult.js b/lib/services/logicManagement/lib/models/requestHistoryListResult.js new file mode 100644 index 0000000000..ca133adeca --- /dev/null +++ b/lib/services/logicManagement/lib/models/requestHistoryListResult.js @@ -0,0 +1,67 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The list of workflow request histories. + */ +class RequestHistoryListResult extends Array { + /** + * Create a RequestHistoryListResult. + * @property {string} [nextLink] The URL to get the next set of results. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of RequestHistoryListResult + * + * @returns {object} metadata of RequestHistoryListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'RequestHistoryListResult', + type: { + name: 'Composite', + className: 'RequestHistoryListResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'RequestHistoryElementType', + type: { + name: 'Composite', + className: 'RequestHistory' + } + } + } + }, + nextLink: { + required: false, + serializedName: 'nextLink', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = RequestHistoryListResult; diff --git a/lib/services/logicManagement/lib/models/requestHistoryProperties.js b/lib/services/logicManagement/lib/models/requestHistoryProperties.js new file mode 100644 index 0000000000..dfa20429ec --- /dev/null +++ b/lib/services/logicManagement/lib/models/requestHistoryProperties.js @@ -0,0 +1,96 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The request history. + * + */ +class RequestHistoryProperties { + /** + * Create a RequestHistoryProperties. + * @property {date} [startTime] The time the request started. + * @property {date} [endTime] The time the request ended. + * @property {object} [request] The request. + * @property {object} [request.headers] A list of all the headers attached to + * the request. + * @property {string} [request.uri] The destination for the request. + * @property {string} [request.method] The HTTP method used for the request. + * @property {object} [response] The response. + * @property {object} [response.headers] A list of all the headers attached + * to the response. + * @property {number} [response.statusCode] The status code of the response. + * @property {object} [response.bodyLink] Details on the location of the body + * content. + * @property {string} [response.bodyLink.uri] The content link URI. + * @property {string} [response.bodyLink.contentVersion] The content version. + * @property {number} [response.bodyLink.contentSize] The content size. + * @property {object} [response.bodyLink.contentHash] The content hash. + * @property {string} [response.bodyLink.contentHash.algorithm] The algorithm + * of the content hash. + * @property {string} [response.bodyLink.contentHash.value] The value of the + * content hash. + * @property {object} [response.bodyLink.metadata] The metadata. + */ + constructor() { + } + + /** + * Defines the metadata of RequestHistoryProperties + * + * @returns {object} metadata of RequestHistoryProperties + * + */ + mapper() { + return { + required: false, + serializedName: 'RequestHistoryProperties', + type: { + name: 'Composite', + className: 'RequestHistoryProperties', + modelProperties: { + startTime: { + required: false, + serializedName: 'startTime', + type: { + name: 'DateTime' + } + }, + endTime: { + required: false, + serializedName: 'endTime', + type: { + name: 'DateTime' + } + }, + request: { + required: false, + serializedName: 'request', + type: { + name: 'Composite', + className: 'Request' + } + }, + response: { + required: false, + serializedName: 'response', + type: { + name: 'Composite', + className: 'Response' + } + } + } + } + }; + } +} + +module.exports = RequestHistoryProperties; diff --git a/lib/services/logicManagement/lib/models/resource.js b/lib/services/logicManagement/lib/models/resource.js index b786ae89f7..5970922939 100644 --- a/lib/services/logicManagement/lib/models/resource.js +++ b/lib/services/logicManagement/lib/models/resource.js @@ -20,11 +20,11 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] The resource id. - * @member {string} [name] Gets the resource name. - * @member {string} [type] Gets the resource type. - * @member {string} [location] The resource location. - * @member {object} [tags] The resource tags. + * @property {string} [id] The resource id. + * @property {string} [name] Gets the resource name. + * @property {string} [type] Gets the resource type. + * @property {string} [location] The resource location. + * @property {object} [tags] The resource tags. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/resourceReference.js b/lib/services/logicManagement/lib/models/resourceReference.js index 4f542ef415..ae11525fe9 100644 --- a/lib/services/logicManagement/lib/models/resourceReference.js +++ b/lib/services/logicManagement/lib/models/resourceReference.js @@ -17,9 +17,9 @@ class ResourceReference { /** * Create a ResourceReference. - * @member {string} [id] The resource id. - * @member {string} [name] Gets the resource name. - * @member {string} [type] Gets the resource type. + * @property {string} [id] The resource id. + * @property {string} [name] Gets the resource name. + * @property {string} [type] Gets the resource type. */ constructor() { } @@ -40,7 +40,6 @@ class ResourceReference { modelProperties: { id: { required: false, - readOnly: true, serializedName: 'id', type: { name: 'String' diff --git a/lib/services/logicManagement/lib/models/response.js b/lib/services/logicManagement/lib/models/response.js new file mode 100644 index 0000000000..cb80cf5b33 --- /dev/null +++ b/lib/services/logicManagement/lib/models/response.js @@ -0,0 +1,79 @@ +/* + * 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'; + +/** + * A response. + * + */ +class Response { + /** + * Create a Response. + * @property {object} [headers] A list of all the headers attached to the + * response. + * @property {number} [statusCode] The status code of the response. + * @property {object} [bodyLink] Details on the location of the body content. + * @property {string} [bodyLink.uri] The content link URI. + * @property {string} [bodyLink.contentVersion] The content version. + * @property {number} [bodyLink.contentSize] The content size. + * @property {object} [bodyLink.contentHash] The content hash. + * @property {string} [bodyLink.contentHash.algorithm] The algorithm of the + * content hash. + * @property {string} [bodyLink.contentHash.value] The value of the content + * hash. + * @property {object} [bodyLink.metadata] The metadata. + */ + constructor() { + } + + /** + * Defines the metadata of Response + * + * @returns {object} metadata of Response + * + */ + mapper() { + return { + required: false, + serializedName: 'Response', + type: { + name: 'Composite', + className: 'Response', + modelProperties: { + headers: { + required: false, + serializedName: 'headers', + type: { + name: 'Object' + } + }, + statusCode: { + required: false, + serializedName: 'statusCode', + type: { + name: 'Number' + } + }, + bodyLink: { + required: false, + serializedName: 'bodyLink', + type: { + name: 'Composite', + className: 'ContentLink' + } + } + } + } + }; + } +} + +module.exports = Response; diff --git a/lib/services/logicManagement/lib/models/retryHistory.js b/lib/services/logicManagement/lib/models/retryHistory.js index 28350a2810..1f643e68a3 100644 --- a/lib/services/logicManagement/lib/models/retryHistory.js +++ b/lib/services/logicManagement/lib/models/retryHistory.js @@ -17,15 +17,15 @@ class RetryHistory { /** * Create a RetryHistory. - * @member {date} [startTime] Gets the start time. - * @member {date} [endTime] Gets the end time. - * @member {string} [code] Gets the status code. - * @member {string} [clientRequestId] Gets the client request Id. - * @member {string} [serviceRequestId] Gets the service request Id. - * @member {object} [error] Gets the error response. - * @member {object} [error.error] The error properties. - * @member {string} [error.error.code] Error code. - * @member {string} [error.error.message] Error message indicating why the + * @property {date} [startTime] Gets the start time. + * @property {date} [endTime] Gets the end time. + * @property {string} [code] Gets the status code. + * @property {string} [clientRequestId] Gets the client request Id. + * @property {string} [serviceRequestId] Gets the service request Id. + * @property {object} [error] Gets the error response. + * @property {object} [error.error] The error properties. + * @property {string} [error.error.code] Error code. + * @property {string} [error.error.message] Error message indicating why the * operation failed. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/runActionCorrelation.js b/lib/services/logicManagement/lib/models/runActionCorrelation.js index b69c875cf2..9103619bb3 100644 --- a/lib/services/logicManagement/lib/models/runActionCorrelation.js +++ b/lib/services/logicManagement/lib/models/runActionCorrelation.js @@ -20,7 +20,7 @@ const models = require('./index'); class RunActionCorrelation extends models['RunCorrelation'] { /** * Create a RunActionCorrelation. - * @member {string} [actionTrackingId] The action tracking identifier. + * @property {string} [actionTrackingId] The action tracking identifier. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/runCorrelation.js b/lib/services/logicManagement/lib/models/runCorrelation.js index f951a36ffc..7684bb1f0a 100644 --- a/lib/services/logicManagement/lib/models/runCorrelation.js +++ b/lib/services/logicManagement/lib/models/runCorrelation.js @@ -17,8 +17,8 @@ class RunCorrelation { /** * Create a RunCorrelation. - * @member {string} [clientTrackingId] The client tracking identifier. - * @member {array} [clientKeywords] The client keywords. + * @property {string} [clientTrackingId] The client tracking identifier. + * @property {array} [clientKeywords] The client keywords. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/setTriggerStateActionDefinition.js b/lib/services/logicManagement/lib/models/setTriggerStateActionDefinition.js index 11767cb1c0..62e9951231 100644 --- a/lib/services/logicManagement/lib/models/setTriggerStateActionDefinition.js +++ b/lib/services/logicManagement/lib/models/setTriggerStateActionDefinition.js @@ -16,44 +16,45 @@ class SetTriggerStateActionDefinition { /** * Create a SetTriggerStateActionDefinition. - * @member {object} source - * @member {string} [source.provisioningState] Gets the provisioning state. + * @property {object} source + * @property {string} [source.provisioningState] Gets the provisioning state. * Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', * 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', * 'Succeeded', 'Moving', 'Updating', 'Registering', 'Registered', * 'Unregistering', 'Unregistered', 'Completed' - * @member {date} [source.createdTime] Gets the created time. - * @member {date} [source.changedTime] Gets the changed time. - * @member {string} [source.state] Gets the state. Possible values include: + * @property {date} [source.createdTime] Gets the created time. + * @property {date} [source.changedTime] Gets the changed time. + * @property {string} [source.state] Gets the state. Possible values include: * 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' - * @member {string} [source.status] Gets the status. Possible values include: - * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', - * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', - * 'Ignored' - * @member {date} [source.lastExecutionTime] Gets the last execution time. - * @member {date} [source.nextExecutionTime] Gets the next execution time. - * @member {object} [source.recurrence] Gets the workflow trigger recurrence. - * @member {string} [source.recurrence.frequency] The frequency. Possible + * @property {string} [source.status] Gets the status. Possible values + * include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', + * 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', + * 'Aborted', 'Ignored' + * @property {date} [source.lastExecutionTime] Gets the last execution time. + * @property {date} [source.nextExecutionTime] Gets the next execution time. + * @property {object} [source.recurrence] Gets the workflow trigger + * recurrence. + * @property {string} [source.recurrence.frequency] The frequency. Possible * values include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', * 'Month', 'Year' - * @member {number} [source.recurrence.interval] The interval. - * @member {string} [source.recurrence.startTime] The start time. - * @member {string} [source.recurrence.endTime] The end time. - * @member {string} [source.recurrence.timeZone] The time zone. - * @member {object} [source.recurrence.schedule] The recurrence schedule. - * @member {array} [source.recurrence.schedule.minutes] The minutes. - * @member {array} [source.recurrence.schedule.hours] The hours. - * @member {array} [source.recurrence.schedule.weekDays] The days of the + * @property {number} [source.recurrence.interval] The interval. + * @property {string} [source.recurrence.startTime] The start time. + * @property {string} [source.recurrence.endTime] The end time. + * @property {string} [source.recurrence.timeZone] The time zone. + * @property {object} [source.recurrence.schedule] The recurrence schedule. + * @property {array} [source.recurrence.schedule.minutes] The minutes. + * @property {array} [source.recurrence.schedule.hours] The hours. + * @property {array} [source.recurrence.schedule.weekDays] The days of the * week. - * @member {array} [source.recurrence.schedule.monthDays] The month days. - * @member {array} [source.recurrence.schedule.monthlyOccurrences] The + * @property {array} [source.recurrence.schedule.monthDays] The month days. + * @property {array} [source.recurrence.schedule.monthlyOccurrences] The * monthly occurrences. - * @member {object} [source.workflow] Gets the reference to workflow. - * @member {string} [source.workflow.id] The resource id. - * @member {string} [source.workflow.name] Gets the resource name. - * @member {string} [source.workflow.type] Gets the resource type. - * @member {string} [source.name] Gets the workflow trigger name. - * @member {string} [source.type] Gets the workflow trigger type. + * @property {object} [source.workflow] Gets the reference to workflow. + * @property {string} [source.workflow.id] The resource id. + * @property {string} [source.workflow.name] Gets the resource name. + * @property {string} [source.workflow.type] Gets the resource type. + * @property {string} [source.name] Gets the workflow trigger name. + * @property {string} [source.type] Gets the workflow trigger type. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/sku.js b/lib/services/logicManagement/lib/models/sku.js index e5f4aece11..84eb804847 100644 --- a/lib/services/logicManagement/lib/models/sku.js +++ b/lib/services/logicManagement/lib/models/sku.js @@ -17,12 +17,12 @@ class Sku { /** * Create a Sku. - * @member {string} name The name. Possible values include: 'NotSpecified', + * @property {string} name The name. Possible values include: 'NotSpecified', * 'Free', 'Shared', 'Basic', 'Standard', 'Premium' - * @member {object} [plan] The reference to plan. - * @member {string} [plan.id] The resource id. - * @member {string} [plan.name] Gets the resource name. - * @member {string} [plan.type] Gets the resource type. + * @property {object} [plan] The reference to plan. + * @property {string} [plan.id] The resource id. + * @property {string} [plan.name] Gets the resource name. + * @property {string} [plan.type] Gets the resource type. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/subResource.js b/lib/services/logicManagement/lib/models/subResource.js index 842664e53f..60a0820acb 100644 --- a/lib/services/logicManagement/lib/models/subResource.js +++ b/lib/services/logicManagement/lib/models/subResource.js @@ -20,7 +20,7 @@ const models = require('./index'); class SubResource extends models['BaseResource'] { /** * Create a SubResource. - * @member {string} [id] The resource id. + * @property {string} [id] The resource id. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/trackingEvent.js b/lib/services/logicManagement/lib/models/trackingEvent.js index 3fd248e362..3878f96235 100644 --- a/lib/services/logicManagement/lib/models/trackingEvent.js +++ b/lib/services/logicManagement/lib/models/trackingEvent.js @@ -16,10 +16,10 @@ class TrackingEvent { /** * Create a TrackingEvent. - * @member {string} eventLevel Possible values include: 'LogAlways', + * @property {string} eventLevel Possible values include: 'LogAlways', * 'Critical', 'Error', 'Warning', 'Informational', 'Verbose' - * @member {date} eventTime - * @member {string} recordType Possible values include: 'NotSpecified', + * @property {date} eventTime + * @property {string} recordType Possible values include: 'NotSpecified', * 'Custom', 'AS2Message', 'AS2MDN', 'X12Interchange', 'X12FunctionalGroup', * 'X12TransactionSet', 'X12InterchangeAcknowledgment', * 'X12FunctionalGroupAcknowledgment', 'X12TransactionSetAcknowledgment', @@ -27,9 +27,9 @@ class TrackingEvent { * 'EdifactInterchangeAcknowledgment', * 'EdifactFunctionalGroupAcknowledgment', * 'EdifactTransactionSetAcknowledgment' - * @member {object} [error] - * @member {string} [error.message] - * @member {string} [error.code] + * @property {object} [error] + * @property {string} [error.message] + * @property {string} [error.code] */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/trackingEventErrorInfo.js b/lib/services/logicManagement/lib/models/trackingEventErrorInfo.js index b98578f781..22144f85df 100644 --- a/lib/services/logicManagement/lib/models/trackingEventErrorInfo.js +++ b/lib/services/logicManagement/lib/models/trackingEventErrorInfo.js @@ -16,8 +16,8 @@ class TrackingEventErrorInfo { /** * Create a TrackingEventErrorInfo. - * @member {string} [message] - * @member {string} [code] + * @property {string} [message] + * @property {string} [code] */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/trackingEventsDefinition.js b/lib/services/logicManagement/lib/models/trackingEventsDefinition.js index 3b745601fb..c8a7459cee 100644 --- a/lib/services/logicManagement/lib/models/trackingEventsDefinition.js +++ b/lib/services/logicManagement/lib/models/trackingEventsDefinition.js @@ -16,10 +16,10 @@ class TrackingEventsDefinition { /** * Create a TrackingEventsDefinition. - * @member {string} sourceType - * @member {string} [trackEventsOptions] Possible values include: 'None', + * @property {string} sourceType + * @property {string} [trackEventsOptions] Possible values include: 'None', * 'DisableSourceInfoEnrich' - * @member {array} events + * @property {array} events */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/workflow.js b/lib/services/logicManagement/lib/models/workflow.js index 6c9efb8a78..34f78bfbdf 100644 --- a/lib/services/logicManagement/lib/models/workflow.js +++ b/lib/services/logicManagement/lib/models/workflow.js @@ -20,30 +20,30 @@ const models = require('./index'); class Workflow extends models['Resource'] { /** * Create a Workflow. - * @member {string} [provisioningState] Gets the provisioning state. Possible - * values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', + * @property {string} [provisioningState] Gets the provisioning state. + * Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', * 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', * 'Succeeded', 'Moving', 'Updating', 'Registering', 'Registered', * 'Unregistering', 'Unregistered', 'Completed' - * @member {date} [createdTime] Gets the created time. - * @member {date} [changedTime] Gets the changed time. - * @member {string} [state] The state. Possible values include: + * @property {date} [createdTime] Gets the created time. + * @property {date} [changedTime] Gets the changed time. + * @property {string} [state] The state. Possible values include: * 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' - * @member {string} [version] Gets the version. - * @member {string} [accessEndpoint] Gets the access endpoint. - * @member {object} [sku] The sku. - * @member {string} [sku.name] The name. Possible values include: + * @property {string} [version] Gets the version. + * @property {string} [accessEndpoint] Gets the access endpoint. + * @property {object} [sku] The sku. + * @property {string} [sku.name] The name. Possible values include: * 'NotSpecified', 'Free', 'Shared', 'Basic', 'Standard', 'Premium' - * @member {object} [sku.plan] The reference to plan. - * @member {string} [sku.plan.id] The resource id. - * @member {string} [sku.plan.name] Gets the resource name. - * @member {string} [sku.plan.type] Gets the resource type. - * @member {object} [integrationAccount] The integration account. - * @member {string} [integrationAccount.id] The resource id. - * @member {string} [integrationAccount.name] Gets the resource name. - * @member {string} [integrationAccount.type] Gets the resource type. - * @member {object} [definition] The definition. - * @member {object} [parameters] The parameters. + * @property {object} [sku.plan] The reference to plan. + * @property {string} [sku.plan.id] The resource id. + * @property {string} [sku.plan.name] Gets the resource name. + * @property {string} [sku.plan.type] Gets the resource type. + * @property {object} [integrationAccount] The integration account. + * @property {string} [integrationAccount.id] The resource id. + * @property {string} [integrationAccount.name] Gets the resource name. + * @property {string} [integrationAccount.type] Gets the resource type. + * @property {object} [definition] The definition. + * @property {object} [parameters] The parameters. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowFilter.js b/lib/services/logicManagement/lib/models/workflowFilter.js index 021d23de22..93ec52de73 100644 --- a/lib/services/logicManagement/lib/models/workflowFilter.js +++ b/lib/services/logicManagement/lib/models/workflowFilter.js @@ -17,8 +17,9 @@ class WorkflowFilter { /** * Create a WorkflowFilter. - * @member {string} [state] The state of workflows. Possible values include: - * 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' + * @property {string} [state] The state of workflows. Possible values + * include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', + * 'Suspended' */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/workflowListResult.js b/lib/services/logicManagement/lib/models/workflowListResult.js index 7034f80094..4154a5b665 100644 --- a/lib/services/logicManagement/lib/models/workflowListResult.js +++ b/lib/services/logicManagement/lib/models/workflowListResult.js @@ -16,7 +16,7 @@ class WorkflowListResult extends Array { /** * Create a WorkflowListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowOutputParameter.js b/lib/services/logicManagement/lib/models/workflowOutputParameter.js index 83aa917ad7..24d7dfddde 100644 --- a/lib/services/logicManagement/lib/models/workflowOutputParameter.js +++ b/lib/services/logicManagement/lib/models/workflowOutputParameter.js @@ -20,7 +20,7 @@ const models = require('./index'); class WorkflowOutputParameter extends models['WorkflowParameter'] { /** * Create a WorkflowOutputParameter. - * @member {object} [error] Gets the error. + * @property {object} [error] Gets the error. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowParameter.js b/lib/services/logicManagement/lib/models/workflowParameter.js index 8971c209bb..6a72231655 100644 --- a/lib/services/logicManagement/lib/models/workflowParameter.js +++ b/lib/services/logicManagement/lib/models/workflowParameter.js @@ -17,12 +17,12 @@ class WorkflowParameter { /** * Create a WorkflowParameter. - * @member {string} [type] The type. Possible values include: 'NotSpecified', - * 'String', 'SecureString', 'Int', 'Float', 'Bool', 'Array', 'Object', - * 'SecureObject' - * @member {object} [value] The value. - * @member {object} [metadata] The metadata. - * @member {string} [description] The description. + * @property {string} [type] The type. Possible values include: + * 'NotSpecified', 'String', 'SecureString', 'Int', 'Float', 'Bool', 'Array', + * 'Object', 'SecureObject' + * @property {object} [value] The value. + * @property {object} [metadata] The metadata. + * @property {string} [description] The description. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/workflowRun.js b/lib/services/logicManagement/lib/models/workflowRun.js index 7e92d6fe4a..28ef3c58a3 100644 --- a/lib/services/logicManagement/lib/models/workflowRun.js +++ b/lib/services/logicManagement/lib/models/workflowRun.js @@ -20,102 +20,107 @@ const models = require('./index'); class WorkflowRun extends models['SubResource'] { /** * Create a WorkflowRun. - * @member {date} [waitEndTime] Gets the wait end time. - * @member {date} [startTime] Gets the start time. - * @member {date} [endTime] Gets the end time. - * @member {string} [status] Gets the status. Possible values include: + * @property {date} [waitEndTime] Gets the wait end time. + * @property {date} [startTime] Gets the start time. + * @property {date} [endTime] Gets the end time. + * @property {string} [status] Gets the status. Possible values include: * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', * 'Ignored' - * @member {string} [code] Gets the code. - * @member {object} [error] Gets the error. - * @member {string} [correlationId] Gets the correlation id. - * @member {object} [correlation] The run correlation. - * @member {string} [correlation.clientTrackingId] The client tracking id. - * @member {object} [workflow] Gets the reference to workflow version. - * @member {string} [workflow.id] The resource id. - * @member {string} [workflow.name] Gets the resource name. - * @member {string} [workflow.type] Gets the resource type. - * @member {object} [trigger] Gets the fired trigger. - * @member {string} [trigger.name] Gets the name. - * @member {object} [trigger.inputs] Gets the inputs. - * @member {object} [trigger.inputsLink] Gets the link to inputs. - * @member {string} [trigger.inputsLink.uri] The content link URI. - * @member {string} [trigger.inputsLink.contentVersion] The content version. - * @member {number} [trigger.inputsLink.contentSize] The content size. - * @member {object} [trigger.inputsLink.contentHash] The content hash. - * @member {string} [trigger.inputsLink.contentHash.algorithm] The algorithm - * of the content hash. - * @member {string} [trigger.inputsLink.contentHash.value] The value of the - * content hash. - * @member {object} [trigger.inputsLink.metadata] The metadata. - * @member {object} [trigger.outputs] Gets the outputs. - * @member {object} [trigger.outputsLink] Gets the link to outputs. - * @member {string} [trigger.outputsLink.uri] The content link URI. - * @member {string} [trigger.outputsLink.contentVersion] The content version. - * @member {number} [trigger.outputsLink.contentSize] The content size. - * @member {object} [trigger.outputsLink.contentHash] The content hash. - * @member {string} [trigger.outputsLink.contentHash.algorithm] The algorithm - * of the content hash. - * @member {string} [trigger.outputsLink.contentHash.value] The value of the + * @property {string} [code] Gets the code. + * @property {object} [error] Gets the error. + * @property {string} [correlationId] Gets the correlation id. + * @property {object} [correlation] The run correlation. + * @property {string} [correlation.clientTrackingId] The client tracking id. + * @property {object} [workflow] Gets the reference to workflow version. + * @property {string} [workflow.id] The resource id. + * @property {string} [workflow.name] Gets the resource name. + * @property {string} [workflow.type] Gets the resource type. + * @property {object} [trigger] Gets the fired trigger. + * @property {string} [trigger.name] Gets the name. + * @property {object} [trigger.inputs] Gets the inputs. + * @property {object} [trigger.inputsLink] Gets the link to inputs. + * @property {string} [trigger.inputsLink.uri] The content link URI. + * @property {string} [trigger.inputsLink.contentVersion] The content + * version. + * @property {number} [trigger.inputsLink.contentSize] The content size. + * @property {object} [trigger.inputsLink.contentHash] The content hash. + * @property {string} [trigger.inputsLink.contentHash.algorithm] The + * algorithm of the content hash. + * @property {string} [trigger.inputsLink.contentHash.value] The value of the * content hash. - * @member {object} [trigger.outputsLink.metadata] The metadata. - * @member {date} [trigger.scheduledTime] Gets the scheduled time. - * @member {date} [trigger.startTime] Gets the start time. - * @member {date} [trigger.endTime] Gets the end time. - * @member {string} [trigger.trackingId] Gets the tracking id. - * @member {object} [trigger.correlation] The run correlation. - * @member {string} [trigger.correlation.clientTrackingId] The client + * @property {object} [trigger.inputsLink.metadata] The metadata. + * @property {object} [trigger.outputs] Gets the outputs. + * @property {object} [trigger.outputsLink] Gets the link to outputs. + * @property {string} [trigger.outputsLink.uri] The content link URI. + * @property {string} [trigger.outputsLink.contentVersion] The content + * version. + * @property {number} [trigger.outputsLink.contentSize] The content size. + * @property {object} [trigger.outputsLink.contentHash] The content hash. + * @property {string} [trigger.outputsLink.contentHash.algorithm] The + * algorithm of the content hash. + * @property {string} [trigger.outputsLink.contentHash.value] The value of + * the content hash. + * @property {object} [trigger.outputsLink.metadata] The metadata. + * @property {date} [trigger.scheduledTime] Gets the scheduled time. + * @property {date} [trigger.startTime] Gets the start time. + * @property {date} [trigger.endTime] Gets the end time. + * @property {string} [trigger.trackingId] Gets the tracking id. + * @property {object} [trigger.correlation] The run correlation. + * @property {string} [trigger.correlation.clientTrackingId] The client * tracking id. - * @member {string} [trigger.code] Gets the code. - * @member {string} [trigger.status] Gets the status. Possible values + * @property {string} [trigger.code] Gets the code. + * @property {string} [trigger.status] Gets the status. Possible values * include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', * 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', * 'Aborted', 'Ignored' - * @member {object} [trigger.error] Gets the error. - * @member {object} [trigger.trackedProperties] Gets the tracked properties. - * @member {object} [outputs] Gets the outputs. - * @member {object} [response] Gets the response of the flow run. - * @member {string} [response.name] Gets the name. - * @member {object} [response.inputs] Gets the inputs. - * @member {object} [response.inputsLink] Gets the link to inputs. - * @member {string} [response.inputsLink.uri] The content link URI. - * @member {string} [response.inputsLink.contentVersion] The content version. - * @member {number} [response.inputsLink.contentSize] The content size. - * @member {object} [response.inputsLink.contentHash] The content hash. - * @member {string} [response.inputsLink.contentHash.algorithm] The algorithm - * of the content hash. - * @member {string} [response.inputsLink.contentHash.value] The value of the - * content hash. - * @member {object} [response.inputsLink.metadata] The metadata. - * @member {object} [response.outputs] Gets the outputs. - * @member {object} [response.outputsLink] Gets the link to outputs. - * @member {string} [response.outputsLink.uri] The content link URI. - * @member {string} [response.outputsLink.contentVersion] The content + * @property {object} [trigger.error] Gets the error. + * @property {object} [trigger.trackedProperties] Gets the tracked + * properties. + * @property {object} [outputs] Gets the outputs. + * @property {object} [response] Gets the response of the flow run. + * @property {string} [response.name] Gets the name. + * @property {object} [response.inputs] Gets the inputs. + * @property {object} [response.inputsLink] Gets the link to inputs. + * @property {string} [response.inputsLink.uri] The content link URI. + * @property {string} [response.inputsLink.contentVersion] The content * version. - * @member {number} [response.outputsLink.contentSize] The content size. - * @member {object} [response.outputsLink.contentHash] The content hash. - * @member {string} [response.outputsLink.contentHash.algorithm] The + * @property {number} [response.inputsLink.contentSize] The content size. + * @property {object} [response.inputsLink.contentHash] The content hash. + * @property {string} [response.inputsLink.contentHash.algorithm] The * algorithm of the content hash. - * @member {string} [response.outputsLink.contentHash.value] The value of the - * content hash. - * @member {object} [response.outputsLink.metadata] The metadata. - * @member {date} [response.scheduledTime] Gets the scheduled time. - * @member {date} [response.startTime] Gets the start time. - * @member {date} [response.endTime] Gets the end time. - * @member {string} [response.trackingId] Gets the tracking id. - * @member {object} [response.correlation] The run correlation. - * @member {string} [response.correlation.clientTrackingId] The client + * @property {string} [response.inputsLink.contentHash.value] The value of + * the content hash. + * @property {object} [response.inputsLink.metadata] The metadata. + * @property {object} [response.outputs] Gets the outputs. + * @property {object} [response.outputsLink] Gets the link to outputs. + * @property {string} [response.outputsLink.uri] The content link URI. + * @property {string} [response.outputsLink.contentVersion] The content + * version. + * @property {number} [response.outputsLink.contentSize] The content size. + * @property {object} [response.outputsLink.contentHash] The content hash. + * @property {string} [response.outputsLink.contentHash.algorithm] The + * algorithm of the content hash. + * @property {string} [response.outputsLink.contentHash.value] The value of + * the content hash. + * @property {object} [response.outputsLink.metadata] The metadata. + * @property {date} [response.scheduledTime] Gets the scheduled time. + * @property {date} [response.startTime] Gets the start time. + * @property {date} [response.endTime] Gets the end time. + * @property {string} [response.trackingId] Gets the tracking id. + * @property {object} [response.correlation] The run correlation. + * @property {string} [response.correlation.clientTrackingId] The client * tracking id. - * @member {string} [response.code] Gets the code. - * @member {string} [response.status] Gets the status. Possible values + * @property {string} [response.code] Gets the code. + * @property {string} [response.status] Gets the status. Possible values * include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', * 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', * 'Aborted', 'Ignored' - * @member {object} [response.error] Gets the error. - * @member {object} [response.trackedProperties] Gets the tracked properties. - * @member {string} [name] Gets the workflow run name. - * @member {string} [type] Gets the workflow run type. + * @property {object} [response.error] Gets the error. + * @property {object} [response.trackedProperties] Gets the tracked + * properties. + * @property {string} [name] Gets the workflow run name. + * @property {string} [type] Gets the workflow run type. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowRunAction.js b/lib/services/logicManagement/lib/models/workflowRunAction.js index 483d3429ac..aff7845bab 100644 --- a/lib/services/logicManagement/lib/models/workflowRunAction.js +++ b/lib/services/logicManagement/lib/models/workflowRunAction.js @@ -20,41 +20,41 @@ const models = require('./index'); class WorkflowRunAction extends models['SubResource'] { /** * Create a WorkflowRunAction. - * @member {date} [startTime] Gets the start time. - * @member {date} [endTime] Gets the end time. - * @member {string} [status] Gets the status. Possible values include: + * @property {date} [startTime] Gets the start time. + * @property {date} [endTime] Gets the end time. + * @property {string} [status] Gets the status. Possible values include: * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', * 'Ignored' - * @member {string} [code] Gets the code. - * @member {object} [error] Gets the error. - * @member {string} [trackingId] Gets the tracking id. - * @member {object} [correlation] The correlation properties. - * @member {string} [correlation.clientTrackingId] The client tracking id. - * @member {object} [inputsLink] Gets the link to inputs. - * @member {string} [inputsLink.uri] The content link URI. - * @member {string} [inputsLink.contentVersion] The content version. - * @member {number} [inputsLink.contentSize] The content size. - * @member {object} [inputsLink.contentHash] The content hash. - * @member {string} [inputsLink.contentHash.algorithm] The algorithm of the + * @property {string} [code] Gets the code. + * @property {object} [error] Gets the error. + * @property {string} [trackingId] Gets the tracking id. + * @property {object} [correlation] The correlation properties. + * @property {string} [correlation.clientTrackingId] The client tracking id. + * @property {object} [inputsLink] Gets the link to inputs. + * @property {string} [inputsLink.uri] The content link URI. + * @property {string} [inputsLink.contentVersion] The content version. + * @property {number} [inputsLink.contentSize] The content size. + * @property {object} [inputsLink.contentHash] The content hash. + * @property {string} [inputsLink.contentHash.algorithm] The algorithm of the * content hash. - * @member {string} [inputsLink.contentHash.value] The value of the content + * @property {string} [inputsLink.contentHash.value] The value of the content * hash. - * @member {object} [inputsLink.metadata] The metadata. - * @member {object} [outputsLink] Gets the link to outputs. - * @member {string} [outputsLink.uri] The content link URI. - * @member {string} [outputsLink.contentVersion] The content version. - * @member {number} [outputsLink.contentSize] The content size. - * @member {object} [outputsLink.contentHash] The content hash. - * @member {string} [outputsLink.contentHash.algorithm] The algorithm of the + * @property {object} [inputsLink.metadata] The metadata. + * @property {object} [outputsLink] Gets the link to outputs. + * @property {string} [outputsLink.uri] The content link URI. + * @property {string} [outputsLink.contentVersion] The content version. + * @property {number} [outputsLink.contentSize] The content size. + * @property {object} [outputsLink.contentHash] The content hash. + * @property {string} [outputsLink.contentHash.algorithm] The algorithm of + * the content hash. + * @property {string} [outputsLink.contentHash.value] The value of the * content hash. - * @member {string} [outputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [outputsLink.metadata] The metadata. - * @member {object} [trackedProperties] Gets the tracked properties. - * @member {array} [retryHistory] Gets the retry histories. - * @member {string} [name] Gets the workflow run action name. - * @member {string} [type] Gets the workflow run action type. + * @property {object} [outputsLink.metadata] The metadata. + * @property {object} [trackedProperties] Gets the tracked properties. + * @property {array} [retryHistory] Gets the retry histories. + * @property {string} [name] Gets the workflow run action name. + * @property {string} [type] Gets the workflow run action type. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowRunActionFilter.js b/lib/services/logicManagement/lib/models/workflowRunActionFilter.js index a0721a3c1f..fac7c399bd 100644 --- a/lib/services/logicManagement/lib/models/workflowRunActionFilter.js +++ b/lib/services/logicManagement/lib/models/workflowRunActionFilter.js @@ -17,7 +17,7 @@ class WorkflowRunActionFilter { /** * Create a WorkflowRunActionFilter. - * @member {string} [status] The status of workflow run action. Possible + * @property {string} [status] The status of workflow run action. Possible * values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', * 'TimedOut', 'Aborted', 'Ignored' diff --git a/lib/services/logicManagement/lib/models/workflowRunActionListResult.js b/lib/services/logicManagement/lib/models/workflowRunActionListResult.js index 17b81c3125..55463d61f3 100644 --- a/lib/services/logicManagement/lib/models/workflowRunActionListResult.js +++ b/lib/services/logicManagement/lib/models/workflowRunActionListResult.js @@ -16,7 +16,7 @@ class WorkflowRunActionListResult extends Array { /** * Create a WorkflowRunActionListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowRunActionRepetitionDefinition.js b/lib/services/logicManagement/lib/models/workflowRunActionRepetitionDefinition.js index 0eace5d6de..174c3a4fbc 100644 --- a/lib/services/logicManagement/lib/models/workflowRunActionRepetitionDefinition.js +++ b/lib/services/logicManagement/lib/models/workflowRunActionRepetitionDefinition.js @@ -20,45 +20,45 @@ const models = require('./index'); class WorkflowRunActionRepetitionDefinition extends models['Resource'] { /** * Create a WorkflowRunActionRepetitionDefinition. - * @member {date} [startTime] The start time of the workflow scope + * @property {date} [startTime] The start time of the workflow scope * repetition. - * @member {date} [endTime] The end time of the workflow scope repetition. - * @member {object} [correlation] The correlation properties. - * @member {string} [correlation.actionTrackingId] The action tracking + * @property {date} [endTime] The end time of the workflow scope repetition. + * @property {object} [correlation] The correlation properties. + * @property {string} [correlation.actionTrackingId] The action tracking * identifier. - * @member {string} [status] The status of the workflow scope repetition. + * @property {string} [status] The status of the workflow scope repetition. * Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', * 'TimedOut', 'Aborted', 'Ignored' - * @member {string} [code] The workflow scope repetition code. - * @member {object} [error] - * @member {string} [trackingId] Gets the tracking id. - * @member {object} [inputs] Gets the inputs. - * @member {object} [inputsLink] Gets the link to inputs. - * @member {string} [inputsLink.uri] The content link URI. - * @member {string} [inputsLink.contentVersion] The content version. - * @member {number} [inputsLink.contentSize] The content size. - * @member {object} [inputsLink.contentHash] The content hash. - * @member {string} [inputsLink.contentHash.algorithm] The algorithm of the + * @property {string} [code] The workflow scope repetition code. + * @property {object} [error] + * @property {string} [trackingId] Gets the tracking id. + * @property {object} [inputs] Gets the inputs. + * @property {object} [inputsLink] Gets the link to inputs. + * @property {string} [inputsLink.uri] The content link URI. + * @property {string} [inputsLink.contentVersion] The content version. + * @property {number} [inputsLink.contentSize] The content size. + * @property {object} [inputsLink.contentHash] The content hash. + * @property {string} [inputsLink.contentHash.algorithm] The algorithm of the * content hash. - * @member {string} [inputsLink.contentHash.value] The value of the content + * @property {string} [inputsLink.contentHash.value] The value of the content * hash. - * @member {object} [inputsLink.metadata] The metadata. - * @member {object} [outputs] Gets the outputs. - * @member {object} [outputsLink] Gets the link to outputs. - * @member {string} [outputsLink.uri] The content link URI. - * @member {string} [outputsLink.contentVersion] The content version. - * @member {number} [outputsLink.contentSize] The content size. - * @member {object} [outputsLink.contentHash] The content hash. - * @member {string} [outputsLink.contentHash.algorithm] The algorithm of the + * @property {object} [inputsLink.metadata] The metadata. + * @property {object} [outputs] Gets the outputs. + * @property {object} [outputsLink] Gets the link to outputs. + * @property {string} [outputsLink.uri] The content link URI. + * @property {string} [outputsLink.contentVersion] The content version. + * @property {number} [outputsLink.contentSize] The content size. + * @property {object} [outputsLink.contentHash] The content hash. + * @property {string} [outputsLink.contentHash.algorithm] The algorithm of + * the content hash. + * @property {string} [outputsLink.contentHash.value] The value of the * content hash. - * @member {string} [outputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [outputsLink.metadata] The metadata. - * @member {object} [trackedProperties] Gets the tracked properties. - * @member {array} [retryHistory] Gets the retry histories. - * @member {number} [iterationCount] - * @member {array} [repetitionIndexes] The repetition indexes. + * @property {object} [outputsLink.metadata] The metadata. + * @property {object} [trackedProperties] Gets the tracked properties. + * @property {array} [retryHistory] Gets the retry histories. + * @property {number} [iterationCount] + * @property {array} [repetitionIndexes] The repetition indexes. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowRunFilter.js b/lib/services/logicManagement/lib/models/workflowRunFilter.js index 30cd61554d..50febc112e 100644 --- a/lib/services/logicManagement/lib/models/workflowRunFilter.js +++ b/lib/services/logicManagement/lib/models/workflowRunFilter.js @@ -17,7 +17,7 @@ class WorkflowRunFilter { /** * Create a WorkflowRunFilter. - * @member {string} [status] The status of workflow run. Possible values + * @property {string} [status] The status of workflow run. Possible values * include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', * 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', * 'Aborted', 'Ignored' diff --git a/lib/services/logicManagement/lib/models/workflowRunListResult.js b/lib/services/logicManagement/lib/models/workflowRunListResult.js index 5a1952db9b..966155b9aa 100644 --- a/lib/services/logicManagement/lib/models/workflowRunListResult.js +++ b/lib/services/logicManagement/lib/models/workflowRunListResult.js @@ -16,7 +16,7 @@ class WorkflowRunListResult extends Array { /** * Create a WorkflowRunListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowRunTrigger.js b/lib/services/logicManagement/lib/models/workflowRunTrigger.js index d503a396f9..6be73d6598 100644 --- a/lib/services/logicManagement/lib/models/workflowRunTrigger.js +++ b/lib/services/logicManagement/lib/models/workflowRunTrigger.js @@ -17,42 +17,42 @@ class WorkflowRunTrigger { /** * Create a WorkflowRunTrigger. - * @member {string} [name] Gets the name. - * @member {object} [inputs] Gets the inputs. - * @member {object} [inputsLink] Gets the link to inputs. - * @member {string} [inputsLink.uri] The content link URI. - * @member {string} [inputsLink.contentVersion] The content version. - * @member {number} [inputsLink.contentSize] The content size. - * @member {object} [inputsLink.contentHash] The content hash. - * @member {string} [inputsLink.contentHash.algorithm] The algorithm of the + * @property {string} [name] Gets the name. + * @property {object} [inputs] Gets the inputs. + * @property {object} [inputsLink] Gets the link to inputs. + * @property {string} [inputsLink.uri] The content link URI. + * @property {string} [inputsLink.contentVersion] The content version. + * @property {number} [inputsLink.contentSize] The content size. + * @property {object} [inputsLink.contentHash] The content hash. + * @property {string} [inputsLink.contentHash.algorithm] The algorithm of the * content hash. - * @member {string} [inputsLink.contentHash.value] The value of the content + * @property {string} [inputsLink.contentHash.value] The value of the content * hash. - * @member {object} [inputsLink.metadata] The metadata. - * @member {object} [outputs] Gets the outputs. - * @member {object} [outputsLink] Gets the link to outputs. - * @member {string} [outputsLink.uri] The content link URI. - * @member {string} [outputsLink.contentVersion] The content version. - * @member {number} [outputsLink.contentSize] The content size. - * @member {object} [outputsLink.contentHash] The content hash. - * @member {string} [outputsLink.contentHash.algorithm] The algorithm of the + * @property {object} [inputsLink.metadata] The metadata. + * @property {object} [outputs] Gets the outputs. + * @property {object} [outputsLink] Gets the link to outputs. + * @property {string} [outputsLink.uri] The content link URI. + * @property {string} [outputsLink.contentVersion] The content version. + * @property {number} [outputsLink.contentSize] The content size. + * @property {object} [outputsLink.contentHash] The content hash. + * @property {string} [outputsLink.contentHash.algorithm] The algorithm of + * the content hash. + * @property {string} [outputsLink.contentHash.value] The value of the * content hash. - * @member {string} [outputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [outputsLink.metadata] The metadata. - * @member {date} [scheduledTime] Gets the scheduled time. - * @member {date} [startTime] Gets the start time. - * @member {date} [endTime] Gets the end time. - * @member {string} [trackingId] Gets the tracking id. - * @member {object} [correlation] The run correlation. - * @member {string} [correlation.clientTrackingId] The client tracking id. - * @member {string} [code] Gets the code. - * @member {string} [status] Gets the status. Possible values include: + * @property {object} [outputsLink.metadata] The metadata. + * @property {date} [scheduledTime] Gets the scheduled time. + * @property {date} [startTime] Gets the start time. + * @property {date} [endTime] Gets the end time. + * @property {string} [trackingId] Gets the tracking id. + * @property {object} [correlation] The run correlation. + * @property {string} [correlation.clientTrackingId] The client tracking id. + * @property {string} [code] Gets the code. + * @property {string} [status] Gets the status. Possible values include: * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', * 'Ignored' - * @member {object} [error] Gets the error. - * @member {object} [trackedProperties] Gets the tracked properties. + * @property {object} [error] Gets the error. + * @property {object} [trackedProperties] Gets the tracked properties. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/workflowTrigger.js b/lib/services/logicManagement/lib/models/workflowTrigger.js index 6b0c50e13a..5bc10d6f91 100644 --- a/lib/services/logicManagement/lib/models/workflowTrigger.js +++ b/lib/services/logicManagement/lib/models/workflowTrigger.js @@ -20,42 +20,42 @@ const models = require('./index'); class WorkflowTrigger extends models['SubResource'] { /** * Create a WorkflowTrigger. - * @member {string} [provisioningState] Gets the provisioning state. Possible - * values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', + * @property {string} [provisioningState] Gets the provisioning state. + * Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', * 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', * 'Succeeded', 'Moving', 'Updating', 'Registering', 'Registered', * 'Unregistering', 'Unregistered', 'Completed' - * @member {date} [createdTime] Gets the created time. - * @member {date} [changedTime] Gets the changed time. - * @member {string} [state] Gets the state. Possible values include: + * @property {date} [createdTime] Gets the created time. + * @property {date} [changedTime] Gets the changed time. + * @property {string} [state] Gets the state. Possible values include: * 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' - * @member {string} [status] Gets the status. Possible values include: + * @property {string} [status] Gets the status. Possible values include: * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', * 'Ignored' - * @member {date} [lastExecutionTime] Gets the last execution time. - * @member {date} [nextExecutionTime] Gets the next execution time. - * @member {object} [recurrence] Gets the workflow trigger recurrence. - * @member {string} [recurrence.frequency] The frequency. Possible values + * @property {date} [lastExecutionTime] Gets the last execution time. + * @property {date} [nextExecutionTime] Gets the next execution time. + * @property {object} [recurrence] Gets the workflow trigger recurrence. + * @property {string} [recurrence.frequency] The frequency. Possible values * include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', * 'Month', 'Year' - * @member {number} [recurrence.interval] The interval. - * @member {string} [recurrence.startTime] The start time. - * @member {string} [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 {string} [recurrence.startTime] The start time. + * @property {string} [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. - * @member {object} [workflow] Gets the reference to workflow. - * @member {string} [workflow.id] The resource id. - * @member {string} [workflow.name] Gets the resource name. - * @member {string} [workflow.type] Gets the resource type. - * @member {string} [name] Gets the workflow trigger name. - * @member {string} [type] Gets the workflow trigger type. + * @property {object} [workflow] Gets the reference to workflow. + * @property {string} [workflow.id] The resource id. + * @property {string} [workflow.name] Gets the resource name. + * @property {string} [workflow.type] Gets the resource type. + * @property {string} [name] Gets the workflow trigger name. + * @property {string} [type] Gets the workflow trigger type. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowTriggerCallbackUrl.js b/lib/services/logicManagement/lib/models/workflowTriggerCallbackUrl.js index c9f2caf618..92fa523902 100644 --- a/lib/services/logicManagement/lib/models/workflowTriggerCallbackUrl.js +++ b/lib/services/logicManagement/lib/models/workflowTriggerCallbackUrl.js @@ -17,22 +17,22 @@ class WorkflowTriggerCallbackUrl { /** * Create a WorkflowTriggerCallbackUrl. - * @member {string} [value] Gets the workflow trigger callback URL. - * @member {string} [method] Gets the workflow trigger callback URL HTTP + * @property {string} [value] Gets the workflow trigger callback URL. + * @property {string} [method] Gets the workflow trigger callback URL HTTP * method. - * @member {string} [basePath] Gets the workflow trigger callback URL base + * @property {string} [basePath] Gets the workflow trigger callback URL base * path. - * @member {string} [relativePath] Gets the workflow trigger callback URL + * @property {string} [relativePath] Gets the workflow trigger callback URL * relative path. - * @member {array} [relativePathParameters] Gets the workflow trigger + * @property {array} [relativePathParameters] Gets the workflow trigger * callback URL relative path parameters. - * @member {object} [queries] Gets the workflow trigger callback URL query + * @property {object} [queries] Gets the workflow trigger callback URL query * parameters. - * @member {string} [queries.apiVersion] The api version. - * @member {string} [queries.sp] The SAS permissions. - * @member {string} [queries.sv] The SAS version. - * @member {string} [queries.sig] The SAS signature. - * @member {string} [queries.se] The SAS timestamp. + * @property {string} [queries.apiVersion] The api version. + * @property {string} [queries.sp] The SAS permissions. + * @property {string} [queries.sv] The SAS version. + * @property {string} [queries.sig] The SAS signature. + * @property {string} [queries.se] The SAS timestamp. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/workflowTriggerFilter.js b/lib/services/logicManagement/lib/models/workflowTriggerFilter.js index 3ae76eaf4a..fc1fcc8b2e 100644 --- a/lib/services/logicManagement/lib/models/workflowTriggerFilter.js +++ b/lib/services/logicManagement/lib/models/workflowTriggerFilter.js @@ -17,7 +17,7 @@ class WorkflowTriggerFilter { /** * Create a WorkflowTriggerFilter. - * @member {string} [state] The state of workflow trigger. Possible values + * @property {string} [state] The state of workflow trigger. Possible values * include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', * 'Suspended' */ diff --git a/lib/services/logicManagement/lib/models/workflowTriggerHistory.js b/lib/services/logicManagement/lib/models/workflowTriggerHistory.js index 6beff6f94a..a5895b277d 100644 --- a/lib/services/logicManagement/lib/models/workflowTriggerHistory.js +++ b/lib/services/logicManagement/lib/models/workflowTriggerHistory.js @@ -20,45 +20,45 @@ const models = require('./index'); class WorkflowTriggerHistory extends models['SubResource'] { /** * Create a WorkflowTriggerHistory. - * @member {date} [startTime] Gets the start time. - * @member {date} [endTime] Gets the end time. - * @member {string} [status] Gets the status. Possible values include: + * @property {date} [startTime] Gets the start time. + * @property {date} [endTime] Gets the end time. + * @property {string} [status] Gets the status. Possible values include: * 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', * 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', * 'Ignored' - * @member {string} [code] Gets the code. - * @member {object} [error] Gets the error. - * @member {string} [trackingId] Gets the tracking id. - * @member {object} [correlation] The run correlation. - * @member {string} [correlation.clientTrackingId] The client tracking id. - * @member {object} [inputsLink] Gets the link to input parameters. - * @member {string} [inputsLink.uri] The content link URI. - * @member {string} [inputsLink.contentVersion] The content version. - * @member {number} [inputsLink.contentSize] The content size. - * @member {object} [inputsLink.contentHash] The content hash. - * @member {string} [inputsLink.contentHash.algorithm] The algorithm of the + * @property {string} [code] Gets the code. + * @property {object} [error] Gets the error. + * @property {string} [trackingId] Gets the tracking id. + * @property {object} [correlation] The run correlation. + * @property {string} [correlation.clientTrackingId] The client tracking id. + * @property {object} [inputsLink] Gets the link to input parameters. + * @property {string} [inputsLink.uri] The content link URI. + * @property {string} [inputsLink.contentVersion] The content version. + * @property {number} [inputsLink.contentSize] The content size. + * @property {object} [inputsLink.contentHash] The content hash. + * @property {string} [inputsLink.contentHash.algorithm] The algorithm of the * content hash. - * @member {string} [inputsLink.contentHash.value] The value of the content + * @property {string} [inputsLink.contentHash.value] The value of the content * hash. - * @member {object} [inputsLink.metadata] The metadata. - * @member {object} [outputsLink] Gets the link to output parameters. - * @member {string} [outputsLink.uri] The content link URI. - * @member {string} [outputsLink.contentVersion] The content version. - * @member {number} [outputsLink.contentSize] The content size. - * @member {object} [outputsLink.contentHash] The content hash. - * @member {string} [outputsLink.contentHash.algorithm] The algorithm of the + * @property {object} [inputsLink.metadata] The metadata. + * @property {object} [outputsLink] Gets the link to output parameters. + * @property {string} [outputsLink.uri] The content link URI. + * @property {string} [outputsLink.contentVersion] The content version. + * @property {number} [outputsLink.contentSize] The content size. + * @property {object} [outputsLink.contentHash] The content hash. + * @property {string} [outputsLink.contentHash.algorithm] The algorithm of + * the content hash. + * @property {string} [outputsLink.contentHash.value] The value of the * content hash. - * @member {string} [outputsLink.contentHash.value] The value of the content - * hash. - * @member {object} [outputsLink.metadata] The metadata. - * @member {boolean} [fired] Gets a value indicating whether trigger was + * @property {object} [outputsLink.metadata] The metadata. + * @property {boolean} [fired] Gets a value indicating whether trigger was * fired. - * @member {object} [run] Gets the reference to workflow run. - * @member {string} [run.id] The resource id. - * @member {string} [run.name] Gets the resource name. - * @member {string} [run.type] Gets the resource type. - * @member {string} [name] Gets the workflow trigger history name. - * @member {string} [type] Gets the workflow trigger history type. + * @property {object} [run] Gets the reference to workflow run. + * @property {string} [run.id] The resource id. + * @property {string} [run.name] Gets the resource name. + * @property {string} [run.type] Gets the resource type. + * @property {string} [name] Gets the workflow trigger history name. + * @property {string} [type] Gets the workflow trigger history type. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowTriggerHistoryFilter.js b/lib/services/logicManagement/lib/models/workflowTriggerHistoryFilter.js index cac03cf70d..ff8854d649 100644 --- a/lib/services/logicManagement/lib/models/workflowTriggerHistoryFilter.js +++ b/lib/services/logicManagement/lib/models/workflowTriggerHistoryFilter.js @@ -17,8 +17,8 @@ class WorkflowTriggerHistoryFilter { /** * Create a WorkflowTriggerHistoryFilter. - * @member {string} [status] The status of workflow trigger history. Possible - * values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', + * @property {string} [status] The status of workflow trigger history. + * Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', * 'TimedOut', 'Aborted', 'Ignored' */ diff --git a/lib/services/logicManagement/lib/models/workflowTriggerHistoryListResult.js b/lib/services/logicManagement/lib/models/workflowTriggerHistoryListResult.js index ecef7a5e89..61fce6bc9d 100644 --- a/lib/services/logicManagement/lib/models/workflowTriggerHistoryListResult.js +++ b/lib/services/logicManagement/lib/models/workflowTriggerHistoryListResult.js @@ -16,7 +16,7 @@ class WorkflowTriggerHistoryListResult extends Array { /** * Create a WorkflowTriggerHistoryListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowTriggerListCallbackUrlQueries.js b/lib/services/logicManagement/lib/models/workflowTriggerListCallbackUrlQueries.js index 2be51f4d69..0e73bbbcca 100644 --- a/lib/services/logicManagement/lib/models/workflowTriggerListCallbackUrlQueries.js +++ b/lib/services/logicManagement/lib/models/workflowTriggerListCallbackUrlQueries.js @@ -17,11 +17,11 @@ class WorkflowTriggerListCallbackUrlQueries { /** * Create a WorkflowTriggerListCallbackUrlQueries. - * @member {string} [apiVersion] The api version. - * @member {string} [sp] The SAS permissions. - * @member {string} [sv] The SAS version. - * @member {string} [sig] The SAS signature. - * @member {string} [se] The SAS timestamp. + * @property {string} [apiVersion] The api version. + * @property {string} [sp] The SAS permissions. + * @property {string} [sv] The SAS version. + * @property {string} [sig] The SAS signature. + * @property {string} [se] The SAS timestamp. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/workflowTriggerListResult.js b/lib/services/logicManagement/lib/models/workflowTriggerListResult.js index 8589def20d..060ff705a2 100644 --- a/lib/services/logicManagement/lib/models/workflowTriggerListResult.js +++ b/lib/services/logicManagement/lib/models/workflowTriggerListResult.js @@ -16,7 +16,7 @@ class WorkflowTriggerListResult extends Array { /** * Create a WorkflowTriggerListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowTriggerRecurrence.js b/lib/services/logicManagement/lib/models/workflowTriggerRecurrence.js index 449a8f8f71..ef892aafe2 100644 --- a/lib/services/logicManagement/lib/models/workflowTriggerRecurrence.js +++ b/lib/services/logicManagement/lib/models/workflowTriggerRecurrence.js @@ -17,18 +17,18 @@ class WorkflowTriggerRecurrence { /** * Create a WorkflowTriggerRecurrence. - * @member {string} [frequency] The frequency. Possible values include: + * @property {string} [frequency] The frequency. Possible values include: * 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year' - * @member {number} [interval] The interval. - * @member {string} [startTime] The start time. - * @member {string} [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 {string} [startTime] The start time. + * @property {string} [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/logicManagement/lib/models/workflowVersion.js b/lib/services/logicManagement/lib/models/workflowVersion.js index 5b120deb11..ee67e9c893 100644 --- a/lib/services/logicManagement/lib/models/workflowVersion.js +++ b/lib/services/logicManagement/lib/models/workflowVersion.js @@ -20,25 +20,25 @@ const models = require('./index'); class WorkflowVersion extends models['Resource'] { /** * Create a WorkflowVersion. - * @member {date} [createdTime] Gets the created time. - * @member {date} [changedTime] Gets the changed time. - * @member {string} [state] The state. Possible values include: + * @property {date} [createdTime] Gets the created time. + * @property {date} [changedTime] Gets the changed time. + * @property {string} [state] The state. Possible values include: * 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' - * @member {string} [version] Gets the version. - * @member {string} [accessEndpoint] Gets the access endpoint. - * @member {object} [sku] The sku. - * @member {string} [sku.name] The name. Possible values include: + * @property {string} [version] Gets the version. + * @property {string} [accessEndpoint] Gets the access endpoint. + * @property {object} [sku] The sku. + * @property {string} [sku.name] The name. Possible values include: * 'NotSpecified', 'Free', 'Shared', 'Basic', 'Standard', 'Premium' - * @member {object} [sku.plan] The reference to plan. - * @member {string} [sku.plan.id] The resource id. - * @member {string} [sku.plan.name] Gets the resource name. - * @member {string} [sku.plan.type] Gets the resource type. - * @member {object} [integrationAccount] The integration account. - * @member {string} [integrationAccount.id] The resource id. - * @member {string} [integrationAccount.name] Gets the resource name. - * @member {string} [integrationAccount.type] Gets the resource type. - * @member {object} [definition] The definition. - * @member {object} [parameters] The parameters. + * @property {object} [sku.plan] The reference to plan. + * @property {string} [sku.plan.id] The resource id. + * @property {string} [sku.plan.name] Gets the resource name. + * @property {string} [sku.plan.type] Gets the resource type. + * @property {object} [integrationAccount] The integration account. + * @property {string} [integrationAccount.id] The resource id. + * @property {string} [integrationAccount.name] Gets the resource name. + * @property {string} [integrationAccount.type] Gets the resource type. + * @property {object} [definition] The definition. + * @property {object} [parameters] The parameters. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/workflowVersionListResult.js b/lib/services/logicManagement/lib/models/workflowVersionListResult.js index 18915cb91f..c548b0efbd 100644 --- a/lib/services/logicManagement/lib/models/workflowVersionListResult.js +++ b/lib/services/logicManagement/lib/models/workflowVersionListResult.js @@ -16,7 +16,7 @@ class WorkflowVersionListResult extends Array { /** * Create a WorkflowVersionListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/logicManagement/lib/models/x12AcknowledgementSettings.js b/lib/services/logicManagement/lib/models/x12AcknowledgementSettings.js index 10b4cb5a73..227014be16 100644 --- a/lib/services/logicManagement/lib/models/x12AcknowledgementSettings.js +++ b/lib/services/logicManagement/lib/models/x12AcknowledgementSettings.js @@ -17,35 +17,35 @@ class X12AcknowledgementSettings { /** * Create a X12AcknowledgementSettings. - * @member {boolean} needTechnicalAcknowledgement The value indicating + * @property {boolean} needTechnicalAcknowledgement The value indicating * whether technical acknowledgement is needed. - * @member {boolean} batchTechnicalAcknowledgements The value indicating + * @property {boolean} batchTechnicalAcknowledgements The value indicating * whether to batch the technical acknowledgements. - * @member {boolean} needFunctionalAcknowledgement The value indicating + * @property {boolean} needFunctionalAcknowledgement The value indicating * whether functional acknowledgement is needed. - * @member {string} [functionalAcknowledgementVersion] The functional + * @property {string} [functionalAcknowledgementVersion] The functional * acknowledgement version. - * @member {boolean} batchFunctionalAcknowledgements The value indicating + * @property {boolean} batchFunctionalAcknowledgements The value indicating * whether to batch functional acknowledgements. - * @member {boolean} needImplementationAcknowledgement The value indicating + * @property {boolean} needImplementationAcknowledgement The value indicating * whether implementation acknowledgement is needed. - * @member {string} [implementationAcknowledgementVersion] The implementation - * acknowledgement version. - * @member {boolean} batchImplementationAcknowledgements The value indicating - * whether to batch implementation acknowledgements. - * @member {boolean} needLoopForValidMessages The value indicating whether a - * loop is needed for valid messages. - * @member {boolean} sendSynchronousAcknowledgement The value indicating + * @property {string} [implementationAcknowledgementVersion] The + * implementation acknowledgement version. + * @property {boolean} batchImplementationAcknowledgements The value + * indicating whether to batch implementation acknowledgements. + * @property {boolean} needLoopForValidMessages The value indicating whether + * a loop is needed for valid messages. + * @property {boolean} sendSynchronousAcknowledgement The value indicating * whether to send synchronous acknowledgement. - * @member {string} [acknowledgementControlNumberPrefix] The acknowledgement - * control number prefix. - * @member {string} [acknowledgementControlNumberSuffix] The acknowledgement - * control number suffix. - * @member {number} acknowledgementControlNumberLowerBound The + * @property {string} [acknowledgementControlNumberPrefix] The + * acknowledgement control number prefix. + * @property {string} [acknowledgementControlNumberSuffix] The + * acknowledgement control number suffix. + * @property {number} acknowledgementControlNumberLowerBound The * acknowledgement control number lower bound. - * @member {number} acknowledgementControlNumberUpperBound The + * @property {number} acknowledgementControlNumberUpperBound The * acknowledgement control number upper bound. - * @member {boolean} rolloverAcknowledgementControlNumber The value + * @property {boolean} rolloverAcknowledgementControlNumber The value * indicating whether to rollover acknowledgement control number. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/x12AgreementContent.js b/lib/services/logicManagement/lib/models/x12AgreementContent.js index 68ed4bb879..e85be6d7a9 100644 --- a/lib/services/logicManagement/lib/models/x12AgreementContent.js +++ b/lib/services/logicManagement/lib/models/x12AgreementContent.js @@ -17,515 +17,517 @@ class X12AgreementContent { /** * Create a X12AgreementContent. - * @member {object} receiveAgreement The X12 one-way receive agreement. - * @member {object} [receiveAgreement.senderBusinessIdentity] The sender + * @property {object} receiveAgreement The X12 one-way receive agreement. + * @property {object} [receiveAgreement.senderBusinessIdentity] The sender * business identity - * @member {string} [receiveAgreement.senderBusinessIdentity.qualifier] The + * @property {string} [receiveAgreement.senderBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.senderBusinessIdentity.value] The user - * defined business identity value. - * @member {object} [receiveAgreement.receiverBusinessIdentity] The receiver - * business identity - * @member {string} [receiveAgreement.receiverBusinessIdentity.qualifier] The - * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiveAgreement.receiverBusinessIdentity.value] The + * @property {string} [receiveAgreement.senderBusinessIdentity.value] The * user defined business identity value. - * @member {object} [receiveAgreement.protocolSettings] The X12 protocol + * @property {object} [receiveAgreement.receiverBusinessIdentity] The + * receiver business identity + * @property {string} [receiveAgreement.receiverBusinessIdentity.qualifier] + * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [receiveAgreement.receiverBusinessIdentity.value] The + * user defined business identity value. + * @property {object} [receiveAgreement.protocolSettings] The X12 protocol * settings. - * @member {object} [receiveAgreement.protocolSettings.validationSettings] + * @property {object} [receiveAgreement.protocolSettings.validationSettings] * The X12 validation settings. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [receiveAgreement.protocolSettings.framingSettings] The + * @property {object} [receiveAgreement.protocolSettings.framingSettings] The * X12 framing settings. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.framingSettings.componentSeparator] The * component separator. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] * The value indicating whether to replace separators in payload. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.framingSettings.replaceCharacter] The * replacement character. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.framingSettings.segmentTerminator] The * segment terminator. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.framingSettings.characterSet] The X12 * character set. Possible values include: 'NotSpecified', 'Basic', * 'Extended', 'UTF8' - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The segment terminator suffix. Possible values include: 'NotSpecified', * 'None', 'CR', 'LF', 'CRLF' - * @member {object} [receiveAgreement.protocolSettings.envelopeSettings] The - * X12 envelope settings. - * @member {number} + * @property {object} [receiveAgreement.protocolSettings.envelopeSettings] + * The X12 envelope settings. + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.controlStandardsId] * The controls standards id. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] * The value indicating whether to use control standards id as repetition * character. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.senderApplicationId] * The sender application id. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.receiverApplicationId] * The receiver application id. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.controlVersionNumber] * The control version number. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] The * functional group id. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] * The group header agency code. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] * The group header version. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] * The group header date format. Possible values include: 'NotSpecified', * 'CCYYMMDD', 'YYMMDD' - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] * The group header time format. Possible values include: 'NotSpecified', * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.envelopeSettings.usageIndicator] The * usage indicator. Possible values include: 'NotSpecified', 'Test', * 'Information', 'Production' - * @member {object} + * @property {object} * [receiveAgreement.protocolSettings.acknowledgementSettings] The X12 * acknowledgment settings. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] * The functional acknowledgement version. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] * The value indicating whether implementation acknowledgement is needed. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] * The implementation acknowledgement version. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} [receiveAgreement.protocolSettings.messageFilter] The X12 - * message filter. - * @member {string} + * @property {object} [receiveAgreement.protocolSettings.messageFilter] The + * X12 message filter. + * @property {string} * [receiveAgreement.protocolSettings.messageFilter.messageFilterType] The * message filter type. Possible values include: 'NotSpecified', 'Include', * 'Exclude' - * @member {object} [receiveAgreement.protocolSettings.securitySettings] The - * X12 security settings. - * @member {string} + * @property {object} [receiveAgreement.protocolSettings.securitySettings] + * The X12 security settings. + * @property {string} * [receiveAgreement.protocolSettings.securitySettings.authorizationQualifier] * The authorization qualifier. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.securitySettings.authorizationValue] * The authorization value. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.securitySettings.securityQualifier] The * security qualifier. - * @member {string} + * @property {string} * [receiveAgreement.protocolSettings.securitySettings.passwordValue] The * password value. - * @member {object} [receiveAgreement.protocolSettings.processingSettings] + * @property {object} [receiveAgreement.protocolSettings.processingSettings] * The X12 processing settings. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.convertImpliedDecimal] * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} [receiveAgreement.protocolSettings.envelopeOverrides] The - * X12 envelope override settings. - * @member {array} [receiveAgreement.protocolSettings.validationOverrides] + * @property {array} [receiveAgreement.protocolSettings.envelopeOverrides] + * The X12 envelope override settings. + * @property {array} [receiveAgreement.protocolSettings.validationOverrides] * The X12 validation override settings. - * @member {array} [receiveAgreement.protocolSettings.messageFilterList] The - * X12 message filter list. - * @member {array} [receiveAgreement.protocolSettings.schemaReferences] The + * @property {array} [receiveAgreement.protocolSettings.messageFilterList] + * The X12 message filter list. + * @property {array} [receiveAgreement.protocolSettings.schemaReferences] The * X12 schema references. - * @member {array} [receiveAgreement.protocolSettings.x12DelimiterOverrides] - * The X12 delimiter override settings. - * @member {object} sendAgreement The X12 one-way send agreement. - * @member {object} [sendAgreement.senderBusinessIdentity] The sender + * @property {array} + * [receiveAgreement.protocolSettings.x12DelimiterOverrides] The X12 + * delimiter override settings. + * @property {object} sendAgreement The X12 one-way send agreement. + * @property {object} [sendAgreement.senderBusinessIdentity] The sender * business identity - * @member {string} [sendAgreement.senderBusinessIdentity.qualifier] The + * @property {string} [sendAgreement.senderBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.senderBusinessIdentity.value] The user + * @property {string} [sendAgreement.senderBusinessIdentity.value] The user * defined business identity value. - * @member {object} [sendAgreement.receiverBusinessIdentity] The receiver + * @property {object} [sendAgreement.receiverBusinessIdentity] The receiver * business identity - * @member {string} [sendAgreement.receiverBusinessIdentity.qualifier] The + * @property {string} [sendAgreement.receiverBusinessIdentity.qualifier] The * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [sendAgreement.receiverBusinessIdentity.value] The user + * @property {string} [sendAgreement.receiverBusinessIdentity.value] The user * defined business identity value. - * @member {object} [sendAgreement.protocolSettings] The X12 protocol + * @property {object} [sendAgreement.protocolSettings] The X12 protocol * settings. - * @member {object} [sendAgreement.protocolSettings.validationSettings] The + * @property {object} [sendAgreement.protocolSettings.validationSettings] The * X12 validation settings. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.validateCharacterSet] * The value indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.validateEdiTypes] The * value indicating whether to Whether to validate EDI types. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.validateXsdTypes] The * value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * The trailing separator policy. Possible values include: 'NotSpecified', * 'NotAllowed', 'Optional', 'Mandatory' - * @member {object} [sendAgreement.protocolSettings.framingSettings] The X12 - * framing settings. - * @member {number} + * @property {object} [sendAgreement.protocolSettings.framingSettings] The + * X12 framing settings. + * @property {number} * [sendAgreement.protocolSettings.framingSettings.dataElementSeparator] The * data element separator. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.framingSettings.componentSeparator] The * component separator. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.framingSettings.replaceSeparatorsInPayload] * The value indicating whether to replace separators in payload. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.framingSettings.replaceCharacter] The * replacement character. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.framingSettings.segmentTerminator] The * segment terminator. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.framingSettings.characterSet] The X12 * character set. Possible values include: 'NotSpecified', 'Basic', * 'Extended', 'UTF8' - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * The segment terminator suffix. Possible values include: 'NotSpecified', * 'None', 'CR', 'LF', 'CRLF' - * @member {object} [sendAgreement.protocolSettings.envelopeSettings] The X12 - * envelope settings. - * @member {number} + * @property {object} [sendAgreement.protocolSettings.envelopeSettings] The + * X12 envelope settings. + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.controlStandardsId] The * controls standards id. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] * The value indicating whether to use control standards id as repetition * character. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.senderApplicationId] The * sender application id. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.receiverApplicationId] * The receiver application id. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.controlVersionNumber] The * control version number. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * The interchange control number lower bound. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * The interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * The value indicating whether to rollover interchange control number. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * The value indicating whether to enable default group headers. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] The * functional group id. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * The group control number lower bound. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * The group control number upper bound. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * The value indicating whether to rollover group control number. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupHeaderAgencyCode] * The group header agency code. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupHeaderVersion] The * group header version. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * The transaction set control number prefix. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * The transaction set control number suffix. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupHeaderDateFormat] * The group header date format. Possible values include: 'NotSpecified', * 'CCYYMMDD', 'YYMMDD' - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.groupHeaderTimeFormat] * The group header time format. Possible values include: 'NotSpecified', * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.envelopeSettings.usageIndicator] The usage * indicator. Possible values include: 'NotSpecified', 'Test', 'Information', * 'Production' - * @member {object} [sendAgreement.protocolSettings.acknowledgementSettings] - * The X12 acknowledgment settings. - * @member {boolean} + * @property {object} + * [sendAgreement.protocolSettings.acknowledgementSettings] The X12 + * acknowledgment settings. + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] * The functional acknowledgement version. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] * The value indicating whether implementation acknowledgement is needed. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] * The implementation acknowledgement version. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * The value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} [sendAgreement.protocolSettings.messageFilter] The X12 + * @property {object} [sendAgreement.protocolSettings.messageFilter] The X12 * message filter. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.messageFilter.messageFilterType] The * message filter type. Possible values include: 'NotSpecified', 'Include', * 'Exclude' - * @member {object} [sendAgreement.protocolSettings.securitySettings] The X12 - * security settings. - * @member {string} + * @property {object} [sendAgreement.protocolSettings.securitySettings] The + * X12 security settings. + * @property {string} * [sendAgreement.protocolSettings.securitySettings.authorizationQualifier] * The authorization qualifier. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.securitySettings.authorizationValue] The * authorization value. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.securitySettings.securityQualifier] The * security qualifier. - * @member {string} + * @property {string} * [sendAgreement.protocolSettings.securitySettings.passwordValue] The * password value. - * @member {object} [sendAgreement.protocolSettings.processingSettings] The + * @property {object} [sendAgreement.protocolSettings.processingSettings] The * X12 processing settings. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] The * value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.convertImpliedDecimal] * The value indicating whether to convert numerical type to implied decimal. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.preserveInterchange] * The value indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * The value indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * The value indicating whether to use dot as decimal separator. - * @member {array} [sendAgreement.protocolSettings.envelopeOverrides] The X12 - * envelope override settings. - * @member {array} [sendAgreement.protocolSettings.validationOverrides] The + * @property {array} [sendAgreement.protocolSettings.envelopeOverrides] The + * X12 envelope override settings. + * @property {array} [sendAgreement.protocolSettings.validationOverrides] The * X12 validation override settings. - * @member {array} [sendAgreement.protocolSettings.messageFilterList] The X12 - * message filter list. - * @member {array} [sendAgreement.protocolSettings.schemaReferences] The X12 - * schema references. - * @member {array} [sendAgreement.protocolSettings.x12DelimiterOverrides] The - * X12 delimiter override settings. + * @property {array} [sendAgreement.protocolSettings.messageFilterList] The + * X12 message filter list. + * @property {array} [sendAgreement.protocolSettings.schemaReferences] The + * X12 schema references. + * @property {array} [sendAgreement.protocolSettings.x12DelimiterOverrides] + * The X12 delimiter override settings. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/x12DelimiterOverrides.js b/lib/services/logicManagement/lib/models/x12DelimiterOverrides.js index 4543ec7a7d..3929b8fb54 100644 --- a/lib/services/logicManagement/lib/models/x12DelimiterOverrides.js +++ b/lib/services/logicManagement/lib/models/x12DelimiterOverrides.js @@ -17,17 +17,17 @@ class X12DelimiterOverrides { /** * Create a X12DelimiterOverrides. - * @member {string} [protocolVersion] The protocol version. - * @member {string} [messageId] The message id. - * @member {number} dataElementSeparator The data element separator. - * @member {number} componentSeparator The component separator. - * @member {number} segmentTerminator The segment terminator. - * @member {string} segmentTerminatorSuffix The segment terminator suffix. + * @property {string} [protocolVersion] The protocol version. + * @property {string} [messageId] The message id. + * @property {number} dataElementSeparator The data element separator. + * @property {number} componentSeparator The component separator. + * @property {number} segmentTerminator The segment terminator. + * @property {string} segmentTerminatorSuffix The segment terminator suffix. * Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' - * @member {number} replaceCharacter The replacement character. - * @member {boolean} replaceSeparatorsInPayload The value indicating whether - * to replace separators in payload. - * @member {string} [targetNamespace] The target namespace on which this + * @property {number} replaceCharacter The replacement character. + * @property {boolean} replaceSeparatorsInPayload The value indicating + * whether to replace separators in payload. + * @property {string} [targetNamespace] The target namespace on which this * delimiter settings has to be applied. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/x12EnvelopeOverride.js b/lib/services/logicManagement/lib/models/x12EnvelopeOverride.js index 09b8cbd432..1866af4467 100644 --- a/lib/services/logicManagement/lib/models/x12EnvelopeOverride.js +++ b/lib/services/logicManagement/lib/models/x12EnvelopeOverride.js @@ -17,21 +17,21 @@ class X12EnvelopeOverride { /** * Create a X12EnvelopeOverride. - * @member {string} targetNamespace The target namespace on which this + * @property {string} targetNamespace The target namespace on which this * envelope settings has to be applied. - * @member {string} protocolVersion The protocol version on which this + * @property {string} protocolVersion The protocol version on which this * envelope settings has to be applied. - * @member {string} messageId The message id on which this envelope settings - * has to be applied. - * @member {string} responsibleAgencyCode The responsible agency code. - * @member {string} headerVersion The header version. - * @member {string} senderApplicationId The sender application id. - * @member {string} receiverApplicationId The receiver application id. - * @member {string} [functionalIdentifierCode] The functional identifier + * @property {string} messageId The message id on which this envelope + * settings has to be applied. + * @property {string} responsibleAgencyCode The responsible agency code. + * @property {string} headerVersion The header version. + * @property {string} senderApplicationId The sender application id. + * @property {string} receiverApplicationId The receiver application id. + * @property {string} [functionalIdentifierCode] The functional identifier * code. - * @member {string} dateFormat The date format. Possible values include: + * @property {string} dateFormat The date format. Possible values include: * 'NotSpecified', 'CCYYMMDD', 'YYMMDD' - * @member {string} timeFormat The time format. Possible values include: + * @property {string} timeFormat The time format. Possible values include: * 'NotSpecified', 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/x12EnvelopeSettings.js b/lib/services/logicManagement/lib/models/x12EnvelopeSettings.js index 595daa586b..b43db46098 100644 --- a/lib/services/logicManagement/lib/models/x12EnvelopeSettings.js +++ b/lib/services/logicManagement/lib/models/x12EnvelopeSettings.js @@ -17,47 +17,47 @@ class X12EnvelopeSettings { /** * Create a X12EnvelopeSettings. - * @member {number} controlStandardsId The controls standards id. - * @member {boolean} useControlStandardsIdAsRepetitionCharacter The value + * @property {number} controlStandardsId The controls standards id. + * @property {boolean} useControlStandardsIdAsRepetitionCharacter The value * indicating whether to use control standards id as repetition character. - * @member {string} senderApplicationId The sender application id. - * @member {string} receiverApplicationId The receiver application id. - * @member {string} controlVersionNumber The control version number. - * @member {number} interchangeControlNumberLowerBound The interchange + * @property {string} senderApplicationId The sender application id. + * @property {string} receiverApplicationId The receiver application id. + * @property {string} controlVersionNumber The control version number. + * @property {number} interchangeControlNumberLowerBound The interchange * control number lower bound. - * @member {number} interchangeControlNumberUpperBound The interchange + * @property {number} interchangeControlNumberUpperBound The interchange * control number upper bound. - * @member {boolean} rolloverInterchangeControlNumber The value indicating + * @property {boolean} rolloverInterchangeControlNumber The value indicating * whether to rollover interchange control number. - * @member {boolean} enableDefaultGroupHeaders The value indicating whether + * @property {boolean} enableDefaultGroupHeaders The value indicating whether * to enable default group headers. - * @member {string} [functionalGroupId] The functional group id. - * @member {number} groupControlNumberLowerBound The group control number + * @property {string} [functionalGroupId] The functional group id. + * @property {number} groupControlNumberLowerBound The group control number * lower bound. - * @member {number} groupControlNumberUpperBound The group control number + * @property {number} groupControlNumberUpperBound The group control number * upper bound. - * @member {boolean} rolloverGroupControlNumber The value indicating whether - * to rollover group control number. - * @member {string} groupHeaderAgencyCode The group header agency code. - * @member {string} groupHeaderVersion The group header version. - * @member {number} transactionSetControlNumberLowerBound The transaction set - * control number lower bound. - * @member {number} transactionSetControlNumberUpperBound The transaction set - * control number upper bound. - * @member {boolean} rolloverTransactionSetControlNumber The value indicating - * whether to rollover transaction set control number. - * @member {string} [transactionSetControlNumberPrefix] The transaction set + * @property {boolean} rolloverGroupControlNumber The value indicating + * whether to rollover group control number. + * @property {string} groupHeaderAgencyCode The group header agency code. + * @property {string} groupHeaderVersion The group header version. + * @property {number} transactionSetControlNumberLowerBound The transaction + * set control number lower bound. + * @property {number} transactionSetControlNumberUpperBound The transaction + * set control number upper bound. + * @property {boolean} rolloverTransactionSetControlNumber The value + * indicating whether to rollover transaction set control number. + * @property {string} [transactionSetControlNumberPrefix] The transaction set * control number prefix. - * @member {string} [transactionSetControlNumberSuffix] The transaction set + * @property {string} [transactionSetControlNumberSuffix] The transaction set * control number suffix. - * @member {boolean} overwriteExistingTransactionSetControlNumber The value + * @property {boolean} overwriteExistingTransactionSetControlNumber The value * indicating whether to overwrite existing transaction set control number. - * @member {string} groupHeaderDateFormat The group header date format. + * @property {string} groupHeaderDateFormat The group header date format. * Possible values include: 'NotSpecified', 'CCYYMMDD', 'YYMMDD' - * @member {string} groupHeaderTimeFormat The group header time format. + * @property {string} groupHeaderTimeFormat The group header time format. * Possible values include: 'NotSpecified', 'HHMM', 'HHMMSS', 'HHMMSSdd', * 'HHMMSSd' - * @member {string} usageIndicator The usage indicator. Possible values + * @property {string} usageIndicator The usage indicator. Possible values * include: 'NotSpecified', 'Test', 'Information', 'Production' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/x12FramingSettings.js b/lib/services/logicManagement/lib/models/x12FramingSettings.js index ad1e7689ae..1022ac7e08 100644 --- a/lib/services/logicManagement/lib/models/x12FramingSettings.js +++ b/lib/services/logicManagement/lib/models/x12FramingSettings.js @@ -17,15 +17,15 @@ class X12FramingSettings { /** * Create a X12FramingSettings. - * @member {number} dataElementSeparator The data element separator. - * @member {number} componentSeparator The component separator. - * @member {boolean} replaceSeparatorsInPayload The value indicating whether - * to replace separators in payload. - * @member {number} replaceCharacter The replacement character. - * @member {number} segmentTerminator The segment terminator. - * @member {string} characterSet The X12 character set. Possible values + * @property {number} dataElementSeparator The data element separator. + * @property {number} componentSeparator The component separator. + * @property {boolean} replaceSeparatorsInPayload The value indicating + * whether to replace separators in payload. + * @property {number} replaceCharacter The replacement character. + * @property {number} segmentTerminator The segment terminator. + * @property {string} characterSet The X12 character set. Possible values * include: 'NotSpecified', 'Basic', 'Extended', 'UTF8' - * @member {string} segmentTerminatorSuffix The segment terminator suffix. + * @property {string} segmentTerminatorSuffix The segment terminator suffix. * Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/x12MessageFilter.js b/lib/services/logicManagement/lib/models/x12MessageFilter.js index 5c9ab0df48..231813bf4f 100644 --- a/lib/services/logicManagement/lib/models/x12MessageFilter.js +++ b/lib/services/logicManagement/lib/models/x12MessageFilter.js @@ -17,7 +17,7 @@ class X12MessageFilter { /** * Create a X12MessageFilter. - * @member {string} messageFilterType The message filter type. Possible + * @property {string} messageFilterType The message filter type. Possible * values include: 'NotSpecified', 'Include', 'Exclude' */ constructor() { diff --git a/lib/services/logicManagement/lib/models/x12MessageIdentifier.js b/lib/services/logicManagement/lib/models/x12MessageIdentifier.js index b61240daf6..5dacf779b0 100644 --- a/lib/services/logicManagement/lib/models/x12MessageIdentifier.js +++ b/lib/services/logicManagement/lib/models/x12MessageIdentifier.js @@ -17,7 +17,7 @@ class X12MessageIdentifier { /** * Create a X12MessageIdentifier. - * @member {string} messageId The message id. + * @property {string} messageId The message id. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/x12OneWayAgreement.js b/lib/services/logicManagement/lib/models/x12OneWayAgreement.js index a0be05cfb8..068573c6f2 100644 --- a/lib/services/logicManagement/lib/models/x12OneWayAgreement.js +++ b/lib/services/logicManagement/lib/models/x12OneWayAgreement.js @@ -17,233 +17,238 @@ class X12OneWayAgreement { /** * Create a X12OneWayAgreement. - * @member {object} senderBusinessIdentity The sender business identity - * @member {string} [senderBusinessIdentity.qualifier] The business identity - * qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [senderBusinessIdentity.value] The user defined business - * identity value. - * @member {object} receiverBusinessIdentity The receiver business identity - * @member {string} [receiverBusinessIdentity.qualifier] The business + * @property {object} senderBusinessIdentity The sender business identity + * @property {string} [senderBusinessIdentity.qualifier] The business * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 - * @member {string} [receiverBusinessIdentity.value] The user defined + * @property {string} [senderBusinessIdentity.value] The user defined * business identity value. - * @member {object} protocolSettings The X12 protocol settings. - * @member {object} [protocolSettings.validationSettings] The X12 validation - * settings. - * @member {boolean} + * @property {object} receiverBusinessIdentity The receiver business identity + * @property {string} [receiverBusinessIdentity.qualifier] The business + * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 + * @property {string} [receiverBusinessIdentity.value] The user defined + * business identity value. + * @property {object} protocolSettings The X12 protocol settings. + * @property {object} [protocolSettings.validationSettings] The X12 + * validation settings. + * @property {boolean} * [protocolSettings.validationSettings.validateCharacterSet] The value * indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * The value indicating whether to check for duplicate interchange control * number. - * @member {number} + * @property {number} * [protocolSettings.validationSettings.interchangeControlNumberValidityDays] * The validity period of interchange control number. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.checkDuplicateGroupControlNumber] The * value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * The value indicating whether to check for duplicate transaction set * control number. - * @member {boolean} [protocolSettings.validationSettings.validateEdiTypes] + * @property {boolean} [protocolSettings.validationSettings.validateEdiTypes] * The value indicating whether to Whether to validate EDI types. - * @member {boolean} [protocolSettings.validationSettings.validateXsdTypes] + * @property {boolean} [protocolSettings.validationSettings.validateXsdTypes] * The value indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to allow leading and trailing spaces and * zeroes. - * @member {boolean} + * @property {boolean} * [protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * The value indicating whether to trim leading and trailing spaces and * zeroes. - * @member {string} + * @property {string} * [protocolSettings.validationSettings.trailingSeparatorPolicy] The trailing * separator policy. Possible values include: 'NotSpecified', 'NotAllowed', * 'Optional', 'Mandatory' - * @member {object} [protocolSettings.framingSettings] The X12 framing + * @property {object} [protocolSettings.framingSettings] The X12 framing * settings. - * @member {number} [protocolSettings.framingSettings.dataElementSeparator] + * @property {number} [protocolSettings.framingSettings.dataElementSeparator] * The data element separator. - * @member {number} [protocolSettings.framingSettings.componentSeparator] The - * component separator. - * @member {boolean} + * @property {number} [protocolSettings.framingSettings.componentSeparator] + * The component separator. + * @property {boolean} * [protocolSettings.framingSettings.replaceSeparatorsInPayload] The value * indicating whether to replace separators in payload. - * @member {number} [protocolSettings.framingSettings.replaceCharacter] The + * @property {number} [protocolSettings.framingSettings.replaceCharacter] The * replacement character. - * @member {number} [protocolSettings.framingSettings.segmentTerminator] The - * segment terminator. - * @member {string} [protocolSettings.framingSettings.characterSet] The X12 + * @property {number} [protocolSettings.framingSettings.segmentTerminator] + * The segment terminator. + * @property {string} [protocolSettings.framingSettings.characterSet] The X12 * character set. Possible values include: 'NotSpecified', 'Basic', * 'Extended', 'UTF8' - * @member {string} + * @property {string} * [protocolSettings.framingSettings.segmentTerminatorSuffix] The segment * terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', * 'LF', 'CRLF' - * @member {object} [protocolSettings.envelopeSettings] The X12 envelope + * @property {object} [protocolSettings.envelopeSettings] The X12 envelope * settings. - * @member {number} [protocolSettings.envelopeSettings.controlStandardsId] + * @property {number} [protocolSettings.envelopeSettings.controlStandardsId] * The controls standards id. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.useControlStandardsIdAsRepetitionCharacter] * The value indicating whether to use control standards id as repetition * character. - * @member {string} [protocolSettings.envelopeSettings.senderApplicationId] + * @property {string} [protocolSettings.envelopeSettings.senderApplicationId] * The sender application id. - * @member {string} [protocolSettings.envelopeSettings.receiverApplicationId] - * The receiver application id. - * @member {string} [protocolSettings.envelopeSettings.controlVersionNumber] - * The control version number. - * @member {number} + * @property {string} + * [protocolSettings.envelopeSettings.receiverApplicationId] The receiver + * application id. + * @property {string} + * [protocolSettings.envelopeSettings.controlVersionNumber] The control + * version number. + * @property {number} * [protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] The * interchange control number lower bound. - * @member {number} + * @property {number} * [protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] The * interchange control number upper bound. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] The * value indicating whether to rollover interchange control number. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.enableDefaultGroupHeaders] The value * indicating whether to enable default group headers. - * @member {string} [protocolSettings.envelopeSettings.functionalGroupId] The - * functional group id. - * @member {number} + * @property {string} [protocolSettings.envelopeSettings.functionalGroupId] + * The functional group id. + * @property {number} * [protocolSettings.envelopeSettings.groupControlNumberLowerBound] The group * control number lower bound. - * @member {number} + * @property {number} * [protocolSettings.envelopeSettings.groupControlNumberUpperBound] The group * control number upper bound. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.rolloverGroupControlNumber] The value * indicating whether to rollover group control number. - * @member {string} [protocolSettings.envelopeSettings.groupHeaderAgencyCode] - * The group header agency code. - * @member {string} [protocolSettings.envelopeSettings.groupHeaderVersion] + * @property {string} + * [protocolSettings.envelopeSettings.groupHeaderAgencyCode] The group header + * agency code. + * @property {string} [protocolSettings.envelopeSettings.groupHeaderVersion] * The group header version. - * @member {number} + * @property {number} * [protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * The transaction set control number lower bound. - * @member {number} + * @property {number} * [protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * The transaction set control number upper bound. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] The * transaction set control number prefix. - * @member {string} + * @property {string} * [protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] The * transaction set control number suffix. - * @member {boolean} + * @property {boolean} * [protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * The value indicating whether to overwrite existing transaction set control * number. - * @member {string} [protocolSettings.envelopeSettings.groupHeaderDateFormat] - * The group header date format. Possible values include: 'NotSpecified', - * 'CCYYMMDD', 'YYMMDD' - * @member {string} [protocolSettings.envelopeSettings.groupHeaderTimeFormat] - * The group header time format. Possible values include: 'NotSpecified', - * 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' - * @member {string} [protocolSettings.envelopeSettings.usageIndicator] The + * @property {string} + * [protocolSettings.envelopeSettings.groupHeaderDateFormat] The group header + * date format. Possible values include: 'NotSpecified', 'CCYYMMDD', 'YYMMDD' + * @property {string} + * [protocolSettings.envelopeSettings.groupHeaderTimeFormat] The group header + * time format. Possible values include: 'NotSpecified', 'HHMM', 'HHMMSS', + * 'HHMMSSdd', 'HHMMSSd' + * @property {string} [protocolSettings.envelopeSettings.usageIndicator] The * usage indicator. Possible values include: 'NotSpecified', 'Test', * 'Information', 'Production' - * @member {object} [protocolSettings.acknowledgementSettings] The X12 + * @property {object} [protocolSettings.acknowledgementSettings] The X12 * acknowledgment settings. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * The value indicating whether functional acknowledgement is needed. - * @member {string} + * @property {string} * [protocolSettings.acknowledgementSettings.functionalAcknowledgementVersion] * The functional acknowledgement version. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * The value indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.needImplementationAcknowledgement] * The value indicating whether implementation acknowledgement is needed. - * @member {string} + * @property {string} * [protocolSettings.acknowledgementSettings.implementationAcknowledgementVersion] * The implementation acknowledgement version. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.batchImplementationAcknowledgements] * The value indicating whether to batch implementation acknowledgements. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.needLoopForValidMessages] The * value indicating whether a loop is needed for valid messages. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {string} * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * The acknowledgement control number prefix. - * @member {string} + * @property {string} * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * The acknowledgement control number suffix. - * @member {number} + * @property {number} * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * The acknowledgement control number lower bound. - * @member {number} + * @property {number} * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * The acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * The value indicating whether to rollover acknowledgement control number. - * @member {object} [protocolSettings.messageFilter] The X12 message filter. - * @member {string} [protocolSettings.messageFilter.messageFilterType] The + * @property {object} [protocolSettings.messageFilter] The X12 message + * filter. + * @property {string} [protocolSettings.messageFilter.messageFilterType] The * message filter type. Possible values include: 'NotSpecified', 'Include', * 'Exclude' - * @member {object} [protocolSettings.securitySettings] The X12 security + * @property {object} [protocolSettings.securitySettings] The X12 security * settings. - * @member {string} + * @property {string} * [protocolSettings.securitySettings.authorizationQualifier] The * authorization qualifier. - * @member {string} [protocolSettings.securitySettings.authorizationValue] + * @property {string} [protocolSettings.securitySettings.authorizationValue] * The authorization value. - * @member {string} [protocolSettings.securitySettings.securityQualifier] The - * security qualifier. - * @member {string} [protocolSettings.securitySettings.passwordValue] The + * @property {string} [protocolSettings.securitySettings.securityQualifier] + * The security qualifier. + * @property {string} [protocolSettings.securitySettings.passwordValue] The * password value. - * @member {object} [protocolSettings.processingSettings] The X12 processing - * settings. - * @member {boolean} [protocolSettings.processingSettings.maskSecurityInfo] + * @property {object} [protocolSettings.processingSettings] The X12 + * processing settings. + * @property {boolean} [protocolSettings.processingSettings.maskSecurityInfo] * The value indicating whether to mask security information. - * @member {boolean} + * @property {boolean} * [protocolSettings.processingSettings.convertImpliedDecimal] The value * indicating whether to convert numerical type to implied decimal. - * @member {boolean} + * @property {boolean} * [protocolSettings.processingSettings.preserveInterchange] The value * indicating whether to preserve interchange. - * @member {boolean} + * @property {boolean} * [protocolSettings.processingSettings.suspendInterchangeOnError] The value * indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} * [protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * The value indicating whether to create empty xml tags for trailing * separators. - * @member {boolean} + * @property {boolean} * [protocolSettings.processingSettings.useDotAsDecimalSeparator] The value * indicating whether to use dot as decimal separator. - * @member {array} [protocolSettings.envelopeOverrides] The X12 envelope - * override settings. - * @member {array} [protocolSettings.validationOverrides] The X12 validation + * @property {array} [protocolSettings.envelopeOverrides] The X12 envelope * override settings. - * @member {array} [protocolSettings.messageFilterList] The X12 message + * @property {array} [protocolSettings.validationOverrides] The X12 + * validation override settings. + * @property {array} [protocolSettings.messageFilterList] The X12 message * filter list. - * @member {array} [protocolSettings.schemaReferences] The X12 schema + * @property {array} [protocolSettings.schemaReferences] The X12 schema * references. - * @member {array} [protocolSettings.x12DelimiterOverrides] The X12 delimiter - * override settings. + * @property {array} [protocolSettings.x12DelimiterOverrides] The X12 + * delimiter override settings. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/x12ProcessingSettings.js b/lib/services/logicManagement/lib/models/x12ProcessingSettings.js index 8c4b56d413..a39f2618fc 100644 --- a/lib/services/logicManagement/lib/models/x12ProcessingSettings.js +++ b/lib/services/logicManagement/lib/models/x12ProcessingSettings.js @@ -17,18 +17,18 @@ class X12ProcessingSettings { /** * Create a X12ProcessingSettings. - * @member {boolean} maskSecurityInfo The value indicating whether to mask + * @property {boolean} maskSecurityInfo The value indicating whether to mask * security information. - * @member {boolean} convertImpliedDecimal The value indicating whether to + * @property {boolean} convertImpliedDecimal The value indicating whether to * convert numerical type to implied decimal. - * @member {boolean} preserveInterchange The value indicating whether to + * @property {boolean} preserveInterchange The value indicating whether to * preserve interchange. - * @member {boolean} suspendInterchangeOnError The value indicating whether + * @property {boolean} suspendInterchangeOnError The value indicating whether * to suspend interchange on error. - * @member {boolean} createEmptyXmlTagsForTrailingSeparators The value + * @property {boolean} createEmptyXmlTagsForTrailingSeparators The value * indicating whether to create empty xml tags for trailing separators. - * @member {boolean} useDotAsDecimalSeparator The value indicating whether to - * use dot as decimal separator. + * @property {boolean} useDotAsDecimalSeparator The value indicating whether + * to use dot as decimal separator. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/x12ProtocolSettings.js b/lib/services/logicManagement/lib/models/x12ProtocolSettings.js index 3c4ea4e43e..2c180f5c2b 100644 --- a/lib/services/logicManagement/lib/models/x12ProtocolSettings.js +++ b/lib/services/logicManagement/lib/models/x12ProtocolSettings.js @@ -17,173 +17,181 @@ class X12ProtocolSettings { /** * Create a X12ProtocolSettings. - * @member {object} validationSettings The X12 validation settings. - * @member {boolean} [validationSettings.validateCharacterSet] The value + * @property {object} validationSettings The X12 validation settings. + * @property {boolean} [validationSettings.validateCharacterSet] The value * indicating whether to validate character set in the message. - * @member {boolean} + * @property {boolean} * [validationSettings.checkDuplicateInterchangeControlNumber] The value * indicating whether to check for duplicate interchange control number. - * @member {number} [validationSettings.interchangeControlNumberValidityDays] - * The validity period of interchange control number. - * @member {boolean} [validationSettings.checkDuplicateGroupControlNumber] + * @property {number} + * [validationSettings.interchangeControlNumberValidityDays] The validity + * period of interchange control number. + * @property {boolean} [validationSettings.checkDuplicateGroupControlNumber] * The value indicating whether to check for duplicate group control number. - * @member {boolean} + * @property {boolean} * [validationSettings.checkDuplicateTransactionSetControlNumber] The value * indicating whether to check for duplicate transaction set control number. - * @member {boolean} [validationSettings.validateEdiTypes] The value + * @property {boolean} [validationSettings.validateEdiTypes] The value * indicating whether to Whether to validate EDI types. - * @member {boolean} [validationSettings.validateXsdTypes] The value + * @property {boolean} [validationSettings.validateXsdTypes] The value * indicating whether to Whether to validate XSD types. - * @member {boolean} + * @property {boolean} * [validationSettings.allowLeadingAndTrailingSpacesAndZeroes] The value * indicating whether to allow leading and trailing spaces and zeroes. - * @member {boolean} + * @property {boolean} * [validationSettings.trimLeadingAndTrailingSpacesAndZeroes] The value * indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} [validationSettings.trailingSeparatorPolicy] The trailing - * separator policy. Possible values include: 'NotSpecified', 'NotAllowed', - * 'Optional', 'Mandatory' - * @member {object} framingSettings The X12 framing settings. - * @member {number} [framingSettings.dataElementSeparator] The data element + * @property {string} [validationSettings.trailingSeparatorPolicy] The + * trailing separator policy. Possible values include: 'NotSpecified', + * 'NotAllowed', 'Optional', 'Mandatory' + * @property {object} framingSettings The X12 framing settings. + * @property {number} [framingSettings.dataElementSeparator] The data element * separator. - * @member {number} [framingSettings.componentSeparator] The component + * @property {number} [framingSettings.componentSeparator] The component * separator. - * @member {boolean} [framingSettings.replaceSeparatorsInPayload] The value + * @property {boolean} [framingSettings.replaceSeparatorsInPayload] The value * indicating whether to replace separators in payload. - * @member {number} [framingSettings.replaceCharacter] The replacement + * @property {number} [framingSettings.replaceCharacter] The replacement * character. - * @member {number} [framingSettings.segmentTerminator] The segment + * @property {number} [framingSettings.segmentTerminator] The segment * terminator. - * @member {string} [framingSettings.characterSet] The X12 character set. + * @property {string} [framingSettings.characterSet] The X12 character set. * Possible values include: 'NotSpecified', 'Basic', 'Extended', 'UTF8' - * @member {string} [framingSettings.segmentTerminatorSuffix] The segment + * @property {string} [framingSettings.segmentTerminatorSuffix] The segment * terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', * 'LF', 'CRLF' - * @member {object} envelopeSettings The X12 envelope settings. - * @member {number} [envelopeSettings.controlStandardsId] The controls + * @property {object} envelopeSettings The X12 envelope settings. + * @property {number} [envelopeSettings.controlStandardsId] The controls * standards id. - * @member {boolean} + * @property {boolean} * [envelopeSettings.useControlStandardsIdAsRepetitionCharacter] The value * indicating whether to use control standards id as repetition character. - * @member {string} [envelopeSettings.senderApplicationId] The sender + * @property {string} [envelopeSettings.senderApplicationId] The sender * application id. - * @member {string} [envelopeSettings.receiverApplicationId] The receiver + * @property {string} [envelopeSettings.receiverApplicationId] The receiver * application id. - * @member {string} [envelopeSettings.controlVersionNumber] The control + * @property {string} [envelopeSettings.controlVersionNumber] The control * version number. - * @member {number} [envelopeSettings.interchangeControlNumberLowerBound] The - * interchange control number lower bound. - * @member {number} [envelopeSettings.interchangeControlNumberUpperBound] The - * interchange control number upper bound. - * @member {boolean} [envelopeSettings.rolloverInterchangeControlNumber] The - * value indicating whether to rollover interchange control number. - * @member {boolean} [envelopeSettings.enableDefaultGroupHeaders] The value + * @property {number} [envelopeSettings.interchangeControlNumberLowerBound] + * The interchange control number lower bound. + * @property {number} [envelopeSettings.interchangeControlNumberUpperBound] + * The interchange control number upper bound. + * @property {boolean} [envelopeSettings.rolloverInterchangeControlNumber] + * The value indicating whether to rollover interchange control number. + * @property {boolean} [envelopeSettings.enableDefaultGroupHeaders] The value * indicating whether to enable default group headers. - * @member {string} [envelopeSettings.functionalGroupId] The functional group - * id. - * @member {number} [envelopeSettings.groupControlNumberLowerBound] The group - * control number lower bound. - * @member {number} [envelopeSettings.groupControlNumberUpperBound] The group - * control number upper bound. - * @member {boolean} [envelopeSettings.rolloverGroupControlNumber] The value - * indicating whether to rollover group control number. - * @member {string} [envelopeSettings.groupHeaderAgencyCode] The group header - * agency code. - * @member {string} [envelopeSettings.groupHeaderVersion] The group header + * @property {string} [envelopeSettings.functionalGroupId] The functional + * group id. + * @property {number} [envelopeSettings.groupControlNumberLowerBound] The + * group control number lower bound. + * @property {number} [envelopeSettings.groupControlNumberUpperBound] The + * group control number upper bound. + * @property {boolean} [envelopeSettings.rolloverGroupControlNumber] The + * value indicating whether to rollover group control number. + * @property {string} [envelopeSettings.groupHeaderAgencyCode] The group + * header agency code. + * @property {string} [envelopeSettings.groupHeaderVersion] The group header * version. - * @member {number} [envelopeSettings.transactionSetControlNumberLowerBound] - * The transaction set control number lower bound. - * @member {number} [envelopeSettings.transactionSetControlNumberUpperBound] - * The transaction set control number upper bound. - * @member {boolean} [envelopeSettings.rolloverTransactionSetControlNumber] + * @property {number} + * [envelopeSettings.transactionSetControlNumberLowerBound] The transaction + * set control number lower bound. + * @property {number} + * [envelopeSettings.transactionSetControlNumberUpperBound] The transaction + * set control number upper bound. + * @property {boolean} [envelopeSettings.rolloverTransactionSetControlNumber] * The value indicating whether to rollover transaction set control number. - * @member {string} [envelopeSettings.transactionSetControlNumberPrefix] The - * transaction set control number prefix. - * @member {string} [envelopeSettings.transactionSetControlNumberSuffix] The - * transaction set control number suffix. - * @member {boolean} + * @property {string} [envelopeSettings.transactionSetControlNumberPrefix] + * The transaction set control number prefix. + * @property {string} [envelopeSettings.transactionSetControlNumberSuffix] + * The transaction set control number suffix. + * @property {boolean} * [envelopeSettings.overwriteExistingTransactionSetControlNumber] The value * indicating whether to overwrite existing transaction set control number. - * @member {string} [envelopeSettings.groupHeaderDateFormat] The group header - * date format. Possible values include: 'NotSpecified', 'CCYYMMDD', 'YYMMDD' - * @member {string} [envelopeSettings.groupHeaderTimeFormat] The group header - * time format. Possible values include: 'NotSpecified', 'HHMM', 'HHMMSS', - * 'HHMMSSdd', 'HHMMSSd' - * @member {string} [envelopeSettings.usageIndicator] The usage indicator. + * @property {string} [envelopeSettings.groupHeaderDateFormat] The group + * header date format. Possible values include: 'NotSpecified', 'CCYYMMDD', + * 'YYMMDD' + * @property {string} [envelopeSettings.groupHeaderTimeFormat] The group + * header time format. Possible values include: 'NotSpecified', 'HHMM', + * 'HHMMSS', 'HHMMSSdd', 'HHMMSSd' + * @property {string} [envelopeSettings.usageIndicator] The usage indicator. * Possible values include: 'NotSpecified', 'Test', 'Information', * 'Production' - * @member {object} acknowledgementSettings The X12 acknowledgment settings. - * @member {boolean} [acknowledgementSettings.needTechnicalAcknowledgement] + * @property {object} acknowledgementSettings The X12 acknowledgment + * settings. + * @property {boolean} [acknowledgementSettings.needTechnicalAcknowledgement] * The value indicating whether technical acknowledgement is needed. - * @member {boolean} [acknowledgementSettings.batchTechnicalAcknowledgements] - * The value indicating whether to batch the technical acknowledgements. - * @member {boolean} [acknowledgementSettings.needFunctionalAcknowledgement] - * The value indicating whether functional acknowledgement is needed. - * @member {string} + * @property {boolean} + * [acknowledgementSettings.batchTechnicalAcknowledgements] The value + * indicating whether to batch the technical acknowledgements. + * @property {boolean} + * [acknowledgementSettings.needFunctionalAcknowledgement] The value + * indicating whether functional acknowledgement is needed. + * @property {string} * [acknowledgementSettings.functionalAcknowledgementVersion] The functional * acknowledgement version. - * @member {boolean} + * @property {boolean} * [acknowledgementSettings.batchFunctionalAcknowledgements] The value * indicating whether to batch functional acknowledgements. - * @member {boolean} + * @property {boolean} * [acknowledgementSettings.needImplementationAcknowledgement] The value * indicating whether implementation acknowledgement is needed. - * @member {string} + * @property {string} * [acknowledgementSettings.implementationAcknowledgementVersion] The * implementation acknowledgement version. - * @member {boolean} + * @property {boolean} * [acknowledgementSettings.batchImplementationAcknowledgements] The value * indicating whether to batch implementation acknowledgements. - * @member {boolean} [acknowledgementSettings.needLoopForValidMessages] The + * @property {boolean} [acknowledgementSettings.needLoopForValidMessages] The * value indicating whether a loop is needed for valid messages. - * @member {boolean} [acknowledgementSettings.sendSynchronousAcknowledgement] - * The value indicating whether to send synchronous acknowledgement. - * @member {string} + * @property {boolean} + * [acknowledgementSettings.sendSynchronousAcknowledgement] The value + * indicating whether to send synchronous acknowledgement. + * @property {string} * [acknowledgementSettings.acknowledgementControlNumberPrefix] The * acknowledgement control number prefix. - * @member {string} + * @property {string} * [acknowledgementSettings.acknowledgementControlNumberSuffix] The * acknowledgement control number suffix. - * @member {number} + * @property {number} * [acknowledgementSettings.acknowledgementControlNumberLowerBound] The * acknowledgement control number lower bound. - * @member {number} + * @property {number} * [acknowledgementSettings.acknowledgementControlNumberUpperBound] The * acknowledgement control number upper bound. - * @member {boolean} + * @property {boolean} * [acknowledgementSettings.rolloverAcknowledgementControlNumber] The value * indicating whether to rollover acknowledgement control number. - * @member {object} messageFilter The X12 message filter. - * @member {string} [messageFilter.messageFilterType] The message filter + * @property {object} messageFilter The X12 message filter. + * @property {string} [messageFilter.messageFilterType] The message filter * type. Possible values include: 'NotSpecified', 'Include', 'Exclude' - * @member {object} securitySettings The X12 security settings. - * @member {string} [securitySettings.authorizationQualifier] The + * @property {object} securitySettings The X12 security settings. + * @property {string} [securitySettings.authorizationQualifier] The * authorization qualifier. - * @member {string} [securitySettings.authorizationValue] The authorization + * @property {string} [securitySettings.authorizationValue] The authorization * value. - * @member {string} [securitySettings.securityQualifier] The security + * @property {string} [securitySettings.securityQualifier] The security * qualifier. - * @member {string} [securitySettings.passwordValue] The password value. - * @member {object} processingSettings The X12 processing settings. - * @member {boolean} [processingSettings.maskSecurityInfo] The value + * @property {string} [securitySettings.passwordValue] The password value. + * @property {object} processingSettings The X12 processing settings. + * @property {boolean} [processingSettings.maskSecurityInfo] The value * indicating whether to mask security information. - * @member {boolean} [processingSettings.convertImpliedDecimal] The value + * @property {boolean} [processingSettings.convertImpliedDecimal] The value * indicating whether to convert numerical type to implied decimal. - * @member {boolean} [processingSettings.preserveInterchange] The value + * @property {boolean} [processingSettings.preserveInterchange] The value * indicating whether to preserve interchange. - * @member {boolean} [processingSettings.suspendInterchangeOnError] The value - * indicating whether to suspend interchange on error. - * @member {boolean} + * @property {boolean} [processingSettings.suspendInterchangeOnError] The + * value indicating whether to suspend interchange on error. + * @property {boolean} * [processingSettings.createEmptyXmlTagsForTrailingSeparators] The value * indicating whether to create empty xml tags for trailing separators. - * @member {boolean} [processingSettings.useDotAsDecimalSeparator] The value - * indicating whether to use dot as decimal separator. - * @member {array} [envelopeOverrides] The X12 envelope override settings. - * @member {array} [validationOverrides] The X12 validation override + * @property {boolean} [processingSettings.useDotAsDecimalSeparator] The + * value indicating whether to use dot as decimal separator. + * @property {array} [envelopeOverrides] The X12 envelope override settings. + * @property {array} [validationOverrides] The X12 validation override * settings. - * @member {array} [messageFilterList] The X12 message filter list. - * @member {array} schemaReferences The X12 schema references. - * @member {array} [x12DelimiterOverrides] The X12 delimiter override + * @property {array} [messageFilterList] The X12 message filter list. + * @property {array} schemaReferences The X12 schema references. + * @property {array} [x12DelimiterOverrides] The X12 delimiter override * settings. */ constructor() { diff --git a/lib/services/logicManagement/lib/models/x12SchemaReference.js b/lib/services/logicManagement/lib/models/x12SchemaReference.js index a7cf23ad5c..051b9d12bf 100644 --- a/lib/services/logicManagement/lib/models/x12SchemaReference.js +++ b/lib/services/logicManagement/lib/models/x12SchemaReference.js @@ -17,10 +17,10 @@ class X12SchemaReference { /** * Create a X12SchemaReference. - * @member {string} messageId The message id. - * @member {string} [senderApplicationId] The sender application id. - * @member {string} schemaVersion The schema version. - * @member {string} schemaName The schema name. + * @property {string} messageId The message id. + * @property {string} [senderApplicationId] The sender application id. + * @property {string} schemaVersion The schema version. + * @property {string} schemaName The schema name. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/x12SecuritySettings.js b/lib/services/logicManagement/lib/models/x12SecuritySettings.js index d6e624ce71..0f6212f5e1 100644 --- a/lib/services/logicManagement/lib/models/x12SecuritySettings.js +++ b/lib/services/logicManagement/lib/models/x12SecuritySettings.js @@ -17,10 +17,10 @@ class X12SecuritySettings { /** * Create a X12SecuritySettings. - * @member {string} authorizationQualifier The authorization qualifier. - * @member {string} [authorizationValue] The authorization value. - * @member {string} securityQualifier The security qualifier. - * @member {string} [passwordValue] The password value. + * @property {string} authorizationQualifier The authorization qualifier. + * @property {string} [authorizationValue] The authorization value. + * @property {string} securityQualifier The security qualifier. + * @property {string} [passwordValue] The password value. */ constructor() { } diff --git a/lib/services/logicManagement/lib/models/x12ValidationOverride.js b/lib/services/logicManagement/lib/models/x12ValidationOverride.js index 4c83ade39e..c656b76d1a 100644 --- a/lib/services/logicManagement/lib/models/x12ValidationOverride.js +++ b/lib/services/logicManagement/lib/models/x12ValidationOverride.js @@ -17,19 +17,19 @@ class X12ValidationOverride { /** * Create a X12ValidationOverride. - * @member {string} messageId The message id on which the validation settings - * has to be applied. - * @member {boolean} validateEdiTypes The value indicating whether to + * @property {string} messageId The message id on which the validation + * settings has to be applied. + * @property {boolean} validateEdiTypes The value indicating whether to * validate EDI types. - * @member {boolean} validateXsdTypes The value indicating whether to + * @property {boolean} validateXsdTypes The value indicating whether to * validate XSD types. - * @member {boolean} allowLeadingAndTrailingSpacesAndZeroes The value + * @property {boolean} allowLeadingAndTrailingSpacesAndZeroes The value * indicating whether to allow leading and trailing spaces and zeroes. - * @member {boolean} validateCharacterSet The value indicating whether to + * @property {boolean} validateCharacterSet The value indicating whether to * validate character Set. - * @member {boolean} trimLeadingAndTrailingSpacesAndZeroes The value + * @property {boolean} trimLeadingAndTrailingSpacesAndZeroes The value * indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} trailingSeparatorPolicy The trailing separator policy. + * @property {string} trailingSeparatorPolicy The trailing separator policy. * Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', * 'Mandatory' */ diff --git a/lib/services/logicManagement/lib/models/x12ValidationSettings.js b/lib/services/logicManagement/lib/models/x12ValidationSettings.js index 5d09e3a095..45259770a6 100644 --- a/lib/services/logicManagement/lib/models/x12ValidationSettings.js +++ b/lib/services/logicManagement/lib/models/x12ValidationSettings.js @@ -17,25 +17,25 @@ class X12ValidationSettings { /** * Create a X12ValidationSettings. - * @member {boolean} validateCharacterSet The value indicating whether to + * @property {boolean} validateCharacterSet The value indicating whether to * validate character set in the message. - * @member {boolean} checkDuplicateInterchangeControlNumber The value + * @property {boolean} checkDuplicateInterchangeControlNumber The value * indicating whether to check for duplicate interchange control number. - * @member {number} interchangeControlNumberValidityDays The validity period - * of interchange control number. - * @member {boolean} checkDuplicateGroupControlNumber The value indicating + * @property {number} interchangeControlNumberValidityDays The validity + * period of interchange control number. + * @property {boolean} checkDuplicateGroupControlNumber The value indicating * whether to check for duplicate group control number. - * @member {boolean} checkDuplicateTransactionSetControlNumber The value + * @property {boolean} checkDuplicateTransactionSetControlNumber The value * indicating whether to check for duplicate transaction set control number. - * @member {boolean} validateEdiTypes The value indicating whether to Whether - * to validate EDI types. - * @member {boolean} validateXsdTypes The value indicating whether to Whether - * to validate XSD types. - * @member {boolean} allowLeadingAndTrailingSpacesAndZeroes The value + * @property {boolean} validateEdiTypes The value indicating whether to + * Whether to validate EDI types. + * @property {boolean} validateXsdTypes The value indicating whether to + * Whether to validate XSD types. + * @property {boolean} allowLeadingAndTrailingSpacesAndZeroes The value * indicating whether to allow leading and trailing spaces and zeroes. - * @member {boolean} trimLeadingAndTrailingSpacesAndZeroes The value + * @property {boolean} trimLeadingAndTrailingSpacesAndZeroes The value * indicating whether to trim leading and trailing spaces and zeroes. - * @member {string} trailingSeparatorPolicy The trailing separator policy. + * @property {string} trailingSeparatorPolicy The trailing separator policy. * Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', * 'Mandatory' */ diff --git a/lib/services/logicManagement/lib/operations/index.d.ts b/lib/services/logicManagement/lib/operations/index.d.ts index 6536615d1d..51a61d5d54 100644 --- a/lib/services/logicManagement/lib/operations/index.d.ts +++ b/lib/services/logicManagement/lib/operations/index.d.ts @@ -231,6 +231,8 @@ export interface Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -273,6 +275,8 @@ export interface Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -334,6 +338,8 @@ export interface Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -376,6 +382,8 @@ export interface Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -809,6 +817,8 @@ export interface Workflows { * * @param {object} [moveParameter.integrationAccount] The integration account. * + * @param {string} [moveParameter.integrationAccount.id] The resource id. + * * @param {object} [moveParameter.definition] The definition. * * @param {object} [moveParameter.parameters] The parameters. @@ -851,6 +861,8 @@ export interface Workflows { * * @param {object} [moveParameter.integrationAccount] The integration account. * + * @param {string} [moveParameter.integrationAccount.id] The resource id. + * * @param {object} [moveParameter.definition] The definition. * * @param {object} [moveParameter.parameters] The parameters. @@ -979,6 +991,8 @@ export interface Workflows { * * @param {object} [validate.integrationAccount] The integration account. * + * @param {string} [validate.integrationAccount.id] The resource id. + * * @param {object} [validate.definition] The definition. * * @param {object} [validate.parameters] The parameters. @@ -1021,6 +1035,8 @@ export interface Workflows { * * @param {object} [validate.integrationAccount] The integration account. * + * @param {string} [validate.integrationAccount.id] The resource id. + * * @param {object} [validate.definition] The definition. * * @param {object} [validate.parameters] The parameters. @@ -1083,6 +1099,8 @@ export interface Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -1127,6 +1145,8 @@ export interface Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -3129,6 +3149,426 @@ export interface WorkflowRunActionRepetitions { listExpressionTraces(resourceGroupName: string, workflowName: string, runName: string, actionName: string, repetitionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; } +/** + * @class + * WorkflowRunActionRepetitionsRequestHistories + * __NOTE__: An instance of this class is automatically created for an + * instance of the LogicManagementClient. + */ +export interface WorkflowRunActionRepetitionsRequestHistories { + + + /** + * List a workflow run repetition request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} repetitionName The workflow repetition. + * + * @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. + */ + listWithHttpOperationResponse(resourceGroupName: string, workflowName: string, runName: string, actionName: string, repetitionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * List a workflow run repetition request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} repetitionName The workflow repetition. + * + * @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 {RequestHistoryListResult} - 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. + * + * {RequestHistoryListResult} [result] - The deserialized result object if an error did not occur. + * See {@link RequestHistoryListResult} 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. + */ + list(resourceGroupName: string, workflowName: string, runName: string, actionName: string, repetitionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(resourceGroupName: string, workflowName: string, runName: string, actionName: string, repetitionName: string, callback: ServiceCallback): void; + list(resourceGroupName: string, workflowName: string, runName: string, actionName: string, repetitionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets a workflow run repetition request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} repetitionName The workflow repetition. + * + * @param {string} requestHistoryName The request history name. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName: string, workflowName: string, runName: string, actionName: string, repetitionName: string, requestHistoryName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets a workflow run repetition request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} repetitionName The workflow repetition. + * + * @param {string} requestHistoryName The request history name. + * + * @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 {RequestHistory} - 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. + * + * {RequestHistory} [result] - The deserialized result object if an error did not occur. + * See {@link RequestHistory} 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. + */ + get(resourceGroupName: string, workflowName: string, runName: string, actionName: string, repetitionName: string, requestHistoryName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, workflowName: string, runName: string, actionName: string, repetitionName: string, requestHistoryName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, workflowName: string, runName: string, actionName: string, repetitionName: string, requestHistoryName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * List a workflow run repetition request history. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * List a workflow run repetition request history. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {RequestHistoryListResult} - 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. + * + * {RequestHistoryListResult} [result] - The deserialized result object if an error did not occur. + * See {@link RequestHistoryListResult} 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. + */ + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * WorkflowRunActionRequestHistories + * __NOTE__: An instance of this class is automatically created for an + * instance of the LogicManagementClient. + */ +export interface WorkflowRunActionRequestHistories { + + + /** + * List a workflow run request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @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. + */ + listWithHttpOperationResponse(resourceGroupName: string, workflowName: string, runName: string, actionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * List a workflow run request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @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 {RequestHistoryListResult} - 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. + * + * {RequestHistoryListResult} [result] - The deserialized result object if an error did not occur. + * See {@link RequestHistoryListResult} 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. + */ + list(resourceGroupName: string, workflowName: string, runName: string, actionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(resourceGroupName: string, workflowName: string, runName: string, actionName: string, callback: ServiceCallback): void; + list(resourceGroupName: string, workflowName: string, runName: string, actionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets a workflow run request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} requestHistoryName The request history name. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName: string, workflowName: string, runName: string, actionName: string, requestHistoryName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets a workflow run request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} requestHistoryName The request history name. + * + * @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 {RequestHistory} - 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. + * + * {RequestHistory} [result] - The deserialized result object if an error did not occur. + * See {@link RequestHistory} 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. + */ + get(resourceGroupName: string, workflowName: string, runName: string, actionName: string, requestHistoryName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, workflowName: string, runName: string, actionName: string, requestHistoryName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, workflowName: string, runName: string, actionName: string, requestHistoryName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * List a workflow run request history. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * List a workflow run request history. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {RequestHistoryListResult} - 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. + * + * {RequestHistoryListResult} [result] - The deserialized result object if an error did not occur. + * See {@link RequestHistoryListResult} 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. + */ + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + /** * @class * WorkflowRunActionScopeRepetitions @@ -3859,6 +4299,8 @@ export interface IntegrationAccounts { * * @param {object} listKeyVaultKeysParameter.keyVault The key vault reference. * + * @param {string} [listKeyVaultKeysParameter.keyVault.id] The resource id. + * * @param {string} [listKeyVaultKeysParameter.skipToken] The skip token. * * @param {object} [options] Optional Parameters. @@ -3885,6 +4327,8 @@ export interface IntegrationAccounts { * * @param {object} listKeyVaultKeysParameter.keyVault The key vault reference. * + * @param {string} [listKeyVaultKeysParameter.keyVault.id] The resource id. + * * @param {string} [listKeyVaultKeysParameter.skipToken] The skip token. * * @param {object} [options] Optional Parameters. diff --git a/lib/services/logicManagement/lib/operations/index.js b/lib/services/logicManagement/lib/operations/index.js index dc0ce17904..564ca4be58 100644 --- a/lib/services/logicManagement/lib/operations/index.js +++ b/lib/services/logicManagement/lib/operations/index.js @@ -22,6 +22,8 @@ exports.WorkflowTriggerHistories = require('./workflowTriggerHistories'); exports.WorkflowRuns = require('./workflowRuns'); exports.WorkflowRunActions = require('./workflowRunActions'); exports.WorkflowRunActionRepetitions = require('./workflowRunActionRepetitions'); +exports.WorkflowRunActionRepetitionsRequestHistories = require('./workflowRunActionRepetitionsRequestHistories'); +exports.WorkflowRunActionRequestHistories = require('./workflowRunActionRequestHistories'); exports.WorkflowRunActionScopeRepetitions = require('./workflowRunActionScopeRepetitions'); exports.WorkflowRunOperations = require('./workflowRunOperations'); exports.IntegrationAccounts = require('./integrationAccounts'); diff --git a/lib/services/logicManagement/lib/operations/integrationAccounts.js b/lib/services/logicManagement/lib/operations/integrationAccounts.js index ac4c98a719..63c09be381 100644 --- a/lib/services/logicManagement/lib/operations/integrationAccounts.js +++ b/lib/services/logicManagement/lib/operations/integrationAccounts.js @@ -1129,6 +1129,8 @@ function _listCallbackUrl(resourceGroupName, integrationAccountName, parameters, * * @param {object} listKeyVaultKeysParameter.keyVault The key vault reference. * + * @param {string} [listKeyVaultKeysParameter.keyVault.id] The resource id. + * * @param {string} [listKeyVaultKeysParameter.skipToken] The skip token. * * @param {object} [options] Optional Parameters. @@ -2568,6 +2570,8 @@ class IntegrationAccounts { * * @param {object} listKeyVaultKeysParameter.keyVault The key vault reference. * + * @param {string} [listKeyVaultKeysParameter.keyVault.id] The resource id. + * * @param {string} [listKeyVaultKeysParameter.skipToken] The skip token. * * @param {object} [options] Optional Parameters. @@ -2606,6 +2610,8 @@ class IntegrationAccounts { * * @param {object} listKeyVaultKeysParameter.keyVault The key vault reference. * + * @param {string} [listKeyVaultKeysParameter.keyVault.id] The resource id. + * * @param {string} [listKeyVaultKeysParameter.skipToken] The skip token. * * @param {object} [options] Optional Parameters. diff --git a/lib/services/logicManagement/lib/operations/workflowRunActionRepetitionsRequestHistories.js b/lib/services/logicManagement/lib/operations/workflowRunActionRepetitionsRequestHistories.js new file mode 100644 index 0000000000..e68f8a8caa --- /dev/null +++ b/lib/services/logicManagement/lib/operations/workflowRunActionRepetitionsRequestHistories.js @@ -0,0 +1,782 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * List a workflow run repetition request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} repetitionName The workflow repetition. + * + * @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 RequestHistoryListResult} 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 _list(resourceGroupName, workflowName, runName, actionName, repetitionName, 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 (workflowName === null || workflowName === undefined || typeof workflowName.valueOf() !== 'string') { + throw new Error('workflowName cannot be null or undefined and it must be of type string.'); + } + if (runName === null || runName === undefined || typeof runName.valueOf() !== 'string') { + throw new Error('runName cannot be null or undefined and it must be of type string.'); + } + if (actionName === null || actionName === undefined || typeof actionName.valueOf() !== 'string') { + throw new Error('actionName cannot be null or undefined and it must be of type string.'); + } + if (repetitionName === null || repetitionName === undefined || typeof repetitionName.valueOf() !== 'string') { + throw new Error('repetitionName cannot be null or undefined and it must be of type string.'); + } + 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 (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.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{workflowName}', encodeURIComponent(workflowName)); + requestUrl = requestUrl.replace('{runName}', encodeURIComponent(runName)); + requestUrl = requestUrl.replace('{actionName}', encodeURIComponent(actionName)); + requestUrl = requestUrl.replace('{repetitionName}', encodeURIComponent(repetitionName)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['RequestHistoryListResult']().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); + }); +} + +/** + * Gets a workflow run repetition request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} repetitionName The workflow repetition. + * + * @param {string} requestHistoryName The request history name. + * + * @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 RequestHistory} 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 _get(resourceGroupName, workflowName, runName, actionName, repetitionName, requestHistoryName, 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 (workflowName === null || workflowName === undefined || typeof workflowName.valueOf() !== 'string') { + throw new Error('workflowName cannot be null or undefined and it must be of type string.'); + } + if (runName === null || runName === undefined || typeof runName.valueOf() !== 'string') { + throw new Error('runName cannot be null or undefined and it must be of type string.'); + } + if (actionName === null || actionName === undefined || typeof actionName.valueOf() !== 'string') { + throw new Error('actionName cannot be null or undefined and it must be of type string.'); + } + if (repetitionName === null || repetitionName === undefined || typeof repetitionName.valueOf() !== 'string') { + throw new Error('repetitionName cannot be null or undefined and it must be of type string.'); + } + if (requestHistoryName === null || requestHistoryName === undefined || typeof requestHistoryName.valueOf() !== 'string') { + throw new Error('requestHistoryName cannot be null or undefined and it must be of type string.'); + } + 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 (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.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{workflowName}', encodeURIComponent(workflowName)); + requestUrl = requestUrl.replace('{runName}', encodeURIComponent(runName)); + requestUrl = requestUrl.replace('{actionName}', encodeURIComponent(actionName)); + requestUrl = requestUrl.replace('{repetitionName}', encodeURIComponent(repetitionName)); + requestUrl = requestUrl.replace('{requestHistoryName}', encodeURIComponent(requestHistoryName)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['RequestHistory']().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); + }); +} + +/** + * List a workflow run repetition request history. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 RequestHistoryListResult} 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 _listNext(nextPageLink, 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 (nextPageLink === null || nextPageLink === undefined || typeof nextPageLink.valueOf() !== 'string') { + throw new Error('nextPageLink cannot be null or undefined and it must be of type string.'); + } + 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 requestUrl = '{nextLink}'; + requestUrl = requestUrl.replace('{nextLink}', nextPageLink); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['RequestHistoryListResult']().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); + }); +} + +/** Class representing a WorkflowRunActionRepetitionsRequestHistories. */ +class WorkflowRunActionRepetitionsRequestHistories { + /** + * Create a WorkflowRunActionRepetitionsRequestHistories. + * @param {LogicManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._list = _list; + this._get = _get; + this._listNext = _listNext; + } + + /** + * List a workflow run repetition request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} repetitionName The workflow repetition. + * + * @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. + */ + listWithHttpOperationResponse(resourceGroupName, workflowName, runName, actionName, repetitionName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(resourceGroupName, workflowName, runName, actionName, repetitionName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * List a workflow run repetition request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} repetitionName The workflow repetition. + * + * @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 {RequestHistoryListResult} - 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 RequestHistoryListResult} 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. + */ + list(resourceGroupName, workflowName, runName, actionName, repetitionName, 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._list(resourceGroupName, workflowName, runName, actionName, repetitionName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(resourceGroupName, workflowName, runName, actionName, repetitionName, options, optionalCallback); + } + } + + /** + * Gets a workflow run repetition request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} repetitionName The workflow repetition. + * + * @param {string} requestHistoryName The request history name. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName, workflowName, runName, actionName, repetitionName, requestHistoryName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._get(resourceGroupName, workflowName, runName, actionName, repetitionName, requestHistoryName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets a workflow run repetition request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} repetitionName The workflow repetition. + * + * @param {string} requestHistoryName The request history name. + * + * @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 {RequestHistory} - 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 RequestHistory} 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. + */ + get(resourceGroupName, workflowName, runName, actionName, repetitionName, requestHistoryName, 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._get(resourceGroupName, workflowName, runName, actionName, repetitionName, requestHistoryName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._get(resourceGroupName, workflowName, runName, actionName, repetitionName, requestHistoryName, options, optionalCallback); + } + } + + /** + * List a workflow run repetition request history. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listNext(nextPageLink, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * List a workflow run repetition request history. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {RequestHistoryListResult} - 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 RequestHistoryListResult} 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. + */ + listNext(nextPageLink, 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._listNext(nextPageLink, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listNext(nextPageLink, options, optionalCallback); + } + } + +} + +module.exports = WorkflowRunActionRepetitionsRequestHistories; diff --git a/lib/services/logicManagement/lib/operations/workflowRunActionRequestHistories.js b/lib/services/logicManagement/lib/operations/workflowRunActionRequestHistories.js new file mode 100644 index 0000000000..42a1208a5f --- /dev/null +++ b/lib/services/logicManagement/lib/operations/workflowRunActionRequestHistories.js @@ -0,0 +1,762 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * List a workflow run request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @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 RequestHistoryListResult} 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 _list(resourceGroupName, workflowName, runName, actionName, 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 (workflowName === null || workflowName === undefined || typeof workflowName.valueOf() !== 'string') { + throw new Error('workflowName cannot be null or undefined and it must be of type string.'); + } + if (runName === null || runName === undefined || typeof runName.valueOf() !== 'string') { + throw new Error('runName cannot be null or undefined and it must be of type string.'); + } + if (actionName === null || actionName === undefined || typeof actionName.valueOf() !== 'string') { + throw new Error('actionName cannot be null or undefined and it must be of type string.'); + } + 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 (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.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{workflowName}', encodeURIComponent(workflowName)); + requestUrl = requestUrl.replace('{runName}', encodeURIComponent(runName)); + requestUrl = requestUrl.replace('{actionName}', encodeURIComponent(actionName)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['RequestHistoryListResult']().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); + }); +} + +/** + * Gets a workflow run request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} requestHistoryName The request history name. + * + * @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 RequestHistory} 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 _get(resourceGroupName, workflowName, runName, actionName, requestHistoryName, 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 (workflowName === null || workflowName === undefined || typeof workflowName.valueOf() !== 'string') { + throw new Error('workflowName cannot be null or undefined and it must be of type string.'); + } + if (runName === null || runName === undefined || typeof runName.valueOf() !== 'string') { + throw new Error('runName cannot be null or undefined and it must be of type string.'); + } + if (actionName === null || actionName === undefined || typeof actionName.valueOf() !== 'string') { + throw new Error('actionName cannot be null or undefined and it must be of type string.'); + } + if (requestHistoryName === null || requestHistoryName === undefined || typeof requestHistoryName.valueOf() !== 'string') { + throw new Error('requestHistoryName cannot be null or undefined and it must be of type string.'); + } + 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 (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.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories/{requestHistoryName}'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{workflowName}', encodeURIComponent(workflowName)); + requestUrl = requestUrl.replace('{runName}', encodeURIComponent(runName)); + requestUrl = requestUrl.replace('{actionName}', encodeURIComponent(actionName)); + requestUrl = requestUrl.replace('{requestHistoryName}', encodeURIComponent(requestHistoryName)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['RequestHistory']().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); + }); +} + +/** + * List a workflow run request history. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 RequestHistoryListResult} 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 _listNext(nextPageLink, 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 (nextPageLink === null || nextPageLink === undefined || typeof nextPageLink.valueOf() !== 'string') { + throw new Error('nextPageLink cannot be null or undefined and it must be of type string.'); + } + 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 requestUrl = '{nextLink}'; + requestUrl = requestUrl.replace('{nextLink}', nextPageLink); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['RequestHistoryListResult']().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); + }); +} + +/** Class representing a WorkflowRunActionRequestHistories. */ +class WorkflowRunActionRequestHistories { + /** + * Create a WorkflowRunActionRequestHistories. + * @param {LogicManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._list = _list; + this._get = _get; + this._listNext = _listNext; + } + + /** + * List a workflow run request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @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. + */ + listWithHttpOperationResponse(resourceGroupName, workflowName, runName, actionName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(resourceGroupName, workflowName, runName, actionName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * List a workflow run request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @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 {RequestHistoryListResult} - 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 RequestHistoryListResult} 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. + */ + list(resourceGroupName, workflowName, runName, actionName, 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._list(resourceGroupName, workflowName, runName, actionName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(resourceGroupName, workflowName, runName, actionName, options, optionalCallback); + } + } + + /** + * Gets a workflow run request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} requestHistoryName The request history name. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName, workflowName, runName, actionName, requestHistoryName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._get(resourceGroupName, workflowName, runName, actionName, requestHistoryName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets a workflow run request history. + * + * @param {string} resourceGroupName The resource group name. + * + * @param {string} workflowName The workflow name. + * + * @param {string} runName The workflow run name. + * + * @param {string} actionName The workflow action name. + * + * @param {string} requestHistoryName The request history name. + * + * @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 {RequestHistory} - 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 RequestHistory} 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. + */ + get(resourceGroupName, workflowName, runName, actionName, requestHistoryName, 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._get(resourceGroupName, workflowName, runName, actionName, requestHistoryName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._get(resourceGroupName, workflowName, runName, actionName, requestHistoryName, options, optionalCallback); + } + } + + /** + * List a workflow run request history. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listNext(nextPageLink, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * List a workflow run request history. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {RequestHistoryListResult} - 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 RequestHistoryListResult} 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. + */ + listNext(nextPageLink, 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._listNext(nextPageLink, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listNext(nextPageLink, options, optionalCallback); + } + } + +} + +module.exports = WorkflowRunActionRequestHistories; diff --git a/lib/services/logicManagement/lib/operations/workflows.js b/lib/services/logicManagement/lib/operations/workflows.js index eb1cccc46a..dc3e0a9d1a 100644 --- a/lib/services/logicManagement/lib/operations/workflows.js +++ b/lib/services/logicManagement/lib/operations/workflows.js @@ -492,6 +492,8 @@ function _get(resourceGroupName, workflowName, options, callback) { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -693,6 +695,8 @@ function _createOrUpdate(resourceGroupName, workflowName, workflow, options, cal * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -1749,6 +1753,8 @@ function _listSwagger(resourceGroupName, workflowName, options, callback) { * * @param {object} [moveParameter.integrationAccount] The integration account. * + * @param {string} [moveParameter.integrationAccount.id] The resource id. + * * @param {object} [moveParameter.definition] The definition. * * @param {object} [moveParameter.parameters] The parameters. @@ -2064,6 +2070,8 @@ function _regenerateAccessKey(resourceGroupName, workflowName, keyType, options, * * @param {object} [validate.integrationAccount] The integration account. * + * @param {string} [validate.integrationAccount.id] The resource id. + * * @param {object} [validate.definition] The definition. * * @param {object} [validate.parameters] The parameters. @@ -2232,6 +2240,8 @@ function _validateByResourceGroup(resourceGroupName, workflowName, validate, opt * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -2953,6 +2963,8 @@ class Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -3007,6 +3019,8 @@ class Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -3083,6 +3097,8 @@ class Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -3137,6 +3153,8 @@ class Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -3747,6 +3765,8 @@ class Workflows { * * @param {object} [moveParameter.integrationAccount] The integration account. * + * @param {string} [moveParameter.integrationAccount.id] The resource id. + * * @param {object} [moveParameter.definition] The definition. * * @param {object} [moveParameter.parameters] The parameters. @@ -3801,6 +3821,8 @@ class Workflows { * * @param {object} [moveParameter.integrationAccount] The integration account. * + * @param {string} [moveParameter.integrationAccount.id] The resource id. + * * @param {object} [moveParameter.definition] The definition. * * @param {object} [moveParameter.parameters] The parameters. @@ -3971,6 +3993,8 @@ class Workflows { * * @param {object} [validate.integrationAccount] The integration account. * + * @param {string} [validate.integrationAccount.id] The resource id. + * * @param {object} [validate.definition] The definition. * * @param {object} [validate.parameters] The parameters. @@ -4025,6 +4049,8 @@ class Workflows { * * @param {object} [validate.integrationAccount] The integration account. * + * @param {string} [validate.integrationAccount.id] The resource id. + * * @param {object} [validate.definition] The definition. * * @param {object} [validate.parameters] The parameters. @@ -4102,6 +4128,8 @@ class Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. @@ -4158,6 +4186,8 @@ class Workflows { * * @param {object} [workflow.integrationAccount] The integration account. * + * @param {string} [workflow.integrationAccount.id] The resource id. + * * @param {object} [workflow.definition] The definition. * * @param {object} [workflow.parameters] The parameters. diff --git a/lib/services/logicManagement/package.json b/lib/services/logicManagement/package.json index e5c976578d..59877270cf 100644 --- a/lib/services/logicManagement/package.json +++ b/lib/services/logicManagement/package.json @@ -2,7 +2,7 @@ "name": "azure-arm-logic", "author": "Microsoft Corporation", "description": "LogicManagementClient Library with typescript type definitions for node", - "version": "4.1.0", + "version": "4.2.0", "dependencies": { "ms-rest": "^2.3.3", "ms-rest-azure": "^2.5.5" @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +} diff --git a/lib/services/luis/authoring/README.md b/lib/services/luis/authoring/README.md index 9f6daa4e1a..94432e30af 100644 --- a/lib/services/luis/authoring/README.md +++ b/lib/services/luis/authoring/README.md @@ -3,22 +3,24 @@ uid: azure-cognitiveservices-luis-authoring summary: *content --- -# Microsoft Azure SDK for Node.js - LUISAuthoringClient +**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 - LUISAuthoringClient + 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-cognitiveservices-luis-authoring ``` -## How to use +### How to use -### Authentication, client creation and listPhraseLists features as an example. +#### Authentication, client creation, and listPhraseLists features as an example. ```javascript const msRest = require("ms-rest"); @@ -31,6 +33,7 @@ const appId = ec7b1657-199d-4d8a-bbb2-89a11a42e02a; const versionId = "testversionId"; const skip = 1; const take = 1; + client.features.listPhraseLists(appId, versionId, skip, take).then((result) => { console.log("The result is:"); console.log(result); @@ -38,7 +41,8 @@ client.features.listPhraseLists(appId, versionId, skip, take).then((result) => { console.log('An error occurred:'); 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/luis/authoring/lib/lUISAuthoringClient.d.ts b/lib/services/luis/authoring/lib/lUISAuthoringClient.d.ts index 08ffd0ea4f..016adef630 100644 --- a/lib/services/luis/authoring/lib/lUISAuthoringClient.d.ts +++ b/lib/services/luis/authoring/lib/lUISAuthoringClient.d.ts @@ -47,6 +47,7 @@ export default class LUISAuthoringClient extends ServiceClient { train: operations.Train; permissions: operations.Permissions; pattern: operations.Pattern; + settings: operations.Settings; } export { LUISAuthoringClient, models as LUISAuthoringModels }; diff --git a/lib/services/luis/authoring/lib/lUISAuthoringClient.js b/lib/services/luis/authoring/lib/lUISAuthoringClient.js index b5fa344490..ada27b1c25 100644 --- a/lib/services/luis/authoring/lib/lUISAuthoringClient.js +++ b/lib/services/luis/authoring/lib/lUISAuthoringClient.js @@ -59,6 +59,7 @@ class LUISAuthoringClient extends ServiceClient { this.train = new operations.Train(this); this.permissions = new operations.Permissions(this); this.pattern = new operations.Pattern(this); + this.settings = new operations.Settings(this); this.models = models; msRest.addSerializationMixin(this); } diff --git a/lib/services/luis/authoring/lib/models/appVersionSettingObject.js b/lib/services/luis/authoring/lib/models/appVersionSettingObject.js new file mode 100644 index 0000000000..1f0134e2ac --- /dev/null +++ b/lib/services/luis/authoring/lib/models/appVersionSettingObject.js @@ -0,0 +1,60 @@ +/* + * 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'; + +/** + * Object model of an application version setting. + * + */ +class AppVersionSettingObject { + /** + * Create a AppVersionSettingObject. + * @property {string} [name] The application version setting name. + * @property {string} [value] The application version setting value. + */ + constructor() { + } + + /** + * Defines the metadata of AppVersionSettingObject + * + * @returns {object} metadata of AppVersionSettingObject + * + */ + mapper() { + return { + required: false, + serializedName: 'AppVersionSettingObject', + type: { + name: 'Composite', + className: 'AppVersionSettingObject', + modelProperties: { + name: { + required: false, + serializedName: 'name', + type: { + name: 'String' + } + }, + value: { + required: false, + serializedName: 'value', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = AppVersionSettingObject; diff --git a/lib/services/luis/authoring/lib/models/applicationCreateObject.js b/lib/services/luis/authoring/lib/models/applicationCreateObject.js index 444d2e3ca9..8ae4a89e42 100644 --- a/lib/services/luis/authoring/lib/models/applicationCreateObject.js +++ b/lib/services/luis/authoring/lib/models/applicationCreateObject.js @@ -17,18 +17,18 @@ class ApplicationCreateObject { /** * Create a ApplicationCreateObject. - * @member {string} culture The culture for the new application. It is the + * @property {string} culture The culture for the new application. It is the * language that your app understands and speaks. E.g.: "en-us". Note: the * culture cannot be changed after the app is created. - * @member {string} [domain] The domain for the new application. Optional. + * @property {string} [domain] The domain for the new application. Optional. * E.g.: Comics. - * @member {string} [description] Description of the new application. + * @property {string} [description] Description of the new application. * Optional. - * @member {string} [initialVersionId] The initial version ID. Optional. + * @property {string} [initialVersionId] The initial version ID. Optional. * Default value is: "0.1" - * @member {string} [usageScenario] Defines the scenario for the new + * @property {string} [usageScenario] Defines the scenario for the new * application. Optional. E.g.: IoT. - * @member {string} name The name for the new application. + * @property {string} name The name for the new application. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/applicationInfoResponse.js b/lib/services/luis/authoring/lib/models/applicationInfoResponse.js index 832957f3a4..45d56bf5ca 100644 --- a/lib/services/luis/authoring/lib/models/applicationInfoResponse.js +++ b/lib/services/luis/authoring/lib/models/applicationInfoResponse.js @@ -17,22 +17,22 @@ class ApplicationInfoResponse { /** * Create a ApplicationInfoResponse. - * @member {uuid} [id] The ID (GUID) of the application. - * @member {string} [name] The name of the application. - * @member {string} [description] The description of the application. - * @member {string} [culture] The culture of the application. E.g.: en-us. - * @member {string} [usageScenario] Defines the scenario for the new + * @property {uuid} [id] The ID (GUID) of the application. + * @property {string} [name] The name of the application. + * @property {string} [description] The description of the application. + * @property {string} [culture] The culture of the application. E.g.: en-us. + * @property {string} [usageScenario] Defines the scenario for the new * application. Optional. E.g.: IoT. - * @member {string} [domain] The domain for the new application. Optional. + * @property {string} [domain] The domain for the new application. Optional. * E.g.: Comics. - * @member {number} [versionsCount] Amount of model versions within the + * @property {number} [versionsCount] Amount of model versions within the * application. - * @member {string} [createdDateTime] The version's creation timestamp. - * @member {object} [endpoints] The Runtime endpoint URL for this model + * @property {string} [createdDateTime] The version's creation timestamp. + * @property {object} [endpoints] The Runtime endpoint URL for this model * version. - * @member {number} [endpointHitsCount] Number of calls made to this + * @property {number} [endpointHitsCount] Number of calls made to this * endpoint. - * @member {string} [activeVersion] The version ID currently marked as + * @property {string} [activeVersion] The version ID currently marked as * active. */ constructor() { diff --git a/lib/services/luis/authoring/lib/models/applicationPublishObject.js b/lib/services/luis/authoring/lib/models/applicationPublishObject.js index 3bc2e06e17..deb05fda9a 100644 --- a/lib/services/luis/authoring/lib/models/applicationPublishObject.js +++ b/lib/services/luis/authoring/lib/models/applicationPublishObject.js @@ -17,11 +17,9 @@ class ApplicationPublishObject { /** * Create a ApplicationPublishObject. - * @member {string} [versionId] The version ID to publish. - * @member {boolean} [isStaging] Indicates if the staging slot should be + * @property {string} [versionId] The version ID to publish. + * @property {boolean} [isStaging] Indicates if the staging slot should be * used, instead of the Production one. Default value: false . - * @member {string} [region] The target region that the application is - * published to. */ constructor() { } @@ -54,13 +52,6 @@ class ApplicationPublishObject { type: { name: 'Boolean' } - }, - region: { - required: false, - serializedName: 'region', - type: { - name: 'String' - } } } } diff --git a/lib/services/luis/authoring/lib/models/applicationSettingUpdateObject.js b/lib/services/luis/authoring/lib/models/applicationSettingUpdateObject.js index 4db46ee96e..e6006d7a07 100644 --- a/lib/services/luis/authoring/lib/models/applicationSettingUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/applicationSettingUpdateObject.js @@ -17,7 +17,7 @@ class ApplicationSettingUpdateObject { /** * Create a ApplicationSettingUpdateObject. - * @member {boolean} [publicProperty] Setting your application as public + * @property {boolean} [publicProperty] Setting your application as public * allows other people to use your application's endpoint using their own * keys. */ diff --git a/lib/services/luis/authoring/lib/models/applicationSettings.js b/lib/services/luis/authoring/lib/models/applicationSettings.js index 1e03958229..8aff2a2769 100644 --- a/lib/services/luis/authoring/lib/models/applicationSettings.js +++ b/lib/services/luis/authoring/lib/models/applicationSettings.js @@ -17,9 +17,9 @@ class ApplicationSettings { /** * Create a ApplicationSettings. - * @member {uuid} id The application ID. - * @member {boolean} isPublic Setting your application as public allows other - * people to use your application's endpoint using their own keys. + * @property {uuid} id The application ID. + * @property {boolean} isPublic Setting your application as public allows + * other people to use your application's endpoint using their own keys. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/applicationUpdateObject.js b/lib/services/luis/authoring/lib/models/applicationUpdateObject.js index 71962b8ab1..eaad61f3b7 100644 --- a/lib/services/luis/authoring/lib/models/applicationUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/applicationUpdateObject.js @@ -17,8 +17,8 @@ class ApplicationUpdateObject { /** * Create a ApplicationUpdateObject. - * @member {string} [name] The application's new name. - * @member {string} [description] The application's new description. + * @property {string} [name] The application's new name. + * @property {string} [description] The application's new description. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/availableCulture.js b/lib/services/luis/authoring/lib/models/availableCulture.js index c0ffcfe6cb..7373b8faa2 100644 --- a/lib/services/luis/authoring/lib/models/availableCulture.js +++ b/lib/services/luis/authoring/lib/models/availableCulture.js @@ -17,8 +17,8 @@ class AvailableCulture { /** * Create a AvailableCulture. - * @member {string} [name] The language name. - * @member {string} [code] The ISO value for the language. + * @property {string} [name] The language name. + * @property {string} [code] The ISO value for the language. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/availablePrebuiltEntityModel.js b/lib/services/luis/authoring/lib/models/availablePrebuiltEntityModel.js index 397336bdb6..b236eea6cc 100644 --- a/lib/services/luis/authoring/lib/models/availablePrebuiltEntityModel.js +++ b/lib/services/luis/authoring/lib/models/availablePrebuiltEntityModel.js @@ -17,10 +17,10 @@ class AvailablePrebuiltEntityModel { /** * Create a AvailablePrebuiltEntityModel. - * @member {string} [name] The entity name. - * @member {string} [description] The entity description and usage + * @property {string} [name] The entity name. + * @property {string} [description] The entity description and usage * information. - * @member {string} [examples] Usage examples. + * @property {string} [examples] Usage examples. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/batchLabelExample.js b/lib/services/luis/authoring/lib/models/batchLabelExample.js index d347c3b7d8..654fb30930 100644 --- a/lib/services/luis/authoring/lib/models/batchLabelExample.js +++ b/lib/services/luis/authoring/lib/models/batchLabelExample.js @@ -17,14 +17,14 @@ class BatchLabelExample { /** * Create a BatchLabelExample. - * @member {object} [value] - * @member {string} [value.utteranceText] The sample's utterance. - * @member {number} [value.exampleId] The newly created sample ID. - * @member {boolean} [hasError] - * @member {object} [error] - * @member {string} [error.code] Status Code. Possible values include: + * @property {object} [value] + * @property {string} [value.utteranceText] The sample's utterance. + * @property {number} [value.exampleId] The newly created sample ID. + * @property {boolean} [hasError] + * @property {object} [error] + * @property {string} [error.code] Status Code. Possible values include: * 'Failed', 'FAILED', 'Success' - * @member {string} [error.message] Status details. + * @property {string} [error.message] Status details. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/childEntity.js b/lib/services/luis/authoring/lib/models/childEntity.js index 2e9b7ff54f..60af9a6266 100644 --- a/lib/services/luis/authoring/lib/models/childEntity.js +++ b/lib/services/luis/authoring/lib/models/childEntity.js @@ -17,8 +17,8 @@ class ChildEntity { /** * Create a ChildEntity. - * @member {uuid} id The ID (GUID) belonging to a child entity. - * @member {string} [name] The name of a child entity. + * @property {uuid} id The ID (GUID) belonging to a child entity. + * @property {string} [name] The name of a child entity. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/closedList.js b/lib/services/luis/authoring/lib/models/closedList.js index 59966c5977..7e0395c97f 100644 --- a/lib/services/luis/authoring/lib/models/closedList.js +++ b/lib/services/luis/authoring/lib/models/closedList.js @@ -17,9 +17,9 @@ class ClosedList { /** * Create a ClosedList. - * @member {string} [name] Name of the closed list feature. - * @member {array} [subLists] Sublists for the feature. - * @member {array} [roles] + * @property {string} [name] Name of the closed list feature. + * @property {array} [subLists] Sublists for the feature. + * @property {array} [roles] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/closedListEntityExtractor.js b/lib/services/luis/authoring/lib/models/closedListEntityExtractor.js index 7783f8784c..985dd66555 100644 --- a/lib/services/luis/authoring/lib/models/closedListEntityExtractor.js +++ b/lib/services/luis/authoring/lib/models/closedListEntityExtractor.js @@ -17,16 +17,16 @@ class ClosedListEntityExtractor { /** * Create a ClosedListEntityExtractor. - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {array} [subLists] List of sub-lists. + * @property {uuid} id The ID of the Entity Model. + * @property {string} [name] Name of the Entity Model. + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} readableType Possible values include: 'Entity + * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity + * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity + * Extractor', 'Regex Entity Extractor' + * @property {array} [roles] + * @property {array} [subLists] List of sub-lists. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/closedListModelCreateObject.js b/lib/services/luis/authoring/lib/models/closedListModelCreateObject.js index 1eedda138e..73ef737d1b 100644 --- a/lib/services/luis/authoring/lib/models/closedListModelCreateObject.js +++ b/lib/services/luis/authoring/lib/models/closedListModelCreateObject.js @@ -17,8 +17,8 @@ class ClosedListModelCreateObject { /** * Create a ClosedListModelCreateObject. - * @member {array} [subLists] Sublists for the feature. - * @member {string} [name] Name of the closed list feature. + * @property {array} [subLists] Sublists for the feature. + * @property {string} [name] Name of the closed list feature. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/closedListModelPatchObject.js b/lib/services/luis/authoring/lib/models/closedListModelPatchObject.js index 8a71d88297..89eac27233 100644 --- a/lib/services/luis/authoring/lib/models/closedListModelPatchObject.js +++ b/lib/services/luis/authoring/lib/models/closedListModelPatchObject.js @@ -17,7 +17,7 @@ class ClosedListModelPatchObject { /** * Create a ClosedListModelPatchObject. - * @member {array} [subLists] Sublists to add. + * @property {array} [subLists] Sublists to add. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/closedListModelUpdateObject.js b/lib/services/luis/authoring/lib/models/closedListModelUpdateObject.js index dcacfa7f6d..c55d7cbf6a 100644 --- a/lib/services/luis/authoring/lib/models/closedListModelUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/closedListModelUpdateObject.js @@ -17,8 +17,8 @@ class ClosedListModelUpdateObject { /** * Create a ClosedListModelUpdateObject. - * @member {array} [subLists] The new sublists for the feature. - * @member {string} [name] The new name of the closed list feature. + * @property {array} [subLists] The new sublists for the feature. + * @property {string} [name] The new name of the closed list feature. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/collaboratorsArray.js b/lib/services/luis/authoring/lib/models/collaboratorsArray.js index 6e911824cb..b5b1b0887b 100644 --- a/lib/services/luis/authoring/lib/models/collaboratorsArray.js +++ b/lib/services/luis/authoring/lib/models/collaboratorsArray.js @@ -16,7 +16,7 @@ class CollaboratorsArray { /** * Create a CollaboratorsArray. - * @member {array} [emails] The email address of the users. + * @property {array} [emails] The email address of the users. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/compositeChildModelCreateObject.js b/lib/services/luis/authoring/lib/models/compositeChildModelCreateObject.js index 4c7065b175..005ca930f1 100644 --- a/lib/services/luis/authoring/lib/models/compositeChildModelCreateObject.js +++ b/lib/services/luis/authoring/lib/models/compositeChildModelCreateObject.js @@ -16,7 +16,7 @@ class CompositeChildModelCreateObject { /** * Create a CompositeChildModelCreateObject. - * @member {string} [name] + * @property {string} [name] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/compositeEntityExtractor.js b/lib/services/luis/authoring/lib/models/compositeEntityExtractor.js index b0a4ab6e4d..8e892684c4 100644 --- a/lib/services/luis/authoring/lib/models/compositeEntityExtractor.js +++ b/lib/services/luis/authoring/lib/models/compositeEntityExtractor.js @@ -17,16 +17,16 @@ class CompositeEntityExtractor { /** * Create a CompositeEntityExtractor. - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {array} [children] List of child entities. + * @property {uuid} id The ID of the Entity Model. + * @property {string} [name] Name of the Entity Model. + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} readableType Possible values include: 'Entity + * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity + * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity + * Extractor', 'Regex Entity Extractor' + * @property {array} [roles] + * @property {array} [children] List of child entities. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/compositeEntityModel.js b/lib/services/luis/authoring/lib/models/compositeEntityModel.js index c3da990f6e..cbc7d24c25 100644 --- a/lib/services/luis/authoring/lib/models/compositeEntityModel.js +++ b/lib/services/luis/authoring/lib/models/compositeEntityModel.js @@ -17,8 +17,8 @@ class CompositeEntityModel { /** * Create a CompositeEntityModel. - * @member {array} [children] Child entities. - * @member {string} [name] Entity name. + * @property {array} [children] Child entities. + * @property {string} [name] Entity name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/customPrebuiltModel.js b/lib/services/luis/authoring/lib/models/customPrebuiltModel.js index 92624bcac5..8feba66eab 100644 --- a/lib/services/luis/authoring/lib/models/customPrebuiltModel.js +++ b/lib/services/luis/authoring/lib/models/customPrebuiltModel.js @@ -17,17 +17,18 @@ class CustomPrebuiltModel { /** * Create a CustomPrebuiltModel. - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {string} [customPrebuiltDomainName] The domain name. - * @member {string} [customPrebuiltModelName] The intent name or entity name. - * @member {array} [roles] + * @property {uuid} id The ID of the Entity Model. + * @property {string} [name] Name of the Entity Model. + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} readableType Possible values include: 'Entity + * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity + * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity + * Extractor', 'Regex Entity Extractor' + * @property {string} [customPrebuiltDomainName] The domain name. + * @property {string} [customPrebuiltModelName] The intent name or entity + * name. + * @property {array} [roles] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/endpointInfo.js b/lib/services/luis/authoring/lib/models/endpointInfo.js index dece173db1..1adc49815f 100644 --- a/lib/services/luis/authoring/lib/models/endpointInfo.js +++ b/lib/services/luis/authoring/lib/models/endpointInfo.js @@ -17,16 +17,16 @@ class EndpointInfo { /** * Create a EndpointInfo. - * @member {string} [versionId] The version ID to publish. - * @member {boolean} [isStaging] Indicates if the staging slot should be + * @property {string} [versionId] The version ID to publish. + * @property {boolean} [isStaging] Indicates if the staging slot should be * used, instead of the Production one. - * @member {string} [endpointUrl] The Runtime endpoint URL for this model + * @property {string} [endpointUrl] The Runtime endpoint URL for this model * version. - * @member {string} [region] The target region that the application is + * @property {string} [region] The target region that the application is * published to. - * @member {string} [assignedEndpointKey] The endpoint key. - * @member {string} [endpointRegion] The endpoint's region. - * @member {string} [publishedDateTime] Timestamp when was last published. + * @property {string} [assignedEndpointKey] The endpoint key. + * @property {string} [endpointRegion] The endpoint's region. + * @property {string} [publishedDateTime] Timestamp when was last published. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/enqueueTrainingResponse.js b/lib/services/luis/authoring/lib/models/enqueueTrainingResponse.js index cfa70c0390..d94949ddc9 100644 --- a/lib/services/luis/authoring/lib/models/enqueueTrainingResponse.js +++ b/lib/services/luis/authoring/lib/models/enqueueTrainingResponse.js @@ -17,9 +17,9 @@ class EnqueueTrainingResponse { /** * Create a EnqueueTrainingResponse. - * @member {number} [statusId] The train request status ID. - * @member {string} [status] Possible values include: 'Queued', 'InProgress', - * 'UpToDate', 'Fail', 'Success' + * @property {number} [statusId] The train request status ID. + * @property {string} [status] Possible values include: 'Queued', + * 'InProgress', 'UpToDate', 'Fail', 'Success' */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/entitiesSuggestionExample.js b/lib/services/luis/authoring/lib/models/entitiesSuggestionExample.js index de84bf8d12..2cb443d930 100644 --- a/lib/services/luis/authoring/lib/models/entitiesSuggestionExample.js +++ b/lib/services/luis/authoring/lib/models/entitiesSuggestionExample.js @@ -17,11 +17,11 @@ class EntitiesSuggestionExample { /** * Create a EntitiesSuggestionExample. - * @member {string} [text] The utterance. E.g.: what's the weather like in + * @property {string} [text] The utterance. E.g.: what's the weather like in * seattle? - * @member {array} [tokenizedText] The utterance tokenized. - * @member {array} [intentPredictions] Predicted/suggested intents. - * @member {array} [entityPredictions] Predicted/suggested entities. + * @property {array} [tokenizedText] The utterance tokenized. + * @property {array} [intentPredictions] Predicted/suggested intents. + * @property {array} [entityPredictions] Predicted/suggested entities. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/entityExtractor.js b/lib/services/luis/authoring/lib/models/entityExtractor.js index 1c4c8ae6ca..9125f6c4f0 100644 --- a/lib/services/luis/authoring/lib/models/entityExtractor.js +++ b/lib/services/luis/authoring/lib/models/entityExtractor.js @@ -17,17 +17,18 @@ class EntityExtractor { /** * Create a EntityExtractor. - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {string} [customPrebuiltDomainName] The domain name. - * @member {string} [customPrebuiltModelName] The intent name or entity name. + * @property {uuid} id The ID of the Entity Model. + * @property {string} [name] Name of the Entity Model. + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} readableType Possible values include: 'Entity + * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity + * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity + * Extractor', 'Regex Entity Extractor' + * @property {array} [roles] + * @property {string} [customPrebuiltDomainName] The domain name. + * @property {string} [customPrebuiltModelName] The intent name or entity + * name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/entityLabel.js b/lib/services/luis/authoring/lib/models/entityLabel.js index 6b8c11d0de..a425e091ec 100644 --- a/lib/services/luis/authoring/lib/models/entityLabel.js +++ b/lib/services/luis/authoring/lib/models/entityLabel.js @@ -18,10 +18,10 @@ class EntityLabel { /** * Create a EntityLabel. - * @member {string} entityName The entity type. - * @member {number} startTokenIndex The index within the utterance where the - * extracted entity starts. - * @member {number} endTokenIndex The index within the utterance where the + * @property {string} entityName The entity type. + * @property {number} startTokenIndex The index within the utterance where + * the extracted entity starts. + * @property {number} endTokenIndex The index within the utterance where the * extracted entity ends. */ constructor() { diff --git a/lib/services/luis/authoring/lib/models/entityLabelObject.js b/lib/services/luis/authoring/lib/models/entityLabelObject.js index 93da4a0ff1..583f05800b 100644 --- a/lib/services/luis/authoring/lib/models/entityLabelObject.js +++ b/lib/services/luis/authoring/lib/models/entityLabelObject.js @@ -18,10 +18,10 @@ class EntityLabelObject { /** * Create a EntityLabelObject. - * @member {string} entityName The entity type. - * @member {number} startCharIndex The index within the utterance where the + * @property {string} entityName The entity type. + * @property {number} startCharIndex The index within the utterance where the * extracted entity starts. - * @member {number} endCharIndex The index within the utterance where the + * @property {number} endCharIndex The index within the utterance where the * extracted entity ends. */ constructor() { diff --git a/lib/services/luis/authoring/lib/models/entityModelInfo.js b/lib/services/luis/authoring/lib/models/entityModelInfo.js index 5b93724751..002ec8e453 100644 --- a/lib/services/luis/authoring/lib/models/entityModelInfo.js +++ b/lib/services/luis/authoring/lib/models/entityModelInfo.js @@ -20,7 +20,7 @@ const models = require('./index'); class EntityModelInfo extends models['ModelInfo'] { /** * Create a EntityModelInfo. - * @member {array} [roles] + * @property {array} [roles] */ constructor() { super(); diff --git a/lib/services/luis/authoring/lib/models/entityPrediction.js b/lib/services/luis/authoring/lib/models/entityPrediction.js index e6fc4f16a3..6eb9941f08 100644 --- a/lib/services/luis/authoring/lib/models/entityPrediction.js +++ b/lib/services/luis/authoring/lib/models/entityPrediction.js @@ -17,12 +17,12 @@ class EntityPrediction { /** * Create a EntityPrediction. - * @member {string} entityName The entity's name - * @member {number} startTokenIndex The index within the utterance where the - * extracted entity starts. - * @member {number} endTokenIndex The index within the utterance where the + * @property {string} entityName The entity's name + * @property {number} startTokenIndex The index within the utterance where + * the extracted entity starts. + * @property {number} endTokenIndex The index within the utterance where the * extracted entity ends. - * @member {string} phrase The actual token(s) that comprise the entity. + * @property {string} phrase The actual token(s) that comprise the entity. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/entityRole.js b/lib/services/luis/authoring/lib/models/entityRole.js index 77c4015981..49efef4ff7 100644 --- a/lib/services/luis/authoring/lib/models/entityRole.js +++ b/lib/services/luis/authoring/lib/models/entityRole.js @@ -17,8 +17,8 @@ class EntityRole { /** * Create a EntityRole. - * @member {uuid} [id] The entity role ID. - * @member {string} [name] The entity role name. + * @property {uuid} [id] The entity role ID. + * @property {string} [name] The entity role name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/entityRoleCreateObject.js b/lib/services/luis/authoring/lib/models/entityRoleCreateObject.js index f5db3294bc..46033050e3 100644 --- a/lib/services/luis/authoring/lib/models/entityRoleCreateObject.js +++ b/lib/services/luis/authoring/lib/models/entityRoleCreateObject.js @@ -17,7 +17,7 @@ class EntityRoleCreateObject { /** * Create a EntityRoleCreateObject. - * @member {string} [name] The entity role name. + * @property {string} [name] The entity role name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/entityRoleUpdateObject.js b/lib/services/luis/authoring/lib/models/entityRoleUpdateObject.js index 03ab723a98..9f791249a3 100644 --- a/lib/services/luis/authoring/lib/models/entityRoleUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/entityRoleUpdateObject.js @@ -17,7 +17,7 @@ class EntityRoleUpdateObject { /** * Create a EntityRoleUpdateObject. - * @member {string} [name] The entity role name. + * @property {string} [name] The entity role name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/errorResponse.js b/lib/services/luis/authoring/lib/models/errorResponse.js index c6acbb4f29..1ea302ab17 100644 --- a/lib/services/luis/authoring/lib/models/errorResponse.js +++ b/lib/services/luis/authoring/lib/models/errorResponse.js @@ -17,7 +17,7 @@ class ErrorResponse { /** * Create a ErrorResponse. - * @member {string} [errorType] + * @property {string} [errorType] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/exampleLabelObject.js b/lib/services/luis/authoring/lib/models/exampleLabelObject.js index 07804bc808..f7027e948c 100644 --- a/lib/services/luis/authoring/lib/models/exampleLabelObject.js +++ b/lib/services/luis/authoring/lib/models/exampleLabelObject.js @@ -17,9 +17,10 @@ class ExampleLabelObject { /** * Create a ExampleLabelObject. - * @member {string} [text] The sample's utterance. - * @member {array} [entityLabels] The idenfied entities within the utterance. - * @member {string} [intentName] The idenfitied intent representing the + * @property {string} [text] The sample's utterance. + * @property {array} [entityLabels] The idenfied entities within the + * utterance. + * @property {string} [intentName] The idenfitied intent representing the * utterance. */ constructor() { diff --git a/lib/services/luis/authoring/lib/models/explicitListItem.js b/lib/services/luis/authoring/lib/models/explicitListItem.js index 421f0e13c5..0cdc192aed 100644 --- a/lib/services/luis/authoring/lib/models/explicitListItem.js +++ b/lib/services/luis/authoring/lib/models/explicitListItem.js @@ -17,8 +17,8 @@ class ExplicitListItem { /** * Create a ExplicitListItem. - * @member {number} [id] The explicit list item ID. - * @member {string} [explicitListItem] The explicit list item value. + * @property {number} [id] The explicit list item ID. + * @property {string} [explicitListItem] The explicit list item value. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/explicitListItemCreateObject.js b/lib/services/luis/authoring/lib/models/explicitListItemCreateObject.js index 0f32eb6ed8..f7fe09c0f8 100644 --- a/lib/services/luis/authoring/lib/models/explicitListItemCreateObject.js +++ b/lib/services/luis/authoring/lib/models/explicitListItemCreateObject.js @@ -17,7 +17,7 @@ class ExplicitListItemCreateObject { /** * Create a ExplicitListItemCreateObject. - * @member {string} [explicitListItem] The explicit list item. + * @property {string} [explicitListItem] The explicit list item. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/explicitListItemUpdateObject.js b/lib/services/luis/authoring/lib/models/explicitListItemUpdateObject.js index b987eb25df..5c9ff0a0e3 100644 --- a/lib/services/luis/authoring/lib/models/explicitListItemUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/explicitListItemUpdateObject.js @@ -17,7 +17,7 @@ class ExplicitListItemUpdateObject { /** * Create a ExplicitListItemUpdateObject. - * @member {string} [explicitListItem] The explicit list item. + * @property {string} [explicitListItem] The explicit list item. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/featureInfoObject.js b/lib/services/luis/authoring/lib/models/featureInfoObject.js index f4ac3479f9..255569f8eb 100644 --- a/lib/services/luis/authoring/lib/models/featureInfoObject.js +++ b/lib/services/luis/authoring/lib/models/featureInfoObject.js @@ -17,9 +17,9 @@ class FeatureInfoObject { /** * Create a FeatureInfoObject. - * @member {number} [id] A six-digit ID used for Features. - * @member {string} [name] The name of the Feature. - * @member {boolean} [isActive] Indicates if the feature is enabled. + * @property {number} [id] A six-digit ID used for Features. + * @property {string} [name] The name of the Feature. + * @property {boolean} [isActive] Indicates if the feature is enabled. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/featuresResponseObject.js b/lib/services/luis/authoring/lib/models/featuresResponseObject.js index 1eb800bbf5..d4e8ca9401 100644 --- a/lib/services/luis/authoring/lib/models/featuresResponseObject.js +++ b/lib/services/luis/authoring/lib/models/featuresResponseObject.js @@ -17,8 +17,8 @@ class FeaturesResponseObject { /** * Create a FeaturesResponseObject. - * @member {array} [phraselistFeatures] - * @member {array} [patternFeatures] + * @property {array} [phraselistFeatures] + * @property {array} [patternFeatures] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/hierarchicalChildEntity.js b/lib/services/luis/authoring/lib/models/hierarchicalChildEntity.js index c0097cf6ea..e8ad504b8f 100644 --- a/lib/services/luis/authoring/lib/models/hierarchicalChildEntity.js +++ b/lib/services/luis/authoring/lib/models/hierarchicalChildEntity.js @@ -20,8 +20,8 @@ const models = require('./index'); class HierarchicalChildEntity extends models['ChildEntity'] { /** * Create a HierarchicalChildEntity. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} [readableType] Possible values include: 'Entity + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} [readableType] Possible values include: 'Entity * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity diff --git a/lib/services/luis/authoring/lib/models/hierarchicalChildModelCreateObject.js b/lib/services/luis/authoring/lib/models/hierarchicalChildModelCreateObject.js index 506c78688d..8974784383 100644 --- a/lib/services/luis/authoring/lib/models/hierarchicalChildModelCreateObject.js +++ b/lib/services/luis/authoring/lib/models/hierarchicalChildModelCreateObject.js @@ -16,7 +16,7 @@ class HierarchicalChildModelCreateObject { /** * Create a HierarchicalChildModelCreateObject. - * @member {string} [name] + * @property {string} [name] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/hierarchicalChildModelUpdateObject.js b/lib/services/luis/authoring/lib/models/hierarchicalChildModelUpdateObject.js index 4483afd4e0..f60bc0ef6b 100644 --- a/lib/services/luis/authoring/lib/models/hierarchicalChildModelUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/hierarchicalChildModelUpdateObject.js @@ -16,7 +16,7 @@ class HierarchicalChildModelUpdateObject { /** * Create a HierarchicalChildModelUpdateObject. - * @member {string} [name] + * @property {string} [name] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/hierarchicalEntityExtractor.js b/lib/services/luis/authoring/lib/models/hierarchicalEntityExtractor.js index 4daf9b0a66..066a0a3044 100644 --- a/lib/services/luis/authoring/lib/models/hierarchicalEntityExtractor.js +++ b/lib/services/luis/authoring/lib/models/hierarchicalEntityExtractor.js @@ -17,16 +17,16 @@ class HierarchicalEntityExtractor { /** * Create a HierarchicalEntityExtractor. - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {array} [children] List of child entities. + * @property {uuid} id The ID of the Entity Model. + * @property {string} [name] Name of the Entity Model. + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} readableType Possible values include: 'Entity + * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity + * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity + * Extractor', 'Regex Entity Extractor' + * @property {array} [roles] + * @property {array} [children] List of child entities. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/hierarchicalEntityModel.js b/lib/services/luis/authoring/lib/models/hierarchicalEntityModel.js index d16fc5c417..219d5e24e6 100644 --- a/lib/services/luis/authoring/lib/models/hierarchicalEntityModel.js +++ b/lib/services/luis/authoring/lib/models/hierarchicalEntityModel.js @@ -17,8 +17,8 @@ class HierarchicalEntityModel { /** * Create a HierarchicalEntityModel. - * @member {array} [children] Child entities. - * @member {string} [name] Entity name. + * @property {array} [children] Child entities. + * @property {string} [name] Entity name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/hierarchicalModel.js b/lib/services/luis/authoring/lib/models/hierarchicalModel.js index 4fc2e6e65b..60d689345f 100644 --- a/lib/services/luis/authoring/lib/models/hierarchicalModel.js +++ b/lib/services/luis/authoring/lib/models/hierarchicalModel.js @@ -16,12 +16,12 @@ class HierarchicalModel { /** * Create a HierarchicalModel. - * @member {string} [name] - * @member {array} [children] - * @member {object} [inherits] - * @member {string} [inherits.domainName] - * @member {string} [inherits.modelName] - * @member {array} [roles] + * @property {string} [name] + * @property {array} [children] + * @property {object} [inherits] + * @property {string} [inherits.domainName] + * @property {string} [inherits.modelName] + * @property {array} [roles] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/index.d.ts b/lib/services/luis/authoring/lib/models/index.d.ts index 2613285b07..6e54d47206 100644 --- a/lib/services/luis/authoring/lib/models/index.d.ts +++ b/lib/services/luis/authoring/lib/models/index.d.ts @@ -1,569 +1,558 @@ /* * 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 * as moment from "moment"; - /** - * @class - * Initializes a new instance of the EntityLabelObject class. - * @constructor - * Defines the entity type and position of the extracted entity within the - * example. - * - * @member {string} entityName The entity type. - * @member {number} startCharIndex The index within the utterance where the - * extracted entity starts. - * @member {number} endCharIndex The index within the utterance where the - * extracted entity ends. + * Defines the entity type and position of the extracted entity within the example. */ export interface EntityLabelObject { + /** + * The entity type. + */ entityName: string; + /** + * The index within the utterance where the extracted entity starts. + */ startCharIndex: number; + /** + * The index within the utterance where the extracted entity ends. + */ endCharIndex: number; } /** - * @class - * Initializes a new instance of the ApplicationCreateObject class. - * @constructor * Properties for creating a new LUIS Application - * - * @member {string} culture The culture for the new application. It is the - * language that your app understands and speaks. E.g.: "en-us". Note: the - * culture cannot be changed after the app is created. - * @member {string} [domain] The domain for the new application. Optional. - * E.g.: Comics. - * @member {string} [description] Description of the new application. Optional. - * @member {string} [initialVersionId] The initial version ID. Optional. - * Default value is: "0.1" - * @member {string} [usageScenario] Defines the scenario for the new - * application. Optional. E.g.: IoT. - * @member {string} name The name for the new application. */ export interface ApplicationCreateObject { + /** + * The culture for the new application. It is the language that your app understands and speaks. + * E.g.: "en-us". Note: the culture cannot be changed after the app is created. + */ culture: string; + /** + * The domain for the new application. Optional. E.g.: Comics. + */ domain?: string; + /** + * Description of the new application. Optional. + */ description?: string; + /** + * The initial version ID. Optional. Default value is: "0.1" + */ initialVersionId?: string; + /** + * Defines the scenario for the new application. Optional. E.g.: IoT. + */ usageScenario?: string; + /** + * The name for the new application. + */ name: string; } /** - * @class - * Initializes a new instance of the PrebuiltDomainCreateBaseObject class. - * @constructor - * A model object containing the name of the custom prebuilt entity and the - * name of the domain to which this model belongs. - * - * @member {string} [domainName] The domain name. + * A model object containing the name of the custom prebuilt entity and the name of the domain to + * which this model belongs. */ export interface PrebuiltDomainCreateBaseObject { + /** + * The domain name. + */ domainName?: string; } /** - * @class - * Initializes a new instance of the PrebuiltDomainCreateObject class. - * @constructor - * A prebuilt domain create object containing the name and culture of the - * domain. - * - * @member {string} [domainName] The domain name. - * @member {string} [culture] The culture of the new domain. + * A prebuilt domain create object containing the name and culture of the domain. */ export interface PrebuiltDomainCreateObject { + /** + * The domain name. + */ domainName?: string; + /** + * The culture of the new domain. + */ culture?: string; } /** - * @class - * Initializes a new instance of the PrebuiltDomainModelCreateObject class. - * @constructor - * A model object containing the name of the custom prebuilt intent or entity - * and the name of the domain to which this model belongs. - * - * @member {string} [domainName] The domain name. - * @member {string} [modelName] The intent name or entity name. + * A model object containing the name of the custom prebuilt intent or entity and the name of the + * domain to which this model belongs. */ export interface PrebuiltDomainModelCreateObject { + /** + * The domain name. + */ domainName?: string; + /** + * The intent name or entity name. + */ modelName?: string; } /** - * @class - * Initializes a new instance of the HierarchicalEntityModel class. - * @constructor * A Hierarchical Entity Extractor. - * - * @member {array} [children] Child entities. - * @member {string} [name] Entity name. */ export interface HierarchicalEntityModel { + /** + * Child entities. + */ children?: string[]; + /** + * Entity name. + */ name?: string; } /** - * @class - * Initializes a new instance of the CompositeEntityModel class. - * @constructor * A composite entity. - * - * @member {array} [children] Child entities. - * @member {string} [name] Entity name. */ export interface CompositeEntityModel { + /** + * Child entities. + */ children?: string[]; + /** + * Entity name. + */ name?: string; } /** - * @class - * Initializes a new instance of the JSONEntity class. - * @constructor * Exported Model - Extracted Entity from utterance. - * - * @member {number} startPos The index within the utterance where the extracted - * entity starts. - * @member {number} endPos The index within the utterance where the extracted - * entity ends. - * @member {string} entity The entity name. */ export interface JSONEntity { + /** + * The index within the utterance where the extracted entity starts. + */ startPos: number; + /** + * The index within the utterance where the extracted entity ends. + */ endPos: number; + /** + * The entity name. + */ entity: string; } /** - * @class - * Initializes a new instance of the ApplicationSettingUpdateObject class. - * @constructor * Object model for updating an application's settings. - * - * @member {boolean} [publicProperty] Setting your application as public allows - * other people to use your application's endpoint using their own keys. */ export interface ApplicationSettingUpdateObject { + /** + * Setting your application as public allows other people to use your application's endpoint + * using their own keys. + */ publicProperty?: boolean; } /** - * @class - * Initializes a new instance of the PublishSettingUpdateObject class. - * @constructor * Object model for updating an application's publish settings. - * - * @member {boolean} [sentimentAnalysis] Setting sentiment analysis as true - * returns the Sentiment of the input utterance along with the resopnse - * @member {boolean} [speech] Setting speech as public enables speech priming - * in your app - * @member {boolean} [spellChecker] Setting spell checker as public enables - * spell checking the input utterance. */ export interface PublishSettingUpdateObject { + /** + * Setting sentiment analysis as true returns the Sentiment of the input utterance along with the + * resopnse + */ sentimentAnalysis?: boolean; + /** + * Setting speech as public enables speech priming in your app + */ speech?: boolean; + /** + * Setting spell checker as public enables spell checking the input utterance. + */ spellChecker?: boolean; } /** - * @class - * Initializes a new instance of the ExampleLabelObject class. - * @constructor * A labeled example. - * - * @member {string} [text] The sample's utterance. - * @member {array} [entityLabels] The idenfied entities within the utterance. - * @member {string} [intentName] The idenfitied intent representing the - * utterance. */ export interface ExampleLabelObject { + /** + * The sample's utterance. + */ text?: string; + /** + * The idenfied entities within the utterance. + */ entityLabels?: EntityLabelObject[]; + /** + * The idenfitied intent representing the utterance. + */ intentName?: string; } /** - * @class - * Initializes a new instance of the PhraselistCreateObject class. - * @constructor * Object model for creating a phraselist model. - * - * @member {string} [phrases] List of comma-separated phrases that represent - * the Phraselist. - * @member {string} [name] The Phraselist name. - * @member {boolean} [isExchangeable] An exchangeable phrase list feature are - * serves as single feature to the LUIS underlying training algorithm. It is - * used as a lexicon lookup feature where its value is 1 if the lexicon - * contains a given word or 0 if it doesn’t. Think of an exchangeable as a - * synonyms list. A non-exchangeable phrase list feature has all the phrases in - * the list serve as separate features to the underlying training algorithm. - * So, if you your phrase list feature contains 5 phrases, they will be mapped - * to 5 separate features. You can think of the non-exchangeable phrase list - * feature as an additional bag of words that you are willing to add to LUIS - * existing vocabulary features. Think of a non-exchangeable as set of - * different words. Default value is true. Default value: true . */ export interface PhraselistCreateObject { + /** + * List of comma-separated phrases that represent the Phraselist. + */ phrases?: string; + /** + * The Phraselist name. + */ name?: string; + /** + * An exchangeable phrase list feature are serves as single feature to the LUIS underlying + * training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon + * contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A + * non-exchangeable phrase list feature has all the phrases in the list serve as separate + * features to the underlying training algorithm. So, if you your phrase list feature contains 5 + * phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable + * phrase list feature as an additional bag of words that you are willing to add to LUIS existing + * vocabulary features. Think of a non-exchangeable as set of different words. Default value is + * true. + */ isExchangeable?: boolean; } /** - * @class - * Initializes a new instance of the SubClosedList class. - * @constructor * Sublist of items for a Closed list. - * - * @member {string} [canonicalForm] The standard form that the list represents. - * @member {array} [list] List of synonym words. */ export interface SubClosedList { + /** + * The standard form that the list represents. + */ canonicalForm?: string; + /** + * List of synonym words. + */ list?: string[]; } /** - * @class - * Initializes a new instance of the SubClosedListResponse class. - * @constructor * Sublist of items for a Closed list. - * - * @member {number} [id] The sublist ID */ export interface SubClosedListResponse extends SubClosedList { + /** + * The sublist ID + */ id?: number; } /** - * @class - * Initializes a new instance of the ApplicationUpdateObject class. - * @constructor * Object model for updating the name or description of an application. - * - * @member {string} [name] The application's new name. - * @member {string} [description] The application's new description. */ export interface ApplicationUpdateObject { + /** + * The application's new name. + */ name?: string; + /** + * The application's new description. + */ description?: string; } /** - * @class - * Initializes a new instance of the JSONRegexFeature class. - * @constructor * Exported Model - A Pattern feature. - * - * @member {string} [pattern] The Regular Expression to match. - * @member {boolean} [activated] Indicates if the Pattern feature is enabled. - * @member {string} [name] Name of the feature. */ export interface JSONRegexFeature { + /** + * The Regular Expression to match. + */ pattern?: string; + /** + * Indicates if the Pattern feature is enabled. + */ activated?: boolean; + /** + * Name of the feature. + */ name?: string; } /** - * @class - * Initializes a new instance of the PatternUpdateObject class. - * @constructor * Object model for updating an existing Pattern feature. - * - * @member {string} [pattern] The Regular Expression to match. - * @member {string} [name] Name of the feature. - * @member {boolean} [isActive] Indicates if the Pattern feature is enabled. - * Default value: true . */ export interface PatternUpdateObject { + /** + * The Regular Expression to match. + */ pattern?: string; + /** + * Name of the feature. + */ name?: string; + /** + * Indicates if the Pattern feature is enabled. + */ isActive?: boolean; } /** - * @class - * Initializes a new instance of the ClosedList class. - * @constructor * Exported Model - A Closed List. - * - * @member {string} [name] Name of the closed list feature. - * @member {array} [subLists] Sublists for the feature. - * @member {array} [roles] */ export interface ClosedList { + /** + * Name of the closed list feature. + */ name?: string; + /** + * Sublists for the feature. + */ subLists?: SubClosedList[]; roles?: string[]; } /** - * @class - * Initializes a new instance of the WordListObject class. - * @constructor * Sublist of items for a Closed list. - * - * @member {string} [canonicalForm] The standard form that the list represents. - * @member {array} [list] List of synonym words. - */ +*/ export interface WordListObject { + /** + * The standard form that the list represents. + */ canonicalForm?: string; + /** + * List of synonym words. + */ list?: string[]; } /** - * @class - * Initializes a new instance of the ClosedListModelPatchObject class. - * @constructor * Object model for adding a batch of sublists to an existing closedlist. - * - * @member {array} [subLists] Sublists to add. - */ +*/ export interface ClosedListModelPatchObject { + /** + * Sublists to add. + */ subLists?: WordListObject[]; } /** - * @class - * Initializes a new instance of the JSONModelFeature class. - * @constructor * Exported Model - Phraselist Model Feature. - * - * @member {boolean} [activated] Indicates if the feature is enabled. - * @member {string} [name] The Phraselist name. - * @member {string} [words] List of comma-separated phrases that represent the - * Phraselist. - * @member {boolean} [mode] An exchangeable phrase list feature are serves as - * single feature to the LUIS underlying training algorithm. It is used as a - * lexicon lookup feature where its value is 1 if the lexicon contains a given - * word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A - * non-exchangeable phrase list feature has all the phrases in the list serve - * as separate features to the underlying training algorithm. So, if you your - * phrase list feature contains 5 phrases, they will be mapped to 5 separate - * features. You can think of the non-exchangeable phrase list feature as an - * additional bag of words that you are willing to add to LUIS existing - * vocabulary features. Think of a non-exchangeable as set of different words. - * Default value is true. - */ +*/ export interface JSONModelFeature { + /** + * Indicates if the feature is enabled. + */ activated?: boolean; + /** + * The Phraselist name. + */ name?: string; + /** + * List of comma-separated phrases that represent the Phraselist. + */ words?: string; + /** + * An exchangeable phrase list feature are serves as single feature to the LUIS underlying + * training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon + * contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A + * non-exchangeable phrase list feature has all the phrases in the list serve as separate + * features to the underlying training algorithm. So, if you your phrase list feature contains 5 + * phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable + * phrase list feature as an additional bag of words that you are willing to add to LUIS existing + * vocabulary features. Think of a non-exchangeable as set of different words. Default value is + * true. + */ mode?: boolean; } /** - * @class - * Initializes a new instance of the ModelCreateObject class. - * @constructor * Object model for creating a new entity extractor. - * - * @member {string} [name] Name of the new entity extractor. - */ +*/ export interface ModelCreateObject { + /** + * Name of the new entity extractor. + */ name?: string; } /** - * @class - * Initializes a new instance of the PatternCreateObject class. - * @constructor * Object model for creating a Pattern feature. - * - * @member {string} [pattern] The Regular Expression to match. - * @member {string} [name] Name of the feature. - */ +*/ export interface PatternCreateObject { + /** + * The Regular Expression to match. + */ pattern?: string; + /** + * Name of the feature. + */ name?: string; } /** - * @class - * Initializes a new instance of the WordListBaseUpdateObject class. - * @constructor * Object model for updating one of the closed list's sublists. - * - * @member {string} [canonicalForm] The standard form that the list represents. - * @member {array} [list] List of synonym words. - */ +*/ export interface WordListBaseUpdateObject { + /** + * The standard form that the list represents. + */ canonicalForm?: string; + /** + * List of synonym words. + */ list?: string[]; } /** - * @class - * Initializes a new instance of the JSONUtterance class. - * @constructor * Exported Model - Utterance that was used to train the model. - * - * @member {string} [text] The utterance. - * @member {string} [intent] The matched intent. - * @member {array} [entities] The matched entities. - */ +*/ export interface JSONUtterance { + /** + * The utterance. + */ text?: string; + /** + * The matched intent. + */ intent?: string; + /** + * The matched entities. + */ entities?: JSONEntity[]; } /** - * @class - * Initializes a new instance of the ModelUpdateObject class. - * @constructor * Object model for updating an intent classifier. - * - * @member {string} [name] The entity's new name. - */ +*/ export interface ModelUpdateObject { + /** + * The entity's new name. + */ name?: string; } /** - * @class - * Initializes a new instance of the ClosedListModelUpdateObject class. - * @constructor * Object model for updating a closed list. - * - * @member {array} [subLists] The new sublists for the feature. - * @member {string} [name] The new name of the closed list feature. - */ +*/ export interface ClosedListModelUpdateObject { + /** + * The new sublists for the feature. + */ subLists?: WordListObject[]; + /** + * The new name of the closed list feature. + */ name?: string; } /** - * @class - * Initializes a new instance of the ClosedListModelCreateObject class. - * @constructor * Object model for creating a closed list. - * - * @member {array} [subLists] Sublists for the feature. - * @member {string} [name] Name of the closed list feature. - */ +*/ export interface ClosedListModelCreateObject { + /** + * Sublists for the feature. + */ subLists?: WordListObject[]; + /** + * Name of the closed list feature. + */ name?: string; } /** - * @class - * Initializes a new instance of the VersionInfo class. - * @constructor * Object model of an application version. - * - * @member {string} version The version ID. E.g.: "0.1" - * @member {date} [createdDateTime] The version's creation timestamp. - * @member {date} [lastModifiedDateTime] Timestamp of the last update. - * @member {date} [lastTrainedDateTime] Timestamp of the last time the model - * was trained. - * @member {date} [lastPublishedDateTime] Timestamp when was last published. - * @member {string} [endpointUrl] The Runtime endpoint URL for this model - * version. - * @member {object} [assignedEndpointKey] The endpoint key. - * @member {object} [externalApiKeys] External keys. - * @member {number} [intentsCount] Number of intents in this model. - * @member {number} [entitiesCount] Number of entities in this model. - * @member {number} [endpointHitsCount] Number of calls made to this endpoint. - * @member {string} trainingStatus The current training status. Possible values - * include: 'NeedsTraining', 'InProgress', 'Trained' - */ +*/ export interface VersionInfo { + /** + * The version ID. E.g.: "0.1" + */ version: string; + /** + * The version's creation timestamp. + */ createdDateTime?: Date; + /** + * Timestamp of the last update. + */ lastModifiedDateTime?: Date; + /** + * Timestamp of the last time the model was trained. + */ lastTrainedDateTime?: Date; + /** + * Timestamp when was last published. + */ lastPublishedDateTime?: Date; + /** + * The Runtime endpoint URL for this model version. + */ endpointUrl?: string; + /** + * The endpoint key. + */ assignedEndpointKey?: { [propertyName: string]: string }; + /** + * External keys. + */ externalApiKeys?: any; + /** + * Number of intents in this model. + */ intentsCount?: number; + /** + * Number of entities in this model. + */ entitiesCount?: number; + /** + * Number of calls made to this endpoint. + */ endpointHitsCount?: number; + /** + * The current training status. Possible values include: 'NeedsTraining', 'InProgress', 'Trained' + */ trainingStatus: string; } /** - * @class - * Initializes a new instance of the TaskUpdateObject class. - * @constructor * Object model for cloning an application's version. - * - * @member {string} [version] The new version for the cloned model. - */ +*/ export interface TaskUpdateObject { + /** + * The new version for the cloned model. + */ version?: string; } /** - * @class - * Initializes a new instance of the PhraselistUpdateObject class. - * @constructor * Object model for updating a Phraselist. - * - * @member {string} [phrases] List of comma-separated phrases that represent - * the Phraselist. - * @member {string} [name] The Phraselist name. - * @member {boolean} [isActive] Indicates if the Phraselist is enabled. Default - * value: true . - * @member {boolean} [isExchangeable] An exchangeable phrase list feature are - * serves as single feature to the LUIS underlying training algorithm. It is - * used as a lexicon lookup feature where its value is 1 if the lexicon - * contains a given word or 0 if it doesn’t. Think of an exchangeable as a - * synonyms list. A non-exchangeable phrase list feature has all the phrases in - * the list serve as separate features to the underlying training algorithm. - * So, if you your phrase list feature contains 5 phrases, they will be mapped - * to 5 separate features. You can think of the non-exchangeable phrase list - * feature as an additional bag of words that you are willing to add to LUIS - * existing vocabulary features. Think of a non-exchangeable as set of - * different words. Default value is true. Default value: true . - */ +*/ export interface PhraselistUpdateObject { + /** + * List of comma-separated phrases that represent the Phraselist. + */ phrases?: string; + /** + * The Phraselist name. + */ name?: string; + /** + * Indicates if the Phraselist is enabled. + */ isActive?: boolean; + /** + * An exchangeable phrase list feature are serves as single feature to the LUIS underlying + * training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon + * contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A + * non-exchangeable phrase list feature has all the phrases in the list serve as separate + * features to the underlying training algorithm. So, if you your phrase list feature contains 5 + * phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable + * phrase list feature as an additional bag of words that you are willing to add to LUIS existing + * vocabulary features. Think of a non-exchangeable as set of different words. Default value is + * true. + */ isExchangeable?: boolean; } -/** - * @class - * Initializes a new instance of the PrebuiltDomainObject class. - * @constructor - * @member {string} [domainName] - * @member {string} [modelName] - */ export interface PrebuiltDomainObject { domainName?: string; modelName?: string; } -/** - * @class - * Initializes a new instance of the HierarchicalModel class. - * @constructor - * @member {string} [name] - * @member {array} [children] - * @member {object} [inherits] - * @member {string} [inherits.domainName] - * @member {string} [inherits.modelName] - * @member {array} [roles] - */ export interface HierarchicalModel { name?: string; children?: string[]; @@ -572,33 +561,22 @@ export interface HierarchicalModel { } /** - * @class - * Initializes a new instance of the ApplicationPublishObject class. - * @constructor * Object model for publishing a specific application version. - * - * @member {string} [versionId] The version ID to publish. - * @member {boolean} [isStaging] Indicates if the staging slot should be used, - * instead of the Production one. Default value: false . - * @member {string} [region] The target region that the application is - * published to. - */ +*/ export interface ApplicationPublishObject { + /** + * The version ID to publish. + */ versionId?: string; + /** + * Indicates if the staging slot should be used, instead of the Production one. + */ isStaging?: boolean; - region?: string; } /** - * @class - * Initializes a new instance of the PatternAny class. - * @constructor * Pattern.Any Entity Extractor. - * - * @member {string} [name] - * @member {array} [explicitList] - * @member {array} [roles] - */ +*/ export interface PatternAny { name?: string; explicitList?: string[]; @@ -606,15 +584,8 @@ export interface PatternAny { } /** - * @class - * Initializes a new instance of the RegexEntity class. - * @constructor * Regular Expression Entity Extractor. - * - * @member {string} [name] - * @member {string} [regexPattern] - * @member {array} [roles] - */ +*/ export interface RegexEntity { name?: string; regexPattern?: string; @@ -622,622 +593,663 @@ export interface RegexEntity { } /** - * @class - * Initializes a new instance of the PrebuiltEntity class. - * @constructor * Prebuilt Entity Extractor. - * - * @member {string} [name] - * @member {array} [roles] - */ +*/ export interface PrebuiltEntity { name?: string; roles?: string[]; } /** - * @class - * Initializes a new instance of the PatternRule class. - * @constructor * Pattern - * - * @member {string} [pattern] The pattern text. - * @member {string} [intent] The intent's name where the pattern belongs to. - */ +*/ export interface PatternRule { + /** + * The pattern text. + */ pattern?: string; + /** + * The intent's name where the pattern belongs to. + */ intent?: string; } /** - * @class - * Initializes a new instance of the LuisApp class. - * @constructor * Exported Model - An exported LUIS Application. - * - * @member {string} [name] The name of the application. - * @member {string} [versionId] The version ID of the application that was - * exported. - * @member {string} [desc] The description of the application. - * @member {string} [culture] The culture of the application. E.g.: en-us. - * @member {array} [intents] List of intents. - * @member {array} [entities] List of entities. - * @member {array} [closedLists] List of closed lists. - * @member {array} [composites] List of composite entities. - * @member {array} [patternAnyEntities] List of Pattern.Any entities. - * @member {array} [regexEntities] List of regular expression entities. - * @member {array} [prebuiltEntities] List of prebuilt entities. - * @member {array} [regexFeatures] List of pattern features. - * @member {array} [modelFeatures] List of model features. - * @member {array} [patterns] List of patterns. - * @member {array} [utterances] List of sample utterances. - */ +*/ export interface LuisApp { + /** + * The name of the application. + */ name?: string; + /** + * The version ID of the application that was exported. + */ versionId?: string; + /** + * The description of the application. + */ desc?: string; + /** + * The culture of the application. E.g.: en-us. + */ culture?: string; + /** + * List of intents. + */ intents?: HierarchicalModel[]; + /** + * List of entities. + */ entities?: HierarchicalModel[]; + /** + * List of closed lists. + */ closedLists?: ClosedList[]; + /** + * List of composite entities. + */ composites?: HierarchicalModel[]; + /** + * List of Pattern.Any entities. + */ patternAnyEntities?: PatternAny[]; + /** + * List of regular expression entities. + */ regexEntities?: RegexEntity[]; + /** + * List of prebuilt entities. + */ prebuiltEntities?: PrebuiltEntity[]; + /** + * List of pattern features. + */ regexFeatures?: JSONRegexFeature[]; + /** + * List of model features. + */ modelFeatures?: JSONModelFeature[]; + /** + * List of patterns. + */ patterns?: PatternRule[]; + /** + * List of sample utterances. + */ utterances?: JSONUtterance[]; /** - * @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 EntityLabel class. - * @constructor - * Defines the entity type and position of the extracted entity within the - * example. - * - * @member {string} entityName The entity type. - * @member {number} startTokenIndex The index within the utterance where the - * extracted entity starts. - * @member {number} endTokenIndex The index within the utterance where the - * extracted entity ends. - */ + * Defines the entity type and position of the extracted entity within the example. +*/ export interface EntityLabel { + /** + * The entity type. + */ entityName: string; + /** + * The index within the utterance where the extracted entity starts. + */ startTokenIndex: number; + /** + * The index within the utterance where the extracted entity ends. + */ endTokenIndex: number; } /** - * @class - * Initializes a new instance of the IntentPrediction class. - * @constructor * A suggested intent. - * - * @member {string} [name] The intent's name - * @member {number} [score] The intent's score, based on the prediction model. - */ +*/ export interface IntentPrediction { + /** + * The intent's name + */ name?: string; + /** + * The intent's score, based on the prediction model. + */ score?: number; } /** - * @class - * Initializes a new instance of the EntityPrediction class. - * @constructor * A suggested entity. - * - * @member {string} entityName The entity's name - * @member {number} startTokenIndex The index within the utterance where the - * extracted entity starts. - * @member {number} endTokenIndex The index within the utterance where the - * extracted entity ends. - * @member {string} phrase The actual token(s) that comprise the entity. - */ +*/ export interface EntityPrediction { + /** + * The entity's name + */ entityName: string; + /** + * The index within the utterance where the extracted entity starts. + */ startTokenIndex: number; + /** + * The index within the utterance where the extracted entity ends. + */ endTokenIndex: number; + /** + * The actual token(s) that comprise the entity. + */ phrase: string; } /** - * @class - * Initializes a new instance of the LabeledUtterance class. - * @constructor * A prediction and label pair of an example. - * - * @member {number} [id] ID of Labeled Utterance. - * @member {string} [text] The utterance. E.g.: what's the weather like in - * seattle? - * @member {array} [tokenizedText] The utterance tokenized. - * @member {string} [intentLabel] The intent matching the example. - * @member {array} [entityLabels] The entities matching the example. - * @member {array} [intentPredictions] List of suggested intents. - * @member {array} [entityPredictions] List of suggested entities. - */ +*/ export interface LabeledUtterance { + /** + * ID of Labeled Utterance. + */ id?: number; + /** + * The utterance. E.g.: what's the weather like in seattle? + */ text?: string; + /** + * The utterance tokenized. + */ tokenizedText?: string[]; + /** + * The intent matching the example. + */ intentLabel?: string; + /** + * The entities matching the example. + */ entityLabels?: EntityLabel[]; + /** + * List of suggested intents. + */ intentPredictions?: IntentPrediction[]; + /** + * List of suggested entities. + */ entityPredictions?: EntityPrediction[]; } /** - * @class - * Initializes a new instance of the IntentsSuggestionExample class. - * @constructor * Predicted/suggested intent. - * - * @member {string} [text] The utterance. E.g.: what's the weather like in - * seattle? - * @member {array} [tokenizedText] The utterance tokenized. - * @member {array} [intentPredictions] Predicted/suggested intents. - * @member {array} [entityPredictions] Predicted/suggested entities. - */ +*/ export interface IntentsSuggestionExample { + /** + * The utterance. E.g.: what's the weather like in seattle? + */ text?: string; + /** + * The utterance tokenized. + */ tokenizedText?: string[]; + /** + * Predicted/suggested intents. + */ intentPredictions?: IntentPrediction[]; + /** + * Predicted/suggested entities. + */ entityPredictions?: EntityPrediction[]; } /** - * @class - * Initializes a new instance of the EntitiesSuggestionExample class. - * @constructor * Predicted/suggested entity. - * - * @member {string} [text] The utterance. E.g.: what's the weather like in - * seattle? - * @member {array} [tokenizedText] The utterance tokenized. - * @member {array} [intentPredictions] Predicted/suggested intents. - * @member {array} [entityPredictions] Predicted/suggested entities. - */ +*/ export interface EntitiesSuggestionExample { + /** + * The utterance. E.g.: what's the weather like in seattle? + */ text?: string; + /** + * The utterance tokenized. + */ tokenizedText?: string[]; + /** + * Predicted/suggested intents. + */ intentPredictions?: IntentPrediction[]; + /** + * Predicted/suggested entities. + */ entityPredictions?: EntityPrediction[]; } /** - * @class - * Initializes a new instance of the PersonalAssistantsResponse class. - * @constructor - * Response containing user's endpoint keys and the endpoint URLs of the - * prebuilt Cortana applications. - * - * @member {array} [endpointKeys] - * @member {object} [endpointUrls] - */ + * Response containing user's endpoint keys and the endpoint URLs of the prebuilt Cortana + * applications. +*/ export interface PersonalAssistantsResponse { endpointKeys?: string[]; endpointUrls?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the ModelInfo class. - * @constructor * Base type used in entity types. - * - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - */ +*/ export interface ModelInfo { + /** + * The ID of the Entity Model. + */ id: string; + /** + * Name of the Entity Model. + */ name?: string; + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType: string; } /** - * @class - * Initializes a new instance of the EntityRole class. - * @constructor * Entity extractor role - * - * @member {uuid} [id] The entity role ID. - * @member {string} [name] The entity role name. - */ +*/ export interface EntityRole { + /** + * The entity role ID. + */ id?: string; + /** + * The entity role name. + */ name?: string; } /** - * @class - * Initializes a new instance of the ChildEntity class. - * @constructor * The base child entity type. - * - * @member {uuid} id The ID (GUID) belonging to a child entity. - * @member {string} [name] The name of a child entity. - */ +*/ export interface ChildEntity { + /** + * The ID (GUID) belonging to a child entity. + */ id: string; + /** + * The name of a child entity. + */ name?: string; } /** - * @class - * Initializes a new instance of the ExplicitListItem class. - * @constructor * Explicit list item - * - * @member {number} [id] The explicit list item ID. - * @member {string} [explicitListItem] The explicit list item value. - */ +*/ export interface ExplicitListItem { + /** + * The explicit list item ID. + */ id?: number; + /** + * The explicit list item value. + */ explicitListItem?: string; } /** - * @class - * Initializes a new instance of the ModelInfoResponse class. - * @constructor * An application model info. - * - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {array} [children] List of child entities. - * @member {array} [subLists] List of sub-lists. - * @member {string} [customPrebuiltDomainName] The domain name. - * @member {string} [customPrebuiltModelName] The intent name or entity name. - * @member {string} [regexPattern] The Regex entity pattern. - * @member {array} [explicitList] - */ +*/ export interface ModelInfoResponse { + /** + * The ID of the Entity Model. + */ id: string; + /** + * Name of the Entity Model. + */ name?: string; + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType: string; roles?: EntityRole[]; + /** + * List of child entities. + */ children?: ChildEntity[]; + /** + * List of sub-lists. + */ subLists?: SubClosedListResponse[]; + /** + * The domain name. + */ customPrebuiltDomainName?: string; + /** + * The intent name or entity name. + */ customPrebuiltModelName?: string; + /** + * The Regex entity pattern. + */ regexPattern?: string; explicitList?: ExplicitListItem[]; } /** - * @class - * Initializes a new instance of the EntityModelInfo class. - * @constructor * An Entity Extractor model info. - * - * @member {array} [roles] - */ +*/ export interface EntityModelInfo extends ModelInfo { roles?: EntityRole[]; } /** - * @class - * Initializes a new instance of the HierarchicalEntityExtractor class. - * @constructor * Hierarchical Entity Extractor. - * - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {array} [children] List of child entities. - */ +*/ export interface HierarchicalEntityExtractor { + /** + * The ID of the Entity Model. + */ id: string; + /** + * Name of the Entity Model. + */ name?: string; + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType: string; roles?: EntityRole[]; + /** + * List of child entities. + */ children?: ChildEntity[]; } /** - * @class - * Initializes a new instance of the CompositeEntityExtractor class. - * @constructor * A Composite Entity Extractor. - * - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {array} [children] List of child entities. - */ +*/ export interface CompositeEntityExtractor { + /** + * The ID of the Entity Model. + */ id: string; + /** + * Name of the Entity Model. + */ name?: string; + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType: string; roles?: EntityRole[]; + /** + * List of child entities. + */ children?: ChildEntity[]; } /** - * @class - * Initializes a new instance of the ClosedListEntityExtractor class. - * @constructor * Closed List Entity Extractor. - * - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {array} [subLists] List of sub-lists. - */ +*/ export interface ClosedListEntityExtractor { + /** + * The ID of the Entity Model. + */ id: string; + /** + * Name of the Entity Model. + */ name?: string; + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType: string; roles?: EntityRole[]; + /** + * List of sub-lists. + */ subLists?: SubClosedListResponse[]; } /** - * @class - * Initializes a new instance of the PrebuiltEntityExtractor class. - * @constructor * Prebuilt Entity Extractor. - * - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - */ +*/ export interface PrebuiltEntityExtractor { + /** + * The ID of the Entity Model. + */ id: string; + /** + * Name of the Entity Model. + */ name?: string; + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType: string; roles?: EntityRole[]; } /** - * @class - * Initializes a new instance of the HierarchicalChildEntity class. - * @constructor * A Hierarchical Child Entity. - * - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} [readableType] Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - */ +*/ export interface HierarchicalChildEntity extends ChildEntity { + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType?: string; } /** - * @class - * Initializes a new instance of the CustomPrebuiltModel class. - * @constructor * A Custom Prebuilt model. - * - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {string} [customPrebuiltDomainName] The domain name. - * @member {string} [customPrebuiltModelName] The intent name or entity name. - * @member {array} [roles] - */ +*/ export interface CustomPrebuiltModel { + /** + * The ID of the Entity Model. + */ id: string; + /** + * Name of the Entity Model. + */ name?: string; + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType: string; + /** + * The domain name. + */ customPrebuiltDomainName?: string; + /** + * The intent name or entity name. + */ customPrebuiltModelName?: string; roles?: EntityRole[]; } /** - * @class - * Initializes a new instance of the IntentClassifier class. - * @constructor * Intent Classifier. - * - * @member {string} [customPrebuiltDomainName] The domain name. - * @member {string} [customPrebuiltModelName] The intent name or entity name. - */ +*/ export interface IntentClassifier extends ModelInfo { + /** + * The domain name. + */ customPrebuiltDomainName?: string; + /** + * The intent name or entity name. + */ customPrebuiltModelName?: string; } /** - * @class - * Initializes a new instance of the EntityExtractor class. - * @constructor * Entity Extractor. - * - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {string} [customPrebuiltDomainName] The domain name. - * @member {string} [customPrebuiltModelName] The intent name or entity name. - */ +*/ export interface EntityExtractor { + /** + * The ID of the Entity Model. + */ id: string; + /** + * Name of the Entity Model. + */ name?: string; + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType: string; roles?: EntityRole[]; + /** + * The domain name. + */ customPrebuiltDomainName?: string; + /** + * The intent name or entity name. + */ customPrebuiltModelName?: string; } /** - * @class - * Initializes a new instance of the FeatureInfoObject class. - * @constructor * The base class Features-related response objects inherit from. - * - * @member {number} [id] A six-digit ID used for Features. - * @member {string} [name] The name of the Feature. - * @member {boolean} [isActive] Indicates if the feature is enabled. - */ +*/ export interface FeatureInfoObject { + /** + * A six-digit ID used for Features. + */ id?: number; + /** + * The name of the Feature. + */ name?: string; + /** + * Indicates if the feature is enabled. + */ isActive?: boolean; } /** - * @class - * Initializes a new instance of the PhraseListFeatureInfo class. - * @constructor * Phraselist Feature. - * - * @member {string} [phrases] A list of comma-separated values. - * @member {boolean} [isExchangeable] An exchangeable phrase list feature are - * serves as single feature to the LUIS underlying training algorithm. It is - * used as a lexicon lookup feature where its value is 1 if the lexicon - * contains a given word or 0 if it doesn’t. Think of an exchangeable as a - * synonyms list. A non-exchangeable phrase list feature has all the phrases in - * the list serve as separate features to the underlying training algorithm. - * So, if you your phrase list feature contains 5 phrases, they will be mapped - * to 5 separate features. You can think of the non-exchangeable phrase list - * feature as an additional bag of words that you are willing to add to LUIS - * existing vocabulary features. Think of a non-exchangeable as set of - * different words. Default value is true. - */ +*/ export interface PhraseListFeatureInfo extends FeatureInfoObject { + /** + * A list of comma-separated values. + */ phrases?: string; + /** + * An exchangeable phrase list feature are serves as single feature to the LUIS underlying + * training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon + * contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A + * non-exchangeable phrase list feature has all the phrases in the list serve as separate + * features to the underlying training algorithm. So, if you your phrase list feature contains 5 + * phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable + * phrase list feature as an additional bag of words that you are willing to add to LUIS existing + * vocabulary features. Think of a non-exchangeable as set of different words. Default value is + * true. + */ isExchangeable?: boolean; } /** - * @class - * Initializes a new instance of the PatternFeatureInfo class. - * @constructor * Pattern feature. - * - * @member {string} [pattern] The Regular Expression to match. - */ +*/ export interface PatternFeatureInfo extends FeatureInfoObject { + /** + * The Regular Expression to match. + */ pattern?: string; } /** - * @class - * Initializes a new instance of the FeaturesResponseObject class. - * @constructor * Model Features, including Patterns and Phraselists. - * - * @member {array} [phraselistFeatures] - * @member {array} [patternFeatures] - */ +*/ export interface FeaturesResponseObject { phraselistFeatures?: PhraseListFeatureInfo[]; patternFeatures?: PatternFeatureInfo[]; } /** - * @class - * Initializes a new instance of the LabelExampleResponse class. - * @constructor * Response when adding a labeled example. - * - * @member {string} [utteranceText] The sample's utterance. - * @member {number} [exampleId] The newly created sample ID. - */ +*/ export interface LabelExampleResponse { + /** + * The sample's utterance. + */ utteranceText?: string; + /** + * The newly created sample ID. + */ exampleId?: number; } /** - * @class - * Initializes a new instance of the OperationStatus class. - * @constructor * Response of an Operation status. - * - * @member {string} [code] Status Code. Possible values include: 'Failed', - * 'FAILED', 'Success' - * @member {string} [message] Status details. - */ +*/ export interface OperationStatus { + /** + * Status Code. Possible values include: 'Failed', 'FAILED', 'Success' + */ code?: string; + /** + * Status details. + */ message?: string; } /** - * @class - * Initializes a new instance of the BatchLabelExample class. - * @constructor * Response when adding a batch of labeled examples. - * - * @member {object} [value] - * @member {string} [value.utteranceText] The sample's utterance. - * @member {number} [value.exampleId] The newly created sample ID. - * @member {boolean} [hasError] - * @member {object} [error] - * @member {string} [error.code] Status Code. Possible values include: - * 'Failed', 'FAILED', 'Success' - * @member {string} [error.message] Status details. - */ +*/ export interface BatchLabelExample { value?: LabelExampleResponse; hasError?: boolean; @@ -1245,273 +1257,257 @@ export interface BatchLabelExample { } /** - * @class - * Initializes a new instance of the ApplicationInfoResponse class. - * @constructor * Response containing the Application Info. - * - * @member {uuid} [id] The ID (GUID) of the application. - * @member {string} [name] The name of the application. - * @member {string} [description] The description of the application. - * @member {string} [culture] The culture of the application. E.g.: en-us. - * @member {string} [usageScenario] Defines the scenario for the new - * application. Optional. E.g.: IoT. - * @member {string} [domain] The domain for the new application. Optional. - * E.g.: Comics. - * @member {number} [versionsCount] Amount of model versions within the - * application. - * @member {string} [createdDateTime] The version's creation timestamp. - * @member {object} [endpoints] The Runtime endpoint URL for this model - * version. - * @member {number} [endpointHitsCount] Number of calls made to this endpoint. - * @member {string} [activeVersion] The version ID currently marked as active. - */ +*/ export interface ApplicationInfoResponse { + /** + * The ID (GUID) of the application. + */ id?: string; + /** + * The name of the application. + */ name?: string; + /** + * The description of the application. + */ description?: string; + /** + * The culture of the application. E.g.: en-us. + */ culture?: string; + /** + * Defines the scenario for the new application. Optional. E.g.: IoT. + */ usageScenario?: string; + /** + * The domain for the new application. Optional. E.g.: Comics. + */ domain?: string; + /** + * Amount of model versions within the application. + */ versionsCount?: number; + /** + * The version's creation timestamp. + */ createdDateTime?: string; + /** + * The Runtime endpoint URL for this model version. + */ endpoints?: any; + /** + * Number of calls made to this endpoint. + */ endpointHitsCount?: number; + /** + * The version ID currently marked as active. + */ activeVersion?: string; } /** - * @class - * Initializes a new instance of the EndpointInfo class. - * @constructor * The base class "ProductionOrStagingEndpointInfo" inherits from. - * - * @member {string} [versionId] The version ID to publish. - * @member {boolean} [isStaging] Indicates if the staging slot should be used, - * instead of the Production one. - * @member {string} [endpointUrl] The Runtime endpoint URL for this model - * version. - * @member {string} [region] The target region that the application is - * published to. - * @member {string} [assignedEndpointKey] The endpoint key. - * @member {string} [endpointRegion] The endpoint's region. - * @member {string} [publishedDateTime] Timestamp when was last published. - */ +*/ export interface EndpointInfo { + /** + * The version ID to publish. + */ versionId?: string; + /** + * Indicates if the staging slot should be used, instead of the Production one. + */ isStaging?: boolean; + /** + * The Runtime endpoint URL for this model version. + */ endpointUrl?: string; + /** + * The target region that the application is published to. + */ region?: string; + /** + * The endpoint key. + */ assignedEndpointKey?: string; + /** + * The endpoint's region. + */ endpointRegion?: string; + /** + * Timestamp when was last published. + */ publishedDateTime?: string; } -/** - * @class - * Initializes a new instance of the ProductionOrStagingEndpointInfo class. - * @constructor - */ export interface ProductionOrStagingEndpointInfo extends EndpointInfo { } /** - * @class - * Initializes a new instance of the AvailableCulture class. - * @constructor * Available culture for using in a new application. - * - * @member {string} [name] The language name. - * @member {string} [code] The ISO value for the language. - */ +*/ export interface AvailableCulture { + /** + * The language name. + */ name?: string; + /** + * The ISO value for the language. + */ code?: string; } /** - * @class - * Initializes a new instance of the ApplicationSettings class. - * @constructor * The application settings. - * - * @member {uuid} id The application ID. - * @member {boolean} isPublic Setting your application as public allows other - * people to use your application's endpoint using their own keys. - */ +*/ export interface ApplicationSettings { + /** + * The application ID. + */ id: string; + /** + * Setting your application as public allows other people to use your application's endpoint + * using their own keys. + */ isPublic: boolean; } /** - * @class - * Initializes a new instance of the PublishSettings class. - * @constructor * The application publish settings. - * - * @member {uuid} id The application ID. - * @member {boolean} isSentimentAnalysisEnabled Setting sentiment analysis as - * true returns the Sentiment of the input utterance along with the resopnse - * @member {boolean} isSpeechEnabled Setting speech as public enables speech - * priming in your app - * @member {boolean} isSpellCheckerEnabled Setting spell checker as public - * enables spell checking the input utterance. - */ +*/ export interface PublishSettings { + /** + * The application ID. + */ id: string; + /** + * Setting sentiment analysis as true returns the Sentiment of the input utterance along with the + * resopnse + */ isSentimentAnalysisEnabled: boolean; + /** + * Setting speech as public enables speech priming in your app + */ isSpeechEnabled: boolean; + /** + * Setting spell checker as public enables spell checking the input utterance. + */ isSpellCheckerEnabled: boolean; } /** - * @class - * Initializes a new instance of the AvailablePrebuiltEntityModel class. - * @constructor * Available Prebuilt entity model for using in an application. - * - * @member {string} [name] The entity name. - * @member {string} [description] The entity description and usage information. - * @member {string} [examples] Usage examples. - */ +*/ export interface AvailablePrebuiltEntityModel { + /** + * The entity name. + */ name?: string; + /** + * The entity description and usage information. + */ description?: string; + /** + * Usage examples. + */ examples?: string; } /** - * @class - * Initializes a new instance of the EnqueueTrainingResponse class. - * @constructor * Response model when requesting to train the model. - * - * @member {number} [statusId] The train request status ID. - * @member {string} [status] Possible values include: 'Queued', 'InProgress', - * 'UpToDate', 'Fail', 'Success' - */ +*/ export interface EnqueueTrainingResponse { + /** + * The train request status ID. + */ statusId?: number; + /** + * Possible values include: 'Queued', 'InProgress', 'UpToDate', 'Fail', 'Success' + */ status?: string; } /** - * @class - * Initializes a new instance of the ModelTrainingDetails class. - * @constructor * Model Training Details. - * - * @member {number} [statusId] The train request status ID. - * @member {string} [status] Possible values include: 'Queued', 'InProgress', - * 'UpToDate', 'Fail', 'Success' - * @member {number} [exampleCount] The count of examples used to train the - * model. - * @member {date} [trainingDateTime] When the model was trained. - * @member {string} [failureReason] Reason for the training failure. - */ +*/ export interface ModelTrainingDetails { + /** + * The train request status ID. + */ statusId?: number; + /** + * Possible values include: 'Queued', 'InProgress', 'UpToDate', 'Fail', 'Success' + */ status?: string; + /** + * The count of examples used to train the model. + */ exampleCount?: number; + /** + * When the model was trained. + */ trainingDateTime?: Date; + /** + * Reason for the training failure. + */ failureReason?: string; } /** - * @class - * Initializes a new instance of the ModelTrainingInfo class. - * @constructor * Model Training Info. - * - * @member {uuid} [modelId] The ID (GUID) of the model. - * @member {object} [details] - * @member {number} [details.statusId] The train request status ID. - * @member {string} [details.status] Possible values include: 'Queued', - * 'InProgress', 'UpToDate', 'Fail', 'Success' - * @member {number} [details.exampleCount] The count of examples used to train - * the model. - * @member {date} [details.trainingDateTime] When the model was trained. - * @member {string} [details.failureReason] Reason for the training failure. - */ +*/ export interface ModelTrainingInfo { + /** + * The ID (GUID) of the model. + */ modelId?: string; details?: ModelTrainingDetails; } /** - * @class - * Initializes a new instance of the UserAccessList class. - * @constructor * List of user permissions. - * - * @member {string} [owner] The email address of owner of the application. - * @member {array} [emails] - */ +*/ export interface UserAccessList { + /** + * The email address of owner of the application. + */ owner?: string; emails?: string[]; } -/** - * @class - * Initializes a new instance of the UserCollaborator class. - * @constructor - * @member {string} [email] The email address of the user. - */ export interface UserCollaborator { + /** + * The email address of the user. + */ email?: string; } -/** - * @class - * Initializes a new instance of the CollaboratorsArray class. - * @constructor - * @member {array} [emails] The email address of the users. - */ export interface CollaboratorsArray { + /** + * The email address of the users. + */ emails?: string[]; } /** - * @class - * Initializes a new instance of the ErrorResponse class. - * @constructor * Error response when invoking an operation on the API. - * - * @member {string} [errorType] - */ +*/ export interface ErrorResponse { errorType?: 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 OperationError class. - * @constructor * Operation error details when invoking an operation on the API. - * - * @member {string} [code] - * @member {string} [message] - */ +*/ export interface OperationError { code?: string; message?: string; } -/** - * @class - * Initializes a new instance of the PrebuiltDomainItem class. - * @constructor - * @member {string} [name] - * @member {string} [description] - * @member {string} [examples] - */ export interface PrebuiltDomainItem { name?: string; description?: string; @@ -1519,18 +1515,8 @@ export interface PrebuiltDomainItem { } /** - * @class - * Initializes a new instance of the PrebuiltDomain class. - * @constructor * Prebuilt Domain. - * - * @member {string} [name] - * @member {string} [culture] - * @member {string} [description] - * @member {string} [examples] - * @member {array} [intents] - * @member {array} [entities] - */ +*/ export interface PrebuiltDomain { name?: string; culture?: string; @@ -1541,247 +1527,244 @@ export interface PrebuiltDomain { } /** - * @class - * Initializes a new instance of the EntityRoleCreateObject class. - * @constructor * Object model for creating an entity role. - * - * @member {string} [name] The entity role name. - */ +*/ export interface EntityRoleCreateObject { + /** + * The entity role name. + */ name?: string; } /** - * @class - * Initializes a new instance of the RegexModelCreateObject class. - * @constructor * Model object for creating a regex entity model. - * - * @member {string} [regexPattern] The regex entity pattern. - * @member {string} [name] The model name. - */ +*/ export interface RegexModelCreateObject { + /** + * The regex entity pattern. + */ regexPattern?: string; + /** + * The model name. + */ name?: string; } /** - * @class - * Initializes a new instance of the PatternAnyModelCreateObject class. - * @constructor * Model object for creating a Pattern.Any entity model. - * - * @member {string} [name] The model name. - * @member {array} [explicitList] The Pattern.Any explicit list. - */ +*/ export interface PatternAnyModelCreateObject { + /** + * The model name. + */ name?: string; + /** + * The Pattern.Any explicit list. + */ explicitList?: string[]; } /** - * @class - * Initializes a new instance of the ExplicitListItemCreateObject class. - * @constructor * Object model for creating an explicit list item. - * - * @member {string} [explicitListItem] The explicit list item. - */ +*/ export interface ExplicitListItemCreateObject { + /** + * The explicit list item. + */ explicitListItem?: string; } /** - * @class - * Initializes a new instance of the RegexModelUpdateObject class. - * @constructor * Model object for updating a regex entity model. - * - * @member {string} [regexPattern] The regex entity pattern. - * @member {string} [name] The model name. - */ +*/ export interface RegexModelUpdateObject { + /** + * The regex entity pattern. + */ regexPattern?: string; + /** + * The model name. + */ name?: string; } /** - * @class - * Initializes a new instance of the PatternAnyModelUpdateObject class. - * @constructor * Model object for updating a Pattern.Any entity model. - * - * @member {string} [name] The model name. - * @member {array} [explicitList] The Pattern.Any explicit list. - */ +*/ export interface PatternAnyModelUpdateObject { + /** + * The model name. + */ name?: string; + /** + * The Pattern.Any explicit list. + */ explicitList?: string[]; } /** - * @class - * Initializes a new instance of the EntityRoleUpdateObject class. - * @constructor * Object model for updating an entity role. - * - * @member {string} [name] The entity role name. - */ +*/ export interface EntityRoleUpdateObject { + /** + * The entity role name. + */ name?: string; } /** - * @class - * Initializes a new instance of the ExplicitListItemUpdateObject class. - * @constructor * Model object for updating an explicit list item. - * - * @member {string} [explicitListItem] The explicit list item. - */ +*/ export interface ExplicitListItemUpdateObject { + /** + * The explicit list item. + */ explicitListItem?: string; } /** - * @class - * Initializes a new instance of the PatternRuleCreateObject class. - * @constructor * Object model for creating a pattern - * - * @member {string} [pattern] The pattern text. - * @member {string} [intent] The intent's name which the pattern belongs to. - */ +*/ export interface PatternRuleCreateObject { + /** + * The pattern text. + */ pattern?: string; + /** + * The intent's name which the pattern belongs to. + */ intent?: string; } /** - * @class - * Initializes a new instance of the PatternRuleUpdateObject class. - * @constructor * Object model for updating a pattern. - * - * @member {uuid} [id] The pattern ID. - * @member {string} [pattern] The pattern text. - * @member {string} [intent] The intent's name which the pattern belongs to. - */ +*/ export interface PatternRuleUpdateObject { + /** + * The pattern ID. + */ id?: string; + /** + * The pattern text. + */ pattern?: string; + /** + * The intent's name which the pattern belongs to. + */ intent?: string; } /** - * @class - * Initializes a new instance of the RegexEntityExtractor class. - * @constructor * Regex Entity Extractor. - * - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {string} [regexPattern] The Regex entity pattern. - */ +*/ export interface RegexEntityExtractor { + /** + * The ID of the Entity Model. + */ id: string; + /** + * Name of the Entity Model. + */ name?: string; + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType: string; roles?: EntityRole[]; + /** + * The Regex entity pattern. + */ regexPattern?: string; } /** - * @class - * Initializes a new instance of the PatternAnyEntityExtractor class. - * @constructor * Pattern.Any Entity Extractor. - * - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {array} [explicitList] - */ +*/ export interface PatternAnyEntityExtractor { + /** + * The ID of the Entity Model. + */ id: string; + /** + * Name of the Entity Model. + */ name?: string; + /** + * The type ID of the Entity Model. + */ typeId?: number; + /** + * Possible values include: 'Entity Extractor', 'Hierarchical Entity Extractor', 'Hierarchical + * Child Entity Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', 'Regex + * Entity Extractor' + */ readableType: string; roles?: EntityRole[]; explicitList?: ExplicitListItem[]; } /** - * @class - * Initializes a new instance of the PatternRuleInfo class. - * @constructor * Pattern rule - * - * @member {uuid} [id] The pattern ID. - * @member {string} [pattern] The pattern text. - * @member {string} [intent] The intent's name where the pattern belongs to. - */ +*/ export interface PatternRuleInfo { + /** + * The pattern ID. + */ id?: string; + /** + * The pattern text. + */ pattern?: string; + /** + * The intent's name where the pattern belongs to. + */ intent?: string; } /** - * @class - * Initializes a new instance of the LabelTextObject class. - * @constructor * An object containing the example's text. - * - * @member {number} [id] The ID of the Label. - * @member {string} [text] The text of the label. - */ +*/ export interface LabelTextObject { + /** + * The ID of the Label. + */ id?: number; + /** + * The text of the label. + */ text?: string; } /** - * @class - * Initializes a new instance of the HierarchicalChildModelUpdateObject class. - * @constructor - * @member {string} [name] - */ + * Object model of an application version setting. +*/ +export interface AppVersionSettingObject { + /** + * The application version setting name. + */ + name?: string; + /** + * The application version setting value. + */ + value?: string; +} + export interface HierarchicalChildModelUpdateObject { name?: string; } -/** - * @class - * Initializes a new instance of the HierarchicalChildModelCreateObject class. - * @constructor - * @member {string} [name] - */ export interface HierarchicalChildModelCreateObject { name?: string; } -/** - * @class - * Initializes a new instance of the CompositeChildModelCreateObject class. - * @constructor - * @member {string} [name] - */ export interface CompositeChildModelCreateObject { name?: string; } diff --git a/lib/services/luis/authoring/lib/models/index.js b/lib/services/luis/authoring/lib/models/index.js index ea15399868..2063beae51 100644 --- a/lib/services/luis/authoring/lib/models/index.js +++ b/lib/services/luis/authoring/lib/models/index.js @@ -112,6 +112,7 @@ exports.RegexEntityExtractor = require('./regexEntityExtractor'); exports.PatternAnyEntityExtractor = require('./patternAnyEntityExtractor'); exports.PatternRuleInfo = require('./patternRuleInfo'); exports.LabelTextObject = require('./labelTextObject'); +exports.AppVersionSettingObject = require('./appVersionSettingObject'); exports.HierarchicalChildModelUpdateObject = require('./hierarchicalChildModelUpdateObject'); exports.HierarchicalChildModelCreateObject = require('./hierarchicalChildModelCreateObject'); exports.CompositeChildModelCreateObject = require('./compositeChildModelCreateObject'); diff --git a/lib/services/luis/authoring/lib/models/intentClassifier.js b/lib/services/luis/authoring/lib/models/intentClassifier.js index 2e80d54c27..6c7b2363ed 100644 --- a/lib/services/luis/authoring/lib/models/intentClassifier.js +++ b/lib/services/luis/authoring/lib/models/intentClassifier.js @@ -20,8 +20,9 @@ const models = require('./index'); class IntentClassifier extends models['ModelInfo'] { /** * Create a IntentClassifier. - * @member {string} [customPrebuiltDomainName] The domain name. - * @member {string} [customPrebuiltModelName] The intent name or entity name. + * @property {string} [customPrebuiltDomainName] The domain name. + * @property {string} [customPrebuiltModelName] The intent name or entity + * name. */ constructor() { super(); diff --git a/lib/services/luis/authoring/lib/models/intentPrediction.js b/lib/services/luis/authoring/lib/models/intentPrediction.js index f78c55b92c..b61e2ea0b9 100644 --- a/lib/services/luis/authoring/lib/models/intentPrediction.js +++ b/lib/services/luis/authoring/lib/models/intentPrediction.js @@ -17,8 +17,8 @@ class IntentPrediction { /** * Create a IntentPrediction. - * @member {string} [name] The intent's name - * @member {number} [score] The intent's score, based on the prediction + * @property {string} [name] The intent's name + * @property {number} [score] The intent's score, based on the prediction * model. */ constructor() { diff --git a/lib/services/luis/authoring/lib/models/intentsSuggestionExample.js b/lib/services/luis/authoring/lib/models/intentsSuggestionExample.js index f3e9680d86..f656540e27 100644 --- a/lib/services/luis/authoring/lib/models/intentsSuggestionExample.js +++ b/lib/services/luis/authoring/lib/models/intentsSuggestionExample.js @@ -17,11 +17,11 @@ class IntentsSuggestionExample { /** * Create a IntentsSuggestionExample. - * @member {string} [text] The utterance. E.g.: what's the weather like in + * @property {string} [text] The utterance. E.g.: what's the weather like in * seattle? - * @member {array} [tokenizedText] The utterance tokenized. - * @member {array} [intentPredictions] Predicted/suggested intents. - * @member {array} [entityPredictions] Predicted/suggested entities. + * @property {array} [tokenizedText] The utterance tokenized. + * @property {array} [intentPredictions] Predicted/suggested intents. + * @property {array} [entityPredictions] Predicted/suggested entities. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/jSONEntity.js b/lib/services/luis/authoring/lib/models/jSONEntity.js index 58685602f1..5ddede4377 100644 --- a/lib/services/luis/authoring/lib/models/jSONEntity.js +++ b/lib/services/luis/authoring/lib/models/jSONEntity.js @@ -17,11 +17,11 @@ class JSONEntity { /** * Create a JSONEntity. - * @member {number} startPos The index within the utterance where the + * @property {number} startPos The index within the utterance where the * extracted entity starts. - * @member {number} endPos The index within the utterance where the extracted - * entity ends. - * @member {string} entity The entity name. + * @property {number} endPos The index within the utterance where the + * extracted entity ends. + * @property {string} entity The entity name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/jSONModelFeature.js b/lib/services/luis/authoring/lib/models/jSONModelFeature.js index 6d239a7977..c31e65aecd 100644 --- a/lib/services/luis/authoring/lib/models/jSONModelFeature.js +++ b/lib/services/luis/authoring/lib/models/jSONModelFeature.js @@ -17,13 +17,13 @@ class JSONModelFeature { /** * Create a JSONModelFeature. - * @member {boolean} [activated] Indicates if the feature is enabled. - * @member {string} [name] The Phraselist name. - * @member {string} [words] List of comma-separated phrases that represent + * @property {boolean} [activated] Indicates if the feature is enabled. + * @property {string} [name] The Phraselist name. + * @property {string} [words] List of comma-separated phrases that represent * the Phraselist. - * @member {boolean} [mode] An exchangeable phrase list feature are serves as - * single feature to the LUIS underlying training algorithm. It is used as a - * lexicon lookup feature where its value is 1 if the lexicon contains a + * @property {boolean} [mode] An exchangeable phrase list feature are serves + * as single feature to the LUIS underlying training algorithm. It is used as + * a lexicon lookup feature where its value is 1 if the lexicon contains a * given word or 0 if it doesn’t. Think of an exchangeable as a synonyms * list. A non-exchangeable phrase list feature has all the phrases in the * list serve as separate features to the underlying training algorithm. So, diff --git a/lib/services/luis/authoring/lib/models/jSONRegexFeature.js b/lib/services/luis/authoring/lib/models/jSONRegexFeature.js index abe470edbd..f067aa2a8f 100644 --- a/lib/services/luis/authoring/lib/models/jSONRegexFeature.js +++ b/lib/services/luis/authoring/lib/models/jSONRegexFeature.js @@ -17,9 +17,10 @@ class JSONRegexFeature { /** * Create a JSONRegexFeature. - * @member {string} [pattern] The Regular Expression to match. - * @member {boolean} [activated] Indicates if the Pattern feature is enabled. - * @member {string} [name] Name of the feature. + * @property {string} [pattern] The Regular Expression to match. + * @property {boolean} [activated] Indicates if the Pattern feature is + * enabled. + * @property {string} [name] Name of the feature. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/jSONUtterance.js b/lib/services/luis/authoring/lib/models/jSONUtterance.js index e9cbc3c64f..bad61af840 100644 --- a/lib/services/luis/authoring/lib/models/jSONUtterance.js +++ b/lib/services/luis/authoring/lib/models/jSONUtterance.js @@ -17,9 +17,9 @@ class JSONUtterance { /** * Create a JSONUtterance. - * @member {string} [text] The utterance. - * @member {string} [intent] The matched intent. - * @member {array} [entities] The matched entities. + * @property {string} [text] The utterance. + * @property {string} [intent] The matched intent. + * @property {array} [entities] The matched entities. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/labelExampleResponse.js b/lib/services/luis/authoring/lib/models/labelExampleResponse.js index bdb0ef81ef..794ba14459 100644 --- a/lib/services/luis/authoring/lib/models/labelExampleResponse.js +++ b/lib/services/luis/authoring/lib/models/labelExampleResponse.js @@ -17,8 +17,8 @@ class LabelExampleResponse { /** * Create a LabelExampleResponse. - * @member {string} [utteranceText] The sample's utterance. - * @member {number} [exampleId] The newly created sample ID. + * @property {string} [utteranceText] The sample's utterance. + * @property {number} [exampleId] The newly created sample ID. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/labelTextObject.js b/lib/services/luis/authoring/lib/models/labelTextObject.js index 2aa5876cf5..ae26343945 100644 --- a/lib/services/luis/authoring/lib/models/labelTextObject.js +++ b/lib/services/luis/authoring/lib/models/labelTextObject.js @@ -17,8 +17,8 @@ class LabelTextObject { /** * Create a LabelTextObject. - * @member {number} [id] The ID of the Label. - * @member {string} [text] The text of the label. + * @property {number} [id] The ID of the Label. + * @property {string} [text] The text of the label. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/labeledUtterance.js b/lib/services/luis/authoring/lib/models/labeledUtterance.js index ecee78611a..e1c2b8ef7c 100644 --- a/lib/services/luis/authoring/lib/models/labeledUtterance.js +++ b/lib/services/luis/authoring/lib/models/labeledUtterance.js @@ -17,14 +17,14 @@ class LabeledUtterance { /** * Create a LabeledUtterance. - * @member {number} [id] ID of Labeled Utterance. - * @member {string} [text] The utterance. E.g.: what's the weather like in + * @property {number} [id] ID of Labeled Utterance. + * @property {string} [text] The utterance. E.g.: what's the weather like in * seattle? - * @member {array} [tokenizedText] The utterance tokenized. - * @member {string} [intentLabel] The intent matching the example. - * @member {array} [entityLabels] The entities matching the example. - * @member {array} [intentPredictions] List of suggested intents. - * @member {array} [entityPredictions] List of suggested entities. + * @property {array} [tokenizedText] The utterance tokenized. + * @property {string} [intentLabel] The intent matching the example. + * @property {array} [entityLabels] The entities matching the example. + * @property {array} [intentPredictions] List of suggested intents. + * @property {array} [entityPredictions] List of suggested entities. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/luisApp.js b/lib/services/luis/authoring/lib/models/luisApp.js index 1491b7a1cd..516a7e6823 100644 --- a/lib/services/luis/authoring/lib/models/luisApp.js +++ b/lib/services/luis/authoring/lib/models/luisApp.js @@ -17,22 +17,22 @@ class LuisApp { /** * Create a LuisApp. - * @member {string} [name] The name of the application. - * @member {string} [versionId] The version ID of the application that was + * @property {string} [name] The name of the application. + * @property {string} [versionId] The version ID of the application that was * exported. - * @member {string} [desc] The description of the application. - * @member {string} [culture] The culture of the application. E.g.: en-us. - * @member {array} [intents] List of intents. - * @member {array} [entities] List of entities. - * @member {array} [closedLists] List of closed lists. - * @member {array} [composites] List of composite entities. - * @member {array} [patternAnyEntities] List of Pattern.Any entities. - * @member {array} [regexEntities] List of regular expression entities. - * @member {array} [prebuiltEntities] List of prebuilt entities. - * @member {array} [regexFeatures] List of pattern features. - * @member {array} [modelFeatures] List of model features. - * @member {array} [patterns] List of patterns. - * @member {array} [utterances] List of sample utterances. + * @property {string} [desc] The description of the application. + * @property {string} [culture] The culture of the application. E.g.: en-us. + * @property {array} [intents] List of intents. + * @property {array} [entities] List of entities. + * @property {array} [closedLists] List of closed lists. + * @property {array} [composites] List of composite entities. + * @property {array} [patternAnyEntities] List of Pattern.Any entities. + * @property {array} [regexEntities] List of regular expression entities. + * @property {array} [prebuiltEntities] List of prebuilt entities. + * @property {array} [regexFeatures] List of pattern features. + * @property {array} [modelFeatures] List of model features. + * @property {array} [patterns] List of patterns. + * @property {array} [utterances] List of sample utterances. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/modelCreateObject.js b/lib/services/luis/authoring/lib/models/modelCreateObject.js index 8e22df1cbb..bf7240e091 100644 --- a/lib/services/luis/authoring/lib/models/modelCreateObject.js +++ b/lib/services/luis/authoring/lib/models/modelCreateObject.js @@ -17,7 +17,7 @@ class ModelCreateObject { /** * Create a ModelCreateObject. - * @member {string} [name] Name of the new entity extractor. + * @property {string} [name] Name of the new entity extractor. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/modelInfo.js b/lib/services/luis/authoring/lib/models/modelInfo.js index 205acabacd..f6795bf7de 100644 --- a/lib/services/luis/authoring/lib/models/modelInfo.js +++ b/lib/services/luis/authoring/lib/models/modelInfo.js @@ -17,14 +17,14 @@ class ModelInfo { /** * Create a ModelInfo. - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' + * @property {uuid} id The ID of the Entity Model. + * @property {string} [name] Name of the Entity Model. + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} readableType Possible values include: 'Entity + * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity + * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity + * Extractor', 'Regex Entity Extractor' */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/modelInfoResponse.js b/lib/services/luis/authoring/lib/models/modelInfoResponse.js index 24d22adbf7..b7ef2b50ed 100644 --- a/lib/services/luis/authoring/lib/models/modelInfoResponse.js +++ b/lib/services/luis/authoring/lib/models/modelInfoResponse.js @@ -17,21 +17,22 @@ class ModelInfoResponse { /** * Create a ModelInfoResponse. - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {array} [children] List of child entities. - * @member {array} [subLists] List of sub-lists. - * @member {string} [customPrebuiltDomainName] The domain name. - * @member {string} [customPrebuiltModelName] The intent name or entity name. - * @member {string} [regexPattern] The Regex entity pattern. - * @member {array} [explicitList] + * @property {uuid} id The ID of the Entity Model. + * @property {string} [name] Name of the Entity Model. + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} readableType Possible values include: 'Entity + * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity + * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity + * Extractor', 'Regex Entity Extractor' + * @property {array} [roles] + * @property {array} [children] List of child entities. + * @property {array} [subLists] List of sub-lists. + * @property {string} [customPrebuiltDomainName] The domain name. + * @property {string} [customPrebuiltModelName] The intent name or entity + * name. + * @property {string} [regexPattern] The Regex entity pattern. + * @property {array} [explicitList] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/modelTrainingDetails.js b/lib/services/luis/authoring/lib/models/modelTrainingDetails.js index b27180ecc7..41df61379f 100644 --- a/lib/services/luis/authoring/lib/models/modelTrainingDetails.js +++ b/lib/services/luis/authoring/lib/models/modelTrainingDetails.js @@ -17,13 +17,13 @@ class ModelTrainingDetails { /** * Create a ModelTrainingDetails. - * @member {number} [statusId] The train request status ID. - * @member {string} [status] Possible values include: 'Queued', 'InProgress', - * 'UpToDate', 'Fail', 'Success' - * @member {number} [exampleCount] The count of examples used to train the + * @property {number} [statusId] The train request status ID. + * @property {string} [status] Possible values include: 'Queued', + * 'InProgress', 'UpToDate', 'Fail', 'Success' + * @property {number} [exampleCount] The count of examples used to train the * model. - * @member {date} [trainingDateTime] When the model was trained. - * @member {string} [failureReason] Reason for the training failure. + * @property {date} [trainingDateTime] When the model was trained. + * @property {string} [failureReason] Reason for the training failure. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/modelTrainingInfo.js b/lib/services/luis/authoring/lib/models/modelTrainingInfo.js index d79eff19c9..7acd10bd42 100644 --- a/lib/services/luis/authoring/lib/models/modelTrainingInfo.js +++ b/lib/services/luis/authoring/lib/models/modelTrainingInfo.js @@ -17,15 +17,16 @@ class ModelTrainingInfo { /** * Create a ModelTrainingInfo. - * @member {uuid} [modelId] The ID (GUID) of the model. - * @member {object} [details] - * @member {number} [details.statusId] The train request status ID. - * @member {string} [details.status] Possible values include: 'Queued', + * @property {uuid} [modelId] The ID (GUID) of the model. + * @property {object} [details] + * @property {number} [details.statusId] The train request status ID. + * @property {string} [details.status] Possible values include: 'Queued', * 'InProgress', 'UpToDate', 'Fail', 'Success' - * @member {number} [details.exampleCount] The count of examples used to + * @property {number} [details.exampleCount] The count of examples used to * train the model. - * @member {date} [details.trainingDateTime] When the model was trained. - * @member {string} [details.failureReason] Reason for the training failure. + * @property {date} [details.trainingDateTime] When the model was trained. + * @property {string} [details.failureReason] Reason for the training + * failure. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/modelUpdateObject.js b/lib/services/luis/authoring/lib/models/modelUpdateObject.js index b896f8aa60..793eebb71a 100644 --- a/lib/services/luis/authoring/lib/models/modelUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/modelUpdateObject.js @@ -17,7 +17,7 @@ class ModelUpdateObject { /** * Create a ModelUpdateObject. - * @member {string} [name] The entity's new name. + * @property {string} [name] The entity's new name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/operationError.js b/lib/services/luis/authoring/lib/models/operationError.js index c82ed4ba84..1a4fc1c7b4 100644 --- a/lib/services/luis/authoring/lib/models/operationError.js +++ b/lib/services/luis/authoring/lib/models/operationError.js @@ -17,8 +17,8 @@ class OperationError { /** * Create a OperationError. - * @member {string} [code] - * @member {string} [message] + * @property {string} [code] + * @property {string} [message] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/operationStatus.js b/lib/services/luis/authoring/lib/models/operationStatus.js index 19cab05248..1675f0cac8 100644 --- a/lib/services/luis/authoring/lib/models/operationStatus.js +++ b/lib/services/luis/authoring/lib/models/operationStatus.js @@ -17,9 +17,9 @@ class OperationStatus { /** * Create a OperationStatus. - * @member {string} [code] Status Code. Possible values include: 'Failed', + * @property {string} [code] Status Code. Possible values include: 'Failed', * 'FAILED', 'Success' - * @member {string} [message] Status details. + * @property {string} [message] Status details. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/patternAny.js b/lib/services/luis/authoring/lib/models/patternAny.js index 06e7cb92f8..ba85c23c71 100644 --- a/lib/services/luis/authoring/lib/models/patternAny.js +++ b/lib/services/luis/authoring/lib/models/patternAny.js @@ -17,9 +17,9 @@ class PatternAny { /** * Create a PatternAny. - * @member {string} [name] - * @member {array} [explicitList] - * @member {array} [roles] + * @property {string} [name] + * @property {array} [explicitList] + * @property {array} [roles] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/patternAnyEntityExtractor.js b/lib/services/luis/authoring/lib/models/patternAnyEntityExtractor.js index f75003e387..b68fb922e6 100644 --- a/lib/services/luis/authoring/lib/models/patternAnyEntityExtractor.js +++ b/lib/services/luis/authoring/lib/models/patternAnyEntityExtractor.js @@ -17,16 +17,16 @@ class PatternAnyEntityExtractor { /** * Create a PatternAnyEntityExtractor. - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {array} [explicitList] + * @property {uuid} id The ID of the Entity Model. + * @property {string} [name] Name of the Entity Model. + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} readableType Possible values include: 'Entity + * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity + * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity + * Extractor', 'Regex Entity Extractor' + * @property {array} [roles] + * @property {array} [explicitList] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/patternAnyModelCreateObject.js b/lib/services/luis/authoring/lib/models/patternAnyModelCreateObject.js index d2259bf7f4..f612b8098f 100644 --- a/lib/services/luis/authoring/lib/models/patternAnyModelCreateObject.js +++ b/lib/services/luis/authoring/lib/models/patternAnyModelCreateObject.js @@ -17,8 +17,8 @@ class PatternAnyModelCreateObject { /** * Create a PatternAnyModelCreateObject. - * @member {string} [name] The model name. - * @member {array} [explicitList] The Pattern.Any explicit list. + * @property {string} [name] The model name. + * @property {array} [explicitList] The Pattern.Any explicit list. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/patternAnyModelUpdateObject.js b/lib/services/luis/authoring/lib/models/patternAnyModelUpdateObject.js index d23605cf9c..ef7df01c33 100644 --- a/lib/services/luis/authoring/lib/models/patternAnyModelUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/patternAnyModelUpdateObject.js @@ -17,8 +17,8 @@ class PatternAnyModelUpdateObject { /** * Create a PatternAnyModelUpdateObject. - * @member {string} [name] The model name. - * @member {array} [explicitList] The Pattern.Any explicit list. + * @property {string} [name] The model name. + * @property {array} [explicitList] The Pattern.Any explicit list. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/patternCreateObject.js b/lib/services/luis/authoring/lib/models/patternCreateObject.js index 468c0f8dea..3342e39714 100644 --- a/lib/services/luis/authoring/lib/models/patternCreateObject.js +++ b/lib/services/luis/authoring/lib/models/patternCreateObject.js @@ -17,8 +17,8 @@ class PatternCreateObject { /** * Create a PatternCreateObject. - * @member {string} [pattern] The Regular Expression to match. - * @member {string} [name] Name of the feature. + * @property {string} [pattern] The Regular Expression to match. + * @property {string} [name] Name of the feature. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/patternFeatureInfo.js b/lib/services/luis/authoring/lib/models/patternFeatureInfo.js index 44f1be43db..aa6c16ce2e 100644 --- a/lib/services/luis/authoring/lib/models/patternFeatureInfo.js +++ b/lib/services/luis/authoring/lib/models/patternFeatureInfo.js @@ -20,7 +20,7 @@ const models = require('./index'); class PatternFeatureInfo extends models['FeatureInfoObject'] { /** * Create a PatternFeatureInfo. - * @member {string} [pattern] The Regular Expression to match. + * @property {string} [pattern] The Regular Expression to match. */ constructor() { super(); diff --git a/lib/services/luis/authoring/lib/models/patternRule.js b/lib/services/luis/authoring/lib/models/patternRule.js index 946d688701..dda634d619 100644 --- a/lib/services/luis/authoring/lib/models/patternRule.js +++ b/lib/services/luis/authoring/lib/models/patternRule.js @@ -17,8 +17,9 @@ class PatternRule { /** * Create a PatternRule. - * @member {string} [pattern] The pattern text. - * @member {string} [intent] The intent's name where the pattern belongs to. + * @property {string} [pattern] The pattern text. + * @property {string} [intent] The intent's name where the pattern belongs + * to. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/patternRuleCreateObject.js b/lib/services/luis/authoring/lib/models/patternRuleCreateObject.js index 072e06eafc..9ca966eba0 100644 --- a/lib/services/luis/authoring/lib/models/patternRuleCreateObject.js +++ b/lib/services/luis/authoring/lib/models/patternRuleCreateObject.js @@ -17,8 +17,9 @@ class PatternRuleCreateObject { /** * Create a PatternRuleCreateObject. - * @member {string} [pattern] The pattern text. - * @member {string} [intent] The intent's name which the pattern belongs to. + * @property {string} [pattern] The pattern text. + * @property {string} [intent] The intent's name which the pattern belongs + * to. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/patternRuleInfo.js b/lib/services/luis/authoring/lib/models/patternRuleInfo.js index 0d6b89b77e..7dab87f157 100644 --- a/lib/services/luis/authoring/lib/models/patternRuleInfo.js +++ b/lib/services/luis/authoring/lib/models/patternRuleInfo.js @@ -17,9 +17,10 @@ class PatternRuleInfo { /** * Create a PatternRuleInfo. - * @member {uuid} [id] The pattern ID. - * @member {string} [pattern] The pattern text. - * @member {string} [intent] The intent's name where the pattern belongs to. + * @property {uuid} [id] The pattern ID. + * @property {string} [pattern] The pattern text. + * @property {string} [intent] The intent's name where the pattern belongs + * to. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/patternRuleUpdateObject.js b/lib/services/luis/authoring/lib/models/patternRuleUpdateObject.js index 74d7dad67c..95dfe31fbb 100644 --- a/lib/services/luis/authoring/lib/models/patternRuleUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/patternRuleUpdateObject.js @@ -17,9 +17,10 @@ class PatternRuleUpdateObject { /** * Create a PatternRuleUpdateObject. - * @member {uuid} [id] The pattern ID. - * @member {string} [pattern] The pattern text. - * @member {string} [intent] The intent's name which the pattern belongs to. + * @property {uuid} [id] The pattern ID. + * @property {string} [pattern] The pattern text. + * @property {string} [intent] The intent's name which the pattern belongs + * to. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/patternUpdateObject.js b/lib/services/luis/authoring/lib/models/patternUpdateObject.js index 2eff910ceb..a4f9977e8e 100644 --- a/lib/services/luis/authoring/lib/models/patternUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/patternUpdateObject.js @@ -17,10 +17,10 @@ class PatternUpdateObject { /** * Create a PatternUpdateObject. - * @member {string} [pattern] The Regular Expression to match. - * @member {string} [name] Name of the feature. - * @member {boolean} [isActive] Indicates if the Pattern feature is enabled. - * Default value: true . + * @property {string} [pattern] The Regular Expression to match. + * @property {string} [name] Name of the feature. + * @property {boolean} [isActive] Indicates if the Pattern feature is + * enabled. Default value: true . */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/personalAssistantsResponse.js b/lib/services/luis/authoring/lib/models/personalAssistantsResponse.js index 2cf83e45c6..6b43a07c2c 100644 --- a/lib/services/luis/authoring/lib/models/personalAssistantsResponse.js +++ b/lib/services/luis/authoring/lib/models/personalAssistantsResponse.js @@ -18,8 +18,8 @@ class PersonalAssistantsResponse { /** * Create a PersonalAssistantsResponse. - * @member {array} [endpointKeys] - * @member {object} [endpointUrls] + * @property {array} [endpointKeys] + * @property {object} [endpointUrls] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/phraseListFeatureInfo.js b/lib/services/luis/authoring/lib/models/phraseListFeatureInfo.js index 1307a3d38f..2639d955d4 100644 --- a/lib/services/luis/authoring/lib/models/phraseListFeatureInfo.js +++ b/lib/services/luis/authoring/lib/models/phraseListFeatureInfo.js @@ -20,10 +20,10 @@ const models = require('./index'); class PhraseListFeatureInfo extends models['FeatureInfoObject'] { /** * Create a PhraseListFeatureInfo. - * @member {string} [phrases] A list of comma-separated values. - * @member {boolean} [isExchangeable] An exchangeable phrase list feature are - * serves as single feature to the LUIS underlying training algorithm. It is - * used as a lexicon lookup feature where its value is 1 if the lexicon + * @property {string} [phrases] A list of comma-separated values. + * @property {boolean} [isExchangeable] An exchangeable phrase list feature + * are serves as single feature to the LUIS underlying training algorithm. It + * is used as a lexicon lookup feature where its value is 1 if the lexicon * contains a given word or 0 if it doesn’t. Think of an exchangeable as a * synonyms list. A non-exchangeable phrase list feature has all the phrases * in the list serve as separate features to the underlying training diff --git a/lib/services/luis/authoring/lib/models/phraselistCreateObject.js b/lib/services/luis/authoring/lib/models/phraselistCreateObject.js index becafb82fb..a23dc25223 100644 --- a/lib/services/luis/authoring/lib/models/phraselistCreateObject.js +++ b/lib/services/luis/authoring/lib/models/phraselistCreateObject.js @@ -17,12 +17,12 @@ class PhraselistCreateObject { /** * Create a PhraselistCreateObject. - * @member {string} [phrases] List of comma-separated phrases that represent - * the Phraselist. - * @member {string} [name] The Phraselist name. - * @member {boolean} [isExchangeable] An exchangeable phrase list feature are - * serves as single feature to the LUIS underlying training algorithm. It is - * used as a lexicon lookup feature where its value is 1 if the lexicon + * @property {string} [phrases] List of comma-separated phrases that + * represent the Phraselist. + * @property {string} [name] The Phraselist name. + * @property {boolean} [isExchangeable] An exchangeable phrase list feature + * are serves as single feature to the LUIS underlying training algorithm. It + * is used as a lexicon lookup feature where its value is 1 if the lexicon * contains a given word or 0 if it doesn’t. Think of an exchangeable as a * synonyms list. A non-exchangeable phrase list feature has all the phrases * in the list serve as separate features to the underlying training diff --git a/lib/services/luis/authoring/lib/models/phraselistUpdateObject.js b/lib/services/luis/authoring/lib/models/phraselistUpdateObject.js index 17f63efdc4..4bdc22f73d 100644 --- a/lib/services/luis/authoring/lib/models/phraselistUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/phraselistUpdateObject.js @@ -17,14 +17,14 @@ class PhraselistUpdateObject { /** * Create a PhraselistUpdateObject. - * @member {string} [phrases] List of comma-separated phrases that represent - * the Phraselist. - * @member {string} [name] The Phraselist name. - * @member {boolean} [isActive] Indicates if the Phraselist is enabled. + * @property {string} [phrases] List of comma-separated phrases that + * represent the Phraselist. + * @property {string} [name] The Phraselist name. + * @property {boolean} [isActive] Indicates if the Phraselist is enabled. * Default value: true . - * @member {boolean} [isExchangeable] An exchangeable phrase list feature are - * serves as single feature to the LUIS underlying training algorithm. It is - * used as a lexicon lookup feature where its value is 1 if the lexicon + * @property {boolean} [isExchangeable] An exchangeable phrase list feature + * are serves as single feature to the LUIS underlying training algorithm. It + * is used as a lexicon lookup feature where its value is 1 if the lexicon * contains a given word or 0 if it doesn’t. Think of an exchangeable as a * synonyms list. A non-exchangeable phrase list feature has all the phrases * in the list serve as separate features to the underlying training diff --git a/lib/services/luis/authoring/lib/models/prebuiltDomain.js b/lib/services/luis/authoring/lib/models/prebuiltDomain.js index b4d15c6f4d..a7db96b20d 100644 --- a/lib/services/luis/authoring/lib/models/prebuiltDomain.js +++ b/lib/services/luis/authoring/lib/models/prebuiltDomain.js @@ -17,12 +17,12 @@ class PrebuiltDomain { /** * Create a PrebuiltDomain. - * @member {string} [name] - * @member {string} [culture] - * @member {string} [description] - * @member {string} [examples] - * @member {array} [intents] - * @member {array} [entities] + * @property {string} [name] + * @property {string} [culture] + * @property {string} [description] + * @property {string} [examples] + * @property {array} [intents] + * @property {array} [entities] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/prebuiltDomainCreateBaseObject.js b/lib/services/luis/authoring/lib/models/prebuiltDomainCreateBaseObject.js index d235f429c3..9f222d60bd 100644 --- a/lib/services/luis/authoring/lib/models/prebuiltDomainCreateBaseObject.js +++ b/lib/services/luis/authoring/lib/models/prebuiltDomainCreateBaseObject.js @@ -18,7 +18,7 @@ class PrebuiltDomainCreateBaseObject { /** * Create a PrebuiltDomainCreateBaseObject. - * @member {string} [domainName] The domain name. + * @property {string} [domainName] The domain name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/prebuiltDomainCreateObject.js b/lib/services/luis/authoring/lib/models/prebuiltDomainCreateObject.js index b9c44ec35f..24546862b5 100644 --- a/lib/services/luis/authoring/lib/models/prebuiltDomainCreateObject.js +++ b/lib/services/luis/authoring/lib/models/prebuiltDomainCreateObject.js @@ -18,8 +18,8 @@ class PrebuiltDomainCreateObject { /** * Create a PrebuiltDomainCreateObject. - * @member {string} [domainName] The domain name. - * @member {string} [culture] The culture of the new domain. + * @property {string} [domainName] The domain name. + * @property {string} [culture] The culture of the new domain. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/prebuiltDomainItem.js b/lib/services/luis/authoring/lib/models/prebuiltDomainItem.js index 315dfb9d12..2da420193a 100644 --- a/lib/services/luis/authoring/lib/models/prebuiltDomainItem.js +++ b/lib/services/luis/authoring/lib/models/prebuiltDomainItem.js @@ -16,9 +16,9 @@ class PrebuiltDomainItem { /** * Create a PrebuiltDomainItem. - * @member {string} [name] - * @member {string} [description] - * @member {string} [examples] + * @property {string} [name] + * @property {string} [description] + * @property {string} [examples] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/prebuiltDomainModelCreateObject.js b/lib/services/luis/authoring/lib/models/prebuiltDomainModelCreateObject.js index 0ed6597e5e..4b6cdaa35f 100644 --- a/lib/services/luis/authoring/lib/models/prebuiltDomainModelCreateObject.js +++ b/lib/services/luis/authoring/lib/models/prebuiltDomainModelCreateObject.js @@ -18,8 +18,8 @@ class PrebuiltDomainModelCreateObject { /** * Create a PrebuiltDomainModelCreateObject. - * @member {string} [domainName] The domain name. - * @member {string} [modelName] The intent name or entity name. + * @property {string} [domainName] The domain name. + * @property {string} [modelName] The intent name or entity name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/prebuiltDomainObject.js b/lib/services/luis/authoring/lib/models/prebuiltDomainObject.js index d6ee273af3..2d3da7f055 100644 --- a/lib/services/luis/authoring/lib/models/prebuiltDomainObject.js +++ b/lib/services/luis/authoring/lib/models/prebuiltDomainObject.js @@ -16,8 +16,8 @@ class PrebuiltDomainObject { /** * Create a PrebuiltDomainObject. - * @member {string} [domainName] - * @member {string} [modelName] + * @property {string} [domainName] + * @property {string} [modelName] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/prebuiltEntity.js b/lib/services/luis/authoring/lib/models/prebuiltEntity.js index f9d8b6e636..c18cb90b8b 100644 --- a/lib/services/luis/authoring/lib/models/prebuiltEntity.js +++ b/lib/services/luis/authoring/lib/models/prebuiltEntity.js @@ -17,8 +17,8 @@ class PrebuiltEntity { /** * Create a PrebuiltEntity. - * @member {string} [name] - * @member {array} [roles] + * @property {string} [name] + * @property {array} [roles] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/prebuiltEntityExtractor.js b/lib/services/luis/authoring/lib/models/prebuiltEntityExtractor.js index e5173d0ce9..0f70acd213 100644 --- a/lib/services/luis/authoring/lib/models/prebuiltEntityExtractor.js +++ b/lib/services/luis/authoring/lib/models/prebuiltEntityExtractor.js @@ -17,15 +17,15 @@ class PrebuiltEntityExtractor { /** * Create a PrebuiltEntityExtractor. - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] + * @property {uuid} id The ID of the Entity Model. + * @property {string} [name] Name of the Entity Model. + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} readableType Possible values include: 'Entity + * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity + * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity + * Extractor', 'Regex Entity Extractor' + * @property {array} [roles] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/publishSettingUpdateObject.js b/lib/services/luis/authoring/lib/models/publishSettingUpdateObject.js index 07c7309dee..6deca9104c 100644 --- a/lib/services/luis/authoring/lib/models/publishSettingUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/publishSettingUpdateObject.js @@ -17,11 +17,11 @@ class PublishSettingUpdateObject { /** * Create a PublishSettingUpdateObject. - * @member {boolean} [sentimentAnalysis] Setting sentiment analysis as true + * @property {boolean} [sentimentAnalysis] Setting sentiment analysis as true * returns the Sentiment of the input utterance along with the resopnse - * @member {boolean} [speech] Setting speech as public enables speech priming - * in your app - * @member {boolean} [spellChecker] Setting spell checker as public enables + * @property {boolean} [speech] Setting speech as public enables speech + * priming in your app + * @property {boolean} [spellChecker] Setting spell checker as public enables * spell checking the input utterance. */ constructor() { diff --git a/lib/services/luis/authoring/lib/models/publishSettings.js b/lib/services/luis/authoring/lib/models/publishSettings.js index cb88c51f23..45f0fa30e0 100644 --- a/lib/services/luis/authoring/lib/models/publishSettings.js +++ b/lib/services/luis/authoring/lib/models/publishSettings.js @@ -17,12 +17,13 @@ class PublishSettings { /** * Create a PublishSettings. - * @member {uuid} id The application ID. - * @member {boolean} isSentimentAnalysisEnabled Setting sentiment analysis as - * true returns the Sentiment of the input utterance along with the resopnse - * @member {boolean} isSpeechEnabled Setting speech as public enables speech - * priming in your app - * @member {boolean} isSpellCheckerEnabled Setting spell checker as public + * @property {uuid} id The application ID. + * @property {boolean} isSentimentAnalysisEnabled Setting sentiment analysis + * as true returns the Sentiment of the input utterance along with the + * resopnse + * @property {boolean} isSpeechEnabled Setting speech as public enables + * speech priming in your app + * @property {boolean} isSpellCheckerEnabled Setting spell checker as public * enables spell checking the input utterance. */ constructor() { diff --git a/lib/services/luis/authoring/lib/models/regexEntity.js b/lib/services/luis/authoring/lib/models/regexEntity.js index ba69c78ed4..172f55c60a 100644 --- a/lib/services/luis/authoring/lib/models/regexEntity.js +++ b/lib/services/luis/authoring/lib/models/regexEntity.js @@ -17,9 +17,9 @@ class RegexEntity { /** * Create a RegexEntity. - * @member {string} [name] - * @member {string} [regexPattern] - * @member {array} [roles] + * @property {string} [name] + * @property {string} [regexPattern] + * @property {array} [roles] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/regexEntityExtractor.js b/lib/services/luis/authoring/lib/models/regexEntityExtractor.js index 2947fc44d6..37ce6084f6 100644 --- a/lib/services/luis/authoring/lib/models/regexEntityExtractor.js +++ b/lib/services/luis/authoring/lib/models/regexEntityExtractor.js @@ -17,16 +17,16 @@ class RegexEntityExtractor { /** * Create a RegexEntityExtractor. - * @member {uuid} id The ID of the Entity Model. - * @member {string} [name] Name of the Entity Model. - * @member {number} [typeId] The type ID of the Entity Model. - * @member {string} readableType Possible values include: 'Entity Extractor', - * 'Hierarchical Entity Extractor', 'Hierarchical Child Entity Extractor', - * 'Composite Entity Extractor', 'Closed List Entity Extractor', 'Prebuilt - * Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity Extractor', - * 'Regex Entity Extractor' - * @member {array} [roles] - * @member {string} [regexPattern] The Regex entity pattern. + * @property {uuid} id The ID of the Entity Model. + * @property {string} [name] Name of the Entity Model. + * @property {number} [typeId] The type ID of the Entity Model. + * @property {string} readableType Possible values include: 'Entity + * Extractor', 'Hierarchical Entity Extractor', 'Hierarchical Child Entity + * Extractor', 'Composite Entity Extractor', 'Closed List Entity Extractor', + * 'Prebuilt Entity Extractor', 'Intent Classifier', 'Pattern.Any Entity + * Extractor', 'Regex Entity Extractor' + * @property {array} [roles] + * @property {string} [regexPattern] The Regex entity pattern. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/regexModelCreateObject.js b/lib/services/luis/authoring/lib/models/regexModelCreateObject.js index e544993b0e..25e8f7372e 100644 --- a/lib/services/luis/authoring/lib/models/regexModelCreateObject.js +++ b/lib/services/luis/authoring/lib/models/regexModelCreateObject.js @@ -17,8 +17,8 @@ class RegexModelCreateObject { /** * Create a RegexModelCreateObject. - * @member {string} [regexPattern] The regex entity pattern. - * @member {string} [name] The model name. + * @property {string} [regexPattern] The regex entity pattern. + * @property {string} [name] The model name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/regexModelUpdateObject.js b/lib/services/luis/authoring/lib/models/regexModelUpdateObject.js index 4845710a65..3629fc2270 100644 --- a/lib/services/luis/authoring/lib/models/regexModelUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/regexModelUpdateObject.js @@ -17,8 +17,8 @@ class RegexModelUpdateObject { /** * Create a RegexModelUpdateObject. - * @member {string} [regexPattern] The regex entity pattern. - * @member {string} [name] The model name. + * @property {string} [regexPattern] The regex entity pattern. + * @property {string} [name] The model name. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/subClosedList.js b/lib/services/luis/authoring/lib/models/subClosedList.js index 6d67aece9c..b669eb6c16 100644 --- a/lib/services/luis/authoring/lib/models/subClosedList.js +++ b/lib/services/luis/authoring/lib/models/subClosedList.js @@ -17,9 +17,9 @@ class SubClosedList { /** * Create a SubClosedList. - * @member {string} [canonicalForm] The standard form that the list + * @property {string} [canonicalForm] The standard form that the list * represents. - * @member {array} [list] List of synonym words. + * @property {array} [list] List of synonym words. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/subClosedListResponse.js b/lib/services/luis/authoring/lib/models/subClosedListResponse.js index 1fc10510e4..2aa18cd7af 100644 --- a/lib/services/luis/authoring/lib/models/subClosedListResponse.js +++ b/lib/services/luis/authoring/lib/models/subClosedListResponse.js @@ -20,7 +20,7 @@ const models = require('./index'); class SubClosedListResponse extends models['SubClosedList'] { /** * Create a SubClosedListResponse. - * @member {number} [id] The sublist ID + * @property {number} [id] The sublist ID */ constructor() { super(); diff --git a/lib/services/luis/authoring/lib/models/taskUpdateObject.js b/lib/services/luis/authoring/lib/models/taskUpdateObject.js index 34df7787bb..0e027e8218 100644 --- a/lib/services/luis/authoring/lib/models/taskUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/taskUpdateObject.js @@ -17,7 +17,7 @@ class TaskUpdateObject { /** * Create a TaskUpdateObject. - * @member {string} [version] The new version for the cloned model. + * @property {string} [version] The new version for the cloned model. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/userAccessList.js b/lib/services/luis/authoring/lib/models/userAccessList.js index 28ff0f506b..3b0aef9ba7 100644 --- a/lib/services/luis/authoring/lib/models/userAccessList.js +++ b/lib/services/luis/authoring/lib/models/userAccessList.js @@ -17,8 +17,8 @@ class UserAccessList { /** * Create a UserAccessList. - * @member {string} [owner] The email address of owner of the application. - * @member {array} [emails] + * @property {string} [owner] The email address of owner of the application. + * @property {array} [emails] */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/userCollaborator.js b/lib/services/luis/authoring/lib/models/userCollaborator.js index c544e99113..65896d695e 100644 --- a/lib/services/luis/authoring/lib/models/userCollaborator.js +++ b/lib/services/luis/authoring/lib/models/userCollaborator.js @@ -16,7 +16,7 @@ class UserCollaborator { /** * Create a UserCollaborator. - * @member {string} [email] The email address of the user. + * @property {string} [email] The email address of the user. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/versionInfo.js b/lib/services/luis/authoring/lib/models/versionInfo.js index 09770a3354..5214a4a4e8 100644 --- a/lib/services/luis/authoring/lib/models/versionInfo.js +++ b/lib/services/luis/authoring/lib/models/versionInfo.js @@ -17,21 +17,22 @@ class VersionInfo { /** * Create a VersionInfo. - * @member {string} version The version ID. E.g.: "0.1" - * @member {date} [createdDateTime] The version's creation timestamp. - * @member {date} [lastModifiedDateTime] Timestamp of the last update. - * @member {date} [lastTrainedDateTime] Timestamp of the last time the model - * was trained. - * @member {date} [lastPublishedDateTime] Timestamp when was last published. - * @member {string} [endpointUrl] The Runtime endpoint URL for this model + * @property {string} version The version ID. E.g.: "0.1" + * @property {date} [createdDateTime] The version's creation timestamp. + * @property {date} [lastModifiedDateTime] Timestamp of the last update. + * @property {date} [lastTrainedDateTime] Timestamp of the last time the + * model was trained. + * @property {date} [lastPublishedDateTime] Timestamp when was last + * published. + * @property {string} [endpointUrl] The Runtime endpoint URL for this model * version. - * @member {object} [assignedEndpointKey] The endpoint key. - * @member {object} [externalApiKeys] External keys. - * @member {number} [intentsCount] Number of intents in this model. - * @member {number} [entitiesCount] Number of entities in this model. - * @member {number} [endpointHitsCount] Number of calls made to this + * @property {object} [assignedEndpointKey] The endpoint key. + * @property {object} [externalApiKeys] External keys. + * @property {number} [intentsCount] Number of intents in this model. + * @property {number} [entitiesCount] Number of entities in this model. + * @property {number} [endpointHitsCount] Number of calls made to this * endpoint. - * @member {string} trainingStatus The current training status. Possible + * @property {string} trainingStatus The current training status. Possible * values include: 'NeedsTraining', 'InProgress', 'Trained' */ constructor() { diff --git a/lib/services/luis/authoring/lib/models/wordListBaseUpdateObject.js b/lib/services/luis/authoring/lib/models/wordListBaseUpdateObject.js index 5aa1519417..bf938ec266 100644 --- a/lib/services/luis/authoring/lib/models/wordListBaseUpdateObject.js +++ b/lib/services/luis/authoring/lib/models/wordListBaseUpdateObject.js @@ -17,9 +17,9 @@ class WordListBaseUpdateObject { /** * Create a WordListBaseUpdateObject. - * @member {string} [canonicalForm] The standard form that the list + * @property {string} [canonicalForm] The standard form that the list * represents. - * @member {array} [list] List of synonym words. + * @property {array} [list] List of synonym words. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/models/wordListObject.js b/lib/services/luis/authoring/lib/models/wordListObject.js index 7526d090e6..48e20b233b 100644 --- a/lib/services/luis/authoring/lib/models/wordListObject.js +++ b/lib/services/luis/authoring/lib/models/wordListObject.js @@ -17,9 +17,9 @@ class WordListObject { /** * Create a WordListObject. - * @member {string} [canonicalForm] The standard form that the list + * @property {string} [canonicalForm] The standard form that the list * represents. - * @member {array} [list] List of synonym words. + * @property {array} [list] List of synonym words. */ constructor() { } diff --git a/lib/services/luis/authoring/lib/operations/apps.js b/lib/services/luis/authoring/lib/operations/apps.js index dd2ab9e476..4c43862aeb 100644 --- a/lib/services/luis/authoring/lib/operations/apps.js +++ b/lib/services/luis/authoring/lib/operations/apps.js @@ -1552,9 +1552,6 @@ function _deleteMethod(appId, options, callback) { * @param {boolean} [applicationPublishObject.isStaging] Indicates if the * staging slot should be used, instead of the Production one. * - * @param {string} [applicationPublishObject.region] The target region that the - * application is published to. - * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -3852,9 +3849,6 @@ class Apps { * @param {boolean} [applicationPublishObject.isStaging] Indicates if the * staging slot should be used, instead of the Production one. * - * @param {string} [applicationPublishObject.region] The target region that the - * application is published to. - * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -3894,9 +3888,6 @@ class Apps { * @param {boolean} [applicationPublishObject.isStaging] Indicates if the * staging slot should be used, instead of the Production one. * - * @param {string} [applicationPublishObject.region] The target region that the - * application is published to. - * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the diff --git a/lib/services/luis/authoring/lib/operations/index.d.ts b/lib/services/luis/authoring/lib/operations/index.d.ts index 41061b4451..5318661967 100644 --- a/lib/services/luis/authoring/lib/operations/index.d.ts +++ b/lib/services/luis/authoring/lib/operations/index.d.ts @@ -8840,9 +8840,6 @@ export interface Apps { * @param {boolean} [applicationPublishObject.isStaging] Indicates if the * staging slot should be used, instead of the Production one. * - * @param {string} [applicationPublishObject.region] The target region that the - * application is published to. - * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -8870,9 +8867,6 @@ export interface Apps { * @param {boolean} [applicationPublishObject.isStaging] Indicates if the * staging slot should be used, instead of the Production one. * - * @param {string} [applicationPublishObject.region] The target region that the - * application is published to. - * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -10942,3 +10936,147 @@ export interface Pattern { getIntentPatterns(appId: string, versionId: string, intentId: string, callback: ServiceCallback): void; getIntentPatterns(appId: string, versionId: string, intentId: string, options: { skip? : number, take? : number, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; } + +/** + * @class + * Settings + * __NOTE__: An instance of this class is automatically created for an + * instance of the LUISAuthoringClient. + */ +export interface Settings { + + + /** + * Gets the application version settings. + * + * @param {uuid} appId The application ID. + * + * @param {string} versionId The version ID. + * + * @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. + */ + listWithHttpOperationResponse(appId: string, versionId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets the application version settings. + * + * @param {uuid} appId The application ID. + * + * @param {string} versionId The version ID. + * + * @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 {Array} - 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. + * + * {Array} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + list(appId: string, versionId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(appId: string, versionId: string, callback: ServiceCallback): void; + list(appId: string, versionId: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates the application version settings. + * + * @param {uuid} appId The application ID. + * + * @param {string} versionId The version ID. + * + * @param {object} listOfAppVersionSettingObject A list of the updated + * application version settings. + * + * @param {string} [listOfAppVersionSettingObject.name] The application version + * setting name. + * + * @param {string} [listOfAppVersionSettingObject.value] The application + * version setting value. + * + * @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. + */ + updateWithHttpOperationResponse(appId: string, versionId: string, listOfAppVersionSettingObject: models.AppVersionSettingObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates the application version settings. + * + * @param {uuid} appId The application ID. + * + * @param {string} versionId The version ID. + * + * @param {object} listOfAppVersionSettingObject A list of the updated + * application version settings. + * + * @param {string} [listOfAppVersionSettingObject.name] The application version + * setting name. + * + * @param {string} [listOfAppVersionSettingObject.value] The application + * version setting value. + * + * @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 {OperationStatus} - 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. + * + * {OperationStatus} [result] - The deserialized result object if an error did not occur. + * See {@link OperationStatus} 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. + */ + update(appId: string, versionId: string, listOfAppVersionSettingObject: models.AppVersionSettingObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + update(appId: string, versionId: string, listOfAppVersionSettingObject: models.AppVersionSettingObject, callback: ServiceCallback): void; + update(appId: string, versionId: string, listOfAppVersionSettingObject: models.AppVersionSettingObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} diff --git a/lib/services/luis/authoring/lib/operations/index.js b/lib/services/luis/authoring/lib/operations/index.js index ef0073f054..3cefaa62cb 100644 --- a/lib/services/luis/authoring/lib/operations/index.js +++ b/lib/services/luis/authoring/lib/operations/index.js @@ -22,3 +22,4 @@ exports.Versions = require('./versions'); exports.Train = require('./train'); exports.Permissions = require('./permissions'); exports.Pattern = require('./pattern'); +exports.Settings = require('./settings'); diff --git a/lib/services/luis/authoring/lib/operations/settings.js b/lib/services/luis/authoring/lib/operations/settings.js new file mode 100644 index 0000000000..2eef1a6c4a --- /dev/null +++ b/lib/services/luis/authoring/lib/operations/settings.js @@ -0,0 +1,516 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const WebResource = msRest.WebResource; + +/** + * Gets the application version settings. + * + * @param {uuid} appId The application ID. + * + * @param {string} versionId The version ID. + * + * @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. + * + * {array} [result] - The deserialized result object if an error did not occur. + * + * {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 _list(appId, versionId, 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.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); + } + if (appId === null || appId === undefined || typeof appId.valueOf() !== 'string' || !msRest.isValidUuid(appId)) { + throw new Error('appId cannot be null or undefined and it must be of type string and must be a valid uuid.'); + } + if (versionId === null || versionId === undefined || typeof versionId.valueOf() !== 'string') { + throw new Error('versionId cannot be null or undefined and it must be of type string.'); + } + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'apps/{appId}/versions/{versionId}/settings'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + requestUrl = requestUrl.replace('{appId}', encodeURIComponent(appId.toString())); + requestUrl = requestUrl.replace('{versionId}', encodeURIComponent(versionId)); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + if(options) { + for(let headerName in options['customHeaders']) { + if (options['customHeaders'].hasOwnProperty(headerName)) { + httpRequest.headers[headerName] = options['customHeaders'][headerName]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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 = { + required: false, + serializedName: 'parsedResponse', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'AppVersionSettingObjectElementType', + type: { + name: 'Composite', + className: 'AppVersionSettingObject' + } + } + } + }; + 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); + }); +} + +/** + * Updates the application version settings. + * + * @param {uuid} appId The application ID. + * + * @param {string} versionId The version ID. + * + * @param {object} listOfAppVersionSettingObject A list of the updated + * application version settings. + * + * @param {string} [listOfAppVersionSettingObject.name] The application version + * setting name. + * + * @param {string} [listOfAppVersionSettingObject.value] The application + * version setting value. + * + * @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 OperationStatus} 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 _update(appId, versionId, listOfAppVersionSettingObject, 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.endpoint === null || this.client.endpoint === undefined || typeof this.client.endpoint.valueOf() !== 'string') { + throw new Error('this.client.endpoint cannot be null or undefined and it must be of type string.'); + } + if (appId === null || appId === undefined || typeof appId.valueOf() !== 'string' || !msRest.isValidUuid(appId)) { + throw new Error('appId cannot be null or undefined and it must be of type string and must be a valid uuid.'); + } + if (versionId === null || versionId === undefined || typeof versionId.valueOf() !== 'string') { + throw new Error('versionId cannot be null or undefined and it must be of type string.'); + } + if (listOfAppVersionSettingObject === null || listOfAppVersionSettingObject === undefined) { + throw new Error('listOfAppVersionSettingObject cannot be null or undefined.'); + } + } catch (error) { + return callback(error); + } + + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'apps/{appId}/versions/{versionId}/settings'; + requestUrl = requestUrl.replace('{Endpoint}', this.client.endpoint); + requestUrl = requestUrl.replace('{appId}', encodeURIComponent(appId.toString())); + requestUrl = requestUrl.replace('{versionId}', encodeURIComponent(versionId)); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'PUT'; + httpRequest.url = requestUrl; + httpRequest.headers = {}; + // Set Headers + httpRequest.headers['Content-Type'] = 'application/json; charset=utf-8'; + 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 (listOfAppVersionSettingObject !== null && listOfAppVersionSettingObject !== undefined) { + let requestModelMapper = new client.models['AppVersionSettingObject']().mapper(); + requestModel = client.serialize(requestModelMapper, listOfAppVersionSettingObject, 'listOfAppVersionSettingObject'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(listOfAppVersionSettingObject, 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['OperationStatus']().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); + }); +} + +/** Class representing a Settings. */ +class Settings { + /** + * Create a Settings. + * @param {LUISAuthoringClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._list = _list; + this._update = _update; + } + + /** + * Gets the application version settings. + * + * @param {uuid} appId The application ID. + * + * @param {string} versionId The version ID. + * + * @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. + */ + listWithHttpOperationResponse(appId, versionId, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(appId, versionId, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets the application version settings. + * + * @param {uuid} appId The application ID. + * + * @param {string} versionId The version ID. + * + * @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 {Array} - 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. + * + * {array} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + list(appId, versionId, 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._list(appId, versionId, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(appId, versionId, options, optionalCallback); + } + } + + /** + * Updates the application version settings. + * + * @param {uuid} appId The application ID. + * + * @param {string} versionId The version ID. + * + * @param {object} listOfAppVersionSettingObject A list of the updated + * application version settings. + * + * @param {string} [listOfAppVersionSettingObject.name] The application version + * setting name. + * + * @param {string} [listOfAppVersionSettingObject.value] The application + * version setting value. + * + * @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. + */ + updateWithHttpOperationResponse(appId, versionId, listOfAppVersionSettingObject, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._update(appId, versionId, listOfAppVersionSettingObject, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Updates the application version settings. + * + * @param {uuid} appId The application ID. + * + * @param {string} versionId The version ID. + * + * @param {object} listOfAppVersionSettingObject A list of the updated + * application version settings. + * + * @param {string} [listOfAppVersionSettingObject.name] The application version + * setting name. + * + * @param {string} [listOfAppVersionSettingObject.value] The application + * version setting value. + * + * @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 {OperationStatus} - 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 OperationStatus} 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. + */ + update(appId, versionId, listOfAppVersionSettingObject, 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._update(appId, versionId, listOfAppVersionSettingObject, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._update(appId, versionId, listOfAppVersionSettingObject, options, optionalCallback); + } + } + +} + +module.exports = Settings; diff --git a/lib/services/luis/authoring/package.json b/lib/services/luis/authoring/package.json index ab44dad38d..42f2b42fbc 100644 --- a/lib/services/luis/authoring/package.json +++ b/lib/services/luis/authoring/package.json @@ -2,7 +2,7 @@ "name": "azure-cognitiveservices-luis-authoring", "author": "Microsoft Corporation", "description": "LUISAuthoringClient Library with typescript type definitions for node", - "version": "1.1.0", + "version": "2.0.0", "dependencies": { "ms-rest": "^2.3.3" }, @@ -21,4 +21,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +} diff --git a/lib/services/luis/runtime/README.md b/lib/services/luis/runtime/README.md index 018f96df17..2473836229 100644 --- a/lib/services/luis/runtime/README.md +++ b/lib/services/luis/runtime/README.md @@ -3,22 +3,24 @@ uid: azure-cognitiveservices-luis-runtime summary: *content --- -# Microsoft Azure SDK for Node.js - LUISRuntimeClient +**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 - LUISRuntimeClient + 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-cognitiveservices-luis-runtime ``` -## How to use +### How to use -### Authentication, client creation and resolve prediction as an example. +#### Authentication, client creation, and resolve prediction as an example. ```javascript const msRest = require("ms-rest"); @@ -35,6 +37,7 @@ const staging = true; const spellCheck = true; const bingSpellCheckSubscriptionKey = "testbingSpellCheckSubscriptionKey"; const log = true; + client.prediction.resolve(appId, query, timezoneOffset, verbose, staging, spellCheck, bingSpellCheckSubscriptionKey, log).then((result) => { console.log("The result is:"); console.log(result); @@ -42,7 +45,8 @@ client.prediction.resolve(appId, query, timezoneOffset, verbose, staging, spellC console.log('An error occurred:'); 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/luis/runtime/lib/models/aPIError.js b/lib/services/luis/runtime/lib/models/aPIError.js index 22b9f31f77..ca5dd628e6 100644 --- a/lib/services/luis/runtime/lib/models/aPIError.js +++ b/lib/services/luis/runtime/lib/models/aPIError.js @@ -17,8 +17,8 @@ class APIError { /** * Create a APIError. - * @member {string} [statusCode] HTTP Status code - * @member {string} [message] Cause of the error. + * @property {string} [statusCode] HTTP Status code + * @property {string} [message] Cause of the error. */ constructor() { } diff --git a/lib/services/luis/runtime/lib/models/compositeChildModel.js b/lib/services/luis/runtime/lib/models/compositeChildModel.js index 833ba5c269..385fcac5fc 100644 --- a/lib/services/luis/runtime/lib/models/compositeChildModel.js +++ b/lib/services/luis/runtime/lib/models/compositeChildModel.js @@ -17,8 +17,8 @@ class CompositeChildModel { /** * Create a CompositeChildModel. - * @member {string} type Type of child entity. - * @member {string} value Value extracted by LUIS. + * @property {string} type Type of child entity. + * @property {string} value Value extracted by LUIS. */ constructor() { } diff --git a/lib/services/luis/runtime/lib/models/compositeEntityModel.js b/lib/services/luis/runtime/lib/models/compositeEntityModel.js index 1e808906e8..e766e31bd2 100644 --- a/lib/services/luis/runtime/lib/models/compositeEntityModel.js +++ b/lib/services/luis/runtime/lib/models/compositeEntityModel.js @@ -17,9 +17,9 @@ class CompositeEntityModel { /** * Create a CompositeEntityModel. - * @member {string} parentType Type/name of parent entity. - * @member {string} value Value for composite entity extracted by LUIS. - * @member {array} children Child entities. + * @property {string} parentType Type/name of parent entity. + * @property {string} value Value for composite entity extracted by LUIS. + * @property {array} children Child entities. */ constructor() { } diff --git a/lib/services/luis/runtime/lib/models/entityModel.js b/lib/services/luis/runtime/lib/models/entityModel.js index 0ba788c5f3..48e8e3b8e5 100644 --- a/lib/services/luis/runtime/lib/models/entityModel.js +++ b/lib/services/luis/runtime/lib/models/entityModel.js @@ -17,11 +17,11 @@ class EntityModel { /** * Create a EntityModel. - * @member {string} entity Name of the entity, as defined in LUIS. - * @member {string} type Type of the entity, as defined in LUIS. - * @member {number} startIndex The position of the first character of the + * @property {string} entity Name of the entity, as defined in LUIS. + * @property {string} type Type of the entity, as defined in LUIS. + * @property {number} startIndex The position of the first character of the * matched entity within the utterance. - * @member {number} endIndex The position of the last character of the + * @property {number} endIndex The position of the last character of the * matched entity within the utterance. */ constructor() { diff --git a/lib/services/luis/runtime/lib/models/entityWithResolution.js b/lib/services/luis/runtime/lib/models/entityWithResolution.js index 3d1d7c0ba7..130f4b292a 100644 --- a/lib/services/luis/runtime/lib/models/entityWithResolution.js +++ b/lib/services/luis/runtime/lib/models/entityWithResolution.js @@ -19,7 +19,8 @@ const models = require('./index'); class EntityWithResolution extends models['EntityModel'] { /** * Create a EntityWithResolution. - * @member {object} resolution Resolution values for pre-built LUIS entities. + * @property {object} resolution Resolution values for pre-built LUIS + * entities. */ constructor() { super(); diff --git a/lib/services/luis/runtime/lib/models/entityWithScore.js b/lib/services/luis/runtime/lib/models/entityWithScore.js index 07c0e6af04..d43f9b3823 100644 --- a/lib/services/luis/runtime/lib/models/entityWithScore.js +++ b/lib/services/luis/runtime/lib/models/entityWithScore.js @@ -19,7 +19,8 @@ const models = require('./index'); class EntityWithScore extends models['EntityModel'] { /** * Create a EntityWithScore. - * @member {number} score Associated prediction score for the intent (float). + * @property {number} score Associated prediction score for the intent + * (float). */ constructor() { super(); diff --git a/lib/services/luis/runtime/lib/models/index.d.ts b/lib/services/luis/runtime/lib/models/index.d.ts index 2f3ac5bb5e..a306378c2a 100644 --- a/lib/services/luis/runtime/lib/models/index.d.ts +++ b/lib/services/luis/runtime/lib/models/index.d.ts @@ -1,166 +1,151 @@ /* * 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 * as moment from "moment"; - /** - * @class - * Initializes a new instance of the IntentModel class. - * @constructor * An intent detected from the utterance. - * - * @member {string} [intent] Name of the intent, as defined in LUIS. - * @member {number} [score] Associated prediction score for the intent (float). */ export interface IntentModel { + /** + * Name of the intent, as defined in LUIS. + */ intent?: string; + /** + * Associated prediction score for the intent (float). + */ score?: number; } /** - * @class - * Initializes a new instance of the EntityModel class. - * @constructor * An entity extracted from the utterance. - * - * @member {string} entity Name of the entity, as defined in LUIS. - * @member {string} type Type of the entity, as defined in LUIS. - * @member {number} startIndex The position of the first character of the - * matched entity within the utterance. - * @member {number} endIndex The position of the last character of the matched - * entity within the utterance. */ export interface EntityModel { + /** + * Name of the entity, as defined in LUIS. + */ entity: string; + /** + * Type of the entity, as defined in LUIS. + */ type: string; + /** + * The position of the first character of the matched entity within the utterance. + */ startIndex: number; + /** + * The position of the last character of the matched entity within the utterance. + */ endIndex: 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 CompositeChildModel class. - * @constructor * Child entity in a LUIS Composite Entity. - * - * @member {string} type Type of child entity. - * @member {string} value Value extracted by LUIS. */ export interface CompositeChildModel { + /** + * Type of child entity. + */ type: string; + /** + * Value extracted by LUIS. + */ value: string; } /** - * @class - * Initializes a new instance of the CompositeEntityModel class. - * @constructor * LUIS Composite Entity. - * - * @member {string} parentType Type/name of parent entity. - * @member {string} value Value for composite entity extracted by LUIS. - * @member {array} children Child entities. */ export interface CompositeEntityModel { + /** + * Type/name of parent entity. + */ parentType: string; + /** + * Value for composite entity extracted by LUIS. + */ value: string; + /** + * Child entities. + */ children: CompositeChildModel[]; } /** - * @class - * Initializes a new instance of the Sentiment class. - * @constructor * Sentiment of the input utterance. - * - * @member {string} [label] The polarity of the sentiment, can be positive, - * neutral or negative. - * @member {number} [score] Score of the sentiment, ranges from 0 (most - * negative) to 1 (most positive). */ export interface Sentiment { + /** + * The polarity of the sentiment, can be positive, neutral or negative. + */ label?: string; + /** + * Score of the sentiment, ranges from 0 (most negative) to 1 (most positive). + */ score?: number; } /** - * @class - * Initializes a new instance of the LuisResult class. - * @constructor * Prediction, based on the input query, containing intent(s) and entities. - * - * @member {string} [query] The input utterance that was analized. - * @member {string} [alteredQuery] The corrected utterance (when spell checking - * was enabled). - * @member {object} [topScoringIntent] - * @member {string} [topScoringIntent.intent] Name of the intent, as defined in - * LUIS. - * @member {number} [topScoringIntent.score] Associated prediction score for - * the intent (float). - * @member {array} [intents] All the intents (and their score) that were - * detected from utterance. - * @member {array} [entities] The entities extracted from the utterance. - * @member {array} [compositeEntities] The composite entities extracted from - * the utterance. - * @member {object} [sentimentAnalysis] - * @member {string} [sentimentAnalysis.label] The polarity of the sentiment, - * can be positive, neutral or negative. - * @member {number} [sentimentAnalysis.score] Score of the sentiment, ranges - * from 0 (most negative) to 1 (most positive). */ export interface LuisResult { + /** + * The input utterance that was analized. + */ query?: string; + /** + * The corrected utterance (when spell checking was enabled). + */ alteredQuery?: string; topScoringIntent?: IntentModel; + /** + * All the intents (and their score) that were detected from utterance. + */ intents?: IntentModel[]; + /** + * The entities extracted from the utterance. + */ entities?: EntityModel[]; + /** + * The composite entities extracted from the utterance. + */ compositeEntities?: CompositeEntityModel[]; sentimentAnalysis?: Sentiment; } -/** - * @class - * Initializes a new instance of the EntityWithScore class. - * @constructor - * @member {number} score Associated prediction score for the intent (float). - */ export interface EntityWithScore extends EntityModel { + /** + * Associated prediction score for the intent (float). + */ score: number; } -/** - * @class - * Initializes a new instance of the EntityWithResolution class. - * @constructor - * @member {object} resolution Resolution values for pre-built LUIS entities. - */ export interface EntityWithResolution extends EntityModel { + /** + * Resolution values for pre-built LUIS entities. + */ resolution: any; } /** - * @class - * Initializes a new instance of the APIError class. - * @constructor * Error information returned by the API - * - * @member {string} [statusCode] HTTP Status code - * @member {string} [message] Cause of the error. - */ +*/ export interface APIError { + /** + * HTTP Status code + */ statusCode?: string; + /** + * Cause of the error. + */ message?: string; } diff --git a/lib/services/luis/runtime/lib/models/intentModel.js b/lib/services/luis/runtime/lib/models/intentModel.js index 980851d895..d45e47e33e 100644 --- a/lib/services/luis/runtime/lib/models/intentModel.js +++ b/lib/services/luis/runtime/lib/models/intentModel.js @@ -17,8 +17,8 @@ class IntentModel { /** * Create a IntentModel. - * @member {string} [intent] Name of the intent, as defined in LUIS. - * @member {number} [score] Associated prediction score for the intent + * @property {string} [intent] Name of the intent, as defined in LUIS. + * @property {number} [score] Associated prediction score for the intent * (float). */ constructor() { diff --git a/lib/services/luis/runtime/lib/models/luisResult.js b/lib/services/luis/runtime/lib/models/luisResult.js index f80aa9af5f..0b0e9ae011 100644 --- a/lib/services/luis/runtime/lib/models/luisResult.js +++ b/lib/services/luis/runtime/lib/models/luisResult.js @@ -17,24 +17,24 @@ class LuisResult { /** * Create a LuisResult. - * @member {string} [query] The input utterance that was analized. - * @member {string} [alteredQuery] The corrected utterance (when spell + * @property {string} [query] The input utterance that was analized. + * @property {string} [alteredQuery] The corrected utterance (when spell * checking was enabled). - * @member {object} [topScoringIntent] - * @member {string} [topScoringIntent.intent] Name of the intent, as defined - * in LUIS. - * @member {number} [topScoringIntent.score] Associated prediction score for - * the intent (float). - * @member {array} [intents] All the intents (and their score) that were + * @property {object} [topScoringIntent] + * @property {string} [topScoringIntent.intent] Name of the intent, as + * defined in LUIS. + * @property {number} [topScoringIntent.score] Associated prediction score + * for the intent (float). + * @property {array} [intents] All the intents (and their score) that were * detected from utterance. - * @member {array} [entities] The entities extracted from the utterance. - * @member {array} [compositeEntities] The composite entities extracted from - * the utterance. - * @member {object} [sentimentAnalysis] - * @member {string} [sentimentAnalysis.label] The polarity of the sentiment, - * can be positive, neutral or negative. - * @member {number} [sentimentAnalysis.score] Score of the sentiment, ranges - * from 0 (most negative) to 1 (most positive). + * @property {array} [entities] The entities extracted from the utterance. + * @property {array} [compositeEntities] The composite entities extracted + * from the utterance. + * @property {object} [sentimentAnalysis] + * @property {string} [sentimentAnalysis.label] The polarity of the + * sentiment, can be positive, neutral or negative. + * @property {number} [sentimentAnalysis.score] Score of the sentiment, + * ranges from 0 (most negative) to 1 (most positive). */ constructor() { } diff --git a/lib/services/luis/runtime/lib/models/sentiment.js b/lib/services/luis/runtime/lib/models/sentiment.js index 2ff5b1621e..a01ac2b804 100644 --- a/lib/services/luis/runtime/lib/models/sentiment.js +++ b/lib/services/luis/runtime/lib/models/sentiment.js @@ -17,9 +17,9 @@ class Sentiment { /** * Create a Sentiment. - * @member {string} [label] The polarity of the sentiment, can be positive, + * @property {string} [label] The polarity of the sentiment, can be positive, * neutral or negative. - * @member {number} [score] Score of the sentiment, ranges from 0 (most + * @property {number} [score] Score of the sentiment, ranges from 0 (most * negative) to 1 (most positive). */ constructor() { diff --git a/lib/services/luis/runtime/package.json b/lib/services/luis/runtime/package.json index 99ac5b50f9..6a28f33a0e 100644 --- a/lib/services/luis/runtime/package.json +++ b/lib/services/luis/runtime/package.json @@ -2,7 +2,7 @@ "name": "azure-cognitiveservices-luis-runtime", "author": "Microsoft Corporation", "description": "LUISRuntimeClient Library with typescript type definitions for node", - "version": "1.1.0", + "version": "1.1.1", "dependencies": { "ms-rest": "^2.3.3" }, @@ -21,4 +21,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +} diff --git a/lib/services/machinelearning/lib/commitmentPlan/azureMLCommitmentPlansManagementClient.d.ts b/lib/services/machinelearning/lib/commitmentPlan/azureMLCommitmentPlansManagementClient.d.ts index 281bab750c..36239aae2b 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/azureMLCommitmentPlansManagementClient.d.ts +++ b/lib/services/machinelearning/lib/commitmentPlan/azureMLCommitmentPlansManagementClient.d.ts @@ -10,9 +10,10 @@ import { ServiceClientCredentials } from 'ms-rest'; import { AzureServiceClient, AzureServiceClientOptions } from 'ms-rest-azure'; +import * as models from "./models"; import * as operations from "./operations"; -declare class AzureMLCommitmentPlansManagementClient extends AzureServiceClient { +export default class AzureMLCommitmentPlansManagementClient extends AzureServiceClient { /** * Initializes a new instance of the AzureMLCommitmentPlansManagementClient class. * @constructor @@ -33,11 +34,11 @@ declare class AzureMLCommitmentPlansManagementClient extends AzureServiceClient * * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy * - * @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. + * @param {string} [options.acceptLanguage] - The preferred language for the response. * - * @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. * - * @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. * */ constructor(credentials: ServiceClientCredentials, subscriptionId: string, baseUri?: string, options?: AzureServiceClientOptions); @@ -55,9 +56,10 @@ declare class AzureMLCommitmentPlansManagementClient extends AzureServiceClient generateClientRequestId: boolean; // Operation groups + skus: operations.Skus; commitmentAssociations: operations.CommitmentAssociations; commitmentPlans: operations.CommitmentPlans; usageHistory: operations.UsageHistory; } -export = AzureMLCommitmentPlansManagementClient; +export { AzureMLCommitmentPlansManagementClient, models as AzureMLCommitmentPlansManagementModels }; diff --git a/lib/services/machinelearning/lib/commitmentPlan/azureMLCommitmentPlansManagementClient.js b/lib/services/machinelearning/lib/commitmentPlan/azureMLCommitmentPlansManagementClient.js index 4282bf27f8..bc0520e17c 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/azureMLCommitmentPlansManagementClient.js +++ b/lib/services/machinelearning/lib/commitmentPlan/azureMLCommitmentPlansManagementClient.js @@ -34,9 +34,9 @@ class AzureMLCommitmentPlansManagementClient extends ServiceClient { * @param {object} [options.requestOptions] - Options for the underlying request object * {@link https://github.com/request/request#requestoptions-callback Options doc} * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy - * @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. - * @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. - * @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * @param {string} [options.acceptLanguage] - The preferred language for the response. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. */ constructor(credentials, subscriptionId, baseUri, options) { if (credentials === null || credentials === undefined) { @@ -72,6 +72,7 @@ class AzureMLCommitmentPlansManagementClient extends ServiceClient { if(options.generateClientRequestId !== null && options.generateClientRequestId !== undefined) { this.generateClientRequestId = options.generateClientRequestId; } + this.skus = new operations.Skus(this); this.commitmentAssociations = new operations.CommitmentAssociations(this); this.commitmentPlans = new operations.CommitmentPlans(this); this.usageHistory = new operations.UsageHistory(this); @@ -82,3 +83,6 @@ class AzureMLCommitmentPlansManagementClient extends ServiceClient { } module.exports = AzureMLCommitmentPlansManagementClient; +module.exports['default'] = AzureMLCommitmentPlansManagementClient; +module.exports.AzureMLCommitmentPlansManagementClient = AzureMLCommitmentPlansManagementClient; +module.exports.AzureMLCommitmentPlansManagementModels = models; diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/catalogSku.js b/lib/services/machinelearning/lib/commitmentPlan/models/catalogSku.js new file mode 100644 index 0000000000..503e0b17dd --- /dev/null +++ b/lib/services/machinelearning/lib/commitmentPlan/models/catalogSku.js @@ -0,0 +1,156 @@ +/* + * 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'; + +/** + * Details of a commitment plan SKU. + * + */ +class CatalogSku { + /** + * Create a CatalogSku. + * @property {string} [resourceType] Resource type name + * @property {string} [name] SKU name + * @property {string} [tier] SKU tier + * @property {array} [locations] Regions where the SKU is available. + * @property {object} [capacity] SKU scaling information + * @property {number} [capacity.minimum] The minimum capacity. + * @property {number} [capacity.maximum] The maximum capacity that can be + * set. + * @property {number} [capacity.default] The default capacity. + * @property {string} [capacity.scaleType] The scale type applicable to the + * sku. Possible values include: 'Automatic', 'Manual', 'None' + * @property {array} [capabilities] The capability information for the + * specified SKU. + * @property {array} [costs] The cost information for the specified SKU. + * @property {array} [restrictions] Restrictions which would prevent a SKU + * from being used. This is empty if there are no restrictions. + */ + constructor() { + } + + /** + * Defines the metadata of CatalogSku + * + * @returns {object} metadata of CatalogSku + * + */ + mapper() { + return { + required: false, + serializedName: 'CatalogSku', + type: { + name: 'Composite', + className: 'CatalogSku', + modelProperties: { + resourceType: { + required: false, + readOnly: true, + serializedName: 'resourceType', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + tier: { + required: false, + readOnly: true, + serializedName: 'tier', + type: { + name: 'String' + } + }, + locations: { + required: false, + readOnly: true, + serializedName: 'locations', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + capacity: { + required: false, + readOnly: true, + serializedName: 'capacity', + type: { + name: 'Composite', + className: 'SkuCapacity' + } + }, + capabilities: { + required: false, + readOnly: true, + serializedName: 'capabilities', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'SkuCapabilityElementType', + type: { + name: 'Composite', + className: 'SkuCapability' + } + } + } + }, + costs: { + required: false, + readOnly: true, + serializedName: 'costs', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'SkuCostElementType', + type: { + name: 'Composite', + className: 'SkuCost' + } + } + } + }, + restrictions: { + required: false, + readOnly: true, + serializedName: 'restrictions', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'SkuRestrictionsElementType', + type: { + name: 'Composite', + className: 'SkuRestrictions' + } + } + } + } + } + } + }; + } +} + +module.exports = CatalogSku; diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociation.js b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociation.js index a360af1dfa..1b9b47f2fc 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociation.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociation.js @@ -21,16 +21,17 @@ const models = require('./index'); class CommitmentAssociation extends models['Resource'] { /** * Create a CommitmentAssociation. - * @member {string} [etag] An entity tag used to enforce optimistic + * @property {string} [etag] An entity tag used to enforce optimistic * concurrency. - * @member {object} [properties] The properties of the commitment association - * resource. - * @member {string} [properties.associatedResourceId] The ID of the resource - * this association points to, such as the ARM ID of an Azure ML web service. - * @member {string} [properties.commitmentPlanId] The ARM ID of the parent + * @property {object} [properties] The properties of the commitment + * association resource. + * @property {string} [properties.associatedResourceId] The ID of the + * resource this association points to, such as the ARM ID of an Azure ML web + * service. + * @property {string} [properties.commitmentPlanId] The ARM ID of the parent * Azure ML commitment plan. - * @member {date} [properties.creationDate] The date at which this commitment - * association was created, in ISO 8601 format. + * @property {date} [properties.creationDate] The date at which this + * commitment association was created, in ISO 8601 format. */ constructor() { super(); diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociationListResult.js b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociationListResult.js index dbed9c36bf..59cd8bf92c 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociationListResult.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociationListResult.js @@ -16,7 +16,7 @@ class CommitmentAssociationListResult extends Array { /** * Create a CommitmentAssociationListResult. - * @member {string} [nextLink] A URI to retrieve the next page of results. + * @property {string} [nextLink] A URI to retrieve the next page of results. */ constructor() { super(); diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociationProperties.js b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociationProperties.js index 2c2f2efbec..1931a418ed 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociationProperties.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentAssociationProperties.js @@ -17,11 +17,11 @@ class CommitmentAssociationProperties { /** * Create a CommitmentAssociationProperties. - * @member {string} [associatedResourceId] The ID of the resource this + * @property {string} [associatedResourceId] The ID of the resource this * association points to, such as the ARM ID of an Azure ML web service. - * @member {string} [commitmentPlanId] The ARM ID of the parent Azure ML + * @property {string} [commitmentPlanId] The ARM ID of the parent Azure ML * commitment plan. - * @member {date} [creationDate] The date at which this commitment + * @property {date} [creationDate] The date at which this commitment * association was created, in ISO 8601 format. */ constructor() { diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlan.js b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlan.js index 3f6d4b7917..23688755c8 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlan.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlan.js @@ -20,37 +20,37 @@ const models = require('./index'); class CommitmentPlan extends models['Resource'] { /** * Create a CommitmentPlan. - * @member {string} [etag] An entity tag used to enforce optimistic + * @property {string} [etag] An entity tag used to enforce optimistic * concurrency. - * @member {object} [properties] The commitment plan properties. - * @member {boolean} [properties.chargeForOverage] Indicates whether usage + * @property {object} [properties] The commitment plan properties. + * @property {boolean} [properties.chargeForOverage] Indicates whether usage * beyond the commitment plan's included quantities will be charged. - * @member {boolean} [properties.chargeForPlan] Indicates whether the + * @property {boolean} [properties.chargeForPlan] Indicates whether the * commitment plan will incur a charge. - * @member {date} [properties.creationDate] The date at which this commitment - * plan was created, in ISO 8601 format. - * @member {object} [properties.includedQuantities] The included resource + * @property {date} [properties.creationDate] The date at which this + * commitment plan was created, in ISO 8601 format. + * @property {object} [properties.includedQuantities] The included resource * quantities this plan gives you. - * @member {number} [properties.maxAssociationLimit] The maximum number of + * @property {number} [properties.maxAssociationLimit] The maximum number of * commitment associations that can be children of this commitment plan. - * @member {number} [properties.maxCapacityLimit] The maximum scale-out + * @property {number} [properties.maxCapacityLimit] The maximum scale-out * capacity for this commitment plan. - * @member {number} [properties.minCapacityLimit] The minimum scale-out + * @property {number} [properties.minCapacityLimit] The minimum scale-out * capacity for this commitment plan. - * @member {string} [properties.planMeter] The Azure meter which will be used - * to charge for this commitment plan. - * @member {number} [properties.refillFrequencyInDays] The frequency at which - * this commitment plan's included quantities are refilled. - * @member {boolean} [properties.suspendPlanOnOverage] Indicates whether this - * commitment plan will be moved into a suspended state if usage goes beyond - * the commitment plan's included quantities. - * @member {object} [sku] The commitment plan SKU. - * @member {number} [sku.capacity] The scale-out capacity of the resource. 1 - * is 1x, 2 is 2x, etc. This impacts the quantities and cost of any + * @property {string} [properties.planMeter] The Azure meter which will be + * used to charge for this commitment plan. + * @property {number} [properties.refillFrequencyInDays] The frequency at + * which this commitment plan's included quantities are refilled. + * @property {boolean} [properties.suspendPlanOnOverage] Indicates whether + * this commitment plan will be moved into a suspended state if usage goes + * beyond the commitment plan's included quantities. + * @property {object} [sku] The commitment plan SKU. + * @property {number} [sku.capacity] The scale-out capacity of the resource. + * 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any * commitment plan resource. - * @member {string} [sku.name] The SKU name. Along with tier, uniquely + * @property {string} [sku.name] The SKU name. Along with tier, uniquely * identifies the SKU. - * @member {string} [sku.tier] The SKU tier. Along with name, uniquely + * @property {string} [sku.tier] The SKU tier. Along with name, uniquely * identifies the SKU. */ constructor() { diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanListResult.js b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanListResult.js index 39c3a4bcf5..fe446e6733 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanListResult.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanListResult.js @@ -16,7 +16,7 @@ class CommitmentPlanListResult extends Array { /** * Create a CommitmentPlanListResult. - * @member {string} [nextLink] A URI to retrieve the next page of results. + * @property {string} [nextLink] A URI to retrieve the next page of results. */ constructor() { super(); diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanPatchPayload.js b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanPatchPayload.js index deeabbd0f2..e75d65567b 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanPatchPayload.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanPatchPayload.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The properties of a commitment plan which may be updated via PATCH. * @@ -19,14 +17,14 @@ const models = require('./index'); class CommitmentPlanPatchPayload { /** * Create a CommitmentPlanPatchPayload. - * @member {object} [tags] User-defined tags for the commitment plan. - * @member {object} [sku] The commitment plan SKU. - * @member {number} [sku.capacity] The scale-out capacity of the resource. 1 - * is 1x, 2 is 2x, etc. This impacts the quantities and cost of any + * @property {object} [tags] User-defined tags for the commitment plan. + * @property {object} [sku] The commitment plan SKU. + * @property {number} [sku.capacity] The scale-out capacity of the resource. + * 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any * commitment plan resource. - * @member {string} [sku.name] The SKU name. Along with tier, uniquely + * @property {string} [sku.name] The SKU name. Along with tier, uniquely * identifies the SKU. - * @member {string} [sku.tier] The SKU tier. Along with name, uniquely + * @property {string} [sku.tier] The SKU tier. Along with name, uniquely * identifies the SKU. */ constructor() { diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanProperties.js b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanProperties.js index 4bf54fb989..c8f41bd85c 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanProperties.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/commitmentPlanProperties.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Properties of an Azure ML commitment plan. * @@ -19,27 +17,27 @@ const models = require('./index'); class CommitmentPlanProperties { /** * Create a CommitmentPlanProperties. - * @member {boolean} [chargeForOverage] Indicates whether usage beyond the + * @property {boolean} [chargeForOverage] Indicates whether usage beyond the * commitment plan's included quantities will be charged. - * @member {boolean} [chargeForPlan] Indicates whether the commitment plan + * @property {boolean} [chargeForPlan] Indicates whether the commitment plan * will incur a charge. - * @member {date} [creationDate] The date at which this commitment plan was + * @property {date} [creationDate] The date at which this commitment plan was * created, in ISO 8601 format. - * @member {object} [includedQuantities] The included resource quantities + * @property {object} [includedQuantities] The included resource quantities * this plan gives you. - * @member {number} [maxAssociationLimit] The maximum number of commitment + * @property {number} [maxAssociationLimit] The maximum number of commitment * associations that can be children of this commitment plan. - * @member {number} [maxCapacityLimit] The maximum scale-out capacity for + * @property {number} [maxCapacityLimit] The maximum scale-out capacity for * this commitment plan. - * @member {number} [minCapacityLimit] The minimum scale-out capacity for + * @property {number} [minCapacityLimit] The minimum scale-out capacity for * this commitment plan. - * @member {string} [planMeter] The Azure meter which will be used to charge - * for this commitment plan. - * @member {number} [refillFrequencyInDays] The frequency at which this + * @property {string} [planMeter] The Azure meter which will be used to + * charge for this commitment plan. + * @property {number} [refillFrequencyInDays] The frequency at which this * commitment plan's included quantities are refilled. - * @member {boolean} [suspendPlanOnOverage] Indicates whether this commitment - * plan will be moved into a suspended state if usage goes beyond the - * commitment plan's included quantities. + * @property {boolean} [suspendPlanOnOverage] Indicates whether this + * commitment plan will be moved into a suspended state if usage goes beyond + * the commitment plan's included quantities. */ constructor() { } diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/index.d.ts b/lib/services/machinelearning/lib/commitmentPlan/models/index.d.ts index 62a8ac92c2..483764348f 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/index.d.ts +++ b/lib/services/machinelearning/lib/commitmentPlan/models/index.d.ts @@ -1,312 +1,392 @@ /* * 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 +}; + +/** + * Describes scaling information of a SKU. + */ +export interface SkuCapacity { + /** + * The minimum capacity. + */ + readonly minimum?: number; + /** + * The maximum capacity that can be set. + */ + readonly maximum?: number; + /** + * The default capacity. + */ + readonly default?: number; + /** + * The scale type applicable to the sku. Possible values include: 'Automatic', 'Manual', 'None' + */ + readonly scaleType?: string; +} + +/** + * Describes The SKU capabilites object. + */ +export interface SkuCapability { + /** + * The capability name. + */ + readonly name?: string; + /** + * The capability value. + */ + readonly value?: string; +} + +/** + * Describes metadata for SKU cost info. + */ +export interface SkuCost { + /** + * The meter used for this part of a SKU's cost. + */ + readonly meterID?: string; + /** + * The multiplier for the meter ID. + */ + readonly quantity?: number; + /** + * The overall duration represented by the quantity. + */ + readonly extendedUnit?: string; +} + +/** + * Describes restrictions which would prevent a SKU from being used. + */ +export interface SkuRestrictions { + /** + * The type of restrictions. Possible values include: 'location', 'zone' + */ + readonly type?: string; + /** + * The value of restrictions. If the restriction type is set to location. This would be different + * locations where the SKU is restricted. + */ + readonly values?: string[]; + /** + * The reason for restriction. Possible values include: 'QuotaId', 'NotAvailableForSubscription' + */ + readonly reasonCode?: string; +} + +/** + * Details of a commitment plan SKU. + */ +export interface CatalogSku { + /** + * Resource type name + */ + readonly resourceType?: string; + /** + * SKU name + */ + readonly name?: string; + /** + * SKU tier + */ + readonly tier?: string; + /** + * Regions where the SKU is available. + */ + readonly locations?: string[]; + /** + * SKU scaling information + */ + readonly capacity?: SkuCapacity; + /** + * The capability information for the specified SKU. + */ + readonly capabilities?: SkuCapability[]; + /** + * The cost information for the specified SKU. + */ + readonly costs?: SkuCost[]; + /** + * Restrictions which would prevent a SKU from being used. This is empty if there are no + * restrictions. + */ + readonly restrictions?: SkuRestrictions[]; +} /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * Common properties of an ARM resource. - * - * @member {string} [id] Resource Id. - * @member {string} [name] Resource name. - * @member {string} location Resource location. - * @member {string} [type] Resource type. - * @member {object} [tags] User-defined tags for the resource. */ export interface Resource extends BaseResource { + /** + * Resource Id. + */ readonly id?: string; + /** + * Resource name. + */ readonly name?: string; + /** + * Resource location. + */ location: string; + /** + * Resource type. + */ readonly type?: string; + /** + * User-defined tags for the resource. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the CommitmentAssociationProperties class. - * @constructor * Properties of an Azure ML commitment association. - * - * @member {string} [associatedResourceId] The ID of the resource this - * association points to, such as the ARM ID of an Azure ML web service. - * @member {string} [commitmentPlanId] The ARM ID of the parent Azure ML - * commitment plan. - * @member {date} [creationDate] The date at which this commitment association - * was created, in ISO 8601 format. */ export interface CommitmentAssociationProperties { + /** + * The ID of the resource this association points to, such as the ARM ID of an Azure ML web + * service. + */ readonly associatedResourceId?: string; + /** + * The ARM ID of the parent Azure ML commitment plan. + */ readonly commitmentPlanId?: string; + /** + * The date at which this commitment association was created, in ISO 8601 format. + */ readonly creationDate?: Date; } /** - * @class - * Initializes a new instance of the CommitmentAssociation class. - * @constructor - * Represents the association between a commitment plan and some other - * resource, such as a Machine Learning web service. - * - * @member {string} [etag] An entity tag used to enforce optimistic - * concurrency. - * @member {object} [properties] The properties of the commitment association - * resource. - * @member {string} [properties.associatedResourceId] The ID of the resource - * this association points to, such as the ARM ID of an Azure ML web service. - * @member {string} [properties.commitmentPlanId] The ARM ID of the parent - * Azure ML commitment plan. - * @member {date} [properties.creationDate] The date at which this commitment - * association was created, in ISO 8601 format. + * Represents the association between a commitment plan and some other resource, such as a Machine + * Learning web service. */ export interface CommitmentAssociation extends Resource { + /** + * An entity tag used to enforce optimistic concurrency. + */ etag?: string; + /** + * The properties of the commitment association resource. + */ properties?: CommitmentAssociationProperties; } /** - * @class - * Initializes a new instance of the ResourceSku class. - * @constructor * The SKU of a resource. - * - * @member {number} [capacity] The scale-out capacity of the resource. 1 is 1x, - * 2 is 2x, etc. This impacts the quantities and cost of any commitment plan - * resource. - * @member {string} [name] The SKU name. Along with tier, uniquely identifies - * the SKU. - * @member {string} [tier] The SKU tier. Along with name, uniquely identifies - * the SKU. */ export interface ResourceSku { + /** + * The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and + * cost of any commitment plan resource. + */ capacity?: number; + /** + * The SKU name. Along with tier, uniquely identifies the SKU. + */ name?: string; + /** + * The SKU tier. Along with name, uniquely identifies the SKU. + */ tier?: string; } /** - * @class - * Initializes a new instance of the MoveCommitmentAssociationRequest class. - * @constructor * Specifies the destination Azure ML commitment plan for a move operation. - * - * @member {string} [destinationPlanId] The ARM ID of the commitment plan to - * re-parent the commitment association to. */ export interface MoveCommitmentAssociationRequest { + /** + * The ARM ID of the commitment plan to re-parent the commitment association to. + */ destinationPlanId?: string; } /** - * @class - * Initializes a new instance of the CommitmentPlanPatchPayload class. - * @constructor * The properties of a commitment plan which may be updated via PATCH. - * - * @member {object} [tags] User-defined tags for the commitment plan. - * @member {object} [sku] The commitment plan SKU. - * @member {number} [sku.capacity] The scale-out capacity of the resource. 1 is - * 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment - * plan resource. - * @member {string} [sku.name] The SKU name. Along with tier, uniquely - * identifies the SKU. - * @member {string} [sku.tier] The SKU tier. Along with name, uniquely - * identifies the SKU. */ export interface CommitmentPlanPatchPayload { + /** + * User-defined tags for the commitment plan. + */ tags?: { [propertyName: string]: string }; + /** + * The commitment plan SKU. + */ sku?: ResourceSku; } /** - * @class - * Initializes a new instance of the PlanQuantity class. - * @constructor * Represents the quantity a commitment plan provides of a metered resource. - * - * @member {number} [allowance] The quantity added to the commitment plan at an - * interval specified by its allowance frequency. - * @member {number} [amount] The quantity available to the plan the last time - * usage was calculated. - * @member {string} [includedQuantityMeter] The Azure meter for usage against - * included quantities. - * @member {string} [overageMeter] The Azure meter for usage which exceeds - * included quantities. */ export interface PlanQuantity { + /** + * The quantity added to the commitment plan at an interval specified by its allowance frequency. + */ readonly allowance?: number; + /** + * The quantity available to the plan the last time usage was calculated. + */ readonly amount?: number; + /** + * The Azure meter for usage against included quantities. + */ readonly includedQuantityMeter?: string; + /** + * The Azure meter for usage which exceeds included quantities. + */ readonly overageMeter?: string; } /** - * @class - * Initializes a new instance of the CommitmentPlanProperties class. - * @constructor * Properties of an Azure ML commitment plan. - * - * @member {boolean} [chargeForOverage] Indicates whether usage beyond the - * commitment plan's included quantities will be charged. - * @member {boolean} [chargeForPlan] Indicates whether the commitment plan will - * incur a charge. - * @member {date} [creationDate] The date at which this commitment plan was - * created, in ISO 8601 format. - * @member {object} [includedQuantities] The included resource quantities this - * plan gives you. - * @member {number} [maxAssociationLimit] The maximum number of commitment - * associations that can be children of this commitment plan. - * @member {number} [maxCapacityLimit] The maximum scale-out capacity for this - * commitment plan. - * @member {number} [minCapacityLimit] The minimum scale-out capacity for this - * commitment plan. - * @member {string} [planMeter] The Azure meter which will be used to charge - * for this commitment plan. - * @member {number} [refillFrequencyInDays] The frequency at which this - * commitment plan's included quantities are refilled. - * @member {boolean} [suspendPlanOnOverage] Indicates whether this commitment - * plan will be moved into a suspended state if usage goes beyond the - * commitment plan's included quantities. */ export interface CommitmentPlanProperties { + /** + * Indicates whether usage beyond the commitment plan's included quantities will be charged. + */ readonly chargeForOverage?: boolean; + /** + * Indicates whether the commitment plan will incur a charge. + */ readonly chargeForPlan?: boolean; + /** + * The date at which this commitment plan was created, in ISO 8601 format. + */ readonly creationDate?: Date; + /** + * The included resource quantities this plan gives you. + */ readonly includedQuantities?: { [propertyName: string]: PlanQuantity }; + /** + * The maximum number of commitment associations that can be children of this commitment plan. + */ readonly maxAssociationLimit?: number; + /** + * The maximum scale-out capacity for this commitment plan. + */ readonly maxCapacityLimit?: number; + /** + * The minimum scale-out capacity for this commitment plan. + */ readonly minCapacityLimit?: number; + /** + * The Azure meter which will be used to charge for this commitment plan. + */ readonly planMeter?: string; + /** + * The frequency at which this commitment plan's included quantities are refilled. + */ readonly refillFrequencyInDays?: number; + /** + * Indicates whether this commitment plan will be moved into a suspended state if usage goes + * beyond the commitment plan's included quantities. + */ readonly suspendPlanOnOverage?: boolean; } /** - * @class - * Initializes a new instance of the CommitmentPlan class. - * @constructor * An Azure ML commitment plan resource. - * - * @member {string} [etag] An entity tag used to enforce optimistic - * concurrency. - * @member {object} [properties] The commitment plan properties. - * @member {boolean} [properties.chargeForOverage] Indicates whether usage - * beyond the commitment plan's included quantities will be charged. - * @member {boolean} [properties.chargeForPlan] Indicates whether the - * commitment plan will incur a charge. - * @member {date} [properties.creationDate] The date at which this commitment - * plan was created, in ISO 8601 format. - * @member {object} [properties.includedQuantities] The included resource - * quantities this plan gives you. - * @member {number} [properties.maxAssociationLimit] The maximum number of - * commitment associations that can be children of this commitment plan. - * @member {number} [properties.maxCapacityLimit] The maximum scale-out - * capacity for this commitment plan. - * @member {number} [properties.minCapacityLimit] The minimum scale-out - * capacity for this commitment plan. - * @member {string} [properties.planMeter] The Azure meter which will be used - * to charge for this commitment plan. - * @member {number} [properties.refillFrequencyInDays] The frequency at which - * this commitment plan's included quantities are refilled. - * @member {boolean} [properties.suspendPlanOnOverage] Indicates whether this - * commitment plan will be moved into a suspended state if usage goes beyond - * the commitment plan's included quantities. - * @member {object} [sku] The commitment plan SKU. - * @member {number} [sku.capacity] The scale-out capacity of the resource. 1 is - * 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment - * plan resource. - * @member {string} [sku.name] The SKU name. Along with tier, uniquely - * identifies the SKU. - * @member {string} [sku.tier] The SKU tier. Along with name, uniquely - * identifies the SKU. */ export interface CommitmentPlan extends Resource { + /** + * An entity tag used to enforce optimistic concurrency. + */ etag?: string; + /** + * The commitment plan properties. + */ readonly properties?: CommitmentPlanProperties; + /** + * The commitment plan SKU. + */ sku?: ResourceSku; } /** - * @class - * Initializes a new instance of the PlanUsageHistory class. - * @constructor - * Represents historical information about usage of the Azure resources - * associated with a commitment plan. - * - * @member {object} [planDeletionOverage] Overage incurred as a result of - * deleting a commitment plan. - * @member {object} [planMigrationOverage] Overage incurred as a result of - * migrating a commitment plan from one SKU to another. - * @member {object} [planQuantitiesAfterUsage] Included quantities remaining - * after usage against the commitment plan's associated resources was - * calculated. - * @member {object} [planQuantitiesBeforeUsage] Included quantities remaining - * before usage against the commitment plan's associated resources was - * calculated. - * @member {object} [planUsageOverage] Usage against the commitment plan's - * associated resources which was not covered by included quantities and is - * therefore overage. - * @member {object} [usage] Usage against the commitment plan's associated - * resources. - * @member {date} [usageDate] The date of usage, in ISO 8601 format. + * Represents historical information about usage of the Azure resources associated with a + * commitment plan. */ export interface PlanUsageHistory { + /** + * Overage incurred as a result of deleting a commitment plan. + */ planDeletionOverage?: { [propertyName: string]: number }; + /** + * Overage incurred as a result of migrating a commitment plan from one SKU to another. + */ planMigrationOverage?: { [propertyName: string]: number }; + /** + * Included quantities remaining after usage against the commitment plan's associated resources + * was calculated. + */ planQuantitiesAfterUsage?: { [propertyName: string]: number }; + /** + * Included quantities remaining before usage against the commitment plan's associated resources + * was calculated. + */ planQuantitiesBeforeUsage?: { [propertyName: string]: number }; + /** + * Usage against the commitment plan's associated resources which was not covered by included + * quantities and is therefore overage. + */ planUsageOverage?: { [propertyName: string]: number }; + /** + * Usage against the commitment plan's associated resources. + */ usage?: { [propertyName: string]: number }; + /** + * The date of usage, in ISO 8601 format. + */ usageDate?: Date; } +/** + * The list of commitment plan SKUs. + */ +export interface SkuListResult extends Array { +} /** - * @class - * Initializes a new instance of the CommitmentAssociationListResult class. - * @constructor * A page of commitment association resources. - * - * @member {string} [nextLink] A URI to retrieve the next page of results. */ export interface CommitmentAssociationListResult extends Array { + /** + * A URI to retrieve the next page of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the CommitmentPlanListResult class. - * @constructor * A page of commitment plan resources. - * - * @member {string} [nextLink] A URI to retrieve the next page of results. */ export interface CommitmentPlanListResult extends Array { + /** + * A URI to retrieve the next page of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the PlanUsageHistoryListResult class. - * @constructor * A page of usage history. - * - * @member {string} [nextLink] A URI to retrieve the next page of results. */ export interface PlanUsageHistoryListResult extends Array { + /** + * A URI to retrieve the next page of results. + */ nextLink?: string; } diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/index.js b/lib/services/machinelearning/lib/commitmentPlan/models/index.js index 46171a5471..d4c1c19763 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/index.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/index.js @@ -18,6 +18,11 @@ var msRestAzure = require('ms-rest-azure'); exports.BaseResource = msRestAzure.BaseResource; exports.CloudError = msRestAzure.CloudError; +exports.SkuCapacity = require('./skuCapacity'); +exports.SkuCapability = require('./skuCapability'); +exports.SkuCost = require('./skuCost'); +exports.SkuRestrictions = require('./skuRestrictions'); +exports.CatalogSku = require('./catalogSku'); exports.Resource = require('./resource'); exports.CommitmentAssociationProperties = require('./commitmentAssociationProperties'); exports.CommitmentAssociation = require('./commitmentAssociation'); @@ -28,6 +33,7 @@ exports.PlanQuantity = require('./planQuantity'); exports.CommitmentPlanProperties = require('./commitmentPlanProperties'); exports.CommitmentPlan = require('./commitmentPlan'); exports.PlanUsageHistory = require('./planUsageHistory'); +exports.SkuListResult = require('./skuListResult'); exports.CommitmentAssociationListResult = require('./commitmentAssociationListResult'); exports.CommitmentPlanListResult = require('./commitmentPlanListResult'); exports.PlanUsageHistoryListResult = require('./planUsageHistoryListResult'); diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/moveCommitmentAssociationRequest.js b/lib/services/machinelearning/lib/commitmentPlan/models/moveCommitmentAssociationRequest.js index f8b01fbced..2be106084a 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/moveCommitmentAssociationRequest.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/moveCommitmentAssociationRequest.js @@ -17,8 +17,8 @@ class MoveCommitmentAssociationRequest { /** * Create a MoveCommitmentAssociationRequest. - * @member {string} [destinationPlanId] The ARM ID of the commitment plan to - * re-parent the commitment association to. + * @property {string} [destinationPlanId] The ARM ID of the commitment plan + * to re-parent the commitment association to. */ constructor() { } diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/planQuantity.js b/lib/services/machinelearning/lib/commitmentPlan/models/planQuantity.js index 6059858666..f884b5da98 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/planQuantity.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/planQuantity.js @@ -17,13 +17,13 @@ class PlanQuantity { /** * Create a PlanQuantity. - * @member {number} [allowance] The quantity added to the commitment plan at - * an interval specified by its allowance frequency. - * @member {number} [amount] The quantity available to the plan the last time - * usage was calculated. - * @member {string} [includedQuantityMeter] The Azure meter for usage against - * included quantities. - * @member {string} [overageMeter] The Azure meter for usage which exceeds + * @property {number} [allowance] The quantity added to the commitment plan + * at an interval specified by its allowance frequency. + * @property {number} [amount] The quantity available to the plan the last + * time usage was calculated. + * @property {string} [includedQuantityMeter] The Azure meter for usage + * against included quantities. + * @property {string} [overageMeter] The Azure meter for usage which exceeds * included quantities. */ constructor() { diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/planUsageHistory.js b/lib/services/machinelearning/lib/commitmentPlan/models/planUsageHistory.js index 4d3badd065..2228414ade 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/planUsageHistory.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/planUsageHistory.js @@ -18,22 +18,22 @@ class PlanUsageHistory { /** * Create a PlanUsageHistory. - * @member {object} [planDeletionOverage] Overage incurred as a result of + * @property {object} [planDeletionOverage] Overage incurred as a result of * deleting a commitment plan. - * @member {object} [planMigrationOverage] Overage incurred as a result of + * @property {object} [planMigrationOverage] Overage incurred as a result of * migrating a commitment plan from one SKU to another. - * @member {object} [planQuantitiesAfterUsage] Included quantities remaining - * after usage against the commitment plan's associated resources was - * calculated. - * @member {object} [planQuantitiesBeforeUsage] Included quantities remaining - * before usage against the commitment plan's associated resources was - * calculated. - * @member {object} [planUsageOverage] Usage against the commitment plan's + * @property {object} [planQuantitiesAfterUsage] Included quantities + * remaining after usage against the commitment plan's associated resources + * was calculated. + * @property {object} [planQuantitiesBeforeUsage] Included quantities + * remaining before usage against the commitment plan's associated resources + * was calculated. + * @property {object} [planUsageOverage] Usage against the commitment plan's * associated resources which was not covered by included quantities and is * therefore overage. - * @member {object} [usage] Usage against the commitment plan's associated + * @property {object} [usage] Usage against the commitment plan's associated * resources. - * @member {date} [usageDate] The date of usage, in ISO 8601 format. + * @property {date} [usageDate] The date of usage, in ISO 8601 format. */ constructor() { } diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/planUsageHistoryListResult.js b/lib/services/machinelearning/lib/commitmentPlan/models/planUsageHistoryListResult.js index 0615e0fbff..7a14d6f041 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/planUsageHistoryListResult.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/planUsageHistoryListResult.js @@ -16,7 +16,7 @@ class PlanUsageHistoryListResult extends Array { /** * Create a PlanUsageHistoryListResult. - * @member {string} [nextLink] A URI to retrieve the next page of results. + * @property {string} [nextLink] A URI to retrieve the next page of results. */ constructor() { super(); diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/resource.js b/lib/services/machinelearning/lib/commitmentPlan/models/resource.js index 3f15f48923..2664553650 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/resource.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/resource.js @@ -20,11 +20,11 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] Resource Id. - * @member {string} [name] Resource name. - * @member {string} location Resource location. - * @member {string} [type] Resource type. - * @member {object} [tags] User-defined tags for the resource. + * @property {string} [id] Resource Id. + * @property {string} [name] Resource name. + * @property {string} location Resource location. + * @property {string} [type] Resource type. + * @property {object} [tags] User-defined tags for the resource. */ constructor() { super(); diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/resourceSku.js b/lib/services/machinelearning/lib/commitmentPlan/models/resourceSku.js index e15eae450b..d62326e1b1 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/models/resourceSku.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/resourceSku.js @@ -17,13 +17,13 @@ class ResourceSku { /** * Create a ResourceSku. - * @member {number} [capacity] The scale-out capacity of the resource. 1 is + * @property {number} [capacity] The scale-out capacity of the resource. 1 is * 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment * plan resource. - * @member {string} [name] The SKU name. Along with tier, uniquely identifies - * the SKU. - * @member {string} [tier] The SKU tier. Along with name, uniquely identifies - * the SKU. + * @property {string} [name] The SKU name. Along with tier, uniquely + * identifies the SKU. + * @property {string} [tier] The SKU tier. Along with name, uniquely + * identifies the SKU. */ constructor() { } diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/skuCapability.js b/lib/services/machinelearning/lib/commitmentPlan/models/skuCapability.js new file mode 100644 index 0000000000..dd336fc6d7 --- /dev/null +++ b/lib/services/machinelearning/lib/commitmentPlan/models/skuCapability.js @@ -0,0 +1,62 @@ +/* + * 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'; + +/** + * Describes The SKU capabilites object. + * + */ +class SkuCapability { + /** + * Create a SkuCapability. + * @property {string} [name] The capability name. + * @property {string} [value] The capability value. + */ + constructor() { + } + + /** + * Defines the metadata of SkuCapability + * + * @returns {object} metadata of SkuCapability + * + */ + mapper() { + return { + required: false, + serializedName: 'SkuCapability', + type: { + name: 'Composite', + className: 'SkuCapability', + modelProperties: { + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + value: { + required: false, + readOnly: true, + serializedName: 'value', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = SkuCapability; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/contentSummary.js b/lib/services/machinelearning/lib/commitmentPlan/models/skuCapacity.js similarity index 54% rename from lib/services/dataLake.Store/lib/filesystem/models/contentSummary.js rename to lib/services/machinelearning/lib/commitmentPlan/models/skuCapacity.js index 0a28148049..ad5b1a9085 100644 --- a/lib/services/dataLake.Store/lib/filesystem/models/contentSummary.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/skuCapacity.js @@ -11,64 +11,65 @@ 'use strict'; /** - * Data Lake Store content summary information + * Describes scaling information of a SKU. * */ -class ContentSummary { +class SkuCapacity { /** - * Create a ContentSummary. - * @property {number} [directoryCount] the number of directories. - * @property {number} [fileCount] the number of files. - * @property {number} [length] the number of bytes used by the content. - * @property {number} [spaceConsumed] the disk space consumed by the content. + * Create a SkuCapacity. + * @property {number} [minimum] The minimum capacity. + * @property {number} [maximum] The maximum capacity that can be set. + * @property {number} [default] The default capacity. + * @property {string} [scaleType] The scale type applicable to the sku. + * Possible values include: 'Automatic', 'Manual', 'None' */ constructor() { } /** - * Defines the metadata of ContentSummary + * Defines the metadata of SkuCapacity * - * @returns {object} metadata of ContentSummary + * @returns {object} metadata of SkuCapacity * */ mapper() { return { required: false, - serializedName: 'ContentSummary', + serializedName: 'SkuCapacity', type: { name: 'Composite', - className: 'ContentSummary', + className: 'SkuCapacity', modelProperties: { - directoryCount: { + minimum: { required: false, readOnly: true, - serializedName: 'directoryCount', + serializedName: 'minimum', type: { name: 'Number' } }, - fileCount: { + maximum: { required: false, readOnly: true, - serializedName: 'fileCount', + serializedName: 'maximum', type: { name: 'Number' } }, - length: { + default: { required: false, readOnly: true, - serializedName: 'length', + serializedName: 'default', type: { name: 'Number' } }, - spaceConsumed: { + scaleType: { required: false, readOnly: true, - serializedName: 'spaceConsumed', + serializedName: 'scaleType', type: { - name: 'Number' + name: 'String' } } } @@ -77,4 +78,4 @@ class ContentSummary { } } -module.exports = ContentSummary; +module.exports = SkuCapacity; diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/skuCost.js b/lib/services/machinelearning/lib/commitmentPlan/models/skuCost.js new file mode 100644 index 0000000000..338be2820e --- /dev/null +++ b/lib/services/machinelearning/lib/commitmentPlan/models/skuCost.js @@ -0,0 +1,72 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Describes metadata for SKU cost info. + * + */ +class SkuCost { + /** + * Create a SkuCost. + * @property {string} [meterID] The meter used for this part of a SKU's cost. + * @property {number} [quantity] The multiplier for the meter ID. + * @property {string} [extendedUnit] The overall duration represented by the + * quantity. + */ + constructor() { + } + + /** + * Defines the metadata of SkuCost + * + * @returns {object} metadata of SkuCost + * + */ + mapper() { + return { + required: false, + serializedName: 'SkuCost', + type: { + name: 'Composite', + className: 'SkuCost', + modelProperties: { + meterID: { + required: false, + readOnly: true, + serializedName: 'meterID', + type: { + name: 'String' + } + }, + quantity: { + required: false, + readOnly: true, + serializedName: 'quantity', + type: { + name: 'Number' + } + }, + extendedUnit: { + required: false, + readOnly: true, + serializedName: 'extendedUnit', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = SkuCost; diff --git a/lib/services/dataLake.Store/lib/filesystem/models/fileStatuses.js b/lib/services/machinelearning/lib/commitmentPlan/models/skuListResult.js similarity index 59% rename from lib/services/dataLake.Store/lib/filesystem/models/fileStatuses.js rename to lib/services/machinelearning/lib/commitmentPlan/models/skuListResult.js index c73fa30d0b..fbbc932589 100644 --- a/lib/services/dataLake.Store/lib/filesystem/models/fileStatuses.js +++ b/lib/services/machinelearning/lib/commitmentPlan/models/skuListResult.js @@ -11,44 +11,42 @@ 'use strict'; /** - * Data Lake Store file status list information. - * + * The list of commitment plan SKUs. */ -class FileStatuses { +class SkuListResult extends Array { /** - * Create a FileStatuses. - * @property {array} [fileStatus] the object containing the list of - * properties of the files. + * Create a SkuListResult. */ constructor() { + super(); } /** - * Defines the metadata of FileStatuses + * Defines the metadata of SkuListResult * - * @returns {object} metadata of FileStatuses + * @returns {object} metadata of SkuListResult * */ mapper() { return { required: false, - serializedName: 'FileStatuses', + serializedName: 'SkuListResult', type: { name: 'Composite', - className: 'FileStatuses', + className: 'SkuListResult', modelProperties: { - fileStatus: { + value: { required: false, readOnly: true, - serializedName: 'fileStatus', + serializedName: '', type: { name: 'Sequence', element: { required: false, - serializedName: 'FileStatusPropertiesElementType', + serializedName: 'CatalogSkuElementType', type: { name: 'Composite', - className: 'FileStatusProperties' + className: 'CatalogSku' } } } @@ -59,4 +57,4 @@ class FileStatuses { } } -module.exports = FileStatuses; +module.exports = SkuListResult; diff --git a/lib/services/machinelearning/lib/commitmentPlan/models/skuRestrictions.js b/lib/services/machinelearning/lib/commitmentPlan/models/skuRestrictions.js new file mode 100644 index 0000000000..6c08046304 --- /dev/null +++ b/lib/services/machinelearning/lib/commitmentPlan/models/skuRestrictions.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'; + +/** + * Describes restrictions which would prevent a SKU from being used. + * + */ +class SkuRestrictions { + /** + * Create a SkuRestrictions. + * @property {string} [type] The type of restrictions. Possible values + * include: 'location', 'zone' + * @property {array} [values] The value of restrictions. If the restriction + * type is set to location. This would be different locations where the SKU + * is restricted. + * @property {string} [reasonCode] The reason for restriction. Possible + * values include: 'QuotaId', 'NotAvailableForSubscription' + */ + constructor() { + } + + /** + * Defines the metadata of SkuRestrictions + * + * @returns {object} metadata of SkuRestrictions + * + */ + mapper() { + return { + required: false, + serializedName: 'SkuRestrictions', + type: { + name: 'Composite', + className: 'SkuRestrictions', + modelProperties: { + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + values: { + required: false, + readOnly: true, + serializedName: 'values', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + reasonCode: { + required: false, + readOnly: true, + serializedName: 'reasonCode', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = SkuRestrictions; diff --git a/lib/services/machinelearning/lib/commitmentPlan/operations/index.d.ts b/lib/services/machinelearning/lib/commitmentPlan/operations/index.d.ts index 26a700ae6d..144ed3d1ab 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/operations/index.d.ts +++ b/lib/services/machinelearning/lib/commitmentPlan/operations/index.d.ts @@ -12,6 +12,66 @@ import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationRes import * as models from '../models'; +/** + * @class + * Skus + * __NOTE__: An instance of this class is automatically created for an + * instance of the AzureMLCommitmentPlansManagementClient. + */ +export interface Skus { + + + /** + * Lists the available commitment plan SKUs. + * + * @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. + */ + listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists the available commitment plan SKUs. + * + * @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 {SkuListResult} - 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. + * + * {SkuListResult} [result] - The deserialized result object if an error did not occur. + * See {@link SkuListResult} 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. + */ + list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(callback: ServiceCallback): void; + list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + /** * @class * CommitmentAssociations diff --git a/lib/services/machinelearning/lib/commitmentPlan/operations/index.js b/lib/services/machinelearning/lib/commitmentPlan/operations/index.js index a1d7abc178..26da863e22 100644 --- a/lib/services/machinelearning/lib/commitmentPlan/operations/index.js +++ b/lib/services/machinelearning/lib/commitmentPlan/operations/index.js @@ -14,6 +14,7 @@ 'use strict'; +exports.Skus = require('./skus'); exports.CommitmentAssociations = require('./commitmentAssociations'); exports.CommitmentPlans = require('./commitmentPlans'); exports.UsageHistory = require('./usageHistory'); diff --git a/lib/services/machinelearning/lib/commitmentPlan/operations/skus.js b/lib/services/machinelearning/lib/commitmentPlan/operations/skus.js new file mode 100644 index 0000000000..ea3f0a0313 --- /dev/null +++ b/lib/services/machinelearning/lib/commitmentPlan/operations/skus.js @@ -0,0 +1,241 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * Lists the available commitment plan SKUs. + * + * @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 SkuListResult} 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 _list(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 (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 (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}/providers/Microsoft.MachineLearning/skus'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SkuListResult']().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); + }); +} + +/** Class representing a Skus. */ +class Skus { + /** + * Create a Skus. + * @param {AzureMLCommitmentPlansManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._list = _list; + } + + /** + * Lists the available commitment plan SKUs. + * + * @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. + */ + listWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists the available commitment plan SKUs. + * + * @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 {SkuListResult} - 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 SkuListResult} 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. + */ + list(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._list(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(options, optionalCallback); + } + } + +} + +module.exports = Skus; diff --git a/lib/services/machinelearning/lib/machinelearning.d.ts b/lib/services/machinelearning/lib/machinelearning.d.ts index 68e690d926..da966cd9bd 100644 --- a/lib/services/machinelearning/lib/machinelearning.d.ts +++ b/lib/services/machinelearning/lib/machinelearning.d.ts @@ -8,5 +8,7 @@ import CommitmentPlansManagementClient = require('./commitmentPlan/azureMLCommit import * as CommitmentPlansModels from './commitmentPlan/models'; import WebServicesManagementClient = require('./webservices/azureMLWebServicesManagementClient'); import * as WebServicesModels from './webservices/models'; +import WorkspacesManagementClient = require('./workspaces/machineLearningWorkspacesManagementClient'); +import * as WorkspacesModels from './webservices/models'; -export { CommitmentPlansManagementClient, CommitmentPlansModels, WebServicesManagementClient, WebServicesModels }; \ No newline at end of file +export { CommitmentPlansManagementClient, CommitmentPlansModels, WebServicesManagementClient, WebServicesModels, WorkspacesManagementClient, WorkspacesModels }; \ No newline at end of file diff --git a/lib/services/machinelearning/lib/machinelearning.js b/lib/services/machinelearning/lib/machinelearning.js index 2fd9d35b03..9e95eed6a7 100644 --- a/lib/services/machinelearning/lib/machinelearning.js +++ b/lib/services/machinelearning/lib/machinelearning.js @@ -7,4 +7,5 @@ exports = module.exports; exports.CommitmentPlansManagementClient = require('./commitmentPlan/azureMLCommitmentPlansManagementClient'); -exports.WebServicesManagementClient = require('./webservices/azureMLWebServicesManagementClient'); \ No newline at end of file +exports.WebServicesManagementClient = require('./webservices/azureMLWebServicesManagementClient'); +exports.WorkspacesManagementClient = require('./workspaces/machineLearningWorkspacesManagementClient'); \ No newline at end of file diff --git a/lib/services/machinelearning/lib/webservices/azureMLWebServicesManagementClient.d.ts b/lib/services/machinelearning/lib/webservices/azureMLWebServicesManagementClient.d.ts index 7dcb5bff61..e4e3773cb2 100644 --- a/lib/services/machinelearning/lib/webservices/azureMLWebServicesManagementClient.d.ts +++ b/lib/services/machinelearning/lib/webservices/azureMLWebServicesManagementClient.d.ts @@ -10,9 +10,10 @@ import { ServiceClientCredentials } from 'ms-rest'; import { AzureServiceClient, AzureServiceClientOptions } from 'ms-rest-azure'; +import * as models from "./models"; import * as operations from "./operations"; -declare class AzureMLWebServicesManagementClient extends AzureServiceClient { +export default class AzureMLWebServicesManagementClient extends AzureServiceClient { /** * Initializes a new instance of the AzureMLWebServicesManagementClient class. * @constructor @@ -33,11 +34,11 @@ declare class AzureMLWebServicesManagementClient extends AzureServiceClient { * * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy * - * @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. + * @param {string} [options.acceptLanguage] - The preferred language for the response. * - * @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. * - * @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. * */ constructor(credentials: ServiceClientCredentials, subscriptionId: string, baseUri?: string, options?: AzureServiceClientOptions); @@ -55,7 +56,8 @@ declare class AzureMLWebServicesManagementClient extends AzureServiceClient { generateClientRequestId: boolean; // Operation groups + operations: operations.Operations; webServices: operations.WebServices; } -export = AzureMLWebServicesManagementClient; +export { AzureMLWebServicesManagementClient, models as AzureMLWebServicesManagementModels }; diff --git a/lib/services/machinelearning/lib/webservices/azureMLWebServicesManagementClient.js b/lib/services/machinelearning/lib/webservices/azureMLWebServicesManagementClient.js index 2c347ff8d0..a45d323980 100644 --- a/lib/services/machinelearning/lib/webservices/azureMLWebServicesManagementClient.js +++ b/lib/services/machinelearning/lib/webservices/azureMLWebServicesManagementClient.js @@ -34,9 +34,9 @@ class AzureMLWebServicesManagementClient extends ServiceClient { * @param {object} [options.requestOptions] - Options for the underlying request object * {@link https://github.com/request/request#requestoptions-callback Options doc} * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy - * @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. - * @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. - * @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * @param {string} [options.acceptLanguage] - The preferred language for the response. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. */ constructor(credentials, subscriptionId, baseUri, options) { if (credentials === null || credentials === undefined) { @@ -72,6 +72,7 @@ class AzureMLWebServicesManagementClient extends ServiceClient { if(options.generateClientRequestId !== null && options.generateClientRequestId !== undefined) { this.generateClientRequestId = options.generateClientRequestId; } + this.operations = new operations.Operations(this); this.webServices = new operations.WebServices(this); this.models = models; msRest.addSerializationMixin(this); @@ -80,3 +81,6 @@ class AzureMLWebServicesManagementClient extends ServiceClient { } module.exports = AzureMLWebServicesManagementClient; +module.exports['default'] = AzureMLWebServicesManagementClient; +module.exports.AzureMLWebServicesManagementClient = AzureMLWebServicesManagementClient; +module.exports.AzureMLWebServicesManagementModels = models; diff --git a/lib/services/machinelearning/lib/webservices/models/assetItem.js b/lib/services/machinelearning/lib/webservices/models/assetItem.js index a1dd63c5e7..4414e96db4 100644 --- a/lib/services/machinelearning/lib/webservices/models/assetItem.js +++ b/lib/services/machinelearning/lib/webservices/models/assetItem.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Information about an asset associated with the web service. * @@ -19,22 +17,23 @@ const models = require('./index'); class AssetItem { /** * Create a AssetItem. - * @member {string} name Asset's friendly name. - * @member {string} [id] Asset's Id. - * @member {string} type Asset's type. Possible values include: 'Module', + * @property {string} name Asset's friendly name. + * @property {string} [id] Asset's Id. + * @property {string} type Asset's type. Possible values include: 'Module', * 'Resource' - * @member {object} locationInfo Access information for the asset. - * @member {string} [locationInfo.uri] The URI from which the blob is + * @property {object} locationInfo Access information for the asset. + * @property {string} [locationInfo.uri] The URI from which the blob is * accessible from. For example, aml://abc for system assets or https://xyz * for user assets or payload. - * @member {string} [locationInfo.credentials] Access credentials for the + * @property {string} [locationInfo.credentials] Access credentials for the * blob, if applicable (e.g. blob specified by storage account connection * string + blob URI) - * @member {object} [inputPorts] Information about the asset's input ports. - * @member {object} [outputPorts] Information about the asset's output ports. - * @member {object} [metadata] If the asset is a custom module, this holds + * @property {object} [inputPorts] Information about the asset's input ports. + * @property {object} [outputPorts] Information about the asset's output + * ports. + * @property {object} [metadata] If the asset is a custom module, this holds * the module's metadata. - * @member {array} [parameters] If the asset is a custom module, this holds + * @property {array} [parameters] If the asset is a custom module, this holds * the module's parameters. */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/asyncOperationErrorInfo.js b/lib/services/machinelearning/lib/webservices/models/asyncOperationErrorInfo.js index eb1967c634..73a0be34d7 100644 --- a/lib/services/machinelearning/lib/webservices/models/asyncOperationErrorInfo.js +++ b/lib/services/machinelearning/lib/webservices/models/asyncOperationErrorInfo.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The error detail information for async operation * @@ -19,10 +17,10 @@ const models = require('./index'); class AsyncOperationErrorInfo { /** * Create a AsyncOperationErrorInfo. - * @member {string} [code] The error code. - * @member {string} [target] The error target. - * @member {string} [message] The error message. - * @member {array} [details] An array containing error information. + * @property {string} [code] The error code. + * @property {string} [target] The error target. + * @property {string} [message] The error message. + * @property {array} [details] An array containing error information. */ constructor() { } @@ -43,6 +41,7 @@ class AsyncOperationErrorInfo { modelProperties: { code: { required: false, + readOnly: true, serializedName: 'code', type: { name: 'String' @@ -50,6 +49,7 @@ class AsyncOperationErrorInfo { }, target: { required: false, + readOnly: true, serializedName: 'target', type: { name: 'String' @@ -57,6 +57,7 @@ class AsyncOperationErrorInfo { }, message: { required: false, + readOnly: true, serializedName: 'message', type: { name: 'String' @@ -64,6 +65,7 @@ class AsyncOperationErrorInfo { }, details: { required: false, + readOnly: true, serializedName: 'details', type: { name: 'Sequence', diff --git a/lib/services/machinelearning/lib/webservices/models/asyncOperationStatus.js b/lib/services/machinelearning/lib/webservices/models/asyncOperationStatus.js index 8693e017fd..171f8396fe 100644 --- a/lib/services/machinelearning/lib/webservices/models/asyncOperationStatus.js +++ b/lib/services/machinelearning/lib/webservices/models/asyncOperationStatus.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Azure async operation status. * @@ -19,21 +17,24 @@ const models = require('./index'); class AsyncOperationStatus { /** * Create a AsyncOperationStatus. - * @member {string} [id] Async operation id. - * @member {string} [name] Async operation name. - * @member {string} [provisioningState] Read Only: The provisioning state of - * the web service. Valid values are Unknown, Provisioning, Succeeded, and + * @property {string} [id] Async operation id. + * @property {string} [name] Async operation name. + * @property {string} [provisioningState] Read Only: The provisioning state + * of the web service. Valid values are Unknown, Provisioning, Succeeded, and * Failed. Possible values include: 'Unknown', 'Provisioning', 'Succeeded', * 'Failed' - * @member {date} [startTime] The date time that the async operation started. - * @member {date} [endTime] The date time that the async operation finished. - * @member {number} [percentComplete] Async operation progress. - * @member {object} [errorInfo] If the async operation fails, this structure - * contains the error details. - * @member {string} [errorInfo.code] The error code. - * @member {string} [errorInfo.target] The error target. - * @member {string} [errorInfo.message] The error message. - * @member {array} [errorInfo.details] An array containing error information. + * @property {date} [startTime] The date time that the async operation + * started. + * @property {date} [endTime] The date time that the async operation + * finished. + * @property {number} [percentComplete] Async operation progress. + * @property {object} [errorInfo] If the async operation fails, this + * structure contains the error details. + * @property {string} [errorInfo.code] The error code. + * @property {string} [errorInfo.target] The error target. + * @property {string} [errorInfo.message] The error message. + * @property {array} [errorInfo.details] An array containing error + * information. */ constructor() { } @@ -54,6 +55,7 @@ class AsyncOperationStatus { modelProperties: { id: { required: false, + readOnly: true, serializedName: 'id', type: { name: 'String' @@ -61,6 +63,7 @@ class AsyncOperationStatus { }, name: { required: false, + readOnly: true, serializedName: 'name', type: { name: 'String' @@ -92,6 +95,7 @@ class AsyncOperationStatus { }, percentComplete: { required: false, + readOnly: true, serializedName: 'percentComplete', type: { name: 'Number' @@ -99,6 +103,7 @@ class AsyncOperationStatus { }, errorInfo: { required: false, + readOnly: true, serializedName: 'errorInfo', type: { name: 'Composite', diff --git a/lib/services/machinelearning/lib/webservices/models/blobLocation.js b/lib/services/machinelearning/lib/webservices/models/blobLocation.js index 9c46fd3e3e..1d532cf6c7 100644 --- a/lib/services/machinelearning/lib/webservices/models/blobLocation.js +++ b/lib/services/machinelearning/lib/webservices/models/blobLocation.js @@ -17,10 +17,10 @@ class BlobLocation { /** * Create a BlobLocation. - * @member {string} uri The URI from which the blob is accessible from. For + * @property {string} uri The URI from which the blob is accessible from. For * example, aml://abc for system assets or https://xyz for user assets or * payload. - * @member {string} [credentials] Access credentials for the blob, if + * @property {string} [credentials] Access credentials for the blob, if * applicable (e.g. blob specified by storage account connection string + * blob URI) */ diff --git a/lib/services/machinelearning/lib/webservices/models/columnSpecification.js b/lib/services/machinelearning/lib/webservices/models/columnSpecification.js index 3634611061..c661df1ff1 100644 --- a/lib/services/machinelearning/lib/webservices/models/columnSpecification.js +++ b/lib/services/machinelearning/lib/webservices/models/columnSpecification.js @@ -19,17 +19,17 @@ class ColumnSpecification { /** * Create a ColumnSpecification. - * @member {string} type Data type of the column. Possible values include: + * @property {string} type Data type of the column. Possible values include: * 'Boolean', 'Integer', 'Number', 'String' - * @member {string} [format] Additional format information for the data type. - * Possible values include: 'Byte', 'Char', 'Complex64', 'Complex128', + * @property {string} [format] Additional format information for the data + * type. Possible values include: 'Byte', 'Char', 'Complex64', 'Complex128', * 'Date-time', 'Date-timeOffset', 'Double', 'Duration', 'Float', 'Int8', * 'Int16', 'Int32', 'Int64', 'Uint8', 'Uint16', 'Uint32', 'Uint64' - * @member {array} [enum] If the data type is categorical, this provides the - * list of accepted categories. - * @member {boolean} [xMsIsnullable] Flag indicating if the type supports + * @property {array} [enum] If the data type is categorical, this provides + * the list of accepted categories. + * @property {boolean} [xMsIsnullable] Flag indicating if the type supports * null values or not. - * @member {boolean} [xMsIsordered] Flag indicating whether the categories + * @property {boolean} [xMsIsordered] Flag indicating whether the categories * are treated as an ordered set or not, if this is a categorical column. */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/commitmentPlan.js b/lib/services/machinelearning/lib/webservices/models/commitmentPlan.js index b8a4a1f3ce..8f6399401c 100644 --- a/lib/services/machinelearning/lib/webservices/models/commitmentPlan.js +++ b/lib/services/machinelearning/lib/webservices/models/commitmentPlan.js @@ -18,7 +18,7 @@ class CommitmentPlan { /** * Create a CommitmentPlan. - * @member {string} id Specifies the Azure Resource Manager ID of the + * @property {string} id Specifies the Azure Resource Manager ID of the * commitment plan associated with the web service. */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/diagnosticsConfiguration.js b/lib/services/machinelearning/lib/webservices/models/diagnosticsConfiguration.js index 70e41cc26f..4192133d60 100644 --- a/lib/services/machinelearning/lib/webservices/models/diagnosticsConfiguration.js +++ b/lib/services/machinelearning/lib/webservices/models/diagnosticsConfiguration.js @@ -17,12 +17,12 @@ class DiagnosticsConfiguration { /** * Create a DiagnosticsConfiguration. - * @member {string} level Specifies the verbosity of the diagnostic output. + * @property {string} level Specifies the verbosity of the diagnostic output. * Valid values are: None - disables tracing; Error - collects only error * (stderr) traces; All - collects all traces (stdout and stderr). Possible * values include: 'None', 'Error', 'All' - * @member {date} [expiry] Specifies the date and time when the logging will - * cease. If null, diagnostic collection is not time limited. + * @property {date} [expiry] Specifies the date and time when the logging + * will cease. If null, diagnostic collection is not time limited. */ constructor() { } diff --git a/lib/services/machinelearning/lib/webservices/models/exampleRequest.js b/lib/services/machinelearning/lib/webservices/models/exampleRequest.js index 587b336d7b..d461d9e25c 100644 --- a/lib/services/machinelearning/lib/webservices/models/exampleRequest.js +++ b/lib/services/machinelearning/lib/webservices/models/exampleRequest.js @@ -17,9 +17,9 @@ class ExampleRequest { /** * Create a ExampleRequest. - * @member {object} [inputs] Sample input data for the web service's input(s) - * given as an input name to sample input values matrix map. - * @member {object} [globalParameters] Sample input data for the web + * @property {object} [inputs] Sample input data for the web service's + * input(s) given as an input name to sample input values matrix map. + * @property {object} [globalParameters] Sample input data for the web * service's global parameters */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/graphEdge.js b/lib/services/machinelearning/lib/webservices/models/graphEdge.js index e9303dd20b..c4c38201eb 100644 --- a/lib/services/machinelearning/lib/webservices/models/graphEdge.js +++ b/lib/services/machinelearning/lib/webservices/models/graphEdge.js @@ -17,11 +17,11 @@ class GraphEdge { /** * Create a GraphEdge. - * @member {string} [sourceNodeId] The source graph node's identifier. - * @member {string} [sourcePortId] The identifier of the source node's port + * @property {string} [sourceNodeId] The source graph node's identifier. + * @property {string} [sourcePortId] The identifier of the source node's port * that the edge connects from. - * @member {string} [targetNodeId] The destination graph node's identifier. - * @member {string} [targetPortId] The identifier of the destination node's + * @property {string} [targetNodeId] The destination graph node's identifier. + * @property {string} [targetPortId] The identifier of the destination node's * port that the edge connects into. */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/graphNode.js b/lib/services/machinelearning/lib/webservices/models/graphNode.js index e65c09f8c5..fa335309bd 100644 --- a/lib/services/machinelearning/lib/webservices/models/graphNode.js +++ b/lib/services/machinelearning/lib/webservices/models/graphNode.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Specifies a node in the web service graph. The node can either be an input, * output or asset node, so only one of the corresponding id properties is @@ -21,12 +19,12 @@ const models = require('./index'); class GraphNode { /** * Create a GraphNode. - * @member {string} [assetId] The id of the asset represented by this node. - * @member {string} [inputId] The id of the input element represented by this - * node. - * @member {string} [outputId] The id of the output element represented by + * @property {string} [assetId] The id of the asset represented by this node. + * @property {string} [inputId] The id of the input element represented by + * this node. + * @property {string} [outputId] The id of the output element represented by * this node. - * @member {object} [parameters] If applicable, parameters of the node. + * @property {object} [parameters] If applicable, parameters of the node. * Global graph parameters map into these, with values set at runtime. */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/graphPackage.js b/lib/services/machinelearning/lib/webservices/models/graphPackage.js index 57993b4aab..995fc77a93 100644 --- a/lib/services/machinelearning/lib/webservices/models/graphPackage.js +++ b/lib/services/machinelearning/lib/webservices/models/graphPackage.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Defines the graph of modules making up the machine learning solution. * @@ -19,12 +17,12 @@ const models = require('./index'); class GraphPackage { /** * Create a GraphPackage. - * @member {object} [nodes] The set of nodes making up the graph, provided as - * a nodeId to GraphNode map - * @member {array} [edges] The list of edges making up the graph. - * @member {object} [graphParameters] The collection of global parameters for - * the graph, given as a global parameter name to GraphParameter map. Each - * parameter here has a 1:1 match with the global parameters values map + * @property {object} [nodes] The set of nodes making up the graph, provided + * as a nodeId to GraphNode map + * @property {array} [edges] The list of edges making up the graph. + * @property {object} [graphParameters] The collection of global parameters + * for the graph, given as a global parameter name to GraphParameter map. + * Each parameter here has a 1:1 match with the global parameters values map * declared at the WebServiceProperties level. */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/graphParameter.js b/lib/services/machinelearning/lib/webservices/models/graphParameter.js index 099968d349..b6ec9d3d85 100644 --- a/lib/services/machinelearning/lib/webservices/models/graphParameter.js +++ b/lib/services/machinelearning/lib/webservices/models/graphParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Defines a global parameter in the graph. * @@ -19,12 +17,12 @@ const models = require('./index'); class GraphParameter { /** * Create a GraphParameter. - * @member {string} [description] Description of this graph parameter. - * @member {string} type Graph parameter's type. Possible values include: + * @property {string} [description] Description of this graph parameter. + * @property {string} type Graph parameter's type. Possible values include: * 'String', 'Int', 'Float', 'Enumerated', 'Script', 'Mode', 'Credential', * 'Boolean', 'Double', 'ColumnPicker', 'ParameterRange', 'DataGatewayName' - * @member {array} links Association links for this parameter to nodes in the - * graph. + * @property {array} links Association links for this parameter to nodes in + * the graph. */ constructor() { } diff --git a/lib/services/machinelearning/lib/webservices/models/graphParameterLink.js b/lib/services/machinelearning/lib/webservices/models/graphParameterLink.js index 6f8ea22670..7960667503 100644 --- a/lib/services/machinelearning/lib/webservices/models/graphParameterLink.js +++ b/lib/services/machinelearning/lib/webservices/models/graphParameterLink.js @@ -17,8 +17,8 @@ class GraphParameterLink { /** * Create a GraphParameterLink. - * @member {string} nodeId The graph node's identifier - * @member {string} parameterKey The identifier of the node parameter that + * @property {string} nodeId The graph node's identifier + * @property {string} parameterKey The identifier of the node parameter that * the global parameter maps to. */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/index.d.ts b/lib/services/machinelearning/lib/webservices/models/index.d.ts index 75ad514ca4..a58e3ccb96 100644 --- a/lib/services/machinelearning/lib/webservices/models/index.d.ts +++ b/lib/services/machinelearning/lib/webservices/models/index.d.ts @@ -1,786 +1,683 @@ /* * 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 resource. - * - * @member {string} [id] Specifies the resource ID. - * @member {string} [name] Specifies the name of the resource. - * @member {string} location Specifies the location of the resource. - * @member {string} [type] Specifies the type of the resource. - * @member {object} [tags] Contains resource tags defined as key/value pairs. */ export interface Resource extends BaseResource { + /** + * Specifies the resource ID. + */ readonly id?: string; + /** + * Specifies the name of the resource. + */ readonly name?: string; + /** + * Specifies the location of the resource. + */ location: string; + /** + * Specifies the type of the resource. + */ readonly type?: string; + /** + * Contains resource tags defined as key/value pairs. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the WebServiceKeys class. - * @constructor * Access keys for the web service calls. - * - * @member {string} [primary] The primary access key. - * @member {string} [secondary] The secondary access key. */ export interface WebServiceKeys { + /** + * The primary access key. + */ primary?: string; + /** + * The secondary access key. + */ secondary?: string; } /** - * @class - * Initializes a new instance of the RealtimeConfiguration class. - * @constructor - * Holds the available configuration options for an Azure ML web service - * endpoint. - * - * @member {number} [maxConcurrentCalls] Specifies the maximum concurrent calls - * that can be made to the web service. Minimum value: 4, Maximum value: 200. + * Holds the available configuration options for an Azure ML web service endpoint. */ export interface RealtimeConfiguration { + /** + * Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, + * Maximum value: 200. + */ maxConcurrentCalls?: number; } /** - * @class - * Initializes a new instance of the DiagnosticsConfiguration class. - * @constructor * Diagnostics settings for an Azure ML web service. - * - * @member {string} level Specifies the verbosity of the diagnostic output. - * Valid values are: None - disables tracing; Error - collects only error - * (stderr) traces; All - collects all traces (stdout and stderr). Possible - * values include: 'None', 'Error', 'All' - * @member {date} [expiry] Specifies the date and time when the logging will - * cease. If null, diagnostic collection is not time limited. */ export interface DiagnosticsConfiguration { + /** + * Specifies the verbosity of the diagnostic output. Valid values are: None - disables tracing; + * Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr). + * Possible values include: 'None', 'Error', 'All' + */ level: string; + /** + * Specifies the date and time when the logging will cease. If null, diagnostic collection is not + * time limited. + */ expiry?: Date; } /** - * @class - * Initializes a new instance of the StorageAccount class. - * @constructor * Access information for a storage account. - * - * @member {string} [name] Specifies the name of the storage account. - * @member {string} [key] Specifies the key used to access the storage account. */ export interface StorageAccount { + /** + * Specifies the name of the storage account. + */ name?: string; + /** + * Specifies the key used to access the storage account. + */ key?: string; } /** - * @class - * Initializes a new instance of the MachineLearningWorkspace class. - * @constructor - * Information about the machine learning workspace containing the experiment - * that is source for the web service. - * - * @member {string} id Specifies the workspace ID of the machine learning - * workspace associated with the web service + * Information about the machine learning workspace containing the experiment that is source for + * the web service. */ export interface MachineLearningWorkspace { + /** + * Specifies the workspace ID of the machine learning workspace associated with the web service + */ id: string; } /** - * @class - * Initializes a new instance of the CommitmentPlan class. - * @constructor - * Information about the machine learning commitment plan associated with the - * web service. - * - * @member {string} id Specifies the Azure Resource Manager ID of the - * commitment plan associated with the web service. + * Information about the machine learning commitment plan associated with the web service. */ export interface CommitmentPlan { + /** + * Specifies the Azure Resource Manager ID of the commitment plan associated with the web + * service. + */ id: string; } /** - * @class - * Initializes a new instance of the ColumnSpecification class. - * @constructor - * Swagger 2.0 schema for a column within the data table representing a web - * service input or output. See Swagger specification: - * http://swagger.io/specification/ - * - * @member {string} type Data type of the column. Possible values include: - * 'Boolean', 'Integer', 'Number', 'String' - * @member {string} [format] Additional format information for the data type. - * Possible values include: 'Byte', 'Char', 'Complex64', 'Complex128', - * 'Date-time', 'Date-timeOffset', 'Double', 'Duration', 'Float', 'Int8', - * 'Int16', 'Int32', 'Int64', 'Uint8', 'Uint16', 'Uint32', 'Uint64' - * @member {array} [enum] If the data type is categorical, this provides the - * list of accepted categories. - * @member {boolean} [xMsIsnullable] Flag indicating if the type supports null - * values or not. - * @member {boolean} [xMsIsordered] Flag indicating whether the categories are - * treated as an ordered set or not, if this is a categorical column. + * Swagger 2.0 schema for a column within the data table representing a web service input or + * output. See Swagger specification: http://swagger.io/specification/ */ export interface ColumnSpecification { + /** + * Data type of the column. Possible values include: 'Boolean', 'Integer', 'Number', 'String' + */ type: string; + /** + * Additional format information for the data type. Possible values include: 'Byte', 'Char', + * 'Complex64', 'Complex128', 'Date-time', 'Date-timeOffset', 'Double', 'Duration', 'Float', + * 'Int8', 'Int16', 'Int32', 'Int64', 'Uint8', 'Uint16', 'Uint32', 'Uint64' + */ format?: string; + /** + * If the data type is categorical, this provides the list of accepted categories. + */ enum?: any[]; + /** + * Flag indicating if the type supports null values or not. + */ xMsIsnullable?: boolean; + /** + * Flag indicating whether the categories are treated as an ordered set or not, if this is a + * categorical column. + */ xMsIsordered?: boolean; } /** - * @class - * Initializes a new instance of the TableSpecification class. - * @constructor - * The swagger 2.0 schema describing a single service input or output. See - * Swagger specification: http://swagger.io/specification/ - * - * @member {string} [title] Swagger schema title. - * @member {string} [description] Swagger schema description. - * @member {string} type The type of the entity described in swagger. Default - * value: 'object' . - * @member {string} [format] The format, if 'type' is not 'object' - * @member {object} [properties] The set of columns within the data table. + * The swagger 2.0 schema describing a single service input or output. See Swagger specification: + * http://swagger.io/specification/ */ export interface TableSpecification { + /** + * Swagger schema title. + */ title?: string; + /** + * Swagger schema description. + */ description?: string; + /** + * The type of the entity described in swagger. + */ type: string; + /** + * The format, if 'type' is not 'object' + */ format?: string; + /** + * The set of columns within the data table. + */ properties?: { [propertyName: string]: ColumnSpecification }; } /** - * @class - * Initializes a new instance of the ServiceInputOutputSpecification class. - * @constructor - * The swagger 2.0 schema describing the service's inputs or outputs. See - * Swagger specification: http://swagger.io/specification/ - * - * @member {string} [title] The title of your Swagger schema. - * @member {string} [description] The description of the Swagger schema. - * @member {string} type The type of the entity described in swagger. Always - * 'object'. Default value: 'object' . - * @member {object} properties Specifies a collection that contains the column - * schema for each input or output of the web service. For more information, - * see the Swagger specification. + * The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: + * http://swagger.io/specification/ */ export interface ServiceInputOutputSpecification { + /** + * The title of your Swagger schema. + */ title?: string; + /** + * The description of the Swagger schema. + */ description?: string; + /** + * The type of the entity described in swagger. Always 'object'. + */ type: string; + /** + * Specifies a collection that contains the column schema for each input or output of the web + * service. For more information, see the Swagger specification. + */ properties: { [propertyName: string]: TableSpecification }; } /** - * @class - * Initializes a new instance of the ExampleRequest class. - * @constructor * Sample input data for the service's input(s). - * - * @member {object} [inputs] Sample input data for the web service's input(s) - * given as an input name to sample input values matrix map. - * @member {object} [globalParameters] Sample input data for the web service's - * global parameters */ export interface ExampleRequest { + /** + * Sample input data for the web service's input(s) given as an input name to sample input values + * matrix map. + */ inputs?: { [propertyName: string]: any[][] }; + /** + * Sample input data for the web service's global parameters + */ globalParameters?: { [propertyName: string]: any }; } /** - * @class - * Initializes a new instance of the BlobLocation class. - * @constructor * Describes the access location for a blob. - * - * @member {string} uri The URI from which the blob is accessible from. For - * example, aml://abc for system assets or https://xyz for user assets or - * payload. - * @member {string} [credentials] Access credentials for the blob, if - * applicable (e.g. blob specified by storage account connection string + blob - * URI) */ export interface BlobLocation { + /** + * The URI from which the blob is accessible from. For example, aml://abc for system assets or + * https://xyz for user assets or payload. + */ uri: string; + /** + * Access credentials for the blob, if applicable (e.g. blob specified by storage account + * connection string + blob URI) + */ credentials?: string; } /** - * @class - * Initializes a new instance of the InputPort class. - * @constructor * Asset input port - * - * @member {string} [type] Port data type. Possible values include: 'Dataset'. - * Default value: 'Dataset' . */ export interface InputPort { + /** + * Port data type. Possible values include: 'Dataset' + */ type?: string; } /** - * @class - * Initializes a new instance of the OutputPort class. - * @constructor * Asset output port - * - * @member {string} [type] Port data type. Possible values include: 'Dataset'. - * Default value: 'Dataset' . */ export interface OutputPort { + /** + * Port data type. Possible values include: 'Dataset' + */ type?: string; } /** - * @class - * Initializes a new instance of the ModeValueInfo class. - * @constructor * Nested parameter definition. - * - * @member {string} [interfaceString] The interface string name for the nested - * parameter. - * @member {array} [parameters] The definition of the parameter. */ export interface ModeValueInfo { + /** + * The interface string name for the nested parameter. + */ interfaceString?: string; + /** + * The definition of the parameter. + */ parameters?: ModuleAssetParameter[]; } /** - * @class - * Initializes a new instance of the ModuleAssetParameter class. - * @constructor * Parameter definition for a module asset. - * - * @member {string} [name] Parameter name. - * @member {string} [parameterType] Parameter type. - * @member {object} [modeValuesInfo] Definitions for nested interface - * parameters if this is a complex module parameter. */ export interface ModuleAssetParameter { + /** + * Parameter name. + */ name?: string; + /** + * Parameter type. + */ parameterType?: string; + /** + * Definitions for nested interface parameters if this is a complex module parameter. + */ modeValuesInfo?: { [propertyName: string]: ModeValueInfo }; } /** - * @class - * Initializes a new instance of the AssetItem class. - * @constructor * Information about an asset associated with the web service. - * - * @member {string} name Asset's friendly name. - * @member {string} [id] Asset's Id. - * @member {string} type Asset's type. Possible values include: 'Module', - * 'Resource' - * @member {object} locationInfo Access information for the asset. - * @member {string} [locationInfo.uri] The URI from which the blob is - * accessible from. For example, aml://abc for system assets or https://xyz for - * user assets or payload. - * @member {string} [locationInfo.credentials] Access credentials for the blob, - * if applicable (e.g. blob specified by storage account connection string + - * blob URI) - * @member {object} [inputPorts] Information about the asset's input ports. - * @member {object} [outputPorts] Information about the asset's output ports. - * @member {object} [metadata] If the asset is a custom module, this holds the - * module's metadata. - * @member {array} [parameters] If the asset is a custom module, this holds the - * module's parameters. */ export interface AssetItem { + /** + * Asset's friendly name. + */ name: string; + /** + * Asset's Id. + */ id?: string; + /** + * Asset's type. Possible values include: 'Module', 'Resource' + */ type: string; + /** + * Access information for the asset. + */ locationInfo: BlobLocation; + /** + * Information about the asset's input ports. + */ inputPorts?: { [propertyName: string]: InputPort }; + /** + * Information about the asset's output ports. + */ outputPorts?: { [propertyName: string]: OutputPort }; + /** + * If the asset is a custom module, this holds the module's metadata. + */ metadata?: { [propertyName: string]: string }; + /** + * If the asset is a custom module, this holds the module's parameters. + */ parameters?: ModuleAssetParameter[]; } /** - * @class - * Initializes a new instance of the WebServiceParameter class. - * @constructor * Web Service Parameter object for node and global parameter - * - * @member {object} [value] The parameter value - * @member {string} [certificateThumbprint] If the parameter value in 'value' - * field is encrypted, the thumbprint of the certificate should be put here. */ export interface WebServiceParameter { + /** + * The parameter value + */ value?: any; + /** + * If the parameter value in 'value' field is encrypted, the thumbprint of the certificate should + * be put here. + */ certificateThumbprint?: string; } /** - * @class - * Initializes a new instance of the WebServiceProperties class. - * @constructor * The set of properties specific to the Azure ML web service resource. - * - * @member {string} [title] The title of the web service. - * @member {string} [description] The description of the web service. - * @member {date} [createdOn] Read Only: The date and time when the web service - * was created. - * @member {date} [modifiedOn] Read Only: The date and time when the web - * service was last modified. - * @member {string} [provisioningState] Read Only: The provision state of the - * web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. - * Possible values include: 'Unknown', 'Provisioning', 'Succeeded', 'Failed' - * @member {object} [keys] Contains the web service provisioning keys. If you - * do not specify provisioning keys, the Azure Machine Learning system - * generates them for you. Note: The keys are not returned from calls to GET - * operations. - * @member {string} [keys.primary] The primary access key. - * @member {string} [keys.secondary] The secondary access key. - * @member {boolean} [readOnly] When set to true, indicates that the web - * service is read-only and can no longer be updated or patched, only removed. - * Default, is false. Note: Once set to true, you cannot change its value. - * @member {string} [swaggerLocation] Read Only: Contains the URI of the - * swagger spec associated with this web service. - * @member {boolean} [exposeSampleData] When set to true, sample data is - * included in the web service's swagger definition. The default value is true. - * @member {object} [realtimeConfiguration] Contains the configuration settings - * for the web service endpoint. - * @member {number} [realtimeConfiguration.maxConcurrentCalls] Specifies the - * maximum concurrent calls that can be made to the web service. Minimum value: - * 4, Maximum value: 200. - * @member {object} [diagnostics] Settings controlling the diagnostics traces - * collection for the web service. - * @member {string} [diagnostics.level] Specifies the verbosity of the - * diagnostic output. Valid values are: None - disables tracing; Error - - * collects only error (stderr) traces; All - collects all traces (stdout and - * stderr). Possible values include: 'None', 'Error', 'All' - * @member {date} [diagnostics.expiry] Specifies the date and time when the - * logging will cease. If null, diagnostic collection is not time limited. - * @member {object} [storageAccount] Specifies the storage account that Azure - * Machine Learning uses to store information about the web service. Only the - * name of the storage account is returned from calls to GET operations. When - * updating the storage account information, you must ensure that all necessary - * assets are available in the new storage account or calls to your web service - * will fail. - * @member {string} [storageAccount.name] Specifies the name of the storage - * account. - * @member {string} [storageAccount.key] Specifies the key used to access the - * storage account. - * @member {object} [machineLearningWorkspace] Specifies the Machine Learning - * workspace containing the experiment that is source for the web service. - * @member {string} [machineLearningWorkspace.id] Specifies the workspace ID of - * the machine learning workspace associated with the web service - * @member {object} [commitmentPlan] Contains the commitment plan associated - * with this web service. Set at creation time. Once set, this value cannot be - * changed. Note: The commitment plan is not returned from calls to GET - * operations. - * @member {string} [commitmentPlan.id] Specifies the Azure Resource Manager ID - * of the commitment plan associated with the web service. - * @member {object} [input] Contains the Swagger 2.0 schema describing one or - * more of the web service's inputs. For more information, see the Swagger - * specification. - * @member {string} [input.title] The title of your Swagger schema. - * @member {string} [input.description] The description of the Swagger schema. - * @member {string} [input.type] The type of the entity described in swagger. - * Always 'object'. - * @member {object} [input.properties] Specifies a collection that contains the - * column schema for each input or output of the web service. For more - * information, see the Swagger specification. - * @member {object} [output] Contains the Swagger 2.0 schema describing one or - * more of the web service's outputs. For more information, see the Swagger - * specification. - * @member {string} [output.title] The title of your Swagger schema. - * @member {string} [output.description] The description of the Swagger schema. - * @member {string} [output.type] The type of the entity described in swagger. - * Always 'object'. - * @member {object} [output.properties] Specifies a collection that contains - * the column schema for each input or output of the web service. For more - * information, see the Swagger specification. - * @member {object} [exampleRequest] Defines sample input data for one or more - * of the service's inputs. - * @member {object} [exampleRequest.inputs] Sample input data for the web - * service's input(s) given as an input name to sample input values matrix map. - * @member {object} [exampleRequest.globalParameters] Sample input data for the - * web service's global parameters - * @member {object} [assets] Contains user defined properties describing web - * service assets. Properties are expressed as Key/Value pairs. - * @member {object} [parameters] The set of global parameters values defined - * for the web service, given as a global parameter name to default value map. - * If no default value is specified, the parameter is considered to be - * required. - * @member {boolean} [payloadsInBlobStorage] When set to true, indicates that - * the payload size is larger than 3 MB. Otherwise false. If the payload size - * exceed 3 MB, the payload is stored in a blob and the PayloadsLocation - * parameter contains the URI of the blob. Otherwise, this will be set to false - * and Assets, Input, Output, Package, Parameters, ExampleRequest are inline. - * The Payload sizes is determined by adding the size of the Assets, Input, - * Output, Package, Parameters, and the ExampleRequest. - * @member {object} [payloadsLocation] The URI of the payload blob. This - * paramater contains a value only if the payloadsInBlobStorage parameter is - * set to true. Otherwise is set to null. - * @member {string} [payloadsLocation.uri] The URI from which the blob is - * accessible from. For example, aml://abc for system assets or https://xyz for - * user assets or payload. - * @member {string} [payloadsLocation.credentials] Access credentials for the - * blob, if applicable (e.g. blob specified by storage account connection - * string + blob URI) - * @member {string} packageType Polymorphic Discriminator */ export interface WebServiceProperties { + /** + * The title of the web service. + */ title?: string; + /** + * The description of the web service. + */ description?: string; + /** + * Read Only: The date and time when the web service was created. + */ readonly createdOn?: Date; + /** + * Read Only: The date and time when the web service was last modified. + */ readonly modifiedOn?: Date; + /** + * Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, + * Succeeded, and Failed. Possible values include: 'Unknown', 'Provisioning', 'Succeeded', + * 'Failed' + */ readonly provisioningState?: string; + /** + * Contains the web service provisioning keys. If you do not specify provisioning keys, the Azure + * Machine Learning system generates them for you. Note: The keys are not returned from calls to + * GET operations. + */ keys?: WebServiceKeys; + /** + * When set to true, indicates that the web service is read-only and can no longer be updated or + * patched, only removed. Default, is false. Note: Once set to true, you cannot change its value. + */ readOnly?: boolean; + /** + * Read Only: Contains the URI of the swagger spec associated with this web service. + */ readonly swaggerLocation?: string; + /** + * When set to true, sample data is included in the web service's swagger definition. The default + * value is true. + */ exposeSampleData?: boolean; + /** + * Contains the configuration settings for the web service endpoint. + */ realtimeConfiguration?: RealtimeConfiguration; + /** + * Settings controlling the diagnostics traces collection for the web service. + */ diagnostics?: DiagnosticsConfiguration; + /** + * Specifies the storage account that Azure Machine Learning uses to store information about the + * web service. Only the name of the storage account is returned from calls to GET operations. + * When updating the storage account information, you must ensure that all necessary assets are + * available in the new storage account or calls to your web service will fail. + */ storageAccount?: StorageAccount; + /** + * Specifies the Machine Learning workspace containing the experiment that is source for the web + * service. + */ machineLearningWorkspace?: MachineLearningWorkspace; + /** + * Contains the commitment plan associated with this web service. Set at creation time. Once set, + * this value cannot be changed. Note: The commitment plan is not returned from calls to GET + * operations. + */ commitmentPlan?: CommitmentPlan; + /** + * Contains the Swagger 2.0 schema describing one or more of the web service's inputs. For more + * information, see the Swagger specification. + */ input?: ServiceInputOutputSpecification; + /** + * Contains the Swagger 2.0 schema describing one or more of the web service's outputs. For more + * information, see the Swagger specification. + */ output?: ServiceInputOutputSpecification; + /** + * Defines sample input data for one or more of the service's inputs. + */ exampleRequest?: ExampleRequest; + /** + * Contains user defined properties describing web service assets. Properties are expressed as + * Key/Value pairs. + */ assets?: { [propertyName: string]: AssetItem }; + /** + * The set of global parameters values defined for the web service, given as a global parameter + * name to default value map. If no default value is specified, the parameter is considered to be + * required. + */ parameters?: { [propertyName: string]: WebServiceParameter }; + /** + * When set to true, indicates that the payload size is larger than 3 MB. Otherwise false. If the + * payload size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation parameter + * contains the URI of the blob. Otherwise, this will be set to false and Assets, Input, Output, + * Package, Parameters, ExampleRequest are inline. The Payload sizes is determined by adding the + * size of the Assets, Input, Output, Package, Parameters, and the ExampleRequest. + */ payloadsInBlobStorage?: boolean; + /** + * The URI of the payload blob. This paramater contains a value only if the payloadsInBlobStorage + * parameter is set to true. Otherwise is set to null. + */ payloadsLocation?: BlobLocation; + /** + * Polymorphic Discriminator + */ packageType: string; } /** - * @class - * Initializes a new instance of the WebService class. - * @constructor * Instance of an Azure ML web service resource. - * - * @member {object} properties Contains the property payload that describes the - * web service. - * @member {string} [properties.title] The title of the web service. - * @member {string} [properties.description] The description of the web - * service. - * @member {date} [properties.createdOn] Read Only: The date and time when the - * web service was created. - * @member {date} [properties.modifiedOn] Read Only: The date and time when the - * web service was last modified. - * @member {string} [properties.provisioningState] Read Only: The provision - * state of the web service. Valid values are Unknown, Provisioning, Succeeded, - * and Failed. Possible values include: 'Unknown', 'Provisioning', 'Succeeded', - * 'Failed' - * @member {object} [properties.keys] Contains the web service provisioning - * keys. If you do not specify provisioning keys, the Azure Machine Learning - * system generates them for you. Note: The keys are not returned from calls to - * GET operations. - * @member {string} [properties.keys.primary] The primary access key. - * @member {string} [properties.keys.secondary] The secondary access key. - * @member {boolean} [properties.readOnly] When set to true, indicates that the - * web service is read-only and can no longer be updated or patched, only - * removed. Default, is false. Note: Once set to true, you cannot change its - * value. - * @member {string} [properties.swaggerLocation] Read Only: Contains the URI of - * the swagger spec associated with this web service. - * @member {boolean} [properties.exposeSampleData] When set to true, sample - * data is included in the web service's swagger definition. The default value - * is true. - * @member {object} [properties.realtimeConfiguration] Contains the - * configuration settings for the web service endpoint. - * @member {number} [properties.realtimeConfiguration.maxConcurrentCalls] - * Specifies the maximum concurrent calls that can be made to the web service. - * Minimum value: 4, Maximum value: 200. - * @member {object} [properties.diagnostics] Settings controlling the - * diagnostics traces collection for the web service. - * @member {string} [properties.diagnostics.level] Specifies the verbosity of - * the diagnostic output. Valid values are: None - disables tracing; Error - - * collects only error (stderr) traces; All - collects all traces (stdout and - * stderr). Possible values include: 'None', 'Error', 'All' - * @member {date} [properties.diagnostics.expiry] Specifies the date and time - * when the logging will cease. If null, diagnostic collection is not time - * limited. - * @member {object} [properties.storageAccount] Specifies the storage account - * that Azure Machine Learning uses to store information about the web service. - * Only the name of the storage account is returned from calls to GET - * operations. When updating the storage account information, you must ensure - * that all necessary assets are available in the new storage account or calls - * to your web service will fail. - * @member {string} [properties.storageAccount.name] Specifies the name of the - * storage account. - * @member {string} [properties.storageAccount.key] Specifies the key used to - * access the storage account. - * @member {object} [properties.machineLearningWorkspace] Specifies the Machine - * Learning workspace containing the experiment that is source for the web - * service. - * @member {string} [properties.machineLearningWorkspace.id] Specifies the - * workspace ID of the machine learning workspace associated with the web - * service - * @member {object} [properties.commitmentPlan] Contains the commitment plan - * associated with this web service. Set at creation time. Once set, this value - * cannot be changed. Note: The commitment plan is not returned from calls to - * GET operations. - * @member {string} [properties.commitmentPlan.id] Specifies the Azure Resource - * Manager ID of the commitment plan associated with the web service. - * @member {object} [properties.input] Contains the Swagger 2.0 schema - * describing one or more of the web service's inputs. For more information, - * see the Swagger specification. - * @member {string} [properties.input.title] The title of your Swagger schema. - * @member {string} [properties.input.description] The description of the - * Swagger schema. - * @member {string} [properties.input.type] The type of the entity described in - * swagger. Always 'object'. - * @member {object} [properties.input.properties] Specifies a collection that - * contains the column schema for each input or output of the web service. For - * more information, see the Swagger specification. - * @member {object} [properties.output] Contains the Swagger 2.0 schema - * describing one or more of the web service's outputs. For more information, - * see the Swagger specification. - * @member {string} [properties.output.title] The title of your Swagger schema. - * @member {string} [properties.output.description] The description of the - * Swagger schema. - * @member {string} [properties.output.type] The type of the entity described - * in swagger. Always 'object'. - * @member {object} [properties.output.properties] Specifies a collection that - * contains the column schema for each input or output of the web service. For - * more information, see the Swagger specification. - * @member {object} [properties.exampleRequest] Defines sample input data for - * one or more of the service's inputs. - * @member {object} [properties.exampleRequest.inputs] Sample input data for - * the web service's input(s) given as an input name to sample input values - * matrix map. - * @member {object} [properties.exampleRequest.globalParameters] Sample input - * data for the web service's global parameters - * @member {object} [properties.assets] Contains user defined properties - * describing web service assets. Properties are expressed as Key/Value pairs. - * @member {object} [properties.parameters] The set of global parameters values - * defined for the web service, given as a global parameter name to default - * value map. If no default value is specified, the parameter is considered to - * be required. - * @member {boolean} [properties.payloadsInBlobStorage] When set to true, - * indicates that the payload size is larger than 3 MB. Otherwise false. If the - * payload size exceed 3 MB, the payload is stored in a blob and the - * PayloadsLocation parameter contains the URI of the blob. Otherwise, this - * will be set to false and Assets, Input, Output, Package, Parameters, - * ExampleRequest are inline. The Payload sizes is determined by adding the - * size of the Assets, Input, Output, Package, Parameters, and the - * ExampleRequest. - * @member {object} [properties.payloadsLocation] The URI of the payload blob. - * This paramater contains a value only if the payloadsInBlobStorage parameter - * is set to true. Otherwise is set to null. - * @member {string} [properties.payloadsLocation.uri] The URI from which the - * blob is accessible from. For example, aml://abc for system assets or - * https://xyz for user assets or payload. - * @member {string} [properties.payloadsLocation.credentials] Access - * credentials for the blob, if applicable (e.g. blob specified by storage - * account connection string + blob URI) - * @member {string} [properties.packageType] Polymorphic Discriminator */ export interface WebService extends Resource { + /** + * Contains the property payload that describes the web service. + */ properties: WebServiceProperties; } /** - * @class - * Initializes a new instance of the GraphNode class. - * @constructor - * Specifies a node in the web service graph. The node can either be an input, - * output or asset node, so only one of the corresponding id properties is - * populated at any given time. - * - * @member {string} [assetId] The id of the asset represented by this node. - * @member {string} [inputId] The id of the input element represented by this - * node. - * @member {string} [outputId] The id of the output element represented by this - * node. - * @member {object} [parameters] If applicable, parameters of the node. Global - * graph parameters map into these, with values set at runtime. + * Specifies a node in the web service graph. The node can either be an input, output or asset + * node, so only one of the corresponding id properties is populated at any given time. */ export interface GraphNode { + /** + * The id of the asset represented by this node. + */ assetId?: string; + /** + * The id of the input element represented by this node. + */ inputId?: string; + /** + * The id of the output element represented by this node. + */ outputId?: string; + /** + * If applicable, parameters of the node. Global graph parameters map into these, with values set + * at runtime. + */ parameters?: { [propertyName: string]: WebServiceParameter }; } /** - * @class - * Initializes a new instance of the GraphEdge class. - * @constructor * Defines an edge within the web service's graph. - * - * @member {string} [sourceNodeId] The source graph node's identifier. - * @member {string} [sourcePortId] The identifier of the source node's port - * that the edge connects from. - * @member {string} [targetNodeId] The destination graph node's identifier. - * @member {string} [targetPortId] The identifier of the destination node's - * port that the edge connects into. */ export interface GraphEdge { + /** + * The source graph node's identifier. + */ sourceNodeId?: string; + /** + * The identifier of the source node's port that the edge connects from. + */ sourcePortId?: string; + /** + * The destination graph node's identifier. + */ targetNodeId?: string; + /** + * The identifier of the destination node's port that the edge connects into. + */ targetPortId?: string; } /** - * @class - * Initializes a new instance of the GraphParameterLink class. - * @constructor * Association link for a graph global parameter to a node in the graph. - * - * @member {string} nodeId The graph node's identifier - * @member {string} parameterKey The identifier of the node parameter that the - * global parameter maps to. */ export interface GraphParameterLink { + /** + * The graph node's identifier + */ nodeId: string; + /** + * The identifier of the node parameter that the global parameter maps to. + */ parameterKey: string; } /** - * @class - * Initializes a new instance of the GraphParameter class. - * @constructor * Defines a global parameter in the graph. - * - * @member {string} [description] Description of this graph parameter. - * @member {string} type Graph parameter's type. Possible values include: - * 'String', 'Int', 'Float', 'Enumerated', 'Script', 'Mode', 'Credential', - * 'Boolean', 'Double', 'ColumnPicker', 'ParameterRange', 'DataGatewayName' - * @member {array} links Association links for this parameter to nodes in the - * graph. */ export interface GraphParameter { + /** + * Description of this graph parameter. + */ description?: string; + /** + * Graph parameter's type. Possible values include: 'String', 'Int', 'Float', 'Enumerated', + * 'Script', 'Mode', 'Credential', 'Boolean', 'Double', 'ColumnPicker', 'ParameterRange', + * 'DataGatewayName' + */ type: string; + /** + * Association links for this parameter to nodes in the graph. + */ links: GraphParameterLink[]; } /** - * @class - * Initializes a new instance of the GraphPackage class. - * @constructor * Defines the graph of modules making up the machine learning solution. - * - * @member {object} [nodes] The set of nodes making up the graph, provided as a - * nodeId to GraphNode map - * @member {array} [edges] The list of edges making up the graph. - * @member {object} [graphParameters] The collection of global parameters for - * the graph, given as a global parameter name to GraphParameter map. Each - * parameter here has a 1:1 match with the global parameters values map - * declared at the WebServiceProperties level. */ export interface GraphPackage { + /** + * The set of nodes making up the graph, provided as a nodeId to GraphNode map + */ nodes?: { [propertyName: string]: GraphNode }; + /** + * The list of edges making up the graph. + */ edges?: GraphEdge[]; + /** + * The collection of global parameters for the graph, given as a global parameter name to + * GraphParameter map. Each parameter here has a 1:1 match with the global parameters values map + * declared at the WebServiceProperties level. + */ graphParameters?: { [propertyName: string]: GraphParameter }; } /** - * @class - * Initializes a new instance of the WebServicePropertiesForGraph class. - * @constructor * Properties specific to a Graph based web service. - * - * @member {object} [packageProperty] The definition of the graph package - * making up this web service. - * @member {object} [packageProperty.nodes] The set of nodes making up the - * graph, provided as a nodeId to GraphNode map - * @member {array} [packageProperty.edges] The list of edges making up the - * graph. - * @member {object} [packageProperty.graphParameters] The collection of global - * parameters for the graph, given as a global parameter name to GraphParameter - * map. Each parameter here has a 1:1 match with the global parameters values - * map declared at the WebServiceProperties level. */ export interface WebServicePropertiesForGraph extends WebServiceProperties { + /** + * The definition of the graph package making up this web service. + */ packageProperty?: GraphPackage; } /** - * @class - * Initializes a new instance of the AsyncOperationErrorInfo class. - * @constructor * The error detail information for async operation - * - * @member {string} [code] The error code. - * @member {string} [target] The error target. - * @member {string} [message] The error message. - * @member {array} [details] An array containing error information. */ export interface AsyncOperationErrorInfo { - code?: string; - target?: string; - message?: string; - details?: AsyncOperationErrorInfo[]; + /** + * The error code. + */ + readonly code?: string; + /** + * The error target. + */ + readonly target?: string; + /** + * The error message. + */ + readonly message?: string; + /** + * An array containing error information. + */ + readonly details?: AsyncOperationErrorInfo[]; } /** - * @class - * Initializes a new instance of the AsyncOperationStatus class. - * @constructor * Azure async operation status. - * - * @member {string} [id] Async operation id. - * @member {string} [name] Async operation name. - * @member {string} [provisioningState] Read Only: The provisioning state of - * the web service. Valid values are Unknown, Provisioning, Succeeded, and - * Failed. Possible values include: 'Unknown', 'Provisioning', 'Succeeded', - * 'Failed' - * @member {date} [startTime] The date time that the async operation started. - * @member {date} [endTime] The date time that the async operation finished. - * @member {number} [percentComplete] Async operation progress. - * @member {object} [errorInfo] If the async operation fails, this structure - * contains the error details. - * @member {string} [errorInfo.code] The error code. - * @member {string} [errorInfo.target] The error target. - * @member {string} [errorInfo.message] The error message. - * @member {array} [errorInfo.details] An array containing error information. */ export interface AsyncOperationStatus { - id?: string; - name?: string; + /** + * Async operation id. + */ + readonly id?: string; + /** + * Async operation name. + */ + readonly name?: string; + /** + * Read Only: The provisioning state of the web service. Valid values are Unknown, Provisioning, + * Succeeded, and Failed. Possible values include: 'Unknown', 'Provisioning', 'Succeeded', + * 'Failed' + */ readonly provisioningState?: string; + /** + * The date time that the async operation started. + */ readonly startTime?: Date; + /** + * The date time that the async operation finished. + */ readonly endTime?: Date; - percentComplete?: number; - errorInfo?: AsyncOperationErrorInfo; + /** + * Async operation progress. + */ + readonly percentComplete?: number; + /** + * If the async operation fails, this structure contains the error details. + */ + readonly errorInfo?: AsyncOperationErrorInfo; +} + +/** + * The API operation info. + */ +export interface OperationDisplayInfo { + /** + * The description of the operation. + */ + readonly description?: string; + /** + * The action that users can perform, based on their permission level. + */ + readonly operation?: string; + /** + * The service provider. + */ + readonly provider?: string; + /** + * The resource on which the operation is performed. + */ + readonly resource?: string; +} + +/** + * An API operation. + */ +export interface OperationEntity { + /** + * Operation name: {provider}/{resource}/{operation}. + */ + readonly name?: string; + /** + * The API operation info. + */ + display?: OperationDisplayInfo; } +/** + * The list of REST API operations. + */ +export interface OperationEntityListResult extends Array { +} /** - * @class - * Initializes a new instance of the PaginatedWebServicesList class. - * @constructor * Paginated list of web services. - * - * @member {string} [nextLink] A continuation link (absolute URI) to the next - * page of results in the list. */ export interface PaginatedWebServicesList extends Array { + /** + * A continuation link (absolute URI) to the next page of results in the list. + */ nextLink?: string; } diff --git a/lib/services/machinelearning/lib/webservices/models/index.js b/lib/services/machinelearning/lib/webservices/models/index.js index 6ecc41d019..f19097cebd 100644 --- a/lib/services/machinelearning/lib/webservices/models/index.js +++ b/lib/services/machinelearning/lib/webservices/models/index.js @@ -46,6 +46,9 @@ exports.GraphPackage = require('./graphPackage'); exports.WebServicePropertiesForGraph = require('./webServicePropertiesForGraph'); exports.AsyncOperationErrorInfo = require('./asyncOperationErrorInfo'); exports.AsyncOperationStatus = require('./asyncOperationStatus'); +exports.OperationDisplayInfo = require('./operationDisplayInfo'); +exports.OperationEntity = require('./operationEntity'); +exports.OperationEntityListResult = require('./operationEntityListResult'); exports.PaginatedWebServicesList = require('./paginatedWebServicesList'); exports.discriminators = { 'WebServiceProperties' : exports.WebServiceProperties, diff --git a/lib/services/machinelearning/lib/webservices/models/inputPort.js b/lib/services/machinelearning/lib/webservices/models/inputPort.js index 8e8d2c97b8..cfb9ea81b3 100644 --- a/lib/services/machinelearning/lib/webservices/models/inputPort.js +++ b/lib/services/machinelearning/lib/webservices/models/inputPort.js @@ -17,7 +17,7 @@ class InputPort { /** * Create a InputPort. - * @member {string} [type] Port data type. Possible values include: + * @property {string} [type] Port data type. Possible values include: * 'Dataset'. Default value: 'Dataset' . */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/machineLearningWorkspace.js b/lib/services/machinelearning/lib/webservices/models/machineLearningWorkspace.js index 6a7d5ebb89..e5d0a56477 100644 --- a/lib/services/machinelearning/lib/webservices/models/machineLearningWorkspace.js +++ b/lib/services/machinelearning/lib/webservices/models/machineLearningWorkspace.js @@ -18,7 +18,7 @@ class MachineLearningWorkspace { /** * Create a MachineLearningWorkspace. - * @member {string} id Specifies the workspace ID of the machine learning + * @property {string} id Specifies the workspace ID of the machine learning * workspace associated with the web service */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/modeValueInfo.js b/lib/services/machinelearning/lib/webservices/models/modeValueInfo.js index 5020abc303..e42f524d3a 100644 --- a/lib/services/machinelearning/lib/webservices/models/modeValueInfo.js +++ b/lib/services/machinelearning/lib/webservices/models/modeValueInfo.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Nested parameter definition. * @@ -19,9 +17,9 @@ const models = require('./index'); class ModeValueInfo { /** * Create a ModeValueInfo. - * @member {string} [interfaceString] The interface string name for the + * @property {string} [interfaceString] The interface string name for the * nested parameter. - * @member {array} [parameters] The definition of the parameter. + * @property {array} [parameters] The definition of the parameter. */ constructor() { } diff --git a/lib/services/machinelearning/lib/webservices/models/moduleAssetParameter.js b/lib/services/machinelearning/lib/webservices/models/moduleAssetParameter.js index ee4dd5978f..fd9f720eaf 100644 --- a/lib/services/machinelearning/lib/webservices/models/moduleAssetParameter.js +++ b/lib/services/machinelearning/lib/webservices/models/moduleAssetParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Parameter definition for a module asset. * @@ -19,9 +17,9 @@ const models = require('./index'); class ModuleAssetParameter { /** * Create a ModuleAssetParameter. - * @member {string} [name] Parameter name. - * @member {string} [parameterType] Parameter type. - * @member {object} [modeValuesInfo] Definitions for nested interface + * @property {string} [name] Parameter name. + * @property {string} [parameterType] Parameter type. + * @property {object} [modeValuesInfo] Definitions for nested interface * parameters if this is a complex module parameter. */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/operationDisplayInfo.js b/lib/services/machinelearning/lib/webservices/models/operationDisplayInfo.js new file mode 100644 index 0000000000..1e0c55d4ab --- /dev/null +++ b/lib/services/machinelearning/lib/webservices/models/operationDisplayInfo.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'; + +/** + * The API operation info. + * + */ +class OperationDisplayInfo { + /** + * Create a OperationDisplayInfo. + * @property {string} [description] The description of the operation. + * @property {string} [operation] The action that users can perform, based on + * their permission level. + * @property {string} [provider] The service provider. + * @property {string} [resource] The resource on which the operation is + * performed. + */ + constructor() { + } + + /** + * Defines the metadata of OperationDisplayInfo + * + * @returns {object} metadata of OperationDisplayInfo + * + */ + mapper() { + return { + required: false, + serializedName: 'OperationDisplayInfo', + type: { + name: 'Composite', + className: 'OperationDisplayInfo', + modelProperties: { + description: { + required: false, + readOnly: true, + serializedName: 'description', + type: { + name: 'String' + } + }, + operation: { + required: false, + readOnly: true, + serializedName: 'operation', + type: { + name: 'String' + } + }, + provider: { + required: false, + readOnly: true, + serializedName: 'provider', + type: { + name: 'String' + } + }, + resource: { + required: false, + readOnly: true, + serializedName: 'resource', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = OperationDisplayInfo; diff --git a/lib/services/machinelearning/lib/webservices/models/operationEntity.js b/lib/services/machinelearning/lib/webservices/models/operationEntity.js new file mode 100644 index 0000000000..f1f135f742 --- /dev/null +++ b/lib/services/machinelearning/lib/webservices/models/operationEntity.js @@ -0,0 +1,69 @@ +/* + * 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'; + +/** + * An API operation. + * + */ +class OperationEntity { + /** + * Create a OperationEntity. + * @property {string} [name] Operation name: + * {provider}/{resource}/{operation}. + * @property {object} [display] The API operation info. + * @property {string} [display.description] The description of the operation. + * @property {string} [display.operation] The action that users can perform, + * based on their permission level. + * @property {string} [display.provider] The service provider. + * @property {string} [display.resource] The resource on which the operation + * is performed. + */ + constructor() { + } + + /** + * Defines the metadata of OperationEntity + * + * @returns {object} metadata of OperationEntity + * + */ + mapper() { + return { + required: false, + serializedName: 'OperationEntity', + type: { + name: 'Composite', + className: 'OperationEntity', + modelProperties: { + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + display: { + required: false, + serializedName: 'display', + type: { + name: 'Composite', + className: 'OperationDisplayInfo' + } + } + } + } + }; + } +} + +module.exports = OperationEntity; diff --git a/lib/services/machinelearning/lib/webservices/models/operationEntityListResult.js b/lib/services/machinelearning/lib/webservices/models/operationEntityListResult.js new file mode 100644 index 0000000000..bc2f6127e5 --- /dev/null +++ b/lib/services/machinelearning/lib/webservices/models/operationEntityListResult.js @@ -0,0 +1,60 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The list of REST API operations. + */ +class OperationEntityListResult extends Array { + /** + * Create a OperationEntityListResult. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of OperationEntityListResult + * + * @returns {object} metadata of OperationEntityListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'OperationEntityListResult', + type: { + name: 'Composite', + className: 'OperationEntityListResult', + modelProperties: { + value: { + required: false, + readOnly: true, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'OperationEntityElementType', + type: { + name: 'Composite', + className: 'OperationEntity' + } + } + } + } + } + } + }; + } +} + +module.exports = OperationEntityListResult; diff --git a/lib/services/machinelearning/lib/webservices/models/outputPort.js b/lib/services/machinelearning/lib/webservices/models/outputPort.js index b6c71476bd..48c0fca207 100644 --- a/lib/services/machinelearning/lib/webservices/models/outputPort.js +++ b/lib/services/machinelearning/lib/webservices/models/outputPort.js @@ -17,7 +17,7 @@ class OutputPort { /** * Create a OutputPort. - * @member {string} [type] Port data type. Possible values include: + * @property {string} [type] Port data type. Possible values include: * 'Dataset'. Default value: 'Dataset' . */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/paginatedWebServicesList.js b/lib/services/machinelearning/lib/webservices/models/paginatedWebServicesList.js index 26a07179fb..c6e8dbc4d8 100644 --- a/lib/services/machinelearning/lib/webservices/models/paginatedWebServicesList.js +++ b/lib/services/machinelearning/lib/webservices/models/paginatedWebServicesList.js @@ -16,8 +16,8 @@ class PaginatedWebServicesList extends Array { /** * Create a PaginatedWebServicesList. - * @member {string} [nextLink] A continuation link (absolute URI) to the next - * page of results in the list. + * @property {string} [nextLink] A continuation link (absolute URI) to the + * next page of results in the list. */ constructor() { super(); diff --git a/lib/services/machinelearning/lib/webservices/models/realtimeConfiguration.js b/lib/services/machinelearning/lib/webservices/models/realtimeConfiguration.js index 47a301f202..0eb7c59d5c 100644 --- a/lib/services/machinelearning/lib/webservices/models/realtimeConfiguration.js +++ b/lib/services/machinelearning/lib/webservices/models/realtimeConfiguration.js @@ -18,7 +18,7 @@ class RealtimeConfiguration { /** * Create a RealtimeConfiguration. - * @member {number} [maxConcurrentCalls] Specifies the maximum concurrent + * @property {number} [maxConcurrentCalls] Specifies the maximum concurrent * calls that can be made to the web service. Minimum value: 4, Maximum * value: 200. */ diff --git a/lib/services/machinelearning/lib/webservices/models/resource.js b/lib/services/machinelearning/lib/webservices/models/resource.js index 41e3ea1a20..03ea5b5525 100644 --- a/lib/services/machinelearning/lib/webservices/models/resource.js +++ b/lib/services/machinelearning/lib/webservices/models/resource.js @@ -20,11 +20,12 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] Specifies the resource ID. - * @member {string} [name] Specifies the name of the resource. - * @member {string} location Specifies the location of the resource. - * @member {string} [type] Specifies the type of the resource. - * @member {object} [tags] Contains resource tags defined as key/value pairs. + * @property {string} [id] Specifies the resource ID. + * @property {string} [name] Specifies the name of the resource. + * @property {string} location Specifies the location of the resource. + * @property {string} [type] Specifies the type of the resource. + * @property {object} [tags] Contains resource tags defined as key/value + * pairs. */ constructor() { super(); diff --git a/lib/services/machinelearning/lib/webservices/models/serviceInputOutputSpecification.js b/lib/services/machinelearning/lib/webservices/models/serviceInputOutputSpecification.js index f048307be9..5f6d531d80 100644 --- a/lib/services/machinelearning/lib/webservices/models/serviceInputOutputSpecification.js +++ b/lib/services/machinelearning/lib/webservices/models/serviceInputOutputSpecification.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The swagger 2.0 schema describing the service's inputs or outputs. See * Swagger specification: http://swagger.io/specification/ @@ -20,11 +18,11 @@ const models = require('./index'); class ServiceInputOutputSpecification { /** * Create a ServiceInputOutputSpecification. - * @member {string} [title] The title of your Swagger schema. - * @member {string} [description] The description of the Swagger schema. - * @member {string} type The type of the entity described in swagger. Always - * 'object'. Default value: 'object' . - * @member {object} properties Specifies a collection that contains the + * @property {string} [title] The title of your Swagger schema. + * @property {string} [description] The description of the Swagger schema. + * @property {string} type The type of the entity described in swagger. + * Always 'object'. Default value: 'object' . + * @property {object} properties Specifies a collection that contains the * column schema for each input or output of the web service. For more * information, see the Swagger specification. */ diff --git a/lib/services/machinelearning/lib/webservices/models/storageAccount.js b/lib/services/machinelearning/lib/webservices/models/storageAccount.js index 5d072b7b6d..ed2d371dee 100644 --- a/lib/services/machinelearning/lib/webservices/models/storageAccount.js +++ b/lib/services/machinelearning/lib/webservices/models/storageAccount.js @@ -17,8 +17,8 @@ class StorageAccount { /** * Create a StorageAccount. - * @member {string} [name] Specifies the name of the storage account. - * @member {string} [key] Specifies the key used to access the storage + * @property {string} [name] Specifies the name of the storage account. + * @property {string} [key] Specifies the key used to access the storage * account. */ constructor() { diff --git a/lib/services/machinelearning/lib/webservices/models/tableSpecification.js b/lib/services/machinelearning/lib/webservices/models/tableSpecification.js index 92a86b694e..b0d6706652 100644 --- a/lib/services/machinelearning/lib/webservices/models/tableSpecification.js +++ b/lib/services/machinelearning/lib/webservices/models/tableSpecification.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The swagger 2.0 schema describing a single service input or output. See * Swagger specification: http://swagger.io/specification/ @@ -20,12 +18,12 @@ const models = require('./index'); class TableSpecification { /** * Create a TableSpecification. - * @member {string} [title] Swagger schema title. - * @member {string} [description] Swagger schema description. - * @member {string} type The type of the entity described in swagger. Default - * value: 'object' . - * @member {string} [format] The format, if 'type' is not 'object' - * @member {object} [properties] The set of columns within the data table. + * @property {string} [title] Swagger schema title. + * @property {string} [description] Swagger schema description. + * @property {string} type The type of the entity described in swagger. + * Default value: 'object' . + * @property {string} [format] The format, if 'type' is not 'object' + * @property {object} [properties] The set of columns within the data table. */ constructor() { } diff --git a/lib/services/machinelearning/lib/webservices/models/webService.js b/lib/services/machinelearning/lib/webservices/models/webService.js index 0aa3382535..0fb159abc1 100644 --- a/lib/services/machinelearning/lib/webservices/models/webService.js +++ b/lib/services/machinelearning/lib/webservices/models/webService.js @@ -20,110 +20,110 @@ const models = require('./index'); class WebService extends models['Resource'] { /** * Create a WebService. - * @member {object} properties Contains the property payload that describes + * @property {object} properties Contains the property payload that describes * the web service. - * @member {string} [properties.title] The title of the web service. - * @member {string} [properties.description] The description of the web + * @property {string} [properties.title] The title of the web service. + * @property {string} [properties.description] The description of the web * service. - * @member {date} [properties.createdOn] Read Only: The date and time when + * @property {date} [properties.createdOn] Read Only: The date and time when * the web service was created. - * @member {date} [properties.modifiedOn] Read Only: The date and time when + * @property {date} [properties.modifiedOn] Read Only: The date and time when * the web service was last modified. - * @member {string} [properties.provisioningState] Read Only: The provision + * @property {string} [properties.provisioningState] Read Only: The provision * state of the web service. Valid values are Unknown, Provisioning, * Succeeded, and Failed. Possible values include: 'Unknown', 'Provisioning', * 'Succeeded', 'Failed' - * @member {object} [properties.keys] Contains the web service provisioning + * @property {object} [properties.keys] Contains the web service provisioning * keys. If you do not specify provisioning keys, the Azure Machine Learning * system generates them for you. Note: The keys are not returned from calls * to GET operations. - * @member {string} [properties.keys.primary] The primary access key. - * @member {string} [properties.keys.secondary] The secondary access key. - * @member {boolean} [properties.readOnly] When set to true, indicates that + * @property {string} [properties.keys.primary] The primary access key. + * @property {string} [properties.keys.secondary] The secondary access key. + * @property {boolean} [properties.readOnly] When set to true, indicates that * the web service is read-only and can no longer be updated or patched, only * removed. Default, is false. Note: Once set to true, you cannot change its * value. - * @member {string} [properties.swaggerLocation] Read Only: Contains the URI - * of the swagger spec associated with this web service. - * @member {boolean} [properties.exposeSampleData] When set to true, sample + * @property {string} [properties.swaggerLocation] Read Only: Contains the + * URI of the swagger spec associated with this web service. + * @property {boolean} [properties.exposeSampleData] When set to true, sample * data is included in the web service's swagger definition. The default * value is true. - * @member {object} [properties.realtimeConfiguration] Contains the + * @property {object} [properties.realtimeConfiguration] Contains the * configuration settings for the web service endpoint. - * @member {number} [properties.realtimeConfiguration.maxConcurrentCalls] + * @property {number} [properties.realtimeConfiguration.maxConcurrentCalls] * Specifies the maximum concurrent calls that can be made to the web * service. Minimum value: 4, Maximum value: 200. - * @member {object} [properties.diagnostics] Settings controlling the + * @property {object} [properties.diagnostics] Settings controlling the * diagnostics traces collection for the web service. - * @member {string} [properties.diagnostics.level] Specifies the verbosity of - * the diagnostic output. Valid values are: None - disables tracing; Error - - * collects only error (stderr) traces; All - collects all traces (stdout and - * stderr). Possible values include: 'None', 'Error', 'All' - * @member {date} [properties.diagnostics.expiry] Specifies the date and time - * when the logging will cease. If null, diagnostic collection is not time - * limited. - * @member {object} [properties.storageAccount] Specifies the storage account - * that Azure Machine Learning uses to store information about the web - * service. Only the name of the storage account is returned from calls to - * GET operations. When updating the storage account information, you must + * @property {string} [properties.diagnostics.level] Specifies the verbosity + * of the diagnostic output. Valid values are: None - disables tracing; Error + * - collects only error (stderr) traces; All - collects all traces (stdout + * and stderr). Possible values include: 'None', 'Error', 'All' + * @property {date} [properties.diagnostics.expiry] Specifies the date and + * time when the logging will cease. If null, diagnostic collection is not + * time limited. + * @property {object} [properties.storageAccount] Specifies the storage + * account that Azure Machine Learning uses to store information about the + * web service. Only the name of the storage account is returned from calls + * to GET operations. When updating the storage account information, you must * ensure that all necessary assets are available in the new storage account * or calls to your web service will fail. - * @member {string} [properties.storageAccount.name] Specifies the name of + * @property {string} [properties.storageAccount.name] Specifies the name of * the storage account. - * @member {string} [properties.storageAccount.key] Specifies the key used to - * access the storage account. - * @member {object} [properties.machineLearningWorkspace] Specifies the + * @property {string} [properties.storageAccount.key] Specifies the key used + * to access the storage account. + * @property {object} [properties.machineLearningWorkspace] Specifies the * Machine Learning workspace containing the experiment that is source for * the web service. - * @member {string} [properties.machineLearningWorkspace.id] Specifies the + * @property {string} [properties.machineLearningWorkspace.id] Specifies the * workspace ID of the machine learning workspace associated with the web * service - * @member {object} [properties.commitmentPlan] Contains the commitment plan - * associated with this web service. Set at creation time. Once set, this - * value cannot be changed. Note: The commitment plan is not returned from - * calls to GET operations. - * @member {string} [properties.commitmentPlan.id] Specifies the Azure + * @property {object} [properties.commitmentPlan] Contains the commitment + * plan associated with this web service. Set at creation time. Once set, + * this value cannot be changed. Note: The commitment plan is not returned + * from calls to GET operations. + * @property {string} [properties.commitmentPlan.id] Specifies the Azure * Resource Manager ID of the commitment plan associated with the web * service. - * @member {object} [properties.input] Contains the Swagger 2.0 schema + * @property {object} [properties.input] Contains the Swagger 2.0 schema * describing one or more of the web service's inputs. For more information, * see the Swagger specification. - * @member {string} [properties.input.title] The title of your Swagger + * @property {string} [properties.input.title] The title of your Swagger * schema. - * @member {string} [properties.input.description] The description of the + * @property {string} [properties.input.description] The description of the * Swagger schema. - * @member {string} [properties.input.type] The type of the entity described - * in swagger. Always 'object'. - * @member {object} [properties.input.properties] Specifies a collection that - * contains the column schema for each input or output of the web service. - * For more information, see the Swagger specification. - * @member {object} [properties.output] Contains the Swagger 2.0 schema + * @property {string} [properties.input.type] The type of the entity + * described in swagger. Always 'object'. + * @property {object} [properties.input.properties] Specifies a collection + * that contains the column schema for each input or output of the web + * service. For more information, see the Swagger specification. + * @property {object} [properties.output] Contains the Swagger 2.0 schema * describing one or more of the web service's outputs. For more information, * see the Swagger specification. - * @member {string} [properties.output.title] The title of your Swagger + * @property {string} [properties.output.title] The title of your Swagger * schema. - * @member {string} [properties.output.description] The description of the + * @property {string} [properties.output.description] The description of the * Swagger schema. - * @member {string} [properties.output.type] The type of the entity described - * in swagger. Always 'object'. - * @member {object} [properties.output.properties] Specifies a collection + * @property {string} [properties.output.type] The type of the entity + * described in swagger. Always 'object'. + * @property {object} [properties.output.properties] Specifies a collection * that contains the column schema for each input or output of the web * service. For more information, see the Swagger specification. - * @member {object} [properties.exampleRequest] Defines sample input data for - * one or more of the service's inputs. - * @member {object} [properties.exampleRequest.inputs] Sample input data for - * the web service's input(s) given as an input name to sample input values - * matrix map. - * @member {object} [properties.exampleRequest.globalParameters] Sample input - * data for the web service's global parameters - * @member {object} [properties.assets] Contains user defined properties + * @property {object} [properties.exampleRequest] Defines sample input data + * for one or more of the service's inputs. + * @property {object} [properties.exampleRequest.inputs] Sample input data + * for the web service's input(s) given as an input name to sample input + * values matrix map. + * @property {object} [properties.exampleRequest.globalParameters] Sample + * input data for the web service's global parameters + * @property {object} [properties.assets] Contains user defined properties * describing web service assets. Properties are expressed as Key/Value * pairs. - * @member {object} [properties.parameters] The set of global parameters + * @property {object} [properties.parameters] The set of global parameters * values defined for the web service, given as a global parameter name to * default value map. If no default value is specified, the parameter is * considered to be required. - * @member {boolean} [properties.payloadsInBlobStorage] When set to true, + * @property {boolean} [properties.payloadsInBlobStorage] When set to true, * indicates that the payload size is larger than 3 MB. Otherwise false. If * the payload size exceed 3 MB, the payload is stored in a blob and the * PayloadsLocation parameter contains the URI of the blob. Otherwise, this @@ -131,16 +131,16 @@ class WebService extends models['Resource'] { * ExampleRequest are inline. The Payload sizes is determined by adding the * size of the Assets, Input, Output, Package, Parameters, and the * ExampleRequest. - * @member {object} [properties.payloadsLocation] The URI of the payload + * @property {object} [properties.payloadsLocation] The URI of the payload * blob. This paramater contains a value only if the payloadsInBlobStorage * parameter is set to true. Otherwise is set to null. - * @member {string} [properties.payloadsLocation.uri] The URI from which the - * blob is accessible from. For example, aml://abc for system assets or + * @property {string} [properties.payloadsLocation.uri] The URI from which + * the blob is accessible from. For example, aml://abc for system assets or * https://xyz for user assets or payload. - * @member {string} [properties.payloadsLocation.credentials] Access + * @property {string} [properties.payloadsLocation.credentials] Access * credentials for the blob, if applicable (e.g. blob specified by storage * account connection string + blob URI) - * @member {string} [properties.packageType] Polymorphic Discriminator + * @property {string} [properties.packageType] Polymorphic Discriminator */ constructor() { super(); diff --git a/lib/services/machinelearning/lib/webservices/models/webServiceKeys.js b/lib/services/machinelearning/lib/webservices/models/webServiceKeys.js index 6d0ad4d062..9467e19879 100644 --- a/lib/services/machinelearning/lib/webservices/models/webServiceKeys.js +++ b/lib/services/machinelearning/lib/webservices/models/webServiceKeys.js @@ -17,8 +17,8 @@ class WebServiceKeys { /** * Create a WebServiceKeys. - * @member {string} [primary] The primary access key. - * @member {string} [secondary] The secondary access key. + * @property {string} [primary] The primary access key. + * @property {string} [secondary] The secondary access key. */ constructor() { } diff --git a/lib/services/machinelearning/lib/webservices/models/webServiceParameter.js b/lib/services/machinelearning/lib/webservices/models/webServiceParameter.js index 4a81c11483..50a46f072a 100644 --- a/lib/services/machinelearning/lib/webservices/models/webServiceParameter.js +++ b/lib/services/machinelearning/lib/webservices/models/webServiceParameter.js @@ -17,9 +17,10 @@ class WebServiceParameter { /** * Create a WebServiceParameter. - * @member {object} [value] The parameter value - * @member {string} [certificateThumbprint] If the parameter value in 'value' - * field is encrypted, the thumbprint of the certificate should be put here. + * @property {object} [value] The parameter value + * @property {string} [certificateThumbprint] If the parameter value in + * 'value' field is encrypted, the thumbprint of the certificate should be + * put here. */ constructor() { } diff --git a/lib/services/machinelearning/lib/webservices/models/webServiceProperties.js b/lib/services/machinelearning/lib/webservices/models/webServiceProperties.js index 039446d4f4..8eba365e29 100644 --- a/lib/services/machinelearning/lib/webservices/models/webServiceProperties.js +++ b/lib/services/machinelearning/lib/webservices/models/webServiceProperties.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The set of properties specific to the Azure ML web service resource. * @@ -19,116 +17,117 @@ const models = require('./index'); class WebServiceProperties { /** * Create a WebServiceProperties. - * @member {string} [title] The title of the web service. - * @member {string} [description] The description of the web service. - * @member {date} [createdOn] Read Only: The date and time when the web + * @property {string} [title] The title of the web service. + * @property {string} [description] The description of the web service. + * @property {date} [createdOn] Read Only: The date and time when the web * service was created. - * @member {date} [modifiedOn] Read Only: The date and time when the web + * @property {date} [modifiedOn] Read Only: The date and time when the web * service was last modified. - * @member {string} [provisioningState] Read Only: The provision state of the - * web service. Valid values are Unknown, Provisioning, Succeeded, and + * @property {string} [provisioningState] Read Only: The provision state of + * the web service. Valid values are Unknown, Provisioning, Succeeded, and * Failed. Possible values include: 'Unknown', 'Provisioning', 'Succeeded', * 'Failed' - * @member {object} [keys] Contains the web service provisioning keys. If you - * do not specify provisioning keys, the Azure Machine Learning system + * @property {object} [keys] Contains the web service provisioning keys. If + * you do not specify provisioning keys, the Azure Machine Learning system * generates them for you. Note: The keys are not returned from calls to GET * operations. - * @member {string} [keys.primary] The primary access key. - * @member {string} [keys.secondary] The secondary access key. - * @member {boolean} [readOnly] When set to true, indicates that the web + * @property {string} [keys.primary] The primary access key. + * @property {string} [keys.secondary] The secondary access key. + * @property {boolean} [readOnly] When set to true, indicates that the web * service is read-only and can no longer be updated or patched, only * removed. Default, is false. Note: Once set to true, you cannot change its * value. - * @member {string} [swaggerLocation] Read Only: Contains the URI of the + * @property {string} [swaggerLocation] Read Only: Contains the URI of the * swagger spec associated with this web service. - * @member {boolean} [exposeSampleData] When set to true, sample data is + * @property {boolean} [exposeSampleData] When set to true, sample data is * included in the web service's swagger definition. The default value is * true. - * @member {object} [realtimeConfiguration] Contains the configuration + * @property {object} [realtimeConfiguration] Contains the configuration * settings for the web service endpoint. - * @member {number} [realtimeConfiguration.maxConcurrentCalls] Specifies the - * maximum concurrent calls that can be made to the web service. Minimum + * @property {number} [realtimeConfiguration.maxConcurrentCalls] Specifies + * the maximum concurrent calls that can be made to the web service. Minimum * value: 4, Maximum value: 200. - * @member {object} [diagnostics] Settings controlling the diagnostics traces - * collection for the web service. - * @member {string} [diagnostics.level] Specifies the verbosity of the + * @property {object} [diagnostics] Settings controlling the diagnostics + * traces collection for the web service. + * @property {string} [diagnostics.level] Specifies the verbosity of the * diagnostic output. Valid values are: None - disables tracing; Error - * collects only error (stderr) traces; All - collects all traces (stdout and * stderr). Possible values include: 'None', 'Error', 'All' - * @member {date} [diagnostics.expiry] Specifies the date and time when the + * @property {date} [diagnostics.expiry] Specifies the date and time when the * logging will cease. If null, diagnostic collection is not time limited. - * @member {object} [storageAccount] Specifies the storage account that Azure - * Machine Learning uses to store information about the web service. Only the - * name of the storage account is returned from calls to GET operations. When - * updating the storage account information, you must ensure that all - * necessary assets are available in the new storage account or calls to your - * web service will fail. - * @member {string} [storageAccount.name] Specifies the name of the storage + * @property {object} [storageAccount] Specifies the storage account that + * Azure Machine Learning uses to store information about the web service. + * Only the name of the storage account is returned from calls to GET + * operations. When updating the storage account information, you must ensure + * that all necessary assets are available in the new storage account or + * calls to your web service will fail. + * @property {string} [storageAccount.name] Specifies the name of the storage * account. - * @member {string} [storageAccount.key] Specifies the key used to access the - * storage account. - * @member {object} [machineLearningWorkspace] Specifies the Machine Learning - * workspace containing the experiment that is source for the web service. - * @member {string} [machineLearningWorkspace.id] Specifies the workspace ID - * of the machine learning workspace associated with the web service - * @member {object} [commitmentPlan] Contains the commitment plan associated - * with this web service. Set at creation time. Once set, this value cannot - * be changed. Note: The commitment plan is not returned from calls to GET - * operations. - * @member {string} [commitmentPlan.id] Specifies the Azure Resource Manager - * ID of the commitment plan associated with the web service. - * @member {object} [input] Contains the Swagger 2.0 schema describing one or - * more of the web service's inputs. For more information, see the Swagger + * @property {string} [storageAccount.key] Specifies the key used to access + * the storage account. + * @property {object} [machineLearningWorkspace] Specifies the Machine + * Learning workspace containing the experiment that is source for the web + * service. + * @property {string} [machineLearningWorkspace.id] Specifies the workspace + * ID of the machine learning workspace associated with the web service + * @property {object} [commitmentPlan] Contains the commitment plan + * associated with this web service. Set at creation time. Once set, this + * value cannot be changed. Note: The commitment plan is not returned from + * calls to GET operations. + * @property {string} [commitmentPlan.id] Specifies the Azure Resource + * Manager ID of the commitment plan associated with the web service. + * @property {object} [input] Contains the Swagger 2.0 schema describing one + * or more of the web service's inputs. For more information, see the Swagger * specification. - * @member {string} [input.title] The title of your Swagger schema. - * @member {string} [input.description] The description of the Swagger + * @property {string} [input.title] The title of your Swagger schema. + * @property {string} [input.description] The description of the Swagger * schema. - * @member {string} [input.type] The type of the entity described in swagger. - * Always 'object'. - * @member {object} [input.properties] Specifies a collection that contains + * @property {string} [input.type] The type of the entity described in + * swagger. Always 'object'. + * @property {object} [input.properties] Specifies a collection that contains * the column schema for each input or output of the web service. For more * information, see the Swagger specification. - * @member {object} [output] Contains the Swagger 2.0 schema describing one + * @property {object} [output] Contains the Swagger 2.0 schema describing one * or more of the web service's outputs. For more information, see the * Swagger specification. - * @member {string} [output.title] The title of your Swagger schema. - * @member {string} [output.description] The description of the Swagger + * @property {string} [output.title] The title of your Swagger schema. + * @property {string} [output.description] The description of the Swagger * schema. - * @member {string} [output.type] The type of the entity described in + * @property {string} [output.type] The type of the entity described in * swagger. Always 'object'. - * @member {object} [output.properties] Specifies a collection that contains - * the column schema for each input or output of the web service. For more - * information, see the Swagger specification. - * @member {object} [exampleRequest] Defines sample input data for one or + * @property {object} [output.properties] Specifies a collection that + * contains the column schema for each input or output of the web service. + * For more information, see the Swagger specification. + * @property {object} [exampleRequest] Defines sample input data for one or * more of the service's inputs. - * @member {object} [exampleRequest.inputs] Sample input data for the web + * @property {object} [exampleRequest.inputs] Sample input data for the web * service's input(s) given as an input name to sample input values matrix * map. - * @member {object} [exampleRequest.globalParameters] Sample input data for + * @property {object} [exampleRequest.globalParameters] Sample input data for * the web service's global parameters - * @member {object} [assets] Contains user defined properties describing web - * service assets. Properties are expressed as Key/Value pairs. - * @member {object} [parameters] The set of global parameters values defined - * for the web service, given as a global parameter name to default value - * map. If no default value is specified, the parameter is considered to be - * required. - * @member {boolean} [payloadsInBlobStorage] When set to true, indicates that - * the payload size is larger than 3 MB. Otherwise false. If the payload size - * exceed 3 MB, the payload is stored in a blob and the PayloadsLocation + * @property {object} [assets] Contains user defined properties describing + * web service assets. Properties are expressed as Key/Value pairs. + * @property {object} [parameters] The set of global parameters values + * defined for the web service, given as a global parameter name to default + * value map. If no default value is specified, the parameter is considered + * to be required. + * @property {boolean} [payloadsInBlobStorage] When set to true, indicates + * that the payload size is larger than 3 MB. Otherwise false. If the payload + * size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation * parameter contains the URI of the blob. Otherwise, this will be set to * false and Assets, Input, Output, Package, Parameters, ExampleRequest are * inline. The Payload sizes is determined by adding the size of the Assets, * Input, Output, Package, Parameters, and the ExampleRequest. - * @member {object} [payloadsLocation] The URI of the payload blob. This + * @property {object} [payloadsLocation] The URI of the payload blob. This * paramater contains a value only if the payloadsInBlobStorage parameter is * set to true. Otherwise is set to null. - * @member {string} [payloadsLocation.uri] The URI from which the blob is + * @property {string} [payloadsLocation.uri] The URI from which the blob is * accessible from. For example, aml://abc for system assets or https://xyz * for user assets or payload. - * @member {string} [payloadsLocation.credentials] Access credentials for the - * blob, if applicable (e.g. blob specified by storage account connection + * @property {string} [payloadsLocation.credentials] Access credentials for + * the blob, if applicable (e.g. blob specified by storage account connection * string + blob URI) - * @member {string} packageType Polymorphic Discriminator + * @property {string} packageType Polymorphic Discriminator */ constructor() { } @@ -332,6 +331,7 @@ class WebServiceProperties { packageType: { required: true, serializedName: 'packageType', + isPolymorphicDiscriminator: true, type: { name: 'String' } diff --git a/lib/services/machinelearning/lib/webservices/models/webServicePropertiesForGraph.js b/lib/services/machinelearning/lib/webservices/models/webServicePropertiesForGraph.js index 23cdf3415f..8ae1a58c8e 100644 --- a/lib/services/machinelearning/lib/webservices/models/webServicePropertiesForGraph.js +++ b/lib/services/machinelearning/lib/webservices/models/webServicePropertiesForGraph.js @@ -20,13 +20,13 @@ const models = require('./index'); class WebServicePropertiesForGraph extends models['WebServiceProperties'] { /** * Create a WebServicePropertiesForGraph. - * @member {object} [packageProperty] The definition of the graph package + * @property {object} [packageProperty] The definition of the graph package * making up this web service. - * @member {object} [packageProperty.nodes] The set of nodes making up the + * @property {object} [packageProperty.nodes] The set of nodes making up the * graph, provided as a nodeId to GraphNode map - * @member {array} [packageProperty.edges] The list of edges making up the + * @property {array} [packageProperty.edges] The list of edges making up the * graph. - * @member {object} [packageProperty.graphParameters] The collection of + * @property {object} [packageProperty.graphParameters] The collection of * global parameters for the graph, given as a global parameter name to * GraphParameter map. Each parameter here has a 1:1 match with the global * parameters values map declared at the WebServiceProperties level. @@ -47,6 +47,11 @@ class WebServicePropertiesForGraph extends models['WebServiceProperties'] { serializedName: 'Graph', type: { name: 'Composite', + polymorphicDiscriminator: { + serializedName: 'packageType', + clientName: 'packageType' + }, + uberParent: 'WebServiceProperties', className: 'WebServicePropertiesForGraph', modelProperties: { title: { @@ -229,6 +234,7 @@ class WebServicePropertiesForGraph extends models['WebServiceProperties'] { packageType: { required: true, serializedName: 'packageType', + isPolymorphicDiscriminator: true, type: { name: 'String' } diff --git a/lib/services/machinelearning/lib/webservices/operations/index.d.ts b/lib/services/machinelearning/lib/webservices/operations/index.d.ts index 164f8e4b96..75594b7ba1 100644 --- a/lib/services/machinelearning/lib/webservices/operations/index.d.ts +++ b/lib/services/machinelearning/lib/webservices/operations/index.d.ts @@ -12,6 +12,67 @@ import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationRes import * as models from '../models'; +/** + * @class + * Operations + * __NOTE__: An instance of this class is automatically created for an + * instance of the AzureMLWebServicesManagementClient. + */ +export interface Operations { + + + /** + * Lists all the available REST API operations. + * + * @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. + */ + listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all the available REST API operations. + * + * @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 {OperationEntityListResult} - 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. + * + * {OperationEntityListResult} [result] - The deserialized result object if an error did not occur. + * See {@link OperationEntityListResult} 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. + */ + list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(callback: ServiceCallback): void; + list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + /** * @class * WebServices diff --git a/lib/services/machinelearning/lib/webservices/operations/index.js b/lib/services/machinelearning/lib/webservices/operations/index.js index cd543ca45f..492c461663 100644 --- a/lib/services/machinelearning/lib/webservices/operations/index.js +++ b/lib/services/machinelearning/lib/webservices/operations/index.js @@ -14,4 +14,5 @@ 'use strict'; +exports.Operations = require('./operations'); exports.WebServices = require('./webServices'); diff --git a/lib/services/machinelearning/lib/webservices/operations/operations.js b/lib/services/machinelearning/lib/webservices/operations/operations.js new file mode 100644 index 0000000000..10663488bb --- /dev/null +++ b/lib/services/machinelearning/lib/webservices/operations/operations.js @@ -0,0 +1,239 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * Lists all the available REST API operations. + * + * @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 OperationEntityListResult} 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 _list(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.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 (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('/') ? '' : '/') + 'providers/Microsoft.MachineLearning/operations'; + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['OperationEntityListResult']().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); + }); +} + +/** Class representing a Operations. */ +class Operations { + /** + * Create a Operations. + * @param {AzureMLWebServicesManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._list = _list; + } + + /** + * Lists all the available REST API operations. + * + * @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. + */ + listWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists all the available REST API operations. + * + * @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 {OperationEntityListResult} - 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 OperationEntityListResult} 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. + */ + list(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._list(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(options, optionalCallback); + } + } + +} + +module.exports = Operations; diff --git a/lib/services/machinelearning/lib/webservices/operations/webServices.js b/lib/services/machinelearning/lib/webservices/operations/webServices.js index 3f5e30bfc0..8ba9a561b6 100644 --- a/lib/services/machinelearning/lib/webservices/operations/webServices.js +++ b/lib/services/machinelearning/lib/webservices/operations/webServices.js @@ -2120,7 +2120,7 @@ function _beginCreateRegionalProperties(resourceGroupName, webServiceName, regio return callback(err); } let statusCode = response.statusCode; - if (statusCode !== 202 && statusCode !== 200) { + if (statusCode !== 200 && statusCode !== 202) { let error = new Error(responseBody); error.statusCode = response.statusCode; error.request = msRest.stripRequest(httpRequest); diff --git a/lib/services/dataLake.Store/lib/filesystem/dataLakeStoreFileSystemManagementClient.d.ts b/lib/services/machinelearning/lib/workspaces/machineLearningWorkspacesManagementClient.d.ts similarity index 53% rename from lib/services/dataLake.Store/lib/filesystem/dataLakeStoreFileSystemManagementClient.d.ts rename to lib/services/machinelearning/lib/workspaces/machineLearningWorkspacesManagementClient.d.ts index 6096d849da..f1079ad3c1 100644 --- a/lib/services/dataLake.Store/lib/filesystem/dataLakeStoreFileSystemManagementClient.d.ts +++ b/lib/services/machinelearning/lib/workspaces/machineLearningWorkspacesManagementClient.d.ts @@ -13,36 +13,18 @@ import { AzureServiceClient, AzureServiceClientOptions } from 'ms-rest-azure'; import * as models from "./models"; import * as operations from "./operations"; -/** - * DataLakeStoreFileSystemManagementClientOptions for DataLakeStoreFileSystemManagementClient. - */ -declare interface DataLakeStoreFileSystemManagementClientOptions extends AzureServiceClientOptions { - /** - * @property {string} [adlsFileSystemDnsSuffix] - Gets the URI used as the base for all cloud service requests. - */ - adlsFileSystemDnsSuffix?: string; - /** - * @property {string} [acceptLanguage] - The preferred language for the response. - */ - acceptLanguage?: string; - /** - * @property {number} [longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. - */ - longRunningOperationRetryTimeout?: number; - /** - * @property {boolean} [generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. - */ - generateClientRequestId?: boolean; -} - -export default class DataLakeStoreFileSystemManagementClient extends AzureServiceClient { +export default class MachineLearningWorkspacesManagementClient extends AzureServiceClient { /** - * Initializes a new instance of the DataLakeStoreFileSystemManagementClient class. + * Initializes a new instance of the MachineLearningWorkspacesManagementClient class. * @constructor * * @class * @param {credentials} credentials - Credentials needed for the client to connect to Azure. * + * @param {string} subscriptionId - The Microsoft Azure subscription ID. + * + * @param {string} [baseUri] - The base URI of the service. + * * @param {object} [options] - The parameter options * * @param {Array} [options.filters] - Filters to be added to the request pipeline @@ -52,8 +34,6 @@ export default class DataLakeStoreFileSystemManagementClient extends AzureServic * * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy * - * @param {string} [options.adlsFileSystemDnsSuffix] - Gets the URI used as the base for all cloud service requests. - * * @param {string} [options.acceptLanguage] - The preferred language for the response. * * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. @@ -61,13 +41,13 @@ export default class DataLakeStoreFileSystemManagementClient extends AzureServic * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. * */ - constructor(credentials: ServiceClientCredentials, options?: DataLakeStoreFileSystemManagementClientOptions); + constructor(credentials: ServiceClientCredentials, subscriptionId: string, baseUri?: string, options?: AzureServiceClientOptions); credentials: ServiceClientCredentials; - apiVersion: string; + subscriptionId: string; - adlsFileSystemDnsSuffix: string; + apiVersion: string; acceptLanguage: string; @@ -76,7 +56,8 @@ export default class DataLakeStoreFileSystemManagementClient extends AzureServic generateClientRequestId: boolean; // Operation groups - fileSystem: operations.FileSystem; + operations: operations.Operations; + workspaces: operations.Workspaces; } -export { DataLakeStoreFileSystemManagementClient, models as DataLakeStoreFileSystemManagementModels }; +export { MachineLearningWorkspacesManagementClient, models as MachineLearningWorkspacesManagementModels }; diff --git a/lib/services/dataLake.Store/lib/filesystem/dataLakeStoreFileSystemManagementClient.js b/lib/services/machinelearning/lib/workspaces/machineLearningWorkspacesManagementClient.js similarity index 70% rename from lib/services/dataLake.Store/lib/filesystem/dataLakeStoreFileSystemManagementClient.js rename to lib/services/machinelearning/lib/workspaces/machineLearningWorkspacesManagementClient.js index f1518f7367..bd9c6cb533 100644 --- a/lib/services/dataLake.Store/lib/filesystem/dataLakeStoreFileSystemManagementClient.js +++ b/lib/services/machinelearning/lib/workspaces/machineLearningWorkspacesManagementClient.js @@ -22,43 +22,47 @@ const models = require('./models'); const operations = require('./operations'); -/** Class representing a DataLakeStoreFileSystemManagementClient. */ -class DataLakeStoreFileSystemManagementClient extends ServiceClient { +/** Class representing a MachineLearningWorkspacesManagementClient. */ +class MachineLearningWorkspacesManagementClient extends ServiceClient { /** - * Create a DataLakeStoreFileSystemManagementClient. + * Create a MachineLearningWorkspacesManagementClient. * @param {credentials} credentials - Credentials needed for the client to connect to Azure. + * @param {string} subscriptionId - The Microsoft Azure subscription ID. + * @param {string} [baseUri] - The base URI of the service. * @param {object} [options] - The parameter options * @param {Array} [options.filters] - Filters to be added to the request pipeline * @param {object} [options.requestOptions] - Options for the underlying request object * {@link https://github.com/request/request#requestoptions-callback Options doc} * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy - * @param {string} [options.adlsFileSystemDnsSuffix] - Gets the URI used as the base for all cloud service requests. * @param {string} [options.acceptLanguage] - The preferred language for the response. * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. */ - constructor(credentials, options) { + constructor(credentials, subscriptionId, baseUri, options) { if (credentials === null || credentials === undefined) { throw new Error('\'credentials\' cannot be null.'); } + if (subscriptionId === null || subscriptionId === undefined) { + throw new Error('\'subscriptionId\' cannot be null.'); + } if (!options) options = {}; super(credentials, options); - this.apiVersion = '2016-11-01'; - this.adlsFileSystemDnsSuffix = 'azuredatalakestore.net'; + this.apiVersion = '2016-04-01'; this.acceptLanguage = 'en-US'; this.longRunningOperationRetryTimeout = 30; this.generateClientRequestId = true; - this.baseUri = 'https://{accountName}.{adlsFileSystemDnsSuffix}'; + this.baseUri = baseUri; + if (!this.baseUri) { + this.baseUri = 'https://management.azure.com'; + } this.credentials = credentials; + this.subscriptionId = subscriptionId; let packageInfo = this.getPackageJsonInfo(__dirname); this.addUserAgentInfo(`${packageInfo.name}/${packageInfo.version}`); - if(options.adlsFileSystemDnsSuffix !== null && options.adlsFileSystemDnsSuffix !== undefined) { - this.adlsFileSystemDnsSuffix = options.adlsFileSystemDnsSuffix; - } if(options.acceptLanguage !== null && options.acceptLanguage !== undefined) { this.acceptLanguage = options.acceptLanguage; } @@ -68,14 +72,15 @@ class DataLakeStoreFileSystemManagementClient extends ServiceClient { if(options.generateClientRequestId !== null && options.generateClientRequestId !== undefined) { this.generateClientRequestId = options.generateClientRequestId; } - this.fileSystem = new operations.FileSystem(this); + this.operations = new operations.Operations(this); + this.workspaces = new operations.Workspaces(this); this.models = models; msRest.addSerializationMixin(this); } } -module.exports = DataLakeStoreFileSystemManagementClient; -module.exports['default'] = DataLakeStoreFileSystemManagementClient; -module.exports.DataLakeStoreFileSystemManagementClient = DataLakeStoreFileSystemManagementClient; -module.exports.DataLakeStoreFileSystemManagementModels = models; +module.exports = MachineLearningWorkspacesManagementClient; +module.exports['default'] = MachineLearningWorkspacesManagementClient; +module.exports.MachineLearningWorkspacesManagementClient = MachineLearningWorkspacesManagementClient; +module.exports.MachineLearningWorkspacesManagementModels = models; diff --git a/lib/services/machinelearning/lib/workspaces/models/errorResponse.js b/lib/services/machinelearning/lib/workspaces/models/errorResponse.js new file mode 100644 index 0000000000..d6f5a446b9 --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/models/errorResponse.js @@ -0,0 +1,60 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The error response send when an operation fails. + * + */ +class ErrorResponse { + /** + * Create a ErrorResponse. + * @property {string} code error code + * @property {string} message error message + */ + constructor() { + } + + /** + * Defines the metadata of ErrorResponse + * + * @returns {object} metadata of ErrorResponse + * + */ + mapper() { + return { + required: false, + serializedName: 'ErrorResponse', + type: { + name: 'Composite', + className: 'ErrorResponse', + modelProperties: { + code: { + required: true, + serializedName: 'code', + type: { + name: 'String' + } + }, + message: { + required: true, + serializedName: 'message', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = ErrorResponse; diff --git a/lib/services/machinelearning/lib/workspaces/models/index.d.ts b/lib/services/machinelearning/lib/workspaces/models/index.d.ts new file mode 100644 index 0000000000..581fd09514 --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/models/index.d.ts @@ -0,0 +1,181 @@ +/* + * 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. + */ + +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; + +export { + + BaseResource, + CloudError +}; + +/** + * The error response send when an operation fails. + */ +export interface ErrorResponse { + /** + * error code + */ + code: string; + /** + * error message + */ + message: string; +} + +/** + * An Azure resource. + */ +export interface Resource extends BaseResource { + /** + * The resource ID. + */ + readonly id?: string; + /** + * The name of the resource. + */ + readonly name?: string; + /** + * The type of the resource. + */ + readonly type?: string; + /** + * The location of the resource. This cannot be changed after the resource is created. + */ + location: string; + /** + * The tags of the resource. + */ + tags?: { [propertyName: string]: string }; +} + +/** + * An object that represents a machine learning workspace. + */ +export interface Workspace extends Resource { + /** + * The fully qualified arm id of the storage account associated with this workspace. + */ + userStorageAccountId: string; + /** + * The email id of the owner for this workspace. + */ + ownerEmail?: string; + /** + * The type of this workspace. Possible values include: 'Production', 'Free', 'Anonymous', + * 'PaidStandard', 'PaidPremium' + */ + readonly workspaceType?: string; + /** + * The current state of workspace resource. Possible values include: 'Deleted', 'Enabled', + * 'Disabled', 'Migrated', 'Updated', 'Registered', 'Unregistered' + */ + readonly workspaceState?: string; + /** + * The immutable id associated with this workspace. + */ + readonly workspaceId?: string; + /** + * The creation time for this workspace resource. + */ + readonly creationTime?: string; + /** + * The regional endpoint for the machine learning studio service which hosts this workspace. + */ + readonly studioEndpoint?: string; + /** + * The key vault identifier used for encrypted workspaces. + */ + keyVaultIdentifierId?: string; +} + +/** + * The parameters for updating a machine learning workspace. + */ +export interface WorkspaceUpdateParameters { + /** + * The resource tags for the machine learning workspace. + */ + tags?: { [propertyName: string]: string }; + /** + * The current state of workspace resource. Possible values include: 'Deleted', 'Enabled', + * 'Disabled', 'Migrated', 'Updated', 'Registered', 'Unregistered' + */ + workspaceState?: string; + /** + * The key vault identifier used for encrypted workspaces. + */ + keyVaultIdentifierId?: string; +} + +/** + * Workspace authorization keys for a workspace. + */ +export interface WorkspaceKeysResponse { + /** + * Primary authorization key for this workspace. + */ + primaryToken?: string; + /** + * Secondary authorization key for this workspace. + */ + secondaryToken?: string; +} + +/** + * Display name of operation + */ +export interface OperationDisplay { + /** + * The resource provider name: Microsoft.MachineLearning + */ + provider?: string; + /** + * The resource on which the operation is performed. + */ + resource?: string; + /** + * The operation that users can perform. + */ + operation?: string; + /** + * The description for the operation. + */ + description?: string; +} + +/** + * Azure Machine Learning Studio REST API operation + */ +export interface Operation { + /** + * Operation name: {provider}/{resource}/{operation} + */ + name?: string; + /** + * Display name of operation + */ + display?: OperationDisplay; +} + +/** + * An array of operations supported by the resource provider. + */ +export interface OperationListResult extends Array { +} + +/** + * The result of a request to list machine learning workspace keys. + */ +export interface WorkspaceListResult extends Array { + /** + * The URI that can be used to request the next list of machine learning workspaces. + */ + nextLink?: string; +} diff --git a/lib/services/machinelearning/lib/workspaces/models/index.js b/lib/services/machinelearning/lib/workspaces/models/index.js new file mode 100644 index 0000000000..ba5d9bfebc --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/models/index.js @@ -0,0 +1,29 @@ +/* + * 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. + */ + +/* jshint latedef:false */ +/* jshint forin:false */ +/* jshint noempty:false */ + +'use strict'; + +var msRestAzure = require('ms-rest-azure'); + +exports.BaseResource = msRestAzure.BaseResource; +exports.CloudError = msRestAzure.CloudError; +exports.ErrorResponse = require('./errorResponse'); +exports.Resource = require('./resource'); +exports.Workspace = require('./workspace'); +exports.WorkspaceUpdateParameters = require('./workspaceUpdateParameters'); +exports.WorkspaceKeysResponse = require('./workspaceKeysResponse'); +exports.OperationDisplay = require('./operationDisplay'); +exports.Operation = require('./operation'); +exports.OperationListResult = require('./operationListResult'); +exports.WorkspaceListResult = require('./workspaceListResult'); diff --git a/lib/services/machinelearning/lib/workspaces/models/operation.js b/lib/services/machinelearning/lib/workspaces/models/operation.js new file mode 100644 index 0000000000..6a8d5dfb42 --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/models/operation.js @@ -0,0 +1,70 @@ +/* + * 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'; + +/** + * Azure Machine Learning Studio REST API operation + * + */ +class Operation { + /** + * Create a Operation. + * @property {string} [name] Operation name: + * {provider}/{resource}/{operation} + * @property {object} [display] Display name of operation + * @property {string} [display.provider] The resource provider name: + * Microsoft.MachineLearning + * @property {string} [display.resource] The resource on which the operation + * is performed. + * @property {string} [display.operation] The operation that users can + * perform. + * @property {string} [display.description] The description for the + * operation. + */ + constructor() { + } + + /** + * Defines the metadata of Operation + * + * @returns {object} metadata of Operation + * + */ + mapper() { + return { + required: false, + serializedName: 'Operation', + type: { + name: 'Composite', + className: 'Operation', + modelProperties: { + name: { + required: false, + serializedName: 'name', + type: { + name: 'String' + } + }, + display: { + required: false, + serializedName: 'display', + type: { + name: 'Composite', + className: 'OperationDisplay' + } + } + } + } + }; + } +} + +module.exports = Operation; diff --git a/lib/services/machinelearning/lib/workspaces/models/operationDisplay.js b/lib/services/machinelearning/lib/workspaces/models/operationDisplay.js new file mode 100644 index 0000000000..0d31e994a8 --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/models/operationDisplay.js @@ -0,0 +1,78 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Display name of operation + * + */ +class OperationDisplay { + /** + * Create a OperationDisplay. + * @property {string} [provider] The resource provider name: + * Microsoft.MachineLearning + * @property {string} [resource] The resource on which the operation is + * performed. + * @property {string} [operation] The operation that users can perform. + * @property {string} [description] The description for the operation. + */ + constructor() { + } + + /** + * Defines the metadata of OperationDisplay + * + * @returns {object} metadata of OperationDisplay + * + */ + mapper() { + return { + required: false, + serializedName: 'Operation_display', + type: { + name: 'Composite', + className: 'OperationDisplay', + modelProperties: { + provider: { + required: false, + serializedName: 'provider', + type: { + name: 'String' + } + }, + resource: { + required: false, + serializedName: 'resource', + type: { + name: 'String' + } + }, + operation: { + required: false, + serializedName: 'operation', + type: { + name: 'String' + } + }, + description: { + required: false, + serializedName: 'description', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = OperationDisplay; diff --git a/lib/services/machinelearning/lib/workspaces/models/operationListResult.js b/lib/services/machinelearning/lib/workspaces/models/operationListResult.js new file mode 100644 index 0000000000..91e43a3a22 --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/models/operationListResult.js @@ -0,0 +1,59 @@ +/* + * 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'; + +/** + * An array of operations supported by the resource provider. + */ +class OperationListResult extends Array { + /** + * Create a OperationListResult. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of OperationListResult + * + * @returns {object} metadata of OperationListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'OperationListResult', + type: { + name: 'Composite', + className: 'OperationListResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'OperationElementType', + type: { + name: 'Composite', + className: 'Operation' + } + } + } + } + } + } + }; + } +} + +module.exports = OperationListResult; diff --git a/lib/services/dataLake.Store/lib/account/models/resource.js b/lib/services/machinelearning/lib/workspaces/models/resource.js similarity index 83% rename from lib/services/dataLake.Store/lib/account/models/resource.js rename to lib/services/machinelearning/lib/workspaces/models/resource.js index 7cd91c5c05..d76fa1783d 100644 --- a/lib/services/dataLake.Store/lib/account/models/resource.js +++ b/lib/services/machinelearning/lib/workspaces/models/resource.js @@ -13,18 +13,19 @@ const models = require('./index'); /** - * The resource model definition. + * An Azure resource. * * @extends models['BaseResource'] */ class Resource extends models['BaseResource'] { /** * Create a 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} [id] The resource ID. + * @property {string} [name] The name of the resource. + * @property {string} [type] The type of the resource. + * @property {string} location The location of the resource. This cannot be + * changed after the resource is created. + * @property {object} [tags] The tags of the resource. */ constructor() { super(); @@ -69,8 +70,7 @@ class Resource extends models['BaseResource'] { } }, location: { - required: false, - readOnly: true, + required: true, serializedName: 'location', type: { name: 'String' @@ -78,7 +78,6 @@ class Resource extends models['BaseResource'] { }, tags: { required: false, - readOnly: true, serializedName: 'tags', type: { name: 'Dictionary', diff --git a/lib/services/machinelearning/lib/workspaces/models/workspace.js b/lib/services/machinelearning/lib/workspaces/models/workspace.js new file mode 100644 index 0000000000..e8aa7a662e --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/models/workspace.js @@ -0,0 +1,174 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * An object that represents a machine learning workspace. + * + * @extends models['Resource'] + */ +class Workspace extends models['Resource'] { + /** + * Create a Workspace. + * @property {string} userStorageAccountId The fully qualified arm id of the + * storage account associated with this workspace. + * @property {string} [ownerEmail] The email id of the owner for this + * workspace. + * @property {string} [workspaceType] The type of this workspace. Possible + * values include: 'Production', 'Free', 'Anonymous', 'PaidStandard', + * 'PaidPremium' + * @property {string} [workspaceState] The current state of workspace + * resource. Possible values include: 'Deleted', 'Enabled', 'Disabled', + * 'Migrated', 'Updated', 'Registered', 'Unregistered' + * @property {string} [workspaceId] The immutable id associated with this + * workspace. + * @property {string} [creationTime] The creation time for this workspace + * resource. + * @property {string} [studioEndpoint] The regional endpoint for the machine + * learning studio service which hosts this workspace. + * @property {string} [keyVaultIdentifierId] The key vault identifier used + * for encrypted workspaces. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of Workspace + * + * @returns {object} metadata of Workspace + * + */ + mapper() { + return { + required: false, + serializedName: 'Workspace', + type: { + name: 'Composite', + className: 'Workspace', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + location: { + required: true, + serializedName: 'location', + type: { + name: 'String' + } + }, + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + userStorageAccountId: { + required: true, + serializedName: 'properties.userStorageAccountId', + type: { + name: 'String' + } + }, + ownerEmail: { + required: false, + serializedName: 'properties.ownerEmail', + type: { + name: 'String' + } + }, + workspaceType: { + required: false, + readOnly: true, + serializedName: 'properties.workspaceType', + type: { + name: 'Enum', + allowedValues: [ 'Production', 'Free', 'Anonymous', 'PaidStandard', 'PaidPremium' ] + } + }, + workspaceState: { + required: false, + readOnly: true, + serializedName: 'properties.workspaceState', + type: { + name: 'Enum', + allowedValues: [ 'Deleted', 'Enabled', 'Disabled', 'Migrated', 'Updated', 'Registered', 'Unregistered' ] + } + }, + workspaceId: { + required: false, + readOnly: true, + serializedName: 'properties.workspaceId', + type: { + name: 'String' + } + }, + creationTime: { + required: false, + readOnly: true, + serializedName: 'properties.creationTime', + type: { + name: 'String' + } + }, + studioEndpoint: { + required: false, + readOnly: true, + serializedName: 'properties.studioEndpoint', + type: { + name: 'String' + } + }, + keyVaultIdentifierId: { + required: false, + serializedName: 'properties.keyVaultIdentifierId', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = Workspace; diff --git a/lib/services/machinelearning/lib/workspaces/models/workspaceKeysResponse.js b/lib/services/machinelearning/lib/workspaces/models/workspaceKeysResponse.js new file mode 100644 index 0000000000..2aa7e62d5a --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/models/workspaceKeysResponse.js @@ -0,0 +1,62 @@ +/* + * 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'; + +/** + * Workspace authorization keys for a workspace. + * + */ +class WorkspaceKeysResponse { + /** + * Create a WorkspaceKeysResponse. + * @property {string} [primaryToken] Primary authorization key for this + * workspace. + * @property {string} [secondaryToken] Secondary authorization key for this + * workspace. + */ + constructor() { + } + + /** + * Defines the metadata of WorkspaceKeysResponse + * + * @returns {object} metadata of WorkspaceKeysResponse + * + */ + mapper() { + return { + required: false, + serializedName: 'WorkspaceKeysResponse', + type: { + name: 'Composite', + className: 'WorkspaceKeysResponse', + modelProperties: { + primaryToken: { + required: false, + serializedName: 'primaryToken', + type: { + name: 'String' + } + }, + secondaryToken: { + required: false, + serializedName: 'secondaryToken', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = WorkspaceKeysResponse; diff --git a/lib/services/machinelearning/lib/workspaces/models/workspaceListResult.js b/lib/services/machinelearning/lib/workspaces/models/workspaceListResult.js new file mode 100644 index 0000000000..030c6218a0 --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/models/workspaceListResult.js @@ -0,0 +1,68 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The result of a request to list machine learning workspace keys. + */ +class WorkspaceListResult extends Array { + /** + * Create a WorkspaceListResult. + * @property {string} [nextLink] The URI that can be used to request the next + * list of machine learning workspaces. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of WorkspaceListResult + * + * @returns {object} metadata of WorkspaceListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'WorkspaceListResult', + type: { + name: 'Composite', + className: 'WorkspaceListResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'WorkspaceElementType', + type: { + name: 'Composite', + className: 'Workspace' + } + } + } + }, + nextLink: { + required: false, + serializedName: 'nextLink', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = WorkspaceListResult; diff --git a/lib/services/machinelearning/lib/workspaces/models/workspaceUpdateParameters.js b/lib/services/machinelearning/lib/workspaces/models/workspaceUpdateParameters.js new file mode 100644 index 0000000000..5349bcb226 --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/models/workspaceUpdateParameters.js @@ -0,0 +1,80 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The parameters for updating a machine learning workspace. + * + */ +class WorkspaceUpdateParameters { + /** + * Create a WorkspaceUpdateParameters. + * @property {object} [tags] The resource tags for the machine learning + * workspace. + * @property {string} [workspaceState] The current state of workspace + * resource. Possible values include: 'Deleted', 'Enabled', 'Disabled', + * 'Migrated', 'Updated', 'Registered', 'Unregistered' + * @property {string} [keyVaultIdentifierId] The key vault identifier used + * for encrypted workspaces. + */ + constructor() { + } + + /** + * Defines the metadata of WorkspaceUpdateParameters + * + * @returns {object} metadata of WorkspaceUpdateParameters + * + */ + mapper() { + return { + required: false, + serializedName: 'WorkspaceUpdateParameters', + type: { + name: 'Composite', + className: 'WorkspaceUpdateParameters', + modelProperties: { + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + workspaceState: { + required: false, + serializedName: 'properties.workspaceState', + type: { + name: 'Enum', + allowedValues: [ 'Deleted', 'Enabled', 'Disabled', 'Migrated', 'Updated', 'Registered', 'Unregistered' ] + } + }, + keyVaultIdentifierId: { + required: false, + serializedName: 'properties.keyVaultIdentifierId', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = WorkspaceUpdateParameters; diff --git a/lib/services/machinelearning/lib/workspaces/operations/index.d.ts b/lib/services/machinelearning/lib/workspaces/operations/index.d.ts new file mode 100644 index 0000000000..b2507311d1 --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/operations/index.d.ts @@ -0,0 +1,738 @@ +/* + * 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. +*/ + +import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse } from 'ms-rest'; +import * as models from '../models'; + + +/** + * @class + * Operations + * __NOTE__: An instance of this class is automatically created for an + * instance of the MachineLearningWorkspacesManagementClient. + */ +export interface Operations { + + + /** + * Lists all of the available Azure Machine Learning Studio REST API + * operations. + * + * @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. + */ + listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all of the available Azure Machine Learning Studio REST API + * operations. + * + * @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 {OperationListResult} - 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. + * + * {OperationListResult} [result] - The deserialized result object if an error did not occur. + * See {@link OperationListResult} 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. + */ + list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(callback: ServiceCallback): void; + list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * Workspaces + * __NOTE__: An instance of this class is automatically created for an + * instance of the MachineLearningWorkspacesManagementClient. + */ +export interface Workspaces { + + + /** + * Gets the properties of the specified machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName: string, workspaceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets the properties of the specified machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @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 {Workspace} - 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. + * + * {Workspace} [result] - The deserialized result object if an error did not occur. + * See {@link Workspace} 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. + */ + get(resourceGroupName: string, workspaceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, workspaceName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, workspaceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates a workspace with the specified parameters. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {object} parameters The parameters for creating or updating a machine + * learning workspace. + * + * @param {string} parameters.userStorageAccountId The fully qualified arm id + * of the storage account associated with this workspace. + * + * @param {string} [parameters.ownerEmail] The email id of the owner for this + * workspace. + * + * @param {string} [parameters.keyVaultIdentifierId] The key vault identifier + * used for encrypted workspaces. + * + * @param {string} parameters.location The location of the resource. This + * cannot be changed after the resource is created. + * + * @param {object} [parameters.tags] The tags of the resource. + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, workspaceName: string, parameters: models.Workspace, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a workspace with the specified parameters. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {object} parameters The parameters for creating or updating a machine + * learning workspace. + * + * @param {string} parameters.userStorageAccountId The fully qualified arm id + * of the storage account associated with this workspace. + * + * @param {string} [parameters.ownerEmail] The email id of the owner for this + * workspace. + * + * @param {string} [parameters.keyVaultIdentifierId] The key vault identifier + * used for encrypted workspaces. + * + * @param {string} parameters.location The location of the resource. This + * cannot be changed after the resource is created. + * + * @param {object} [parameters.tags] The tags of the resource. + * + * @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 {Workspace} - 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. + * + * {Workspace} [result] - The deserialized result object if an error did not occur. + * See {@link Workspace} 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. + */ + createOrUpdate(resourceGroupName: string, workspaceName: string, parameters: models.Workspace, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, workspaceName: string, parameters: models.Workspace, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, workspaceName: string, parameters: models.Workspace, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes a machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName: string, workspaceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes a machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + deleteMethod(resourceGroupName: string, workspaceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, workspaceName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, workspaceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates a machine learning workspace with the specified parameters. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {object} parameters The parameters for updating a machine learning + * workspace. + * + * @param {object} [parameters.tags] The resource tags for the machine learning + * workspace. + * + * @param {string} [parameters.workspaceState] The current state of workspace + * resource. Possible values include: 'Deleted', 'Enabled', 'Disabled', + * 'Migrated', 'Updated', 'Registered', 'Unregistered' + * + * @param {string} [parameters.keyVaultIdentifierId] The key vault identifier + * used for encrypted workspaces. + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName: string, workspaceName: string, parameters: models.WorkspaceUpdateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates a machine learning workspace with the specified parameters. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {object} parameters The parameters for updating a machine learning + * workspace. + * + * @param {object} [parameters.tags] The resource tags for the machine learning + * workspace. + * + * @param {string} [parameters.workspaceState] The current state of workspace + * resource. Possible values include: 'Deleted', 'Enabled', 'Disabled', + * 'Migrated', 'Updated', 'Registered', 'Unregistered' + * + * @param {string} [parameters.keyVaultIdentifierId] The key vault identifier + * used for encrypted workspaces. + * + * @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 {Workspace} - 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. + * + * {Workspace} [result] - The deserialized result object if an error did not occur. + * See {@link Workspace} 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. + */ + update(resourceGroupName: string, workspaceName: string, parameters: models.WorkspaceUpdateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + update(resourceGroupName: string, workspaceName: string, parameters: models.WorkspaceUpdateParameters, callback: ServiceCallback): void; + update(resourceGroupName: string, workspaceName: string, parameters: models.WorkspaceUpdateParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Resync storage keys associated with this workspace. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @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. + */ + resyncStorageKeysWithHttpOperationResponse(workspaceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Resync storage keys associated with this workspace. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + resyncStorageKeys(workspaceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + resyncStorageKeys(workspaceName: string, resourceGroupName: string, callback: ServiceCallback): void; + resyncStorageKeys(workspaceName: string, resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * List the authorization keys associated with this workspace. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @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. + */ + listWorkspaceKeysWithHttpOperationResponse(workspaceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * List the authorization keys associated with this workspace. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @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 {WorkspaceKeysResponse} - 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. + * + * {WorkspaceKeysResponse} [result] - The deserialized result object if an error did not occur. + * See {@link WorkspaceKeysResponse} 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. + */ + listWorkspaceKeys(workspaceName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listWorkspaceKeys(workspaceName: string, resourceGroupName: string, callback: ServiceCallback): void; + listWorkspaceKeys(workspaceName: string, resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists all the available machine learning workspaces under the specified + * resource group. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @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. + */ + listByResourceGroupWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all the available machine learning workspaces under the specified + * resource group. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. + * + * @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 {WorkspaceListResult} - 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. + * + * {WorkspaceListResult} [result] - The deserialized result object if an error did not occur. + * See {@link WorkspaceListResult} 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. + */ + listByResourceGroup(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByResourceGroup(resourceGroupName: string, callback: ServiceCallback): void; + listByResourceGroup(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists all the available machine learning workspaces under the specified + * subscription. + * + * @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. + */ + listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all the available machine learning workspaces under the specified + * subscription. + * + * @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 {WorkspaceListResult} - 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. + * + * {WorkspaceListResult} [result] - The deserialized result object if an error did not occur. + * See {@link WorkspaceListResult} 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. + */ + list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(callback: ServiceCallback): void; + list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists all the available machine learning workspaces under the specified + * resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listByResourceGroupNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all the available machine learning workspaces under the specified + * resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {WorkspaceListResult} - 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. + * + * {WorkspaceListResult} [result] - The deserialized result object if an error did not occur. + * See {@link WorkspaceListResult} 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. + */ + listByResourceGroupNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback): void; + listByResourceGroupNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists all the available machine learning workspaces under the specified + * subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all the available machine learning workspaces under the specified + * subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {WorkspaceListResult} - 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. + * + * {WorkspaceListResult} [result] - The deserialized result object if an error did not occur. + * See {@link WorkspaceListResult} 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. + */ + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} diff --git a/lib/services/dataLake.Store/lib/filesystem/operations/index.js b/lib/services/machinelearning/lib/workspaces/operations/index.js similarity index 81% rename from lib/services/dataLake.Store/lib/filesystem/operations/index.js rename to lib/services/machinelearning/lib/workspaces/operations/index.js index bfe29f562c..c9ad5a809b 100644 --- a/lib/services/dataLake.Store/lib/filesystem/operations/index.js +++ b/lib/services/machinelearning/lib/workspaces/operations/index.js @@ -14,4 +14,5 @@ 'use strict'; -exports.FileSystem = require('./fileSystem'); +exports.Operations = require('./operations'); +exports.Workspaces = require('./workspaces'); diff --git a/lib/services/machinelearning/lib/workspaces/operations/operations.js b/lib/services/machinelearning/lib/workspaces/operations/operations.js new file mode 100644 index 0000000000..ad3ed00565 --- /dev/null +++ b/lib/services/machinelearning/lib/workspaces/operations/operations.js @@ -0,0 +1,241 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * Lists all of the available Azure Machine Learning Studio REST API + * operations. + * + * @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 OperationListResult} 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 _list(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.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 (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('/') ? '' : '/') + 'providers/Microsoft.MachineLearning/operations'; + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['OperationListResult']().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); + }); +} + +/** Class representing a Operations. */ +class Operations { + /** + * Create a Operations. + * @param {MachineLearningWorkspacesManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._list = _list; + } + + /** + * Lists all of the available Azure Machine Learning Studio REST API + * operations. + * + * @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. + */ + listWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists all of the available Azure Machine Learning Studio REST API + * operations. + * + * @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 {OperationListResult} - 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 OperationListResult} 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. + */ + list(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._list(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(options, optionalCallback); + } + } + +} + +module.exports = Operations; diff --git a/lib/services/networkManagement2/lib/operations/virtualWANs.js b/lib/services/machinelearning/lib/workspaces/operations/workspaces.js similarity index 67% rename from lib/services/networkManagement2/lib/operations/virtualWANs.js rename to lib/services/machinelearning/lib/workspaces/operations/workspaces.js index f0a7956eab..6174f1ac42 100644 --- a/lib/services/networkManagement2/lib/operations/virtualWANs.js +++ b/lib/services/machinelearning/lib/workspaces/operations/workspaces.js @@ -15,11 +15,12 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * Retrieves the details of a VirtualWAN. + * Gets the properties of the specified machine learning workspace. * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {string} virtualWANName The name of the VirtualWAN being retrieved. + * @param {string} workspaceName The name of the machine learning workspace. * * @param {object} [options] Optional Parameters. * @@ -33,13 +34,13 @@ const WebResource = msRest.WebResource; * {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 VirtualWAN} for more information. + * See {@link Workspace} 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 _get(resourceGroupName, virtualWANName, options, callback) { +function _get(resourceGroupName, workspaceName, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -49,18 +50,20 @@ function _get(resourceGroupName, virtualWANName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; // Validate try { - 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 (virtualWANName === null || virtualWANName === undefined || typeof virtualWANName.valueOf() !== 'string') { - throw new Error('virtualWANName cannot be null or undefined and it must be of type string.'); + 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 (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 (workspaceName === null || workspaceName === undefined || typeof workspaceName.valueOf() !== 'string') { + throw new Error('workspaceName cannot be null or undefined and it must be of type string.'); + } 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.'); } @@ -70,12 +73,12 @@ function _get(resourceGroupName, virtualWANName, options, callback) { // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}'; - requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{VirtualWANName}', encodeURIComponent(virtualWANName)); + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}'; requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{workspaceName}', encodeURIComponent(workspaceName)); let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(apiVersion)); + queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); if (queryParameters.length > 0) { requestUrl += '?' + queryParameters.join('&'); } @@ -123,7 +126,7 @@ function _get(resourceGroupName, virtualWANName, options, callback) { error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['ErrorModel']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -143,7 +146,7 @@ function _get(resourceGroupName, virtualWANName, options, callback) { parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['VirtualWAN']().mapper(); + let resultMapper = new client.models['Workspace']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -158,47 +161,30 @@ function _get(resourceGroupName, virtualWANName, options, callback) { }); } - /** - * Creates a VirtualWAN resource if it doesn't exist else updates the existing - * VirtualWAN. + * Creates or updates a workspace with the specified parameters. * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {string} virtualWANName The name of the VirtualWAN being created or - * updated. + * @param {string} workspaceName The name of the machine learning workspace. * - * @param {object} wANParameters Parameters supplied to create or update - * VirtualWAN. + * @param {object} parameters The parameters for creating or updating a machine + * learning workspace. * - * @param {boolean} [wANParameters.disableVpnEncryption] Vpn encryption to be - * disabled or not. + * @param {string} parameters.userStorageAccountId The fully qualified arm id + * of the storage account associated with this workspace. * - * @param {string} [wANParameters.securityProviderName] The Security Provider - * name. + * @param {string} [parameters.ownerEmail] The email id of the owner for this + * workspace. * - * @param {boolean} [wANParameters.allowBranchToBranchTraffic] True if branch - * to branch traffic is allowed. + * @param {string} [parameters.keyVaultIdentifierId] The key vault identifier + * used for encrypted workspaces. * - * @param {boolean} [wANParameters.allowVnetToVnetTraffic] True if Vnet to Vnet - * traffic is allowed. + * @param {string} parameters.location The location of the resource. This + * cannot be changed after the resource is created. * - * @param {string} [wANParameters.office365LocalBreakoutCategory] The office - * local breakout category. Possible values include: 'Optimize', - * 'OptimizeAndAllow', 'All', 'None' - * - * @param {array} [wANParameters.p2SVpnServerConfigurations] list of all - * P2SVpnServerConfigurations associated with the virtual wan. - * - * @param {string} [wANParameters.provisioningState] The provisioning state of - * the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', - * 'Failed' - * - * @param {string} [wANParameters.id] Resource ID. - * - * @param {string} [wANParameters.location] Resource location. - * - * @param {object} [wANParameters.tags] Resource tags. + * @param {object} [parameters.tags] The tags of the resource. * * @param {object} [options] Optional Parameters. * @@ -212,50 +198,136 @@ function _get(resourceGroupName, virtualWANName, options, callback) { * {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 VirtualWAN} for more information. + * See {@link Workspace} 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 _createOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, callback) { +function _createOrUpdate(resourceGroupName, workspaceName, parameters, 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.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 (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 (workspaceName === null || workspaceName === undefined || typeof workspaceName.valueOf() !== 'string') { + throw new Error('workspaceName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters 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); + } - // Send request - this.beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, (err, parsedResult, httpRequest, response) => { - if (err) return callback(err); - - let initialResult = new msRest.HttpOperationResponse(); - initialResult.request = httpRequest; - initialResult.response = response; - initialResult.body = response.body; - client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { - if (err) return callback(err); - - // Create Result - let result = null; + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{workspaceName}', encodeURIComponent(workspaceName)); + let queryParameters = []; + queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); + if (queryParameters.length > 0) { + requestUrl += '?' + queryParameters.join('&'); + } - httpRequest = pollingResult.request; - response = pollingResult.response; - let responseBody = pollingResult.body; + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'PUT'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['Workspace']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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; - - // Deserialize Response + let parsedErrorResponse; + try { + parsedErrorResponse = JSON.parse(responseBody); + if (parsedErrorResponse) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; + } + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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['VirtualWAN']().mapper(); + let resultMapper = new client.models['Workspace']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -264,23 +336,19 @@ function _createOrUpdate(resourceGroupName, virtualWANName, wANParameters, optio deserializationError.response = msRest.stripResponse(response); return callback(deserializationError); } + } - return callback(null, result, httpRequest, response); - }); + return callback(null, result, httpRequest, response); }); } - /** - * Updates a VirtualWAN tags. + * Deletes a machine learning workspace. * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {string} virtualWANName The name of the VirtualWAN being updated. - * - * @param {object} wANParameters Parameters supplied to Update VirtualWAN tags. - * - * @param {object} [wANParameters.tags] Resource tags. + * @param {string} workspaceName The name of the machine learning workspace. * * @param {object} [options] Optional Parameters. * @@ -293,132 +361,136 @@ function _createOrUpdate(resourceGroupName, virtualWANName, wANParameters, optio * * {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 VirtualWAN} for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {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 _updateTags(resourceGroupName, virtualWANName, wANParameters, options, callback) { +function _deleteMethod(resourceGroupName, workspaceName, 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.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 (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 (workspaceName === null || workspaceName === undefined || typeof workspaceName.valueOf() !== 'string') { + throw new Error('workspaceName cannot be null or undefined and it must be of type string.'); + } + 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); + } - // Send request - this.beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, options, (err, parsedResult, httpRequest, response) => { - if (err) return callback(err); - - let initialResult = new msRest.HttpOperationResponse(); - initialResult.request = httpRequest; - initialResult.response = response; - initialResult.body = response.body; - client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { - if (err) return callback(err); - - // Create Result - let result = null; + // Construct URL + let baseUrl = this.client.baseUri; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{workspaceName}', encodeURIComponent(workspaceName)); + let queryParameters = []; + queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); + if (queryParameters.length > 0) { + requestUrl += '?' + queryParameters.join('&'); + } - httpRequest = pollingResult.request; - response = pollingResult.response; - let responseBody = pollingResult.body; + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'DELETE'; + 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]; + } + } + } + httpRequest.body = null; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 200 && statusCode !== 204) { + let error = new Error(responseBody); + error.statusCode = response.statusCode; + error.request = msRest.stripRequest(httpRequest); + error.response = msRest.stripResponse(response); if (responseBody === '') responseBody = null; - - // Deserialize Response - let parsedResponse = null; + let parsedErrorResponse; try { - parsedResponse = JSON.parse(responseBody); - result = JSON.parse(responseBody); - if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['VirtualWAN']().mapper(); - result = client.deserialize(resultMapper, parsedResponse, 'result'); + parsedErrorResponse = JSON.parse(responseBody); + if (parsedErrorResponse) { + let internalError = null; + if (parsedErrorResponse.error) internalError = parsedErrorResponse.error; + error.code = internalError ? internalError.code : parsedErrorResponse.code; + error.message = internalError ? internalError.message : parsedErrorResponse.message; } - } 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); + if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { + let resultMapper = new client.models['ErrorResponse']().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; - return callback(null, result, httpRequest, response); - }); + return callback(null, result, httpRequest, response); }); } - /** - * Deletes a VirtualWAN. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being deleted. + * Updates a machine learning workspace with the specified parameters. * - * @param {object} [options] Optional Parameters. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {string} workspaceName The name of the machine learning workspace. * - * @param {function} callback - The callback. + * @param {object} parameters The parameters for updating a machine learning + * workspace. * - * @returns {function} callback(err, result, request, response) + * @param {object} [parameters.tags] The resource tags for the machine learning + * workspace. * - * {Error} err - The Error object if an error occurred, null otherwise. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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 _deleteMethod(resourceGroupName, virtualWANName, 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.'); - } - - // Send request - this.beginDeleteMethod(resourceGroupName, virtualWANName, options, (err, parsedResult, httpRequest, response) => { - if (err) return callback(err); - - let initialResult = new msRest.HttpOperationResponse(); - initialResult.request = httpRequest; - initialResult.response = response; - initialResult.body = response.body; - client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { - if (err) return callback(err); - - // Create Result - let result = null; - - httpRequest = pollingResult.request; - response = pollingResult.response; - let responseBody = pollingResult.body; - if (responseBody === '') responseBody = null; - - // Deserialize Response - - return callback(null, result, httpRequest, response); - }); - }); -} - -/** - * Lists all the VirtualWANs in a resource group. + * @param {string} [parameters.workspaceState] The current state of workspace + * resource. Possible values include: 'Deleted', 'Enabled', 'Disabled', + * 'Migrated', 'Updated', 'Registered', 'Unregistered' * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * @param {string} [parameters.keyVaultIdentifierId] The key vault identifier + * used for encrypted workspaces. * * @param {object} [options] Optional Parameters. * @@ -432,13 +504,13 @@ function _deleteMethod(resourceGroupName, virtualWANName, options, callback) { * {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 ListVirtualWANsResult} for more information. + * See {@link Workspace} 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 _listByResourceGroup(resourceGroupName, options, callback) { +function _update(resourceGroupName, workspaceName, parameters, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -448,15 +520,23 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; // Validate try { + 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 (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 (workspaceName === null || workspaceName === undefined || typeof workspaceName.valueOf() !== 'string') { + throw new Error('workspaceName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters 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.'); } @@ -466,18 +546,19 @@ function _listByResourceGroup(resourceGroupName, options, callback) { // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans'; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}'; requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{workspaceName}', encodeURIComponent(workspaceName)); let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(apiVersion)); + 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 = 'GET'; + httpRequest.method = 'PATCH'; httpRequest.url = requestUrl; httpRequest.headers = {}; // Set Headers @@ -495,7 +576,21 @@ function _listByResourceGroup(resourceGroupName, options, callback) { } } } - httpRequest.body = null; + // Serialize Request + let requestContent = null; + let requestModel = null; + try { + if (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['WorkspaceUpdateParameters']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, null, 2)}.`); + return callback(serializationError); + } + httpRequest.body = requestContent; // Send Request return client.pipeline(httpRequest, (err, response, responseBody) => { if (err) { @@ -518,7 +613,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['ErrorModel']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -538,7 +633,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['ListVirtualWANsResult']().mapper(); + let resultMapper = new client.models['Workspace']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -554,7 +649,12 @@ function _listByResourceGroup(resourceGroupName, options, callback) { } /** - * Lists all the VirtualWANs in a subscription. + * Resync storage keys associated with this workspace. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * * @param {object} [options] Optional Parameters. * @@ -567,14 +667,13 @@ function _listByResourceGroup(resourceGroupName, options, callback) { * * {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 ListVirtualWANsResult} for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {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 _list(options, callback) { +function _resyncStorageKeys(workspaceName, resourceGroupName, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -584,12 +683,20 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; // Validate try { + 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 (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 (workspaceName === null || workspaceName === undefined || typeof workspaceName.valueOf() !== 'string') { + throw new Error('workspaceName 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 (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.'); } @@ -599,17 +706,19 @@ function _list(options, callback) { // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans'; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}/resyncStorageKeys'; requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{workspaceName}', encodeURIComponent(workspaceName)); + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(apiVersion)); + 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 = 'GET'; + httpRequest.method = 'POST'; httpRequest.url = requestUrl; httpRequest.headers = {}; // Set Headers @@ -650,7 +759,7 @@ function _list(options, callback) { error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['ErrorModel']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -659,72 +768,22 @@ function _list(options, callback) { 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['ListVirtualWANsResult']().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); - }); -} - -/** - * Creates a VirtualWAN resource if it doesn't exist else updates the existing - * VirtualWAN. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being created or - * updated. - * - * @param {object} wANParameters Parameters supplied to create or update - * VirtualWAN. - * - * @param {boolean} [wANParameters.disableVpnEncryption] Vpn encryption to be - * disabled or not. - * - * @param {string} [wANParameters.securityProviderName] The Security Provider - * name. - * - * @param {boolean} [wANParameters.allowBranchToBranchTraffic] True if branch - * to branch traffic is allowed. - * - * @param {boolean} [wANParameters.allowVnetToVnetTraffic] True if Vnet to Vnet - * traffic is allowed. - * - * @param {string} [wANParameters.office365LocalBreakoutCategory] The office - * local breakout category. Possible values include: 'Optimize', - * 'OptimizeAndAllow', 'All', 'None' - * - * @param {array} [wANParameters.p2SVpnServerConfigurations] list of all - * P2SVpnServerConfigurations associated with the virtual wan. - * - * @param {string} [wANParameters.provisioningState] The provisioning state of - * the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', - * 'Failed' - * - * @param {string} [wANParameters.id] Resource ID. + } + // Create Result + let result = null; + if (responseBody === '') responseBody = null; + + return callback(null, result, httpRequest, response); + }); +} + +/** + * List the authorization keys associated with this workspace. * - * @param {string} [wANParameters.location] Resource location. + * @param {string} workspaceName The name of the machine learning workspace. * - * @param {object} [wANParameters.tags] Resource tags. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * * @param {object} [options] Optional Parameters. * @@ -738,13 +797,13 @@ function _list(options, callback) { * {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 VirtualWAN} for more information. + * See {@link WorkspaceKeysResponse} 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 _beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, callback) { +function _listWorkspaceKeys(workspaceName, resourceGroupName, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -754,21 +813,20 @@ function _beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; // Validate try { + 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 (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 (workspaceName === null || workspaceName === undefined || typeof workspaceName.valueOf() !== 'string') { + throw new Error('workspaceName 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 (virtualWANName === null || virtualWANName === undefined || typeof virtualWANName.valueOf() !== 'string') { - throw new Error('virtualWANName cannot be null or undefined and it must be of type string.'); - } - if (wANParameters === null || wANParameters === undefined) { - throw new Error('wANParameters 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.'); } @@ -778,19 +836,19 @@ function _beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}'; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}/listWorkspaceKeys'; requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + requestUrl = requestUrl.replace('{workspaceName}', encodeURIComponent(workspaceName)); requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{VirtualWANName}', encodeURIComponent(virtualWANName)); let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(apiVersion)); + 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 = 'PUT'; + httpRequest.method = 'POST'; httpRequest.url = requestUrl; httpRequest.headers = {}; // Set Headers @@ -808,28 +866,14 @@ function _beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, } } } - // Serialize Request - let requestContent = null; - let requestModel = null; - try { - if (wANParameters !== null && wANParameters !== undefined) { - let requestModelMapper = new client.models['VirtualWAN']().mapper(); - requestModel = client.serialize(requestModelMapper, wANParameters, 'wANParameters'); - requestContent = JSON.stringify(requestModel); - } - } catch (error) { - let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + - `payload - ${JSON.stringify(wANParameters, null, 2)}.`); - return callback(serializationError); - } - httpRequest.body = requestContent; + httpRequest.body = null; // Send Request return client.pipeline(httpRequest, (err, response, responseBody) => { if (err) { return callback(err); } let statusCode = response.statusCode; - if (statusCode !== 200 && statusCode !== 201) { + if (statusCode !== 200) { let error = new Error(responseBody); error.statusCode = response.statusCode; error.request = msRest.stripRequest(httpRequest); @@ -845,7 +889,7 @@ function _beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['ErrorModel']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -865,7 +909,7 @@ function _beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['VirtualWAN']().mapper(); + let resultMapper = new client.models['WorkspaceKeysResponse']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -875,38 +919,17 @@ function _beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, return callback(deserializationError); } } - // Deserialize Response - if (statusCode === 201) { - let parsedResponse = null; - try { - parsedResponse = JSON.parse(responseBody); - result = JSON.parse(responseBody); - if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['VirtualWAN']().mapper(); - result = client.deserialize(resultMapper, parsedResponse, 'result'); - } - } catch (error) { - let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); - deserializationError1.request = msRest.stripRequest(httpRequest); - deserializationError1.response = msRest.stripResponse(response); - return callback(deserializationError1); - } - } return callback(null, result, httpRequest, response); }); } /** - * Updates a VirtualWAN tags. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * Lists all the available machine learning workspaces under the specified + * resource group. * - * @param {string} virtualWANName The name of the VirtualWAN being updated. - * - * @param {object} wANParameters Parameters supplied to Update VirtualWAN tags. - * - * @param {object} [wANParameters.tags] Resource tags. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * * @param {object} [options] Optional Parameters. * @@ -920,13 +943,13 @@ function _beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, * {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 VirtualWAN} for more information. + * See {@link WorkspaceListResult} 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 _beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, options, callback) { +function _listByResourceGroup(resourceGroupName, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -936,21 +959,17 @@ function _beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, opti if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; // Validate try { + 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 (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 (virtualWANName === null || virtualWANName === undefined || typeof virtualWANName.valueOf() !== 'string') { - throw new Error('virtualWANName cannot be null or undefined and it must be of type string.'); - } - if (wANParameters === null || wANParameters === undefined) { - throw new Error('wANParameters 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.'); } @@ -960,19 +979,18 @@ function _beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, opti // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}'; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces'; requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{VirtualWANName}', encodeURIComponent(virtualWANName)); let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(apiVersion)); + 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 = 'PATCH'; + httpRequest.method = 'GET'; httpRequest.url = requestUrl; httpRequest.headers = {}; // Set Headers @@ -990,28 +1008,14 @@ function _beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, opti } } } - // Serialize Request - let requestContent = null; - let requestModel = null; - try { - if (wANParameters !== null && wANParameters !== undefined) { - let requestModelMapper = new client.models['TagsObject']().mapper(); - requestModel = client.serialize(requestModelMapper, wANParameters, 'wANParameters'); - requestContent = JSON.stringify(requestModel); - } - } catch (error) { - let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + - `payload - ${JSON.stringify(wANParameters, null, 2)}.`); - return callback(serializationError); - } - httpRequest.body = requestContent; + httpRequest.body = null; // Send Request return client.pipeline(httpRequest, (err, response, responseBody) => { if (err) { return callback(err); } let statusCode = response.statusCode; - if (statusCode !== 200 && statusCode !== 201) { + if (statusCode !== 200) { let error = new Error(responseBody); error.statusCode = response.statusCode; error.request = msRest.stripRequest(httpRequest); @@ -1027,7 +1031,7 @@ function _beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, opti error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['ErrorModel']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -1047,7 +1051,7 @@ function _beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, opti parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['VirtualWAN']().mapper(); + let resultMapper = new client.models['WorkspaceListResult']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -1057,34 +1061,14 @@ function _beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, opti return callback(deserializationError); } } - // Deserialize Response - if (statusCode === 201) { - let parsedResponse = null; - try { - parsedResponse = JSON.parse(responseBody); - result = JSON.parse(responseBody); - if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['VirtualWAN']().mapper(); - result = client.deserialize(resultMapper, parsedResponse, 'result'); - } - } catch (error) { - let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); - deserializationError1.request = msRest.stripRequest(httpRequest); - deserializationError1.response = msRest.stripResponse(response); - return callback(deserializationError1); - } - } return callback(null, result, httpRequest, response); }); } /** - * Deletes a VirtualWAN. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being deleted. + * Lists all the available machine learning workspaces under the specified + * subscription. * * @param {object} [options] Optional Parameters. * @@ -1097,13 +1081,14 @@ function _beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, opti * * {Error} err - The Error object if an error occurred, null otherwise. * - * {null} [result] - The deserialized result object if an error did not occur. + * {object} [result] - The deserialized result object if an error did not occur. + * See {@link WorkspaceListResult} 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 _beginDeleteMethod(resourceGroupName, virtualWANName, options, callback) { +function _list(options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -1113,18 +1098,14 @@ function _beginDeleteMethod(resourceGroupName, virtualWANName, options, callback if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; // Validate try { + 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 (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 (virtualWANName === null || virtualWANName === undefined || typeof virtualWANName.valueOf() !== 'string') { - throw new Error('virtualWANName cannot be null or undefined and it must be of type string.'); - } 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.'); } @@ -1134,19 +1115,17 @@ function _beginDeleteMethod(resourceGroupName, virtualWANName, options, callback // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}'; + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/workspaces'; requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); - requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{VirtualWANName}', encodeURIComponent(virtualWANName)); let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(apiVersion)); + 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 = 'DELETE'; + httpRequest.method = 'GET'; httpRequest.url = requestUrl; httpRequest.headers = {}; // Set Headers @@ -1171,7 +1150,7 @@ function _beginDeleteMethod(resourceGroupName, virtualWANName, options, callback return callback(err); } let statusCode = response.statusCode; - if (statusCode !== 200 && statusCode !== 202 && statusCode !== 204) { + if (statusCode !== 200) { let error = new Error(responseBody); error.statusCode = response.statusCode; error.request = msRest.stripRequest(httpRequest); @@ -1187,7 +1166,7 @@ function _beginDeleteMethod(resourceGroupName, virtualWANName, options, callback error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['ErrorModel']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -1200,13 +1179,31 @@ function _beginDeleteMethod(resourceGroupName, virtualWANName, options, callback // 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['WorkspaceListResult']().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 all the VirtualWANs in a resource group. + * Lists all the available machine learning workspaces under the specified + * resource group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1223,7 +1220,7 @@ function _beginDeleteMethod(resourceGroupName, virtualWANName, options, callback * {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 ListVirtualWANsResult} for more information. + * See {@link WorkspaceListResult} for more information. * * {object} [request] - The HTTP Request object if an error did not occur. * @@ -1298,7 +1295,7 @@ function _listByResourceGroupNext(nextPageLink, options, callback) { error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['ErrorModel']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -1318,7 +1315,7 @@ function _listByResourceGroupNext(nextPageLink, options, callback) { parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['ListVirtualWANsResult']().mapper(); + let resultMapper = new client.models['WorkspaceListResult']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -1334,7 +1331,8 @@ function _listByResourceGroupNext(nextPageLink, options, callback) { } /** - * Lists all the VirtualWANs in a subscription. + * Lists all the available machine learning workspaces under the specified + * subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1351,7 +1349,7 @@ function _listByResourceGroupNext(nextPageLink, options, callback) { * {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 ListVirtualWANsResult} for more information. + * See {@link WorkspaceListResult} for more information. * * {object} [request] - The HTTP Request object if an error did not occur. * @@ -1426,7 +1424,7 @@ function _listNext(nextPageLink, options, callback) { error.message = internalError ? internalError.message : parsedErrorResponse.message; } if (parsedErrorResponse !== null && parsedErrorResponse !== undefined) { - let resultMapper = new client.models['ErrorModel']().mapper(); + let resultMapper = new client.models['ErrorResponse']().mapper(); error.body = client.deserialize(resultMapper, parsedErrorResponse, 'error.body'); } } catch (defaultError) { @@ -1446,7 +1444,7 @@ function _listNext(nextPageLink, options, callback) { parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['ListVirtualWANsResult']().mapper(); + let resultMapper = new client.models['WorkspaceListResult']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -1461,33 +1459,33 @@ function _listNext(nextPageLink, options, callback) { }); } -/** Class representing a VirtualWans. */ -class VirtualWans { +/** Class representing a Workspaces. */ +class Workspaces { /** - * Create a VirtualWans. - * @param {NetworkManagementClient} client Reference to the service client. + * Create a Workspaces. + * @param {MachineLearningWorkspacesManagementClient} client Reference to the service client. */ constructor(client) { this.client = client; this._get = _get; this._createOrUpdate = _createOrUpdate; - this._updateTags = _updateTags; this._deleteMethod = _deleteMethod; + this._update = _update; + this._resyncStorageKeys = _resyncStorageKeys; + this._listWorkspaceKeys = _listWorkspaceKeys; this._listByResourceGroup = _listByResourceGroup; this._list = _list; - this._beginCreateOrUpdate = _beginCreateOrUpdate; - this._beginUpdateTags = _beginUpdateTags; - this._beginDeleteMethod = _beginDeleteMethod; this._listByResourceGroupNext = _listByResourceGroupNext; this._listNext = _listNext; } /** - * Retrieves the details of a VirtualWAN. + * Gets the properties of the specified machine learning workspace. * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {string} virtualWANName The name of the VirtualWAN being retrieved. + * @param {string} workspaceName The name of the machine learning workspace. * * @param {object} [options] Optional Parameters. * @@ -1496,15 +1494,15 @@ class VirtualWans { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - getWithHttpOperationResponse(resourceGroupName, virtualWANName, options) { + getWithHttpOperationResponse(resourceGroupName, workspaceName, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._get(resourceGroupName, virtualWANName, options, (err, result, request, response) => { + self._get(resourceGroupName, workspaceName, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1515,11 +1513,12 @@ class VirtualWans { } /** - * Retrieves the details of a VirtualWAN. + * Gets the properties of the specified machine learning workspace. * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {string} virtualWANName The name of the VirtualWAN being retrieved. + * @param {string} workspaceName The name of the machine learning workspace. * * @param {object} [options] Optional Parameters. * @@ -1533,7 +1532,7 @@ class VirtualWans { * * {Promise} A promise is returned * - * @resolve {VirtualWAN} - The deserialized result object. + * @resolve {Workspace} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1542,13 +1541,13 @@ class VirtualWans { * {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 VirtualWAN} for more information. + * See {@link Workspace} 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. */ - get(resourceGroupName, virtualWANName, options, optionalCallback) { + get(resourceGroupName, workspaceName, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1557,57 +1556,41 @@ class VirtualWans { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._get(resourceGroupName, virtualWANName, options, (err, result, request, response) => { + self._get(resourceGroupName, workspaceName, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._get(resourceGroupName, virtualWANName, options, optionalCallback); + return self._get(resourceGroupName, workspaceName, options, optionalCallback); } } /** - * Creates a VirtualWAN resource if it doesn't exist else updates the existing - * VirtualWAN. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being created or - * updated. + * Creates or updates a workspace with the specified parameters. * - * @param {object} wANParameters Parameters supplied to create or update - * VirtualWAN. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {boolean} [wANParameters.disableVpnEncryption] Vpn encryption to be - * disabled or not. + * @param {string} workspaceName The name of the machine learning workspace. * - * @param {string} [wANParameters.securityProviderName] The Security Provider - * name. + * @param {object} parameters The parameters for creating or updating a machine + * learning workspace. * - * @param {boolean} [wANParameters.allowBranchToBranchTraffic] True if branch - * to branch traffic is allowed. + * @param {string} parameters.userStorageAccountId The fully qualified arm id + * of the storage account associated with this workspace. * - * @param {boolean} [wANParameters.allowVnetToVnetTraffic] True if Vnet to Vnet - * traffic is allowed. + * @param {string} [parameters.ownerEmail] The email id of the owner for this + * workspace. * - * @param {string} [wANParameters.office365LocalBreakoutCategory] The office - * local breakout category. Possible values include: 'Optimize', - * 'OptimizeAndAllow', 'All', 'None' + * @param {string} [parameters.keyVaultIdentifierId] The key vault identifier + * used for encrypted workspaces. * - * @param {array} [wANParameters.p2SVpnServerConfigurations] list of all - * P2SVpnServerConfigurations associated with the virtual wan. + * @param {string} parameters.location The location of the resource. This + * cannot be changed after the resource is created. * - * @param {string} [wANParameters.provisioningState] The provisioning state of - * the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', - * 'Failed' - * - * @param {string} [wANParameters.id] Resource ID. - * - * @param {string} [wANParameters.location] Resource location. - * - * @param {object} [wANParameters.tags] Resource tags. + * @param {object} [parameters.tags] The tags of the resource. * * @param {object} [options] Optional Parameters. * @@ -1616,15 +1599,15 @@ class VirtualWans { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - createOrUpdateWithHttpOperationResponse(resourceGroupName, virtualWANName, wANParameters, options) { + createOrUpdateWithHttpOperationResponse(resourceGroupName, workspaceName, parameters, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._createOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, (err, result, request, response) => { + self._createOrUpdate(resourceGroupName, workspaceName, parameters, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1635,45 +1618,29 @@ class VirtualWans { } /** - * Creates a VirtualWAN resource if it doesn't exist else updates the existing - * VirtualWAN. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being created or - * updated. - * - * @param {object} wANParameters Parameters supplied to create or update - * VirtualWAN. - * - * @param {boolean} [wANParameters.disableVpnEncryption] Vpn encryption to be - * disabled or not. - * - * @param {string} [wANParameters.securityProviderName] The Security Provider - * name. + * Creates or updates a workspace with the specified parameters. * - * @param {boolean} [wANParameters.allowBranchToBranchTraffic] True if branch - * to branch traffic is allowed. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {boolean} [wANParameters.allowVnetToVnetTraffic] True if Vnet to Vnet - * traffic is allowed. + * @param {string} workspaceName The name of the machine learning workspace. * - * @param {string} [wANParameters.office365LocalBreakoutCategory] The office - * local breakout category. Possible values include: 'Optimize', - * 'OptimizeAndAllow', 'All', 'None' + * @param {object} parameters The parameters for creating or updating a machine + * learning workspace. * - * @param {array} [wANParameters.p2SVpnServerConfigurations] list of all - * P2SVpnServerConfigurations associated with the virtual wan. + * @param {string} parameters.userStorageAccountId The fully qualified arm id + * of the storage account associated with this workspace. * - * @param {string} [wANParameters.provisioningState] The provisioning state of - * the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', - * 'Failed' + * @param {string} [parameters.ownerEmail] The email id of the owner for this + * workspace. * - * @param {string} [wANParameters.id] Resource ID. + * @param {string} [parameters.keyVaultIdentifierId] The key vault identifier + * used for encrypted workspaces. * - * @param {string} [wANParameters.location] Resource location. + * @param {string} parameters.location The location of the resource. This + * cannot be changed after the resource is created. * - * @param {object} [wANParameters.tags] Resource tags. + * @param {object} [parameters.tags] The tags of the resource. * * @param {object} [options] Optional Parameters. * @@ -1687,7 +1654,7 @@ class VirtualWans { * * {Promise} A promise is returned * - * @resolve {VirtualWAN} - The deserialized result object. + * @resolve {Workspace} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1696,13 +1663,13 @@ class VirtualWans { * {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 VirtualWAN} for more information. + * See {@link Workspace} 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. */ - createOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, optionalCallback) { + createOrUpdate(resourceGroupName, workspaceName, parameters, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1711,27 +1678,24 @@ class VirtualWans { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._createOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, (err, result, request, response) => { + self._createOrUpdate(resourceGroupName, workspaceName, parameters, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._createOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, optionalCallback); + return self._createOrUpdate(resourceGroupName, workspaceName, parameters, options, optionalCallback); } } /** - * Updates a VirtualWAN tags. + * Deletes a machine learning workspace. * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {string} virtualWANName The name of the VirtualWAN being updated. - * - * @param {object} wANParameters Parameters supplied to Update VirtualWAN tags. - * - * @param {object} [wANParameters.tags] Resource tags. + * @param {string} workspaceName The name of the machine learning workspace. * * @param {object} [options] Optional Parameters. * @@ -1740,15 +1704,15 @@ class VirtualWans { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - updateTagsWithHttpOperationResponse(resourceGroupName, virtualWANName, wANParameters, options) { + deleteMethodWithHttpOperationResponse(resourceGroupName, workspaceName, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._updateTags(resourceGroupName, virtualWANName, wANParameters, options, (err, result, request, response) => { + self._deleteMethod(resourceGroupName, workspaceName, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1759,15 +1723,12 @@ class VirtualWans { } /** - * Updates a VirtualWAN tags. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * Deletes a machine learning workspace. * - * @param {string} virtualWANName The name of the VirtualWAN being updated. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {object} wANParameters Parameters supplied to Update VirtualWAN tags. - * - * @param {object} [wANParameters.tags] Resource tags. + * @param {string} workspaceName The name of the machine learning workspace. * * @param {object} [options] Optional Parameters. * @@ -1781,7 +1742,7 @@ class VirtualWans { * * {Promise} A promise is returned * - * @resolve {VirtualWAN} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1789,14 +1750,13 @@ class VirtualWans { * * {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 VirtualWAN} for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {object} [request] - The HTTP Request object if an error did not occur. * * {stream} [response] - The HTTP Response stream if an error did not occur. */ - updateTags(resourceGroupName, virtualWANName, wANParameters, options, optionalCallback) { + deleteMethod(resourceGroupName, workspaceName, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1805,23 +1765,37 @@ class VirtualWans { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._updateTags(resourceGroupName, virtualWANName, wANParameters, options, (err, result, request, response) => { + self._deleteMethod(resourceGroupName, workspaceName, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._updateTags(resourceGroupName, virtualWANName, wANParameters, options, optionalCallback); + return self._deleteMethod(resourceGroupName, workspaceName, options, optionalCallback); } } /** - * Deletes a VirtualWAN. + * Updates a machine learning workspace with the specified parameters. * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {string} virtualWANName The name of the VirtualWAN being deleted. + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {object} parameters The parameters for updating a machine learning + * workspace. + * + * @param {object} [parameters.tags] The resource tags for the machine learning + * workspace. + * + * @param {string} [parameters.workspaceState] The current state of workspace + * resource. Possible values include: 'Deleted', 'Enabled', 'Disabled', + * 'Migrated', 'Updated', 'Registered', 'Unregistered' + * + * @param {string} [parameters.keyVaultIdentifierId] The key vault identifier + * used for encrypted workspaces. * * @param {object} [options] Optional Parameters. * @@ -1830,15 +1804,15 @@ class VirtualWans { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - deleteMethodWithHttpOperationResponse(resourceGroupName, virtualWANName, options) { + updateWithHttpOperationResponse(resourceGroupName, workspaceName, parameters, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._deleteMethod(resourceGroupName, virtualWANName, options, (err, result, request, response) => { + self._update(resourceGroupName, workspaceName, parameters, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1849,92 +1823,25 @@ class VirtualWans { } /** - * Deletes a VirtualWAN. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being deleted. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {object} [request] - The HTTP Request object if an error did not occur. - * - * {stream} [response] - The HTTP Response stream if an error did not occur. - */ - deleteMethod(resourceGroupName, virtualWANName, 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._deleteMethod(resourceGroupName, virtualWANName, options, (err, result, request, response) => { - if (err) { reject(err); } - else { resolve(result); } - return; - }); - }); - } else { - return self._deleteMethod(resourceGroupName, virtualWANName, options, optionalCallback); - } - } - - /** - * Lists all the VirtualWANs in a resource group. + * Updates a machine learning workspace with the specified parameters. * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * - * @param {object} [options] Optional Parameters. - * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {string} workspaceName The name of the machine learning workspace. * - * @returns {Promise} A promise is returned + * @param {object} parameters The parameters for updating a machine learning + * workspace. * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @param {object} [parameters.tags] The resource tags for the machine learning + * workspace. * - * @reject {Error} - The error object. - */ - listByResourceGroupWithHttpOperationResponse(resourceGroupName, options) { - let client = this.client; - let self = this; - return new Promise((resolve, reject) => { - self._listByResourceGroup(resourceGroupName, options, (err, result, request, response) => { - let httpOperationResponse = new msRest.HttpOperationResponse(request, response); - httpOperationResponse.body = result; - if (err) { reject(err); } - else { resolve(httpOperationResponse); } - return; - }); - }); - } - - /** - * Lists all the VirtualWANs in a resource group. + * @param {string} [parameters.workspaceState] The current state of workspace + * resource. Possible values include: 'Deleted', 'Enabled', 'Disabled', + * 'Migrated', 'Updated', 'Registered', 'Unregistered' * - * @param {string} resourceGroupName The resource group name of the VirtualWan. + * @param {string} [parameters.keyVaultIdentifierId] The key vault identifier + * used for encrypted workspaces. * * @param {object} [options] Optional Parameters. * @@ -1948,7 +1855,7 @@ class VirtualWans { * * {Promise} A promise is returned * - * @resolve {ListVirtualWANsResult} - The deserialized result object. + * @resolve {Workspace} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1957,13 +1864,13 @@ class VirtualWans { * {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 ListVirtualWANsResult} for more information. + * See {@link Workspace} 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. */ - listByResourceGroup(resourceGroupName, options, optionalCallback) { + update(resourceGroupName, workspaceName, parameters, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1972,19 +1879,24 @@ class VirtualWans { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._listByResourceGroup(resourceGroupName, options, (err, result, request, response) => { + self._update(resourceGroupName, workspaceName, parameters, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._listByResourceGroup(resourceGroupName, options, optionalCallback); + return self._update(resourceGroupName, workspaceName, parameters, options, optionalCallback); } } /** - * Lists all the VirtualWANs in a subscription. + * Resync storage keys associated with this workspace. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * * @param {object} [options] Optional Parameters. * @@ -1993,15 +1905,15 @@ class VirtualWans { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - listWithHttpOperationResponse(options) { + resyncStorageKeysWithHttpOperationResponse(workspaceName, resourceGroupName, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._list(options, (err, result, request, response) => { + self._resyncStorageKeys(workspaceName, resourceGroupName, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -2012,7 +1924,12 @@ class VirtualWans { } /** - * Lists all the VirtualWANs in a subscription. + * Resync storage keys associated with this workspace. + * + * @param {string} workspaceName The name of the machine learning workspace. + * + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * * @param {object} [options] Optional Parameters. * @@ -2026,7 +1943,7 @@ class VirtualWans { * * {Promise} A promise is returned * - * @resolve {ListVirtualWANsResult} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error} - The error object. * @@ -2034,14 +1951,13 @@ class VirtualWans { * * {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 ListVirtualWANsResult} for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {object} [request] - The HTTP Request object if an error did not occur. * * {stream} [response] - The HTTP Response stream if an error did not occur. */ - list(options, optionalCallback) { + resyncStorageKeys(workspaceName, resourceGroupName, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -2050,57 +1966,24 @@ class VirtualWans { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._list(options, (err, result, request, response) => { + self._resyncStorageKeys(workspaceName, resourceGroupName, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._list(options, optionalCallback); + return self._resyncStorageKeys(workspaceName, resourceGroupName, options, optionalCallback); } } /** - * Creates a VirtualWAN resource if it doesn't exist else updates the existing - * VirtualWAN. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being created or - * updated. - * - * @param {object} wANParameters Parameters supplied to create or update - * VirtualWAN. - * - * @param {boolean} [wANParameters.disableVpnEncryption] Vpn encryption to be - * disabled or not. - * - * @param {string} [wANParameters.securityProviderName] The Security Provider - * name. - * - * @param {boolean} [wANParameters.allowBranchToBranchTraffic] True if branch - * to branch traffic is allowed. + * List the authorization keys associated with this workspace. * - * @param {boolean} [wANParameters.allowVnetToVnetTraffic] True if Vnet to Vnet - * traffic is allowed. + * @param {string} workspaceName The name of the machine learning workspace. * - * @param {string} [wANParameters.office365LocalBreakoutCategory] The office - * local breakout category. Possible values include: 'Optimize', - * 'OptimizeAndAllow', 'All', 'None' - * - * @param {array} [wANParameters.p2SVpnServerConfigurations] list of all - * P2SVpnServerConfigurations associated with the virtual wan. - * - * @param {string} [wANParameters.provisioningState] The provisioning state of - * the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', - * 'Failed' - * - * @param {string} [wANParameters.id] Resource ID. - * - * @param {string} [wANParameters.location] Resource location. - * - * @param {object} [wANParameters.tags] Resource tags. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * * @param {object} [options] Optional Parameters. * @@ -2109,15 +1992,15 @@ class VirtualWans { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName, virtualWANName, wANParameters, options) { + listWorkspaceKeysWithHttpOperationResponse(workspaceName, resourceGroupName, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, (err, result, request, response) => { + self._listWorkspaceKeys(workspaceName, resourceGroupName, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -2128,45 +2011,12 @@ class VirtualWans { } /** - * Creates a VirtualWAN resource if it doesn't exist else updates the existing - * VirtualWAN. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being created or - * updated. - * - * @param {object} wANParameters Parameters supplied to create or update - * VirtualWAN. + * List the authorization keys associated with this workspace. * - * @param {boolean} [wANParameters.disableVpnEncryption] Vpn encryption to be - * disabled or not. + * @param {string} workspaceName The name of the machine learning workspace. * - * @param {string} [wANParameters.securityProviderName] The Security Provider - * name. - * - * @param {boolean} [wANParameters.allowBranchToBranchTraffic] True if branch - * to branch traffic is allowed. - * - * @param {boolean} [wANParameters.allowVnetToVnetTraffic] True if Vnet to Vnet - * traffic is allowed. - * - * @param {string} [wANParameters.office365LocalBreakoutCategory] The office - * local breakout category. Possible values include: 'Optimize', - * 'OptimizeAndAllow', 'All', 'None' - * - * @param {array} [wANParameters.p2SVpnServerConfigurations] list of all - * P2SVpnServerConfigurations associated with the virtual wan. - * - * @param {string} [wANParameters.provisioningState] The provisioning state of - * the resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', - * 'Failed' - * - * @param {string} [wANParameters.id] Resource ID. - * - * @param {string} [wANParameters.location] Resource location. - * - * @param {object} [wANParameters.tags] Resource tags. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * * @param {object} [options] Optional Parameters. * @@ -2180,7 +2030,7 @@ class VirtualWans { * * {Promise} A promise is returned * - * @resolve {VirtualWAN} - The deserialized result object. + * @resolve {WorkspaceKeysResponse} - The deserialized result object. * * @reject {Error} - The error object. * @@ -2189,13 +2039,13 @@ class VirtualWans { * {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 VirtualWAN} for more information. + * See {@link WorkspaceKeysResponse} 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. */ - beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, optionalCallback) { + listWorkspaceKeys(workspaceName, resourceGroupName, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -2204,27 +2054,23 @@ class VirtualWans { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, (err, result, request, response) => { + self._listWorkspaceKeys(workspaceName, resourceGroupName, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, options, optionalCallback); + return self._listWorkspaceKeys(workspaceName, resourceGroupName, options, optionalCallback); } } /** - * Updates a VirtualWAN tags. + * Lists all the available machine learning workspaces under the specified + * resource group. * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being updated. - * - * @param {object} wANParameters Parameters supplied to Update VirtualWAN tags. - * - * @param {object} [wANParameters.tags] Resource tags. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * * @param {object} [options] Optional Parameters. * @@ -2233,15 +2079,15 @@ class VirtualWans { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - beginUpdateTagsWithHttpOperationResponse(resourceGroupName, virtualWANName, wANParameters, options) { + listByResourceGroupWithHttpOperationResponse(resourceGroupName, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, options, (err, result, request, response) => { + self._listByResourceGroup(resourceGroupName, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -2252,15 +2098,11 @@ class VirtualWans { } /** - * Updates a VirtualWAN tags. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being updated. - * - * @param {object} wANParameters Parameters supplied to Update VirtualWAN tags. + * Lists all the available machine learning workspaces under the specified + * resource group. * - * @param {object} [wANParameters.tags] Resource tags. + * @param {string} resourceGroupName The name of the resource group to which + * the machine learning workspace belongs. * * @param {object} [options] Optional Parameters. * @@ -2274,7 +2116,7 @@ class VirtualWans { * * {Promise} A promise is returned * - * @resolve {VirtualWAN} - The deserialized result object. + * @resolve {WorkspaceListResult} - The deserialized result object. * * @reject {Error} - The error object. * @@ -2283,13 +2125,13 @@ class VirtualWans { * {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 VirtualWAN} for more information. + * See {@link WorkspaceListResult} 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. */ - beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, options, optionalCallback) { + listByResourceGroup(resourceGroupName, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -2298,23 +2140,20 @@ class VirtualWans { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, options, (err, result, request, response) => { + self._listByResourceGroup(resourceGroupName, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, options, optionalCallback); + return self._listByResourceGroup(resourceGroupName, options, optionalCallback); } } /** - * Deletes a VirtualWAN. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being deleted. + * Lists all the available machine learning workspaces under the specified + * subscription. * * @param {object} [options] Optional Parameters. * @@ -2323,15 +2162,15 @@ class VirtualWans { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - beginDeleteMethodWithHttpOperationResponse(resourceGroupName, virtualWANName, options) { + listWithHttpOperationResponse(options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._beginDeleteMethod(resourceGroupName, virtualWANName, options, (err, result, request, response) => { + self._list(options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -2342,11 +2181,8 @@ class VirtualWans { } /** - * Deletes a VirtualWAN. - * - * @param {string} resourceGroupName The resource group name of the VirtualWan. - * - * @param {string} virtualWANName The name of the VirtualWAN being deleted. + * Lists all the available machine learning workspaces under the specified + * subscription. * * @param {object} [options] Optional Parameters. * @@ -2360,7 +2196,7 @@ class VirtualWans { * * {Promise} A promise is returned * - * @resolve {null} - The deserialized result object. + * @resolve {WorkspaceListResult} - The deserialized result object. * * @reject {Error} - The error object. * @@ -2368,13 +2204,14 @@ class VirtualWans { * * {Error} err - The Error object if an error occurred, null otherwise. * - * {null} [result] - The deserialized result object if an error did not occur. + * {object} [result] - The deserialized result object if an error did not occur. + * See {@link WorkspaceListResult} 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. */ - beginDeleteMethod(resourceGroupName, virtualWANName, options, optionalCallback) { + list(options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -2383,19 +2220,20 @@ class VirtualWans { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._beginDeleteMethod(resourceGroupName, virtualWANName, options, (err, result, request, response) => { + self._list(options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._beginDeleteMethod(resourceGroupName, virtualWANName, options, optionalCallback); + return self._list(options, optionalCallback); } } /** - * Lists all the VirtualWANs in a resource group. + * Lists all the available machine learning workspaces under the specified + * resource group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -2407,7 +2245,7 @@ class VirtualWans { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ @@ -2426,7 +2264,8 @@ class VirtualWans { } /** - * Lists all the VirtualWANs in a resource group. + * Lists all the available machine learning workspaces under the specified + * resource group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -2443,7 +2282,7 @@ class VirtualWans { * * {Promise} A promise is returned * - * @resolve {ListVirtualWANsResult} - The deserialized result object. + * @resolve {WorkspaceListResult} - The deserialized result object. * * @reject {Error} - The error object. * @@ -2452,7 +2291,7 @@ class VirtualWans { * {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 ListVirtualWANsResult} for more information. + * See {@link WorkspaceListResult} for more information. * * {object} [request] - The HTTP Request object if an error did not occur. * @@ -2479,7 +2318,8 @@ class VirtualWans { } /** - * Lists all the VirtualWANs in a subscription. + * Lists all the available machine learning workspaces under the specified + * subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -2491,7 +2331,7 @@ class VirtualWans { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ @@ -2510,7 +2350,8 @@ class VirtualWans { } /** - * Lists all the VirtualWANs in a subscription. + * Lists all the available machine learning workspaces under the specified + * subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -2527,7 +2368,7 @@ class VirtualWans { * * {Promise} A promise is returned * - * @resolve {ListVirtualWANsResult} - The deserialized result object. + * @resolve {WorkspaceListResult} - The deserialized result object. * * @reject {Error} - The error object. * @@ -2536,7 +2377,7 @@ class VirtualWans { * {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 ListVirtualWANsResult} for more information. + * See {@link WorkspaceListResult} for more information. * * {object} [request] - The HTTP Request object if an error did not occur. * @@ -2564,4 +2405,4 @@ class VirtualWans { } -module.exports = VirtualWans; +module.exports = Workspaces; diff --git a/lib/services/machinelearning/package.json b/lib/services/machinelearning/package.json index 2f33fd6a7e..ab121b9286 100644 --- a/lib/services/machinelearning/package.json +++ b/lib/services/machinelearning/package.json @@ -1,16 +1,12 @@ { "name": "azure-arm-machinelearning", "author": "Microsoft Corporation", - "contributors": [ - "Krishnan, Balaji ", - "Zavery, Amar " - ], "version": "1.2.0-preview", "description": "Microsoft Azure MachineLearning Management Client Library for node", - "tags": [ - "azure", - "sdk" - ], + "dependencies": { + "ms-rest": "^2.3.8", + "ms-rest-azure": "^2.5.9" + }, "keywords": [ "node", "azure" @@ -18,19 +14,12 @@ "main": "./lib/machinelearning.js", "types": "./lib/machinelearning.d.ts", "license": "MIT", - "dependencies": { - "ms-rest": "^2.2.2", - "ms-rest-azure": "^2.3.3" - }, - "homepage": "http://github.com/Azure/azure-sdk-for-node", + "homepage": "http://github.com/Azure/azure-sdk-for-node/tree/master/lib/services/machinelearning", "repository": { "type": "git", "url": "git@github.com:Azure/azure-sdk-for-node.git" }, "bugs": { "url": "http://github.com/Azure/azure-sdk-for-node/issues" - }, - "scripts": { - "test": "npm -s run-script jshint" } } \ No newline at end of file diff --git a/lib/services/networkManagement2/README.md b/lib/services/networkManagement2/README.md new file mode 100644 index 0000000000..6a2b77e44d --- /dev/null +++ b/lib/services/networkManagement2/README.md @@ -0,0 +1,59 @@ +# Microsoft Azure SDK for Node.js - Network Management + +This project provides a Node.js package that makes it easy to manage Microsoft Azure Network Resources. +- **Node.js version: 6.x.x or higher** +- **API version: 2017-10-01** + +## Features + +- Manage virtual network +- Manage subnet +- Manage network security group +- Manage network security rule +- Manage load balancer +- Manage network interface +- Manage publicIPAddress +- Manage application gateway +- Manage connections +- Manage express route +- Manage local network gateway +- Manage application security group +- Manage network watcher +- Manage route table +- Manage route +- Manage virtual network gateway + + + +## How to Install + +```bash +npm install azure-arm-network +``` + +## How to use + +### Authentication, client creation and listing vnets in a resource group as an example + + ```javascript + var msRestAzure = require('ms-rest-azure'); + var NetworkManagementClient = require('azure-arm-network'); + + // Interactive Login + // It provides a url and code that needs to be copied and pasted in a browser and authenticated over there. If successful, + // the user will get a DeviceTokenCredentials object. + msRestAzure.interactiveLogin(function(err, credentials) { + var client = new NetworkManagementClient(credentials, 'your-subscription-id'); + client.virtualNetworks.list(resourceGroupName, function(err, result, request, response) { + if (err) console.log(err); + console.log(result); + }); + }); + ``` + + ## Detailed Sample +A detailed sample for managing a load balancer than can be cloned and is ready to used can be found [here](https://github.com/Azure-Samples/network-node-manage-loadbalancer). + + ## Related projects + +- [Microsoft Azure SDK for Node.js - All-up](https://github.com/WindowsAzure/azure-sdk-for-node) \ No newline at end of file diff --git a/lib/services/networkManagement2/lib/models/addressSpace.js b/lib/services/networkManagement2/lib/models/addressSpace.js index d52191738d..7c45514531 100644 --- a/lib/services/networkManagement2/lib/models/addressSpace.js +++ b/lib/services/networkManagement2/lib/models/addressSpace.js @@ -18,7 +18,7 @@ class AddressSpace { /** * Create a AddressSpace. - * @member {array} [addressPrefixes] A list of address blocks reserved for + * @property {array} [addressPrefixes] A list of address blocks reserved for * this virtual network in CIDR notation. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationGateway.js b/lib/services/networkManagement2/lib/models/applicationGateway.js index a375d3c5d6..13f5cef0cd 100644 --- a/lib/services/networkManagement2/lib/models/applicationGateway.js +++ b/lib/services/networkManagement2/lib/models/applicationGateway.js @@ -20,99 +20,121 @@ const models = require('./index'); class ApplicationGateway extends models['Resource'] { /** * Create a ApplicationGateway. - * @member {object} [sku] SKU of the application gateway resource. - * @member {string} [sku.name] Name of an application gateway SKU. Possible + * @property {object} [sku] SKU of the application gateway resource. + * @property {string} [sku.name] Name of an application gateway SKU. Possible * values include: 'Standard_Small', 'Standard_Medium', 'Standard_Large', * 'WAF_Medium', 'WAF_Large', 'Standard_v2', 'WAF_v2' - * @member {string} [sku.tier] Tier of an application gateway. Possible + * @property {string} [sku.tier] Tier of an application gateway. Possible * values include: 'Standard', 'WAF', 'Standard_v2', 'WAF_v2' - * @member {number} [sku.capacity] Capacity (instance count) of an + * @property {number} [sku.capacity] Capacity (instance count) of an * application gateway. - * @member {object} [sslPolicy] SSL policy of the application gateway + * @property {object} [sslPolicy] SSL policy of the application gateway * resource. - * @member {array} [sslPolicy.disabledSslProtocols] Ssl protocols to be + * @property {array} [sslPolicy.disabledSslProtocols] Ssl protocols to be * disabled on application gateway. - * @member {string} [sslPolicy.policyType] Type of Ssl Policy. Possible + * @property {string} [sslPolicy.policyType] Type of Ssl Policy. Possible * values include: 'Predefined', 'Custom' - * @member {string} [sslPolicy.policyName] Name of Ssl predefined policy. + * @property {string} [sslPolicy.policyName] Name of Ssl predefined policy. * Possible values include: 'AppGwSslPolicy20150501', * 'AppGwSslPolicy20170401', 'AppGwSslPolicy20170401S' - * @member {array} [sslPolicy.cipherSuites] Ssl cipher suites to be enabled + * @property {array} [sslPolicy.cipherSuites] Ssl cipher suites to be enabled * in the specified order to application gateway. - * @member {string} [sslPolicy.minProtocolVersion] Minimum version of Ssl + * @property {string} [sslPolicy.minProtocolVersion] Minimum version of Ssl * protocol to be supported on application gateway. Possible values include: * 'TLSv1_0', 'TLSv1_1', 'TLSv1_2' - * @member {string} [operationalState] Operational state of the application + * @property {string} [operationalState] Operational state of the application * gateway resource. Possible values include: 'Stopped', 'Starting', * 'Running', 'Stopping' - * @member {array} [gatewayIPConfigurations] Subnets of application the + * @property {array} [gatewayIPConfigurations] Subnets of application the * gateway resource. - * @member {array} [authenticationCertificates] Authentication certificates + * @property {array} [authenticationCertificates] Authentication certificates * of the application gateway resource. - * @member {array} [trustedRootCertificates] Trusted Root certificates of the - * application gateway resource. - * @member {array} [sslCertificates] SSL certificates of the application + * @property {array} [trustedRootCertificates] Trusted Root certificates of + * the application gateway resource. + * @property {array} [sslCertificates] SSL certificates of the application * gateway resource. - * @member {array} [frontendIPConfigurations] Frontend IP addresses of the + * @property {array} [frontendIPConfigurations] Frontend IP addresses of the * application gateway resource. - * @member {array} [frontendPorts] Frontend ports of the application gateway - * resource. - * @member {array} [probes] Probes of the application gateway resource. - * @member {array} [backendAddressPools] Backend address pool of the + * @property {array} [frontendPorts] Frontend ports of the application + * gateway resource. + * @property {array} [probes] Probes of the application gateway resource. + * @property {array} [backendAddressPools] Backend address pool of the * application gateway resource. - * @member {array} [backendHttpSettingsCollection] Backend http settings of + * @property {array} [backendHttpSettingsCollection] Backend http settings of * the application gateway resource. - * @member {array} [httpListeners] Http listeners of the application gateway - * resource. - * @member {array} [urlPathMaps] URL path map of the application gateway + * @property {array} [httpListeners] Http listeners of the application + * gateway resource. + * @property {array} [urlPathMaps] URL path map of the application gateway * resource. - * @member {array} [requestRoutingRules] Request routing rules of the + * @property {array} [requestRoutingRules] Request routing rules of the * application gateway resource. - * @member {array} [redirectConfigurations] Redirect configurations of the + * @property {array} [rewriteRuleSets] Rewrite rules for the application + * gateway resource. + * @property {array} [redirectConfigurations] Redirect configurations of the * application gateway resource. - * @member {object} [webApplicationFirewallConfiguration] Web application + * @property {object} [webApplicationFirewallConfiguration] Web application * firewall configuration. - * @member {boolean} [webApplicationFirewallConfiguration.enabled] Whether + * @property {boolean} [webApplicationFirewallConfiguration.enabled] Whether * the web application firewall is enabled or not. - * @member {string} [webApplicationFirewallConfiguration.firewallMode] Web + * @property {string} [webApplicationFirewallConfiguration.firewallMode] Web * application firewall mode. Possible values include: 'Detection', * 'Prevention' - * @member {string} [webApplicationFirewallConfiguration.ruleSetType] The + * @property {string} [webApplicationFirewallConfiguration.ruleSetType] The * type of the web application firewall rule set. Possible values are: * 'OWASP'. - * @member {string} [webApplicationFirewallConfiguration.ruleSetVersion] The - * version of the rule set type. - * @member {array} [webApplicationFirewallConfiguration.disabledRuleGroups] + * @property {string} [webApplicationFirewallConfiguration.ruleSetVersion] + * The version of the rule set type. + * @property {array} [webApplicationFirewallConfiguration.disabledRuleGroups] * The disabled rule groups. - * @member {boolean} [webApplicationFirewallConfiguration.requestBodyCheck] + * @property {boolean} [webApplicationFirewallConfiguration.requestBodyCheck] * Whether allow WAF to check request Body. - * @member {number} [webApplicationFirewallConfiguration.maxRequestBodySize] - * Maxium request body size for WAF. - * @member {number} + * @property {number} + * [webApplicationFirewallConfiguration.maxRequestBodySize] Maxium request + * body size for WAF. + * @property {number} * [webApplicationFirewallConfiguration.maxRequestBodySizeInKb] Maxium * request body size in Kb for WAF. - * @member {number} [webApplicationFirewallConfiguration.fileUploadLimitInMb] - * Maxium file upload size in Mb for WAF. - * @member {array} [webApplicationFirewallConfiguration.exclusions] The + * @property {number} + * [webApplicationFirewallConfiguration.fileUploadLimitInMb] Maxium file + * upload size in Mb for WAF. + * @property {array} [webApplicationFirewallConfiguration.exclusions] The * exclusion list. - * @member {boolean} [enableHttp2] Whether HTTP2 is enabled on the + * @property {boolean} [enableHttp2] Whether HTTP2 is enabled on the * application gateway resource. - * @member {boolean} [enableFips] Whether FIPS is enabled on the application - * gateway resource. - * @member {object} [autoscaleConfiguration] Autoscale Configuration. - * @member {number} [autoscaleConfiguration.minCapacity] Lower bound on + * @property {boolean} [enableFips] Whether FIPS is enabled on the + * application gateway resource. + * @property {object} [autoscaleConfiguration] Autoscale Configuration. + * @property {number} [autoscaleConfiguration.minCapacity] Lower bound on * number of Application Gateway instances - * @member {string} [resourceGuid] Resource GUID property of the application - * gateway resource. - * @member {string} [provisioningState] Provisioning state of the application - * gateway resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {array} [customErrorConfigurations] Custom error configurations of - * the application gateway resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [resourceGuid] Resource GUID property of the + * application gateway resource. + * @property {string} [provisioningState] Provisioning state of the + * application gateway resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + * @property {array} [customErrorConfigurations] Custom error configurations + * of the application gateway resource. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {array} [zones] A list of availability zones denoting where the + * @property {array} [zones] A list of availability zones denoting where the * resource needs to come from. + * @property {object} [identity] The identity of the application gateway, if + * configured. + * @property {string} [identity.principalId] The principal id of the system + * assigned identity. This property will only be provided for a system + * assigned identity. + * @property {string} [identity.tenantId] The tenant id of the system + * assigned identity. This property will only be provided for a system + * assigned identity. + * @property {string} [identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The + * type 'None' will remove any identities from the virtual machine. Possible + * values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, + * UserAssigned', 'None' + * @property {object} [identity.userAssignedIdentities] The list of user + * identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ constructor() { super(); @@ -380,6 +402,21 @@ class ApplicationGateway extends models['Resource'] { } } }, + rewriteRuleSets: { + required: false, + serializedName: 'properties.rewriteRuleSets', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'ApplicationGatewayRewriteRuleSetElementType', + type: { + name: 'Composite', + className: 'ApplicationGatewayRewriteRuleSet' + } + } + } + }, redirectConfigurations: { required: false, serializedName: 'properties.redirectConfigurations', @@ -474,6 +511,14 @@ class ApplicationGateway extends models['Resource'] { } } } + }, + identity: { + required: false, + serializedName: 'identity', + type: { + name: 'Composite', + className: 'ManagedServiceIdentity' + } } } } diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayAuthenticationCertificate.js b/lib/services/networkManagement2/lib/models/applicationGatewayAuthenticationCertificate.js index 5836499b6b..ae95640a1d 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayAuthenticationCertificate.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayAuthenticationCertificate.js @@ -20,15 +20,15 @@ const models = require('./index'); class ApplicationGatewayAuthenticationCertificate extends models['SubResource'] { /** * Create a ApplicationGatewayAuthenticationCertificate. - * @member {string} [data] Certificate public data. - * @member {string} [provisioningState] Provisioning state of the + * @property {string} [data] Certificate public data. + * @property {string} [provisioningState] Provisioning state of the * authentication certificate resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [name] Name of the authentication certificate that is + * @property {string} [name] Name of the authentication certificate that is * unique within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayAutoscaleConfiguration.js b/lib/services/networkManagement2/lib/models/applicationGatewayAutoscaleConfiguration.js index 084d05a93d..8edff41c3a 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayAutoscaleConfiguration.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayAutoscaleConfiguration.js @@ -17,8 +17,8 @@ class ApplicationGatewayAutoscaleConfiguration { /** * Create a ApplicationGatewayAutoscaleConfiguration. - * @member {number} minCapacity Lower bound on number of Application Gateway - * instances + * @property {number} minCapacity Lower bound on number of Application + * Gateway instances */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayAvailableSslOptions.js b/lib/services/networkManagement2/lib/models/applicationGatewayAvailableSslOptions.js index 91f0108d3f..333ec1364a 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayAvailableSslOptions.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayAvailableSslOptions.js @@ -20,15 +20,15 @@ const models = require('./index'); class ApplicationGatewayAvailableSslOptions extends models['Resource'] { /** * Create a ApplicationGatewayAvailableSslOptions. - * @member {array} [predefinedPolicies] List of available Ssl predefined + * @property {array} [predefinedPolicies] List of available Ssl predefined * policy. - * @member {string} [defaultPolicy] Name of the Ssl predefined policy applied - * by default to application gateway. Possible values include: + * @property {string} [defaultPolicy] Name of the Ssl predefined policy + * applied by default to application gateway. Possible values include: * 'AppGwSslPolicy20150501', 'AppGwSslPolicy20170401', * 'AppGwSslPolicy20170401S' - * @member {array} [availableCipherSuites] List of available Ssl cipher + * @property {array} [availableCipherSuites] List of available Ssl cipher * suites. - * @member {array} [availableProtocols] List of available Ssl protocols. + * @property {array} [availableProtocols] List of available Ssl protocols. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayAvailableSslPredefinedPolicies.js b/lib/services/networkManagement2/lib/models/applicationGatewayAvailableSslPredefinedPolicies.js index 5b1ac67da0..7642105f30 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayAvailableSslPredefinedPolicies.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayAvailableSslPredefinedPolicies.js @@ -16,7 +16,7 @@ class ApplicationGatewayAvailableSslPredefinedPolicies extends Array { /** * Create a ApplicationGatewayAvailableSslPredefinedPolicies. - * @member {string} [nextLink] URL to get the next set of results. + * @property {string} [nextLink] URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayAvailableWafRuleSetsResult.js b/lib/services/networkManagement2/lib/models/applicationGatewayAvailableWafRuleSetsResult.js index 6910fb06bd..1de40eefbc 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayAvailableWafRuleSetsResult.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayAvailableWafRuleSetsResult.js @@ -17,7 +17,7 @@ class ApplicationGatewayAvailableWafRuleSetsResult { /** * Create a ApplicationGatewayAvailableWafRuleSetsResult. - * @member {array} [value] The list of application gateway rule sets. + * @property {array} [value] The list of application gateway rule sets. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayBackendAddress.js b/lib/services/networkManagement2/lib/models/applicationGatewayBackendAddress.js index 9efa6a4200..80857ebfc4 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayBackendAddress.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayBackendAddress.js @@ -17,8 +17,8 @@ class ApplicationGatewayBackendAddress { /** * Create a ApplicationGatewayBackendAddress. - * @member {string} [fqdn] Fully qualified domain name (FQDN). - * @member {string} [ipAddress] IP address + * @property {string} [fqdn] Fully qualified domain name (FQDN). + * @property {string} [ipAddress] IP address */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayBackendAddressPool.js b/lib/services/networkManagement2/lib/models/applicationGatewayBackendAddressPool.js index 17c091ffd8..e21e4c2929 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayBackendAddressPool.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayBackendAddressPool.js @@ -20,17 +20,17 @@ const models = require('./index'); class ApplicationGatewayBackendAddressPool extends models['SubResource'] { /** * Create a ApplicationGatewayBackendAddressPool. - * @member {array} [backendIPConfigurations] Collection of references to IPs - * defined in network interfaces. - * @member {array} [backendAddresses] Backend addresses - * @member {string} [provisioningState] Provisioning state of the backend + * @property {array} [backendIPConfigurations] Collection of references to + * IPs defined in network interfaces. + * @property {array} [backendAddresses] Backend addresses + * @property {string} [provisioningState] Provisioning state of the backend * address pool resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] Name of the backend address pool that is unique + * @property {string} [name] Name of the backend address pool that is unique * within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealth.js b/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealth.js index 5d7250a385..f30fd6e3c7 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealth.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealth.js @@ -17,7 +17,7 @@ class ApplicationGatewayBackendHealth { /** * Create a ApplicationGatewayBackendHealth. - * @member {array} [backendAddressPools] + * @property {array} [backendAddressPools] */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthHttpSettings.js b/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthHttpSettings.js index 12d885f864..8ba9f04cb9 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthHttpSettings.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthHttpSettings.js @@ -17,55 +17,55 @@ class ApplicationGatewayBackendHealthHttpSettings { /** * Create a ApplicationGatewayBackendHealthHttpSettings. - * @member {object} [backendHttpSettings] Reference of an + * @property {object} [backendHttpSettings] Reference of an * ApplicationGatewayBackendHttpSettings resource. - * @member {number} [backendHttpSettings.port] The destination port on the + * @property {number} [backendHttpSettings.port] The destination port on the * backend. - * @member {string} [backendHttpSettings.protocol] The protocol used to + * @property {string} [backendHttpSettings.protocol] The protocol used to * communicate with the backend. Possible values are 'Http' and 'Https'. * Possible values include: 'Http', 'Https' - * @member {string} [backendHttpSettings.cookieBasedAffinity] Cookie based + * @property {string} [backendHttpSettings.cookieBasedAffinity] Cookie based * affinity. Possible values include: 'Enabled', 'Disabled' - * @member {number} [backendHttpSettings.requestTimeout] Request timeout in + * @property {number} [backendHttpSettings.requestTimeout] Request timeout in * seconds. Application Gateway will fail the request if response is not * received within RequestTimeout. Acceptable values are from 1 second to * 86400 seconds. - * @member {object} [backendHttpSettings.probe] Probe resource of an + * @property {object} [backendHttpSettings.probe] Probe resource of an * application gateway. - * @member {string} [backendHttpSettings.probe.id] Resource ID. - * @member {array} [backendHttpSettings.authenticationCertificates] Array of - * references to application gateway authentication certificates. - * @member {array} [backendHttpSettings.trustedRootCertificates] Array of + * @property {string} [backendHttpSettings.probe.id] Resource ID. + * @property {array} [backendHttpSettings.authenticationCertificates] Array + * of references to application gateway authentication certificates. + * @property {array} [backendHttpSettings.trustedRootCertificates] Array of * references to application gateway trusted root certificates. - * @member {object} [backendHttpSettings.connectionDraining] Connection + * @property {object} [backendHttpSettings.connectionDraining] Connection * draining of the backend http settings resource. - * @member {boolean} [backendHttpSettings.connectionDraining.enabled] Whether - * connection draining is enabled or not. - * @member {number} + * @property {boolean} [backendHttpSettings.connectionDraining.enabled] + * Whether connection draining is enabled or not. + * @property {number} * [backendHttpSettings.connectionDraining.drainTimeoutInSec] The number of * seconds connection draining is active. Acceptable values are from 1 second * to 3600 seconds. - * @member {string} [backendHttpSettings.hostName] Host header to be sent to - * the backend servers. - * @member {boolean} [backendHttpSettings.pickHostNameFromBackendAddress] + * @property {string} [backendHttpSettings.hostName] Host header to be sent + * to the backend servers. + * @property {boolean} [backendHttpSettings.pickHostNameFromBackendAddress] * Whether to pick host header should be picked from the host name of the * backend server. Default value is false. - * @member {string} [backendHttpSettings.affinityCookieName] Cookie name to + * @property {string} [backendHttpSettings.affinityCookieName] Cookie name to * use for the affinity cookie. - * @member {boolean} [backendHttpSettings.probeEnabled] Whether the probe is - * enabled. Default value is false. - * @member {string} [backendHttpSettings.path] Path which should be used as a - * prefix for all HTTP requests. Null means no path will be prefixed. Default - * value is null. - * @member {string} [backendHttpSettings.provisioningState] Provisioning + * @property {boolean} [backendHttpSettings.probeEnabled] Whether the probe + * is enabled. Default value is false. + * @property {string} [backendHttpSettings.path] Path which should be used as + * a prefix for all HTTP requests. Null means no path will be prefixed. + * Default value is null. + * @property {string} [backendHttpSettings.provisioningState] Provisioning * state of the backend http settings resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [backendHttpSettings.name] Name of the backend http + * @property {string} [backendHttpSettings.name] Name of the backend http * settings that is unique within an Application Gateway. - * @member {string} [backendHttpSettings.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {string} [backendHttpSettings.type] Type of the resource. - * @member {array} [servers] List of ApplicationGatewayBackendHealthServer + * @property {string} [backendHttpSettings.etag] A unique read-only string + * that changes whenever the resource is updated. + * @property {string} [backendHttpSettings.type] Type of the resource. + * @property {array} [servers] List of ApplicationGatewayBackendHealthServer * resources. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthPool.js b/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthPool.js index db90014ab8..ea1fec7ab8 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthPool.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthPool.js @@ -17,20 +17,20 @@ class ApplicationGatewayBackendHealthPool { /** * Create a ApplicationGatewayBackendHealthPool. - * @member {object} [backendAddressPool] Reference of an + * @property {object} [backendAddressPool] Reference of an * ApplicationGatewayBackendAddressPool resource. - * @member {array} [backendAddressPool.backendIPConfigurations] Collection of - * references to IPs defined in network interfaces. - * @member {array} [backendAddressPool.backendAddresses] Backend addresses - * @member {string} [backendAddressPool.provisioningState] Provisioning state - * of the backend address pool resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [backendAddressPool.name] Name of the backend address + * @property {array} [backendAddressPool.backendIPConfigurations] Collection + * of references to IPs defined in network interfaces. + * @property {array} [backendAddressPool.backendAddresses] Backend addresses + * @property {string} [backendAddressPool.provisioningState] Provisioning + * state of the backend address pool resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + * @property {string} [backendAddressPool.name] Name of the backend address * pool that is unique within an Application Gateway. - * @member {string} [backendAddressPool.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {string} [backendAddressPool.type] Type of the resource. - * @member {array} [backendHttpSettingsCollection] List of + * @property {string} [backendAddressPool.etag] A unique read-only string + * that changes whenever the resource is updated. + * @property {string} [backendAddressPool.type] Type of the resource. + * @property {array} [backendHttpSettingsCollection] List of * ApplicationGatewayBackendHealthHttpSettings resources. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthServer.js b/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthServer.js index e09195fe46..a2831585f2 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthServer.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayBackendHealthServer.js @@ -17,272 +17,275 @@ class ApplicationGatewayBackendHealthServer { /** * Create a ApplicationGatewayBackendHealthServer. - * @member {string} [address] IP address or FQDN of backend server. - * @member {object} [ipConfiguration] Reference of IP configuration of + * @property {string} [address] IP address or FQDN of backend server. + * @property {object} [ipConfiguration] Reference of IP configuration of * backend server. - * @member {array} [ipConfiguration.virtualNetworkTaps] The reference to + * @property {array} [ipConfiguration.virtualNetworkTaps] The reference to * Virtual Network Taps. - * @member {array} [ipConfiguration.applicationGatewayBackendAddressPools] + * @property {array} [ipConfiguration.applicationGatewayBackendAddressPools] * The reference of ApplicationGatewayBackendAddressPool resource. - * @member {array} [ipConfiguration.loadBalancerBackendAddressPools] The + * @property {array} [ipConfiguration.loadBalancerBackendAddressPools] The * reference of LoadBalancerBackendAddressPool resource. - * @member {array} [ipConfiguration.loadBalancerInboundNatRules] A list of + * @property {array} [ipConfiguration.loadBalancerInboundNatRules] A list of * references of LoadBalancerInboundNatRules. - * @member {string} [ipConfiguration.privateIPAddress] Private IP address of - * the IP configuration. - * @member {string} [ipConfiguration.privateIPAllocationMethod] Defines how a - * private IP address is assigned. Possible values are: 'Static' and + * @property {string} [ipConfiguration.privateIPAddress] Private IP address + * of the IP configuration. + * @property {string} [ipConfiguration.privateIPAllocationMethod] Defines how + * a private IP address is assigned. Possible values are: 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} [ipConfiguration.privateIPAddressVersion] Available from - * Api-Version 2016-03-30 onwards, it represents whether the specific + * @property {string} [ipConfiguration.privateIPAddressVersion] Available + * from Api-Version 2016-03-30 onwards, it represents whether the specific * ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible * values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', 'IPv6' - * @member {object} [ipConfiguration.subnet] Subnet bound to the IP + * @property {object} [ipConfiguration.subnet] Subnet bound to the IP * configuration. - * @member {string} [ipConfiguration.subnet.addressPrefix] The address prefix - * for the subnet. - * @member {array} [ipConfiguration.subnet.addressPrefixes] List of address - * prefixes for the subnet. - * @member {object} [ipConfiguration.subnet.networkSecurityGroup] The + * @property {string} [ipConfiguration.subnet.addressPrefix] The address + * prefix for the subnet. + * @property {array} [ipConfiguration.subnet.addressPrefixes] List of + * address prefixes for the subnet. + * @property {object} [ipConfiguration.subnet.networkSecurityGroup] The * reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [ipConfiguration.subnet.networkSecurityGroup.securityRules] A collection * of security rules of the network security group. - * @member {array} + * @property {array} * [ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] The * default security rules of network security group. - * @member {array} + * @property {array} * [ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] A * collection of references to network interfaces. - * @member {array} [ipConfiguration.subnet.networkSecurityGroup.subnets] A + * @property {array} [ipConfiguration.subnet.networkSecurityGroup.subnets] A * collection of references to subnets. - * @member {string} + * @property {string} * [ipConfiguration.subnet.networkSecurityGroup.resourceGuid] The resource * GUID property of the network security group resource. - * @member {string} + * @property {string} * [ipConfiguration.subnet.networkSecurityGroup.provisioningState] The * provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.subnet.networkSecurityGroup.etag] A + * @property {string} [ipConfiguration.subnet.networkSecurityGroup.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {object} [ipConfiguration.subnet.routeTable] The reference of the - * RouteTable resource. - * @member {array} [ipConfiguration.subnet.routeTable.routes] Collection of + * @property {object} [ipConfiguration.subnet.routeTable] The reference of + * the RouteTable resource. + * @property {array} [ipConfiguration.subnet.routeTable.routes] Collection of * routes contained within a route table. - * @member {array} [ipConfiguration.subnet.routeTable.subnets] A collection + * @property {array} [ipConfiguration.subnet.routeTable.subnets] A collection * of references to subnets. - * @member {boolean} + * @property {boolean} * [ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] Gets or * sets whether to disable the routes learned by BGP on that route table. * True means disable. - * @member {string} [ipConfiguration.subnet.routeTable.provisioningState] The - * provisioning state of the resource. Possible values are: 'Updating', + * @property {string} [ipConfiguration.subnet.routeTable.provisioningState] + * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.subnet.routeTable.etag] Gets a unique + * @property {string} [ipConfiguration.subnet.routeTable.etag] Gets a unique * read-only string that changes whenever the resource is updated. - * @member {array} [ipConfiguration.subnet.serviceEndpoints] An array of + * @property {array} [ipConfiguration.subnet.serviceEndpoints] An array of * service endpoints. - * @member {array} [ipConfiguration.subnet.serviceEndpointPolicies] An array - * of service endpoint policies. - * @member {array} [ipConfiguration.subnet.interfaceEndpoints] An array of + * @property {array} [ipConfiguration.subnet.serviceEndpointPolicies] An + * array of service endpoint policies. + * @property {array} [ipConfiguration.subnet.interfaceEndpoints] An array of * references to interface endpoints - * @member {array} [ipConfiguration.subnet.ipConfigurations] Gets an array of - * references to the network interface IP configurations using subnet. - * @member {array} [ipConfiguration.subnet.ipConfigurationProfiles] Array of - * IP configuration profiles which reference this subnet. - * @member {array} [ipConfiguration.subnet.resourceNavigationLinks] Gets an + * @property {array} [ipConfiguration.subnet.ipConfigurations] Gets an array + * of references to the network interface IP configurations using subnet. + * @property {array} [ipConfiguration.subnet.ipConfigurationProfiles] Array + * of IP configuration profiles which reference this subnet. + * @property {array} [ipConfiguration.subnet.resourceNavigationLinks] Gets an * array of references to the external resources using subnet. - * @member {array} [ipConfiguration.subnet.serviceAssociationLinks] Gets an + * @property {array} [ipConfiguration.subnet.serviceAssociationLinks] Gets an * array of references to services injecting into this subnet. - * @member {array} [ipConfiguration.subnet.delegations] Gets an array of + * @property {array} [ipConfiguration.subnet.delegations] Gets an array of * references to the delegations on the subnet. - * @member {string} [ipConfiguration.subnet.purpose] A read-only string + * @property {string} [ipConfiguration.subnet.purpose] A read-only string * identifying the intention of use for this subnet based on delegations and * other user-defined properties. - * @member {string} [ipConfiguration.subnet.provisioningState] The + * @property {string} [ipConfiguration.subnet.provisioningState] The * provisioning state of the resource. - * @member {string} [ipConfiguration.subnet.name] The name of the resource + * @property {string} [ipConfiguration.subnet.name] The name of the resource * that is unique within a resource group. This name can be used to access * the resource. - * @member {string} [ipConfiguration.subnet.etag] A unique read-only string + * @property {string} [ipConfiguration.subnet.etag] A unique read-only string * that changes whenever the resource is updated. - * @member {boolean} [ipConfiguration.primary] Gets whether this is a primary - * customer address on the network interface. - * @member {object} [ipConfiguration.publicIPAddress] Public IP address bound - * to the IP configuration. - * @member {object} [ipConfiguration.publicIPAddress.sku] The public IP + * @property {boolean} [ipConfiguration.primary] Gets whether this is a + * primary customer address on the network interface. + * @property {object} [ipConfiguration.publicIPAddress] Public IP address + * bound to the IP configuration. + * @property {object} [ipConfiguration.publicIPAddress.sku] The public IP * address SKU. - * @member {string} [ipConfiguration.publicIPAddress.sku.name] Name of a + * @property {string} [ipConfiguration.publicIPAddress.sku.name] Name of a * public IP address SKU. Possible values include: 'Basic', 'Standard' - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.publicIPAllocationMethod] The public IP * allocation method. Possible values are: 'Static' and 'Dynamic'. Possible * values include: 'Static', 'Dynamic' - * @member {string} [ipConfiguration.publicIPAddress.publicIPAddressVersion] - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - * Possible values include: 'IPv4', 'IPv6' - * @member {object} [ipConfiguration.publicIPAddress.ipConfiguration] The IP - * configuration associated with the public IP address. - * @member {string} + * @property {string} + * [ipConfiguration.publicIPAddress.publicIPAddressVersion] The public IP + * address version. Possible values are: 'IPv4' and 'IPv6'. Possible values + * include: 'IPv4', 'IPv6' + * @property {object} [ipConfiguration.publicIPAddress.ipConfiguration] The + * IP configuration associated with the public IP address. + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] The * private IP address of the IP configuration. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] * The private IP allocation method. Possible values are 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} [ipConfiguration.publicIPAddress.ipConfiguration.subnet] - * The reference of the subnet resource. - * @member {string} + * @property {object} + * [ipConfiguration.publicIPAddress.ipConfiguration.subnet] The reference of + * the subnet resource. + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] The * address prefix for the subnet. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] * The reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] * A collection of references to subnets. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] The * reference of the RouteTable resource. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] * A collection of references to subnets. - * @member {boolean} + * @property {boolean} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] * Gets a unique read-only string that changes whenever the resource is * updated. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] * An array of service endpoints. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] * An array of service endpoint policies. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] * An array of references to interface endpoints - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] * Gets an array of references to the network interface IP configurations * using subnet. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} + * @property {array} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] Gets * an array of references to the delegations on the subnet. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] A * read-only string identifying the intention of use for this subnet based on * delegations and other user-defined properties. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] * The provisioning state of the resource. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.name] The name of * the resource that is unique within a resource group. This name can be used * to access the resource. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.etag] A unique * read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [ipConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] The * reference of the public IP resource. - * @member {string} + * @property {string} * [ipConfiguration.publicIPAddress.ipConfiguration.provisioningState] Gets * the provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.publicIPAddress.ipConfiguration.name] + * @property {string} [ipConfiguration.publicIPAddress.ipConfiguration.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} [ipConfiguration.publicIPAddress.ipConfiguration.etag] A - * unique read-only string that changes whenever the resource is updated. - * @member {object} [ipConfiguration.publicIPAddress.dnsSettings] The FQDN of - * the DNS record associated with the public IP address. - * @member {string} + * @property {string} [ipConfiguration.publicIPAddress.ipConfiguration.etag] + * A unique read-only string that changes whenever the resource is updated. + * @property {object} [ipConfiguration.publicIPAddress.dnsSettings] The FQDN + * of the DNS record associated with the public IP address. + * @property {string} * [ipConfiguration.publicIPAddress.dnsSettings.domainNameLabel] Gets or sets * the Domain name label.The concatenation of the domain name label and the * regionalized DNS zone make up the fully qualified domain name associated * with the public IP address. If a domain name label is specified, an A DNS * record is created for the public IP in the Microsoft Azure DNS system. - * @member {string} [ipConfiguration.publicIPAddress.dnsSettings.fqdn] Gets + * @property {string} [ipConfiguration.publicIPAddress.dnsSettings.fqdn] Gets * the FQDN, Fully qualified domain name of the A DNS record associated with * the public IP. This is the concatenation of the domainNameLabel and the * regionalized DNS zone. - * @member {string} [ipConfiguration.publicIPAddress.dnsSettings.reverseFqdn] - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name - * that resolves to this public IP address. If the reverseFqdn is specified, - * then a PTR DNS record is created pointing from the IP address in the - * in-addr.arpa domain to the reverse FQDN. - * @member {array} [ipConfiguration.publicIPAddress.ipTags] The list of tags - * associated with the public IP address. - * @member {string} [ipConfiguration.publicIPAddress.ipAddress] The IP + * @property {string} + * [ipConfiguration.publicIPAddress.dnsSettings.reverseFqdn] Gets or Sets the + * Reverse FQDN. A user-visible, fully qualified domain name that resolves to + * this public IP address. If the reverseFqdn is specified, then a PTR DNS + * record is created pointing from the IP address in the in-addr.arpa domain + * to the reverse FQDN. + * @property {array} [ipConfiguration.publicIPAddress.ipTags] The list of + * tags associated with the public IP address. + * @property {string} [ipConfiguration.publicIPAddress.ipAddress] The IP * address associated with the public IP address resource. - * @member {object} [ipConfiguration.publicIPAddress.publicIPPrefix] The + * @property {object} [ipConfiguration.publicIPAddress.publicIPPrefix] The * Public IP Prefix this Public IP Address should be allocated from. - * @member {string} [ipConfiguration.publicIPAddress.publicIPPrefix.id] + * @property {string} [ipConfiguration.publicIPAddress.publicIPPrefix.id] * Resource ID. - * @member {number} [ipConfiguration.publicIPAddress.idleTimeoutInMinutes] + * @property {number} [ipConfiguration.publicIPAddress.idleTimeoutInMinutes] * The idle timeout of the public IP address. - * @member {string} [ipConfiguration.publicIPAddress.resourceGuid] The + * @property {string} [ipConfiguration.publicIPAddress.resourceGuid] The * resource GUID property of the public IP resource. - * @member {string} [ipConfiguration.publicIPAddress.provisioningState] The + * @property {string} [ipConfiguration.publicIPAddress.provisioningState] The * provisioning state of the PublicIP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.publicIPAddress.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {array} [ipConfiguration.publicIPAddress.zones] A list of + * @property {string} [ipConfiguration.publicIPAddress.etag] A unique + * read-only string that changes whenever the resource is updated. + * @property {array} [ipConfiguration.publicIPAddress.zones] A list of * availability zones denoting the IP allocated for the resource needs to * come from. - * @member {array} [ipConfiguration.applicationSecurityGroups] Application + * @property {array} [ipConfiguration.applicationSecurityGroups] Application * security groups in which the IP configuration is included. - * @member {string} [ipConfiguration.provisioningState] The provisioning + * @property {string} [ipConfiguration.provisioningState] The provisioning * state of the network interface IP configuration. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.name] The name of the resource that is + * @property {string} [ipConfiguration.name] The name of the resource that is * unique within a resource group. This name can be used to access the * resource. - * @member {string} [ipConfiguration.etag] A unique read-only string that + * @property {string} [ipConfiguration.etag] A unique read-only string that * changes whenever the resource is updated. - * @member {string} [health] Health of backend server. Possible values + * @property {string} [health] Health of backend server. Possible values * include: 'Unknown', 'Up', 'Down', 'Partial', 'Draining' */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayBackendHttpSettings.js b/lib/services/networkManagement2/lib/models/applicationGatewayBackendHttpSettings.js index 0b62d992fc..c0d0a1f426 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayBackendHttpSettings.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayBackendHttpSettings.js @@ -20,46 +20,48 @@ const models = require('./index'); class ApplicationGatewayBackendHttpSettings extends models['SubResource'] { /** * Create a ApplicationGatewayBackendHttpSettings. - * @member {number} [port] The destination port on the backend. - * @member {string} [protocol] The protocol used to communicate with the + * @property {number} [port] The destination port on the backend. + * @property {string} [protocol] The protocol used to communicate with the * backend. Possible values are 'Http' and 'Https'. Possible values include: * 'Http', 'Https' - * @member {string} [cookieBasedAffinity] Cookie based affinity. Possible + * @property {string} [cookieBasedAffinity] Cookie based affinity. Possible * values include: 'Enabled', 'Disabled' - * @member {number} [requestTimeout] Request timeout in seconds. Application - * Gateway will fail the request if response is not received within - * RequestTimeout. Acceptable values are from 1 second to 86400 seconds. - * @member {object} [probe] Probe resource of an application gateway. - * @member {string} [probe.id] Resource ID. - * @member {array} [authenticationCertificates] Array of references to + * @property {number} [requestTimeout] Request timeout in seconds. + * Application Gateway will fail the request if response is not received + * within RequestTimeout. Acceptable values are from 1 second to 86400 + * seconds. + * @property {object} [probe] Probe resource of an application gateway. + * @property {string} [probe.id] Resource ID. + * @property {array} [authenticationCertificates] Array of references to * application gateway authentication certificates. - * @member {array} [trustedRootCertificates] Array of references to + * @property {array} [trustedRootCertificates] Array of references to * application gateway trusted root certificates. - * @member {object} [connectionDraining] Connection draining of the backend + * @property {object} [connectionDraining] Connection draining of the backend * http settings resource. - * @member {boolean} [connectionDraining.enabled] Whether connection draining - * is enabled or not. - * @member {number} [connectionDraining.drainTimeoutInSec] The number of + * @property {boolean} [connectionDraining.enabled] Whether connection + * draining is enabled or not. + * @property {number} [connectionDraining.drainTimeoutInSec] The number of * seconds connection draining is active. Acceptable values are from 1 second * to 3600 seconds. - * @member {string} [hostName] Host header to be sent to the backend servers. - * @member {boolean} [pickHostNameFromBackendAddress] Whether to pick host + * @property {string} [hostName] Host header to be sent to the backend + * servers. + * @property {boolean} [pickHostNameFromBackendAddress] Whether to pick host * header should be picked from the host name of the backend server. Default * value is false. - * @member {string} [affinityCookieName] Cookie name to use for the affinity - * cookie. - * @member {boolean} [probeEnabled] Whether the probe is enabled. Default + * @property {string} [affinityCookieName] Cookie name to use for the + * affinity cookie. + * @property {boolean} [probeEnabled] Whether the probe is enabled. Default * value is false. - * @member {string} [path] Path which should be used as a prefix for all HTTP - * requests. Null means no path will be prefixed. Default value is null. - * @member {string} [provisioningState] Provisioning state of the backend + * @property {string} [path] Path which should be used as a prefix for all + * HTTP requests. Null means no path will be prefixed. Default value is null. + * @property {string} [provisioningState] Provisioning state of the backend * http settings resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] Name of the backend http settings that is unique + * @property {string} [name] Name of the backend http settings that is unique * within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayConnectionDraining.js b/lib/services/networkManagement2/lib/models/applicationGatewayConnectionDraining.js index 657dfbc1ce..57bffe64be 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayConnectionDraining.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayConnectionDraining.js @@ -19,8 +19,8 @@ class ApplicationGatewayConnectionDraining { /** * Create a ApplicationGatewayConnectionDraining. - * @member {boolean} enabled Whether connection draining is enabled or not. - * @member {number} drainTimeoutInSec The number of seconds connection + * @property {boolean} enabled Whether connection draining is enabled or not. + * @property {number} drainTimeoutInSec The number of seconds connection * draining is active. Acceptable values are from 1 second to 3600 seconds. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayCustomError.js b/lib/services/networkManagement2/lib/models/applicationGatewayCustomError.js index 99781e172e..fcd9db712c 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayCustomError.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayCustomError.js @@ -17,9 +17,9 @@ class ApplicationGatewayCustomError { /** * Create a ApplicationGatewayCustomError. - * @member {string} [statusCode] Status code of the application gateway + * @property {string} [statusCode] Status code of the application gateway * customer error. Possible values include: 'HttpStatus403', 'HttpStatus502' - * @member {string} [customErrorPageUrl] Error page URL of the application + * @property {string} [customErrorPageUrl] Error page URL of the application * gateway customer error. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayFirewallDisabledRuleGroup.js b/lib/services/networkManagement2/lib/models/applicationGatewayFirewallDisabledRuleGroup.js index fac27dfd71..843ca6344d 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayFirewallDisabledRuleGroup.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayFirewallDisabledRuleGroup.js @@ -17,10 +17,10 @@ class ApplicationGatewayFirewallDisabledRuleGroup { /** * Create a ApplicationGatewayFirewallDisabledRuleGroup. - * @member {string} ruleGroupName The name of the rule group that will be + * @property {string} ruleGroupName The name of the rule group that will be * disabled. - * @member {array} [rules] The list of rules that will be disabled. If null, - * all rules of the rule group will be disabled. + * @property {array} [rules] The list of rules that will be disabled. If + * null, all rules of the rule group will be disabled. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayFirewallExclusion.js b/lib/services/networkManagement2/lib/models/applicationGatewayFirewallExclusion.js index ee54c2830d..465e2639f3 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayFirewallExclusion.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayFirewallExclusion.js @@ -17,11 +17,11 @@ class ApplicationGatewayFirewallExclusion { /** * Create a ApplicationGatewayFirewallExclusion. - * @member {string} matchVariable The variable to be excluded. - * @member {string} selectorMatchOperator When matchVariable is a collection, - * operate on the selector to specify which elements in the collection this - * exclusion applies to. - * @member {string} selector When matchVariable is a collection, operator + * @property {string} matchVariable The variable to be excluded. + * @property {string} selectorMatchOperator When matchVariable is a + * collection, operate on the selector to specify which elements in the + * collection this exclusion applies to. + * @property {string} selector When matchVariable is a collection, operator * used to specify which elements in the collection this exclusion applies * to. */ diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRule.js b/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRule.js index 73c4850657..081281798a 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRule.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRule.js @@ -17,9 +17,9 @@ class ApplicationGatewayFirewallRule { /** * Create a ApplicationGatewayFirewallRule. - * @member {number} ruleId The identifier of the web application firewall + * @property {number} ruleId The identifier of the web application firewall * rule. - * @member {string} [description] The description of the web application + * @property {string} [description] The description of the web application * firewall rule. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRuleGroup.js b/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRuleGroup.js index 308896fa98..1eb4f665bf 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRuleGroup.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRuleGroup.js @@ -17,11 +17,11 @@ class ApplicationGatewayFirewallRuleGroup { /** * Create a ApplicationGatewayFirewallRuleGroup. - * @member {string} ruleGroupName The name of the web application firewall + * @property {string} ruleGroupName The name of the web application firewall * rule group. - * @member {string} [description] The description of the web application + * @property {string} [description] The description of the web application * firewall rule group. - * @member {array} rules The rules of the web application firewall rule + * @property {array} rules The rules of the web application firewall rule * group. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRuleSet.js b/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRuleSet.js index d33762e006..76ac7cad63 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRuleSet.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayFirewallRuleSet.js @@ -20,14 +20,14 @@ const models = require('./index'); class ApplicationGatewayFirewallRuleSet extends models['Resource'] { /** * Create a ApplicationGatewayFirewallRuleSet. - * @member {string} [provisioningState] The provisioning state of the web + * @property {string} [provisioningState] The provisioning state of the web * application firewall rule set. - * @member {string} ruleSetType The type of the web application firewall rule - * set. - * @member {string} ruleSetVersion The version of the web application - * firewall rule set type. - * @member {array} ruleGroups The rule groups of the web application firewall + * @property {string} ruleSetType The type of the web application firewall * rule set. + * @property {string} ruleSetVersion The version of the web application + * firewall rule set type. + * @property {array} ruleGroups The rule groups of the web application + * firewall rule set. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayFrontendIPConfiguration.js b/lib/services/networkManagement2/lib/models/applicationGatewayFrontendIPConfiguration.js index 67aba664c9..078bd75352 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayFrontendIPConfiguration.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayFrontendIPConfiguration.js @@ -20,21 +20,21 @@ const models = require('./index'); class ApplicationGatewayFrontendIPConfiguration extends models['SubResource'] { /** * Create a ApplicationGatewayFrontendIPConfiguration. - * @member {string} [privateIPAddress] PrivateIPAddress of the network + * @property {string} [privateIPAddress] PrivateIPAddress of the network * interface IP Configuration. - * @member {string} [privateIPAllocationMethod] PrivateIP allocation method. - * Possible values include: 'Static', 'Dynamic' - * @member {object} [subnet] Reference of the subnet resource. - * @member {string} [subnet.id] Resource ID. - * @member {object} [publicIPAddress] Reference of the PublicIP resource. - * @member {string} [publicIPAddress.id] Resource ID. - * @member {string} [provisioningState] Provisioning state of the public IP + * @property {string} [privateIPAllocationMethod] PrivateIP allocation + * method. Possible values include: 'Static', 'Dynamic' + * @property {object} [subnet] Reference of the subnet resource. + * @property {string} [subnet.id] Resource ID. + * @property {object} [publicIPAddress] Reference of the PublicIP resource. + * @property {string} [publicIPAddress.id] Resource ID. + * @property {string} [provisioningState] Provisioning state of the public IP * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] Name of the frontend IP configuration that is + * @property {string} [name] Name of the frontend IP configuration that is * unique within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayFrontendPort.js b/lib/services/networkManagement2/lib/models/applicationGatewayFrontendPort.js index fcd3586a0b..7927b4f2b5 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayFrontendPort.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayFrontendPort.js @@ -20,14 +20,14 @@ const models = require('./index'); class ApplicationGatewayFrontendPort extends models['SubResource'] { /** * Create a ApplicationGatewayFrontendPort. - * @member {number} [port] Frontend port - * @member {string} [provisioningState] Provisioning state of the frontend + * @property {number} [port] Frontend port + * @property {string} [provisioningState] Provisioning state of the frontend * port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] Name of the frontend port that is unique within an - * Application Gateway - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] Name of the frontend port that is unique within + * an Application Gateway + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayHeaderConfiguration.js b/lib/services/networkManagement2/lib/models/applicationGatewayHeaderConfiguration.js new file mode 100644 index 0000000000..527538e077 --- /dev/null +++ b/lib/services/networkManagement2/lib/models/applicationGatewayHeaderConfiguration.js @@ -0,0 +1,60 @@ +/* + * 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'; + +/** + * Header configuration of the Actions set in Application Gateway. + * + */ +class ApplicationGatewayHeaderConfiguration { + /** + * Create a ApplicationGatewayHeaderConfiguration. + * @property {string} [headerName] Header name of the header configuration + * @property {string} [headerValue] Header value of the header configuration + */ + constructor() { + } + + /** + * Defines the metadata of ApplicationGatewayHeaderConfiguration + * + * @returns {object} metadata of ApplicationGatewayHeaderConfiguration + * + */ + mapper() { + return { + required: false, + serializedName: 'ApplicationGatewayHeaderConfiguration', + type: { + name: 'Composite', + className: 'ApplicationGatewayHeaderConfiguration', + modelProperties: { + headerName: { + required: false, + serializedName: 'headerName', + type: { + name: 'String' + } + }, + headerValue: { + required: false, + serializedName: 'headerValue', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = ApplicationGatewayHeaderConfiguration; diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayHttpListener.js b/lib/services/networkManagement2/lib/models/applicationGatewayHttpListener.js index 085411c204..fa17055b8c 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayHttpListener.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayHttpListener.js @@ -20,30 +20,30 @@ const models = require('./index'); class ApplicationGatewayHttpListener extends models['SubResource'] { /** * Create a ApplicationGatewayHttpListener. - * @member {object} [frontendIPConfiguration] Frontend IP configuration + * @property {object} [frontendIPConfiguration] Frontend IP configuration * resource of an application gateway. - * @member {string} [frontendIPConfiguration.id] Resource ID. - * @member {object} [frontendPort] Frontend port resource of an application + * @property {string} [frontendIPConfiguration.id] Resource ID. + * @property {object} [frontendPort] Frontend port resource of an application * gateway. - * @member {string} [frontendPort.id] Resource ID. - * @member {string} [protocol] Protocol of the HTTP listener. Possible values - * are 'Http' and 'Https'. Possible values include: 'Http', 'Https' - * @member {string} [hostName] Host name of HTTP listener. - * @member {object} [sslCertificate] SSL certificate resource of an + * @property {string} [frontendPort.id] Resource ID. + * @property {string} [protocol] Protocol of the HTTP listener. Possible + * values are 'Http' and 'Https'. Possible values include: 'Http', 'Https' + * @property {string} [hostName] Host name of HTTP listener. + * @property {object} [sslCertificate] SSL certificate resource of an * application gateway. - * @member {string} [sslCertificate.id] Resource ID. - * @member {boolean} [requireServerNameIndication] Applicable only if + * @property {string} [sslCertificate.id] Resource ID. + * @property {boolean} [requireServerNameIndication] Applicable only if * protocol is https. Enables SNI for multi-hosting. - * @member {string} [provisioningState] Provisioning state of the HTTP + * @property {string} [provisioningState] Provisioning state of the HTTP * listener resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {array} [customErrorConfigurations] Custom error configurations of - * the HTTP listener. - * @member {string} [name] Name of the HTTP listener that is unique within an - * Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {array} [customErrorConfigurations] Custom error configurations + * of the HTTP listener. + * @property {string} [name] Name of the HTTP listener that is unique within + * an Application Gateway. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayIPConfiguration.js b/lib/services/networkManagement2/lib/models/applicationGatewayIPConfiguration.js index e8b43dce54..f0f6dc738a 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayIPConfiguration.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayIPConfiguration.js @@ -21,17 +21,17 @@ const models = require('./index'); class ApplicationGatewayIPConfiguration extends models['SubResource'] { /** * Create a ApplicationGatewayIPConfiguration. - * @member {object} [subnet] Reference of the subnet resource. A subnet from - * where application gateway gets its private address. - * @member {string} [subnet.id] Resource ID. - * @member {string} [provisioningState] Provisioning state of the application - * gateway subnet resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Name of the IP configuration that is unique within - * an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {object} [subnet] Reference of the subnet resource. A subnet + * from where application gateway gets its private address. + * @property {string} [subnet.id] Resource ID. + * @property {string} [provisioningState] Provisioning state of the + * application gateway subnet resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + * @property {string} [name] Name of the IP configuration that is unique + * within an Application Gateway. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayListResult.js b/lib/services/networkManagement2/lib/models/applicationGatewayListResult.js index faba3912d9..5951addbd2 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayListResult.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayListResult.js @@ -16,7 +16,7 @@ class ApplicationGatewayListResult extends Array { /** * Create a ApplicationGatewayListResult. - * @member {string} [nextLink] URL to get the next set of results. + * @property {string} [nextLink] URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayPathRule.js b/lib/services/networkManagement2/lib/models/applicationGatewayPathRule.js index 2d32927d50..4698b73991 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayPathRule.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayPathRule.js @@ -20,23 +20,26 @@ const models = require('./index'); class ApplicationGatewayPathRule extends models['SubResource'] { /** * Create a ApplicationGatewayPathRule. - * @member {array} [paths] Path rules of URL path map. - * @member {object} [backendAddressPool] Backend address pool resource of URL - * path map path rule. - * @member {string} [backendAddressPool.id] Resource ID. - * @member {object} [backendHttpSettings] Backend http settings resource of + * @property {array} [paths] Path rules of URL path map. + * @property {object} [backendAddressPool] Backend address pool resource of * URL path map path rule. - * @member {string} [backendHttpSettings.id] Resource ID. - * @member {object} [redirectConfiguration] Redirect configuration resource + * @property {string} [backendAddressPool.id] Resource ID. + * @property {object} [backendHttpSettings] Backend http settings resource of + * URL path map path rule. + * @property {string} [backendHttpSettings.id] Resource ID. + * @property {object} [redirectConfiguration] Redirect configuration resource * of URL path map path rule. - * @member {string} [redirectConfiguration.id] Resource ID. - * @member {string} [provisioningState] Path rule of URL path map resource. + * @property {string} [redirectConfiguration.id] Resource ID. + * @property {object} [rewriteRuleSet] Rewrite rule set resource of URL path + * map path rule. + * @property {string} [rewriteRuleSet.id] Resource ID. + * @property {string} [provisioningState] Path rule of URL path map resource. * Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] Name of the path rule that is unique within an + * @property {string} [name] Name of the path rule that is unique within an * Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); @@ -101,6 +104,14 @@ class ApplicationGatewayPathRule extends models['SubResource'] { className: 'SubResource' } }, + rewriteRuleSet: { + required: false, + serializedName: 'properties.rewriteRuleSet', + type: { + name: 'Composite', + className: 'SubResource' + } + }, provisioningState: { required: false, serializedName: 'properties.provisioningState', diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayProbe.js b/lib/services/networkManagement2/lib/models/applicationGatewayProbe.js index df581e90a0..d7781988a9 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayProbe.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayProbe.js @@ -20,39 +20,39 @@ const models = require('./index'); class ApplicationGatewayProbe extends models['SubResource'] { /** * Create a ApplicationGatewayProbe. - * @member {string} [protocol] The protocol used for the probe. Possible + * @property {string} [protocol] The protocol used for the probe. Possible * values are 'Http' and 'Https'. Possible values include: 'Http', 'Https' - * @member {string} [host] Host name to send the probe to. - * @member {string} [path] Relative path of probe. Valid path starts from + * @property {string} [host] Host name to send the probe to. + * @property {string} [path] Relative path of probe. Valid path starts from * '/'. Probe is sent to ://: - * @member {number} [interval] The probing interval in seconds. This is the + * @property {number} [interval] The probing interval in seconds. This is the * time interval between two consecutive probes. Acceptable values are from 1 * second to 86400 seconds. - * @member {number} [timeout] the probe timeout in seconds. Probe marked as + * @property {number} [timeout] the probe timeout in seconds. Probe marked as * failed if valid response is not received with this timeout period. * Acceptable values are from 1 second to 86400 seconds. - * @member {number} [unhealthyThreshold] The probe retry count. Backend + * @property {number} [unhealthyThreshold] The probe retry count. Backend * server is marked down after consecutive probe failure count reaches * UnhealthyThreshold. Acceptable values are from 1 second to 20. - * @member {boolean} [pickHostNameFromBackendHttpSettings] Whether the host + * @property {boolean} [pickHostNameFromBackendHttpSettings] Whether the host * header should be picked from the backend http settings. Default value is * false. - * @member {number} [minServers] Minimum number of servers that are always + * @property {number} [minServers] Minimum number of servers that are always * marked healthy. Default value is 0. - * @member {object} [match] Criterion for classifying a healthy probe + * @property {object} [match] Criterion for classifying a healthy probe * response. - * @member {string} [match.body] Body that must be contained in the health + * @property {string} [match.body] Body that must be contained in the health * response. Default value is empty. - * @member {array} [match.statusCodes] Allowed ranges of healthy status + * @property {array} [match.statusCodes] Allowed ranges of healthy status * codes. Default range of healthy status codes is 200-399. - * @member {string} [provisioningState] Provisioning state of the backend + * @property {string} [provisioningState] Provisioning state of the backend * http settings resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] Name of the probe that is unique within an + * @property {string} [name] Name of the probe that is unique within an * Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayProbeHealthResponseMatch.js b/lib/services/networkManagement2/lib/models/applicationGatewayProbeHealthResponseMatch.js index 75068ec857..a55dd103e4 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayProbeHealthResponseMatch.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayProbeHealthResponseMatch.js @@ -17,9 +17,9 @@ class ApplicationGatewayProbeHealthResponseMatch { /** * Create a ApplicationGatewayProbeHealthResponseMatch. - * @member {string} [body] Body that must be contained in the health + * @property {string} [body] Body that must be contained in the health * response. Default value is empty. - * @member {array} [statusCodes] Allowed ranges of healthy status codes. + * @property {array} [statusCodes] Allowed ranges of healthy status codes. * Default range of healthy status codes is 200-399. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayRedirectConfiguration.js b/lib/services/networkManagement2/lib/models/applicationGatewayRedirectConfiguration.js index 73285d6a03..a30e292a80 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayRedirectConfiguration.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayRedirectConfiguration.js @@ -20,26 +20,27 @@ const models = require('./index'); class ApplicationGatewayRedirectConfiguration extends models['SubResource'] { /** * Create a ApplicationGatewayRedirectConfiguration. - * @member {string} [redirectType] Supported http redirection types - + * @property {string} [redirectType] Supported http redirection types - * Permanent, Temporary, Found, SeeOther. Possible values include: * 'Permanent', 'Found', 'SeeOther', 'Temporary' - * @member {object} [targetListener] Reference to a listener to redirect the - * request to. - * @member {string} [targetListener.id] Resource ID. - * @member {string} [targetUrl] Url to redirect the request to. - * @member {boolean} [includePath] Include path in the redirected url. - * @member {boolean} [includeQueryString] Include query string in the + * @property {object} [targetListener] Reference to a listener to redirect + * the request to. + * @property {string} [targetListener.id] Resource ID. + * @property {string} [targetUrl] Url to redirect the request to. + * @property {boolean} [includePath] Include path in the redirected url. + * @property {boolean} [includeQueryString] Include query string in the * redirected url. - * @member {array} [requestRoutingRules] Request routing specifying redirect + * @property {array} [requestRoutingRules] Request routing specifying + * redirect configuration. + * @property {array} [urlPathMaps] Url path maps specifying default redirect * configuration. - * @member {array} [urlPathMaps] Url path maps specifying default redirect + * @property {array} [pathRules] Path rules specifying redirect * configuration. - * @member {array} [pathRules] Path rules specifying redirect configuration. - * @member {string} [name] Name of the redirect configuration that is unique - * within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] Name of the redirect configuration that is + * unique within an Application Gateway. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayRequestRoutingRule.js b/lib/services/networkManagement2/lib/models/applicationGatewayRequestRoutingRule.js index 50ee73657f..a256ecd44a 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayRequestRoutingRule.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayRequestRoutingRule.js @@ -20,31 +20,34 @@ const models = require('./index'); class ApplicationGatewayRequestRoutingRule extends models['SubResource'] { /** * Create a ApplicationGatewayRequestRoutingRule. - * @member {string} [ruleType] Rule type. Possible values include: 'Basic', + * @property {string} [ruleType] Rule type. Possible values include: 'Basic', * 'PathBasedRouting' - * @member {object} [backendAddressPool] Backend address pool resource of the - * application gateway. - * @member {string} [backendAddressPool.id] Resource ID. - * @member {object} [backendHttpSettings] Backend http settings resource of + * @property {object} [backendAddressPool] Backend address pool resource of * the application gateway. - * @member {string} [backendHttpSettings.id] Resource ID. - * @member {object} [httpListener] Http listener resource of the application - * gateway. - * @member {string} [httpListener.id] Resource ID. - * @member {object} [urlPathMap] URL path map resource of the application + * @property {string} [backendAddressPool.id] Resource ID. + * @property {object} [backendHttpSettings] Backend http settings resource of + * the application gateway. + * @property {string} [backendHttpSettings.id] Resource ID. + * @property {object} [httpListener] Http listener resource of the + * application gateway. + * @property {string} [httpListener.id] Resource ID. + * @property {object} [urlPathMap] URL path map resource of the application * gateway. - * @member {string} [urlPathMap.id] Resource ID. - * @member {object} [redirectConfiguration] Redirect configuration resource + * @property {string} [urlPathMap.id] Resource ID. + * @property {object} [rewriteRuleSet] Rewrite Rule Set resource in Basic + * rule of the application gateway. + * @property {string} [rewriteRuleSet.id] Resource ID. + * @property {object} [redirectConfiguration] Redirect configuration resource * of the application gateway. - * @member {string} [redirectConfiguration.id] Resource ID. - * @member {string} [provisioningState] Provisioning state of the request + * @property {string} [redirectConfiguration.id] Resource ID. + * @property {string} [provisioningState] Provisioning state of the request * routing rule resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] Name of the request routing rule that is unique + * @property {string} [name] Name of the request routing rule that is unique * within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); @@ -110,6 +113,14 @@ class ApplicationGatewayRequestRoutingRule extends models['SubResource'] { className: 'SubResource' } }, + rewriteRuleSet: { + required: false, + serializedName: 'properties.rewriteRuleSet', + type: { + name: 'Composite', + className: 'SubResource' + } + }, redirectConfiguration: { required: false, serializedName: 'properties.redirectConfiguration', diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayRewriteRule.js b/lib/services/networkManagement2/lib/models/applicationGatewayRewriteRule.js new file mode 100644 index 0000000000..c0732abf80 --- /dev/null +++ b/lib/services/networkManagement2/lib/models/applicationGatewayRewriteRule.js @@ -0,0 +1,67 @@ +/* + * 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'; + +/** + * Rewrite rule of an application gateway. + * + */ +class ApplicationGatewayRewriteRule { + /** + * Create a ApplicationGatewayRewriteRule. + * @property {string} [name] Name of the rewrite rule that is unique within + * an Application Gateway. + * @property {object} [actionSet] Set of actions to be done as part of the + * rewrite Rule. + * @property {array} [actionSet.requestHeaderConfigurations] Request Header + * Actions in the Action Set + * @property {array} [actionSet.responseHeaderConfigurations] Response Header + * Actions in the Action Set + */ + constructor() { + } + + /** + * Defines the metadata of ApplicationGatewayRewriteRule + * + * @returns {object} metadata of ApplicationGatewayRewriteRule + * + */ + mapper() { + return { + required: false, + serializedName: 'ApplicationGatewayRewriteRule', + type: { + name: 'Composite', + className: 'ApplicationGatewayRewriteRule', + modelProperties: { + name: { + required: false, + serializedName: 'name', + type: { + name: 'String' + } + }, + actionSet: { + required: false, + serializedName: 'actionSet', + type: { + name: 'Composite', + className: 'ApplicationGatewayRewriteRuleActionSet' + } + } + } + } + }; + } +} + +module.exports = ApplicationGatewayRewriteRule; diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayRewriteRuleActionSet.js b/lib/services/networkManagement2/lib/models/applicationGatewayRewriteRuleActionSet.js new file mode 100644 index 0000000000..57fe717655 --- /dev/null +++ b/lib/services/networkManagement2/lib/models/applicationGatewayRewriteRuleActionSet.js @@ -0,0 +1,78 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Set of actions in the Rewrite Rule in Application Gateway. + * + */ +class ApplicationGatewayRewriteRuleActionSet { + /** + * Create a ApplicationGatewayRewriteRuleActionSet. + * @property {array} [requestHeaderConfigurations] Request Header Actions in + * the Action Set + * @property {array} [responseHeaderConfigurations] Response Header Actions + * in the Action Set + */ + constructor() { + } + + /** + * Defines the metadata of ApplicationGatewayRewriteRuleActionSet + * + * @returns {object} metadata of ApplicationGatewayRewriteRuleActionSet + * + */ + mapper() { + return { + required: false, + serializedName: 'ApplicationGatewayRewriteRuleActionSet', + type: { + name: 'Composite', + className: 'ApplicationGatewayRewriteRuleActionSet', + modelProperties: { + requestHeaderConfigurations: { + required: false, + serializedName: 'requestHeaderConfigurations', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'ApplicationGatewayHeaderConfigurationElementType', + type: { + name: 'Composite', + className: 'ApplicationGatewayHeaderConfiguration' + } + } + } + }, + responseHeaderConfigurations: { + required: false, + serializedName: 'responseHeaderConfigurations', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'ApplicationGatewayHeaderConfigurationElementType', + type: { + name: 'Composite', + className: 'ApplicationGatewayHeaderConfiguration' + } + } + } + } + } + } + }; + } +} + +module.exports = ApplicationGatewayRewriteRuleActionSet; diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayRewriteRuleSet.js b/lib/services/networkManagement2/lib/models/applicationGatewayRewriteRuleSet.js new file mode 100644 index 0000000000..f75f7504a2 --- /dev/null +++ b/lib/services/networkManagement2/lib/models/applicationGatewayRewriteRuleSet.js @@ -0,0 +1,101 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * Rewrite rule set of an application gateway. + * + * @extends models['SubResource'] + */ +class ApplicationGatewayRewriteRuleSet extends models['SubResource'] { + /** + * Create a ApplicationGatewayRewriteRuleSet. + * @property {array} [rewriteRules] Rewrite rules in the rewrite rule set. + * @property {string} [provisioningState] Provisioning state of the rewrite + * rule set resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + * @property {string} [name] Name of the rewrite rule set that is unique + * within an Application Gateway. + * @property {string} [etag] A unique read-only string that changes whenever + * the resource is updated. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ApplicationGatewayRewriteRuleSet + * + * @returns {object} metadata of ApplicationGatewayRewriteRuleSet + * + */ + mapper() { + return { + required: false, + serializedName: 'ApplicationGatewayRewriteRuleSet', + type: { + name: 'Composite', + className: 'ApplicationGatewayRewriteRuleSet', + modelProperties: { + id: { + required: false, + serializedName: 'id', + type: { + name: 'String' + } + }, + rewriteRules: { + required: false, + serializedName: 'properties.rewriteRules', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'ApplicationGatewayRewriteRuleElementType', + type: { + name: 'Composite', + className: 'ApplicationGatewayRewriteRule' + } + } + } + }, + provisioningState: { + required: false, + readOnly: true, + serializedName: 'properties.provisioningState', + type: { + name: 'String' + } + }, + name: { + required: false, + serializedName: 'name', + type: { + name: 'String' + } + }, + etag: { + required: false, + readOnly: true, + serializedName: 'etag', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = ApplicationGatewayRewriteRuleSet; diff --git a/lib/services/networkManagement2/lib/models/applicationGatewaySku.js b/lib/services/networkManagement2/lib/models/applicationGatewaySku.js index 7e76996b52..cc5b661c8f 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewaySku.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewaySku.js @@ -17,12 +17,12 @@ class ApplicationGatewaySku { /** * Create a ApplicationGatewaySku. - * @member {string} [name] Name of an application gateway SKU. Possible + * @property {string} [name] Name of an application gateway SKU. Possible * values include: 'Standard_Small', 'Standard_Medium', 'Standard_Large', * 'WAF_Medium', 'WAF_Large', 'Standard_v2', 'WAF_v2' - * @member {string} [tier] Tier of an application gateway. Possible values + * @property {string} [tier] Tier of an application gateway. Possible values * include: 'Standard', 'WAF', 'Standard_v2', 'WAF_v2' - * @member {number} [capacity] Capacity (instance count) of an application + * @property {number} [capacity] Capacity (instance count) of an application * gateway. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationGatewaySslCertificate.js b/lib/services/networkManagement2/lib/models/applicationGatewaySslCertificate.js index 7881235bf0..423e9f513c 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewaySslCertificate.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewaySslCertificate.js @@ -20,20 +20,22 @@ const models = require('./index'); class ApplicationGatewaySslCertificate extends models['SubResource'] { /** * Create a ApplicationGatewaySslCertificate. - * @member {string} [data] Base-64 encoded pfx certificate. Only applicable + * @property {string} [data] Base-64 encoded pfx certificate. Only applicable * in PUT Request. - * @member {string} [password] Password for the pfx file specified in data. + * @property {string} [password] Password for the pfx file specified in data. * Only applicable in PUT request. - * @member {string} [publicCertData] Base-64 encoded Public cert data + * @property {string} [publicCertData] Base-64 encoded Public cert data * corresponding to pfx specified in data. Only applicable in GET request. - * @member {string} [provisioningState] Provisioning state of the SSL + * @property {string} [keyVaultSecretId] Secret Id of (base-64 encoded + * unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. + * @property {string} [provisioningState] Provisioning state of the SSL * certificate resource Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] Name of the SSL certificate that is unique within - * an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] Name of the SSL certificate that is unique + * within an Application Gateway. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); @@ -81,6 +83,13 @@ class ApplicationGatewaySslCertificate extends models['SubResource'] { name: 'String' } }, + keyVaultSecretId: { + required: false, + serializedName: 'properties.keyVaultSecretId', + type: { + name: 'String' + } + }, provisioningState: { required: false, serializedName: 'properties.provisioningState', diff --git a/lib/services/networkManagement2/lib/models/applicationGatewaySslPolicy.js b/lib/services/networkManagement2/lib/models/applicationGatewaySslPolicy.js index 14f4a8e3bb..a9736b210f 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewaySslPolicy.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewaySslPolicy.js @@ -17,16 +17,16 @@ class ApplicationGatewaySslPolicy { /** * Create a ApplicationGatewaySslPolicy. - * @member {array} [disabledSslProtocols] Ssl protocols to be disabled on + * @property {array} [disabledSslProtocols] Ssl protocols to be disabled on * application gateway. - * @member {string} [policyType] Type of Ssl Policy. Possible values include: - * 'Predefined', 'Custom' - * @member {string} [policyName] Name of Ssl predefined policy. Possible + * @property {string} [policyType] Type of Ssl Policy. Possible values + * include: 'Predefined', 'Custom' + * @property {string} [policyName] Name of Ssl predefined policy. Possible * values include: 'AppGwSslPolicy20150501', 'AppGwSslPolicy20170401', * 'AppGwSslPolicy20170401S' - * @member {array} [cipherSuites] Ssl cipher suites to be enabled in the + * @property {array} [cipherSuites] Ssl cipher suites to be enabled in the * specified order to application gateway. - * @member {string} [minProtocolVersion] Minimum version of Ssl protocol to + * @property {string} [minProtocolVersion] Minimum version of Ssl protocol to * be supported on application gateway. Possible values include: 'TLSv1_0', * 'TLSv1_1', 'TLSv1_2' */ diff --git a/lib/services/networkManagement2/lib/models/applicationGatewaySslPredefinedPolicy.js b/lib/services/networkManagement2/lib/models/applicationGatewaySslPredefinedPolicy.js index 0d3688ed67..6f8f13a368 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewaySslPredefinedPolicy.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewaySslPredefinedPolicy.js @@ -20,10 +20,10 @@ const models = require('./index'); class ApplicationGatewaySslPredefinedPolicy extends models['SubResource'] { /** * Create a ApplicationGatewaySslPredefinedPolicy. - * @member {string} [name] Name of the Ssl predefined policy. - * @member {array} [cipherSuites] Ssl cipher suites to be enabled in the + * @property {string} [name] Name of the Ssl predefined policy. + * @property {array} [cipherSuites] Ssl cipher suites to be enabled in the * specified order for application gateway. - * @member {string} [minProtocolVersion] Minimum version of Ssl protocol to + * @property {string} [minProtocolVersion] Minimum version of Ssl protocol to * be supported on application gateway. Possible values include: 'TLSv1_0', * 'TLSv1_1', 'TLSv1_2' */ diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayTrustedRootCertificate.js b/lib/services/networkManagement2/lib/models/applicationGatewayTrustedRootCertificate.js index 21a267433d..4edcb248b4 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayTrustedRootCertificate.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayTrustedRootCertificate.js @@ -20,16 +20,17 @@ const models = require('./index'); class ApplicationGatewayTrustedRootCertificate extends models['SubResource'] { /** * Create a ApplicationGatewayTrustedRootCertificate. - * @member {string} [data] Certificate public data. - * @member {string} [keyvaultSecretId] KeyVault Secret Id for certificate. - * @member {string} [provisioningState] Provisioning state of the trusted + * @property {string} [data] Certificate public data. + * @property {string} [keyVaultSecretId] Secret Id of (base-64 encoded + * unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. + * @property {string} [provisioningState] Provisioning state of the trusted * root certificate resource. Possible values are: 'Updating', 'Deleting', * and 'Failed'. - * @member {string} [name] Name of the trusted root certificate that is + * @property {string} [name] Name of the trusted root certificate that is * unique within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); @@ -63,9 +64,9 @@ class ApplicationGatewayTrustedRootCertificate extends models['SubResource'] { name: 'String' } }, - keyvaultSecretId: { + keyVaultSecretId: { required: false, - serializedName: 'properties.keyvaultSecretId', + serializedName: 'properties.keyVaultSecretId', type: { name: 'String' } diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayUrlPathMap.js b/lib/services/networkManagement2/lib/models/applicationGatewayUrlPathMap.js index 29032c22f2..391dc28de5 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayUrlPathMap.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayUrlPathMap.js @@ -21,24 +21,27 @@ const models = require('./index'); class ApplicationGatewayUrlPathMap extends models['SubResource'] { /** * Create a ApplicationGatewayUrlPathMap. - * @member {object} [defaultBackendAddressPool] Default backend address pool - * resource of URL path map. - * @member {string} [defaultBackendAddressPool.id] Resource ID. - * @member {object} [defaultBackendHttpSettings] Default backend http + * @property {object} [defaultBackendAddressPool] Default backend address + * pool resource of URL path map. + * @property {string} [defaultBackendAddressPool.id] Resource ID. + * @property {object} [defaultBackendHttpSettings] Default backend http * settings resource of URL path map. - * @member {string} [defaultBackendHttpSettings.id] Resource ID. - * @member {object} [defaultRedirectConfiguration] Default redirect + * @property {string} [defaultBackendHttpSettings.id] Resource ID. + * @property {object} [defaultRewriteRuleSet] Default Rewrite rule set + * resource of URL path map. + * @property {string} [defaultRewriteRuleSet.id] Resource ID. + * @property {object} [defaultRedirectConfiguration] Default redirect * configuration resource of URL path map. - * @member {string} [defaultRedirectConfiguration.id] Resource ID. - * @member {array} [pathRules] Path rule of URL path map resource. - * @member {string} [provisioningState] Provisioning state of the backend + * @property {string} [defaultRedirectConfiguration.id] Resource ID. + * @property {array} [pathRules] Path rule of URL path map resource. + * @property {string} [provisioningState] Provisioning state of the backend * http settings resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] Name of the URL path map that is unique within an - * Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] Name of the URL path map that is unique within + * an Application Gateway. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Type of the resource. + * @property {string} [type] Type of the resource. */ constructor() { super(); @@ -81,6 +84,14 @@ class ApplicationGatewayUrlPathMap extends models['SubResource'] { className: 'SubResource' } }, + defaultRewriteRuleSet: { + required: false, + serializedName: 'properties.defaultRewriteRuleSet', + type: { + name: 'Composite', + className: 'SubResource' + } + }, defaultRedirectConfiguration: { required: false, serializedName: 'properties.defaultRedirectConfiguration', diff --git a/lib/services/networkManagement2/lib/models/applicationGatewayWebApplicationFirewallConfiguration.js b/lib/services/networkManagement2/lib/models/applicationGatewayWebApplicationFirewallConfiguration.js index 0c35215bd0..a2af0c022d 100644 --- a/lib/services/networkManagement2/lib/models/applicationGatewayWebApplicationFirewallConfiguration.js +++ b/lib/services/networkManagement2/lib/models/applicationGatewayWebApplicationFirewallConfiguration.js @@ -17,22 +17,22 @@ class ApplicationGatewayWebApplicationFirewallConfiguration { /** * Create a ApplicationGatewayWebApplicationFirewallConfiguration. - * @member {boolean} enabled Whether the web application firewall is enabled - * or not. - * @member {string} firewallMode Web application firewall mode. Possible + * @property {boolean} enabled Whether the web application firewall is + * enabled or not. + * @property {string} firewallMode Web application firewall mode. Possible * values include: 'Detection', 'Prevention' - * @member {string} ruleSetType The type of the web application firewall rule - * set. Possible values are: 'OWASP'. - * @member {string} ruleSetVersion The version of the rule set type. - * @member {array} [disabledRuleGroups] The disabled rule groups. - * @member {boolean} [requestBodyCheck] Whether allow WAF to check request + * @property {string} ruleSetType The type of the web application firewall + * rule set. Possible values are: 'OWASP'. + * @property {string} ruleSetVersion The version of the rule set type. + * @property {array} [disabledRuleGroups] The disabled rule groups. + * @property {boolean} [requestBodyCheck] Whether allow WAF to check request * Body. - * @member {number} [maxRequestBodySize] Maxium request body size for WAF. - * @member {number} [maxRequestBodySizeInKb] Maxium request body size in Kb + * @property {number} [maxRequestBodySize] Maxium request body size for WAF. + * @property {number} [maxRequestBodySizeInKb] Maxium request body size in Kb * for WAF. - * @member {number} [fileUploadLimitInMb] Maxium file upload size in Mb for + * @property {number} [fileUploadLimitInMb] Maxium file upload size in Mb for * WAF. - * @member {array} [exclusions] The exclusion list. + * @property {array} [exclusions] The exclusion list. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/applicationSecurityGroup.js b/lib/services/networkManagement2/lib/models/applicationSecurityGroup.js index ee4bd13679..e597d13632 100644 --- a/lib/services/networkManagement2/lib/models/applicationSecurityGroup.js +++ b/lib/services/networkManagement2/lib/models/applicationSecurityGroup.js @@ -20,14 +20,14 @@ const models = require('./index'); class ApplicationSecurityGroup extends models['Resource'] { /** * Create a ApplicationSecurityGroup. - * @member {string} [resourceGuid] The resource GUID property of the + * @property {string} [resourceGuid] The resource GUID property of the * application security group resource. It uniquely identifies a resource, * even if the user changes its name or migrate the resource across * subscriptions or resource groups. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * application security group resource. Possible values are: 'Succeeded', * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/applicationSecurityGroupListResult.js b/lib/services/networkManagement2/lib/models/applicationSecurityGroupListResult.js index 0d6190e83a..7ab6a3456b 100644 --- a/lib/services/networkManagement2/lib/models/applicationSecurityGroupListResult.js +++ b/lib/services/networkManagement2/lib/models/applicationSecurityGroupListResult.js @@ -16,7 +16,7 @@ class ApplicationSecurityGroupListResult extends Array { /** * Create a ApplicationSecurityGroupListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/authorizationListResult.js b/lib/services/networkManagement2/lib/models/authorizationListResult.js index 187e7c18d8..0425515e5c 100644 --- a/lib/services/networkManagement2/lib/models/authorizationListResult.js +++ b/lib/services/networkManagement2/lib/models/authorizationListResult.js @@ -17,7 +17,7 @@ class AuthorizationListResult extends Array { /** * Create a AuthorizationListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/availability.js b/lib/services/networkManagement2/lib/models/availability.js index 87dab9ec37..413501cb1a 100644 --- a/lib/services/networkManagement2/lib/models/availability.js +++ b/lib/services/networkManagement2/lib/models/availability.js @@ -17,9 +17,9 @@ class Availability { /** * Create a Availability. - * @member {string} [timeGrain] The time grain of the availability. - * @member {string} [retention] The retention of the availability. - * @member {string} [blobDuration] Duration of the availability blob. + * @property {string} [timeGrain] The time grain of the availability. + * @property {string} [retention] The retention of the availability. + * @property {string} [blobDuration] Duration of the availability blob. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/availableDelegation.js b/lib/services/networkManagement2/lib/models/availableDelegation.js index b248e2fd59..6e76236829 100644 --- a/lib/services/networkManagement2/lib/models/availableDelegation.js +++ b/lib/services/networkManagement2/lib/models/availableDelegation.js @@ -18,12 +18,12 @@ class AvailableDelegation { /** * Create a AvailableDelegation. - * @member {string} [name] The name of the AvailableDelegation resource. - * @member {string} [id] A unique identifier of the AvailableDelegation + * @property {string} [name] The name of the AvailableDelegation resource. + * @property {string} [id] A unique identifier of the AvailableDelegation * resource. - * @member {string} [type] Resource type. - * @member {string} [serviceName] The name of the service and resource - * @member {array} [actions] Describes the actions permitted to the service + * @property {string} [type] Resource type. + * @property {string} [serviceName] The name of the service and resource + * @property {array} [actions] Describes the actions permitted to the service * upon delegation */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/availableDelegationsResult.js b/lib/services/networkManagement2/lib/models/availableDelegationsResult.js index 36e5317a2e..d83983818d 100644 --- a/lib/services/networkManagement2/lib/models/availableDelegationsResult.js +++ b/lib/services/networkManagement2/lib/models/availableDelegationsResult.js @@ -16,7 +16,7 @@ class AvailableDelegationsResult extends Array { /** * Create a AvailableDelegationsResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/availableProvidersList.js b/lib/services/networkManagement2/lib/models/availableProvidersList.js index 3b985cb0a7..243d08dbd6 100644 --- a/lib/services/networkManagement2/lib/models/availableProvidersList.js +++ b/lib/services/networkManagement2/lib/models/availableProvidersList.js @@ -17,7 +17,7 @@ class AvailableProvidersList { /** * Create a AvailableProvidersList. - * @member {array} countries List of available countries. + * @property {array} countries List of available countries. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/availableProvidersListCity.js b/lib/services/networkManagement2/lib/models/availableProvidersListCity.js index 24cc8393a9..584d487cab 100644 --- a/lib/services/networkManagement2/lib/models/availableProvidersListCity.js +++ b/lib/services/networkManagement2/lib/models/availableProvidersListCity.js @@ -17,8 +17,8 @@ class AvailableProvidersListCity { /** * Create a AvailableProvidersListCity. - * @member {string} [cityName] The city or town name. - * @member {array} [providers] A list of Internet service providers. + * @property {string} [cityName] The city or town name. + * @property {array} [providers] A list of Internet service providers. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/availableProvidersListCountry.js b/lib/services/networkManagement2/lib/models/availableProvidersListCountry.js index b87b7f9cec..50ff7dbf41 100644 --- a/lib/services/networkManagement2/lib/models/availableProvidersListCountry.js +++ b/lib/services/networkManagement2/lib/models/availableProvidersListCountry.js @@ -17,9 +17,9 @@ class AvailableProvidersListCountry { /** * Create a AvailableProvidersListCountry. - * @member {string} [countryName] The country name. - * @member {array} [providers] A list of Internet service providers. - * @member {array} [states] List of available states in the country. + * @property {string} [countryName] The country name. + * @property {array} [providers] A list of Internet service providers. + * @property {array} [states] List of available states in the country. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/availableProvidersListParameters.js b/lib/services/networkManagement2/lib/models/availableProvidersListParameters.js index e3faef0eeb..2496be90a8 100644 --- a/lib/services/networkManagement2/lib/models/availableProvidersListParameters.js +++ b/lib/services/networkManagement2/lib/models/availableProvidersListParameters.js @@ -17,10 +17,10 @@ class AvailableProvidersListParameters { /** * Create a AvailableProvidersListParameters. - * @member {array} [azureLocations] A list of Azure regions. - * @member {string} [country] The country for available providers list. - * @member {string} [state] The state for available providers list. - * @member {string} [city] The city or town for available providers list. + * @property {array} [azureLocations] A list of Azure regions. + * @property {string} [country] The country for available providers list. + * @property {string} [state] The state for available providers list. + * @property {string} [city] The city or town for available providers list. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/availableProvidersListState.js b/lib/services/networkManagement2/lib/models/availableProvidersListState.js index 17bd7b8ef6..c2acfda386 100644 --- a/lib/services/networkManagement2/lib/models/availableProvidersListState.js +++ b/lib/services/networkManagement2/lib/models/availableProvidersListState.js @@ -17,9 +17,9 @@ class AvailableProvidersListState { /** * Create a AvailableProvidersListState. - * @member {string} [stateName] The state name. - * @member {array} [providers] A list of Internet service providers. - * @member {array} [cities] List of available cities or towns in the state. + * @property {string} [stateName] The state name. + * @property {array} [providers] A list of Internet service providers. + * @property {array} [cities] List of available cities or towns in the state. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/azureAsyncOperationResult.js b/lib/services/networkManagement2/lib/models/azureAsyncOperationResult.js index 4870803217..7f6d7a5d49 100644 --- a/lib/services/networkManagement2/lib/models/azureAsyncOperationResult.js +++ b/lib/services/networkManagement2/lib/models/azureAsyncOperationResult.js @@ -24,15 +24,15 @@ class AzureAsyncOperationResult { /** * Create a AzureAsyncOperationResult. - * @member {string} [status] Status of the Azure async operation. Possible + * @property {string} [status] Status of the Azure async operation. Possible * values are: 'InProgress', 'Succeeded', and 'Failed'. Possible values * include: 'InProgress', 'Succeeded', 'Failed' - * @member {object} [error] - * @member {string} [error.code] - * @member {string} [error.message] - * @member {string} [error.target] - * @member {array} [error.details] - * @member {string} [error.innerError] + * @property {object} [error] + * @property {string} [error.code] + * @property {string} [error.message] + * @property {string} [error.target] + * @property {array} [error.details] + * @property {string} [error.innerError] */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/azureFirewall.js b/lib/services/networkManagement2/lib/models/azureFirewall.js index 982cc239e2..fd69283902 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewall.js +++ b/lib/services/networkManagement2/lib/models/azureFirewall.js @@ -20,18 +20,18 @@ const models = require('./index'); class AzureFirewall extends models['Resource'] { /** * Create a AzureFirewall. - * @member {array} [applicationRuleCollections] Collection of application + * @property {array} [applicationRuleCollections] Collection of application * rule collections used by Azure Firewall. - * @member {array} [natRuleCollections] Collection of NAT rule collections + * @property {array} [natRuleCollections] Collection of NAT rule collections * used by Azure Firewall. - * @member {array} [networkRuleCollections] Collection of network rule + * @property {array} [networkRuleCollections] Collection of network rule * collections used by Azure Firewall. - * @member {array} [ipConfigurations] IP configuration of the Azure Firewall - * resource. - * @member {string} [provisioningState] The provisioning state of the + * @property {array} [ipConfigurations] IP configuration of the Azure + * Firewall resource. + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureFirewallApplicationRule.js b/lib/services/networkManagement2/lib/models/azureFirewallApplicationRule.js index f1f65b93c4..24e2747441 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallApplicationRule.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallApplicationRule.js @@ -17,13 +17,13 @@ class AzureFirewallApplicationRule { /** * Create a AzureFirewallApplicationRule. - * @member {string} [name] Name of the application rule. - * @member {string} [description] Description of the rule. - * @member {array} [sourceAddresses] List of source IP addresses for this + * @property {string} [name] Name of the application rule. + * @property {string} [description] Description of the rule. + * @property {array} [sourceAddresses] List of source IP addresses for this * rule. - * @member {array} [protocols] Array of ApplicationRuleProtocols. - * @member {array} [targetFqdns] List of FQDNs for this rule. - * @member {array} [fqdnTags] List of FQDN Tags for this rule. + * @property {array} [protocols] Array of ApplicationRuleProtocols. + * @property {array} [targetFqdns] List of FQDNs for this rule. + * @property {array} [fqdnTags] List of FQDN Tags for this rule. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/azureFirewallApplicationRuleCollection.js b/lib/services/networkManagement2/lib/models/azureFirewallApplicationRuleCollection.js index 4e883e0ad6..5701abe73a 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallApplicationRuleCollection.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallApplicationRuleCollection.js @@ -20,19 +20,19 @@ const models = require('./index'); class AzureFirewallApplicationRuleCollection extends models['SubResource'] { /** * Create a AzureFirewallApplicationRuleCollection. - * @member {number} [priority] Priority of the application rule collection + * @property {number} [priority] Priority of the application rule collection * resource. - * @member {object} [action] The action type of a rule collection - * @member {string} [action.type] The type of action. Possible values + * @property {object} [action] The action type of a rule collection + * @property {string} [action.type] The type of action. Possible values * include: 'Allow', 'Deny' - * @member {array} [rules] Collection of rules used by a application rule + * @property {array} [rules] Collection of rules used by a application rule * collection. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [name] Gets name of the resource that is unique within + * a resource group. This name can be used to access the resource. + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureFirewallApplicationRuleProtocol.js b/lib/services/networkManagement2/lib/models/azureFirewallApplicationRuleProtocol.js index 92347d2624..389dd7f82e 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallApplicationRuleProtocol.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallApplicationRuleProtocol.js @@ -17,9 +17,9 @@ class AzureFirewallApplicationRuleProtocol { /** * Create a AzureFirewallApplicationRuleProtocol. - * @member {string} [protocolType] Protocol type. Possible values include: + * @property {string} [protocolType] Protocol type. Possible values include: * 'Http', 'Https' - * @member {number} [port] Port number for the protocol, cannot be greater + * @property {number} [port] Port number for the protocol, cannot be greater * than 64000. This field is optional. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureFirewallFqdnTag.js b/lib/services/networkManagement2/lib/models/azureFirewallFqdnTag.js index c0ee7f2dda..1b5f4eca3e 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallFqdnTag.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallFqdnTag.js @@ -20,10 +20,10 @@ const models = require('./index'); class AzureFirewallFqdnTag extends models['Resource'] { /** * Create a AzureFirewallFqdnTag. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. - * @member {string} [fqdnTagName] The name of this FQDN Tag. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [fqdnTagName] The name of this FQDN Tag. + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureFirewallFqdnTagListResult.js b/lib/services/networkManagement2/lib/models/azureFirewallFqdnTagListResult.js index c382566ecb..976fedc15a 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallFqdnTagListResult.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallFqdnTagListResult.js @@ -16,7 +16,7 @@ class AzureFirewallFqdnTagListResult extends Array { /** * Create a AzureFirewallFqdnTagListResult. - * @member {string} [nextLink] URL to get the next set of results. + * @property {string} [nextLink] URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/azureFirewallIPConfiguration.js b/lib/services/networkManagement2/lib/models/azureFirewallIPConfiguration.js index 193f98b5a0..e7e15ef694 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallIPConfiguration.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallIPConfiguration.js @@ -20,20 +20,20 @@ const models = require('./index'); class AzureFirewallIPConfiguration extends models['SubResource'] { /** * Create a AzureFirewallIPConfiguration. - * @member {string} [privateIPAddress] The Firewall Internal Load Balancer IP - * to be used as the next hop in User Defined Routes. - * @member {object} [subnet] Reference of the subnet resource. This resource - * must be named 'AzureFirewallSubnet'. - * @member {string} [subnet.id] Resource ID. - * @member {object} [publicIPAddress] Reference of the PublicIP resource. + * @property {string} [privateIPAddress] The Firewall Internal Load Balancer + * IP to be used as the next hop in User Defined Routes. + * @property {object} [subnet] Reference of the subnet resource. This + * resource must be named 'AzureFirewallSubnet'. + * @property {string} [subnet.id] Resource ID. + * @property {object} [publicIPAddress] Reference of the PublicIP resource. * This field is a mandatory input if subnet is not null. - * @member {string} [publicIPAddress.id] Resource ID. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [publicIPAddress.id] Resource ID. + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {string} [name] Name of the resource that is unique within a + * @property {string} [name] Name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { @@ -63,6 +63,7 @@ class AzureFirewallIPConfiguration extends models['SubResource'] { }, privateIPAddress: { required: false, + readOnly: true, serializedName: 'properties.privateIPAddress', type: { name: 'String' diff --git a/lib/services/networkManagement2/lib/models/azureFirewallListResult.js b/lib/services/networkManagement2/lib/models/azureFirewallListResult.js index fb1febc884..127c313db5 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallListResult.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallListResult.js @@ -16,7 +16,7 @@ class AzureFirewallListResult extends Array { /** * Create a AzureFirewallListResult. - * @member {string} [nextLink] URL to get the next set of results. + * @property {string} [nextLink] URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/azureFirewallNatRCAction.js b/lib/services/networkManagement2/lib/models/azureFirewallNatRCAction.js index 7a5a98f310..fa76e9408f 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallNatRCAction.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallNatRCAction.js @@ -17,7 +17,7 @@ class AzureFirewallNatRCAction { /** * Create a AzureFirewallNatRCAction. - * @member {string} [type] The type of action. Possible values include: + * @property {string} [type] The type of action. Possible values include: * 'Snat', 'Dnat' */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureFirewallNatRule.js b/lib/services/networkManagement2/lib/models/azureFirewallNatRule.js index f85620e5f6..06e3136e14 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallNatRule.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallNatRule.js @@ -17,18 +17,18 @@ class AzureFirewallNatRule { /** * Create a AzureFirewallNatRule. - * @member {string} [name] Name of the NAT rule. - * @member {string} [description] Description of the rule. - * @member {array} [sourceAddresses] List of source IP addresses for this + * @property {string} [name] Name of the NAT rule. + * @property {string} [description] Description of the rule. + * @property {array} [sourceAddresses] List of source IP addresses for this * rule. - * @member {array} [destinationAddresses] List of destination IP addresses + * @property {array} [destinationAddresses] List of destination IP addresses * for this rule. - * @member {array} [destinationPorts] List of destination ports. - * @member {array} [protocols] Array of AzureFirewallNetworkRuleProtocols + * @property {array} [destinationPorts] List of destination ports. + * @property {array} [protocols] Array of AzureFirewallNetworkRuleProtocols * applicable to this NAT rule. - * @member {string} [translatedAddress] The translated address for this NAT + * @property {string} [translatedAddress] The translated address for this NAT * rule. - * @member {string} [translatedPort] The translated port for this NAT rule. + * @property {string} [translatedPort] The translated port for this NAT rule. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/azureFirewallNatRuleCollection.js b/lib/services/networkManagement2/lib/models/azureFirewallNatRuleCollection.js index 2c17328930..6366f05d83 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallNatRuleCollection.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallNatRuleCollection.js @@ -20,17 +20,19 @@ const models = require('./index'); class AzureFirewallNatRuleCollection extends models['SubResource'] { /** * Create a AzureFirewallNatRuleCollection. - * @member {number} [priority] Priority of the NAT rule collection resource. - * @member {object} [action] The action type of a NAT rule collection - * @member {string} [action.type] The type of action. Possible values + * @property {number} [priority] Priority of the NAT rule collection + * resource. + * @property {object} [action] The action type of a NAT rule collection + * @property {string} [action.type] The type of action. Possible values * include: 'Snat', 'Dnat' - * @member {array} [rules] Collection of rules used by a NAT rule collection. - * @member {string} [provisioningState] The provisioning state of the + * @property {array} [rules] Collection of rules used by a NAT rule + * collection. + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [name] Gets name of the resource that is unique within + * a resource group. This name can be used to access the resource. + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureFirewallNetworkRule.js b/lib/services/networkManagement2/lib/models/azureFirewallNetworkRule.js index 216cc019c1..54833d3f24 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallNetworkRule.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallNetworkRule.js @@ -17,13 +17,13 @@ class AzureFirewallNetworkRule { /** * Create a AzureFirewallNetworkRule. - * @member {string} [name] Name of the network rule. - * @member {string} [description] Description of the rule. - * @member {array} [protocols] Array of AzureFirewallNetworkRuleProtocols. - * @member {array} [sourceAddresses] List of source IP addresses for this + * @property {string} [name] Name of the network rule. + * @property {string} [description] Description of the rule. + * @property {array} [protocols] Array of AzureFirewallNetworkRuleProtocols. + * @property {array} [sourceAddresses] List of source IP addresses for this * rule. - * @member {array} [destinationAddresses] List of destination IP addresses. - * @member {array} [destinationPorts] List of destination ports. + * @property {array} [destinationAddresses] List of destination IP addresses. + * @property {array} [destinationPorts] List of destination ports. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/azureFirewallNetworkRuleCollection.js b/lib/services/networkManagement2/lib/models/azureFirewallNetworkRuleCollection.js index 7a073e2e1f..56d3d62f40 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallNetworkRuleCollection.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallNetworkRuleCollection.js @@ -20,19 +20,19 @@ const models = require('./index'); class AzureFirewallNetworkRuleCollection extends models['SubResource'] { /** * Create a AzureFirewallNetworkRuleCollection. - * @member {number} [priority] Priority of the network rule collection + * @property {number} [priority] Priority of the network rule collection * resource. - * @member {object} [action] The action type of a rule collection - * @member {string} [action.type] The type of action. Possible values + * @property {object} [action] The action type of a rule collection + * @property {string} [action.type] The type of action. Possible values * include: 'Allow', 'Deny' - * @member {array} [rules] Collection of rules used by a network rule + * @property {array} [rules] Collection of rules used by a network rule * collection. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [name] Gets name of the resource that is unique within + * a resource group. This name can be used to access the resource. + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureFirewallRCAction.js b/lib/services/networkManagement2/lib/models/azureFirewallRCAction.js index 24277357c5..ab9dfbe700 100644 --- a/lib/services/networkManagement2/lib/models/azureFirewallRCAction.js +++ b/lib/services/networkManagement2/lib/models/azureFirewallRCAction.js @@ -17,7 +17,7 @@ class AzureFirewallRCAction { /** * Create a AzureFirewallRCAction. - * @member {string} [type] The type of action. Possible values include: + * @property {string} [type] The type of action. Possible values include: * 'Allow', 'Deny' */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureReachabilityReport.js b/lib/services/networkManagement2/lib/models/azureReachabilityReport.js index 86f22b30c6..02d1416d65 100644 --- a/lib/services/networkManagement2/lib/models/azureReachabilityReport.js +++ b/lib/services/networkManagement2/lib/models/azureReachabilityReport.js @@ -17,13 +17,13 @@ class AzureReachabilityReport { /** * Create a AzureReachabilityReport. - * @member {string} aggregationLevel The aggregation level of Azure + * @property {string} aggregationLevel The aggregation level of Azure * reachability report. Can be Country, State or City. - * @member {object} providerLocation - * @member {string} [providerLocation.country] The name of the country. - * @member {string} [providerLocation.state] The name of the state. - * @member {string} [providerLocation.city] The name of the city or town. - * @member {array} reachabilityReport List of Azure reachability report + * @property {object} providerLocation + * @property {string} [providerLocation.country] The name of the country. + * @property {string} [providerLocation.state] The name of the state. + * @property {string} [providerLocation.city] The name of the city or town. + * @property {array} reachabilityReport List of Azure reachability report * items. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureReachabilityReportItem.js b/lib/services/networkManagement2/lib/models/azureReachabilityReportItem.js index d38aa28cb1..ab000ae159 100644 --- a/lib/services/networkManagement2/lib/models/azureReachabilityReportItem.js +++ b/lib/services/networkManagement2/lib/models/azureReachabilityReportItem.js @@ -17,9 +17,9 @@ class AzureReachabilityReportItem { /** * Create a AzureReachabilityReportItem. - * @member {string} [provider] The Internet service provider. - * @member {string} [azureLocation] The Azure region. - * @member {array} [latencies] List of latency details for each of the time + * @property {string} [provider] The Internet service provider. + * @property {string} [azureLocation] The Azure region. + * @property {array} [latencies] List of latency details for each of the time * series. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureReachabilityReportLatencyInfo.js b/lib/services/networkManagement2/lib/models/azureReachabilityReportLatencyInfo.js index 48dab9ab63..aec147f044 100644 --- a/lib/services/networkManagement2/lib/models/azureReachabilityReportLatencyInfo.js +++ b/lib/services/networkManagement2/lib/models/azureReachabilityReportLatencyInfo.js @@ -17,8 +17,8 @@ class AzureReachabilityReportLatencyInfo { /** * Create a AzureReachabilityReportLatencyInfo. - * @member {date} [timeStamp] The time stamp. - * @member {number} [score] The relative latency score between 1 and 100, + * @property {date} [timeStamp] The time stamp. + * @property {number} [score] The relative latency score between 1 and 100, * higher values indicating a faster connection. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/azureReachabilityReportLocation.js b/lib/services/networkManagement2/lib/models/azureReachabilityReportLocation.js index 07582ba250..8264f28a94 100644 --- a/lib/services/networkManagement2/lib/models/azureReachabilityReportLocation.js +++ b/lib/services/networkManagement2/lib/models/azureReachabilityReportLocation.js @@ -17,9 +17,9 @@ class AzureReachabilityReportLocation { /** * Create a AzureReachabilityReportLocation. - * @member {string} country The name of the country. - * @member {string} [state] The name of the state. - * @member {string} [city] The name of the city or town. + * @property {string} country The name of the country. + * @property {string} [state] The name of the state. + * @property {string} [city] The name of the city or town. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/azureReachabilityReportParameters.js b/lib/services/networkManagement2/lib/models/azureReachabilityReportParameters.js index b1af30de76..8d339681ac 100644 --- a/lib/services/networkManagement2/lib/models/azureReachabilityReportParameters.js +++ b/lib/services/networkManagement2/lib/models/azureReachabilityReportParameters.js @@ -17,15 +17,16 @@ class AzureReachabilityReportParameters { /** * Create a AzureReachabilityReportParameters. - * @member {object} providerLocation - * @member {string} [providerLocation.country] The name of the country. - * @member {string} [providerLocation.state] The name of the state. - * @member {string} [providerLocation.city] The name of the city or town. - * @member {array} [providers] List of Internet service providers. - * @member {array} [azureLocations] Optional Azure regions to scope the query - * to. - * @member {date} startTime The start time for the Azure reachability report. - * @member {date} endTime The end time for the Azure reachability report. + * @property {object} providerLocation + * @property {string} [providerLocation.country] The name of the country. + * @property {string} [providerLocation.state] The name of the state. + * @property {string} [providerLocation.city] The name of the city or town. + * @property {array} [providers] List of Internet service providers. + * @property {array} [azureLocations] Optional Azure regions to scope the + * query to. + * @property {date} startTime The start time for the Azure reachability + * report. + * @property {date} endTime The end time for the Azure reachability report. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/bGPCommunity.js b/lib/services/networkManagement2/lib/models/bGPCommunity.js index aba7366bf6..584045928b 100644 --- a/lib/services/networkManagement2/lib/models/bGPCommunity.js +++ b/lib/services/networkManagement2/lib/models/bGPCommunity.js @@ -17,18 +17,18 @@ class BGPCommunity { /** * Create a BGPCommunity. - * @member {string} [serviceSupportedRegion] The region which the service + * @property {string} [serviceSupportedRegion] The region which the service * support. e.g. For O365, region is Global. - * @member {string} [communityName] The name of the bgp community. e.g. + * @property {string} [communityName] The name of the bgp community. e.g. * Skype. - * @member {string} [communityValue] The value of the bgp community. For more - * information: + * @property {string} [communityValue] The value of the bgp community. For + * more information: * https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing. - * @member {array} [communityPrefixes] The prefixes that the bgp community + * @property {array} [communityPrefixes] The prefixes that the bgp community * contains. - * @member {boolean} [isAuthorizedToUse] Customer is authorized to use bgp + * @property {boolean} [isAuthorizedToUse] Customer is authorized to use bgp * community or not. - * @member {string} [serviceGroup] The service group of the bgp community + * @property {string} [serviceGroup] The service group of the bgp community * contains. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/backendAddressPool.js b/lib/services/networkManagement2/lib/models/backendAddressPool.js index 5a8cd61113..40d749467b 100644 --- a/lib/services/networkManagement2/lib/models/backendAddressPool.js +++ b/lib/services/networkManagement2/lib/models/backendAddressPool.js @@ -20,18 +20,19 @@ const models = require('./index'); class BackendAddressPool extends models['SubResource'] { /** * Create a BackendAddressPool. - * @member {array} [backendIPConfigurations] Gets collection of references to - * IP addresses defined in network interfaces. - * @member {array} [loadBalancingRules] Gets load balancing rules that use + * @property {array} [backendIPConfigurations] Gets collection of references + * to IP addresses defined in network interfaces. + * @property {array} [loadBalancingRules] Gets load balancing rules that use * this backend address pool. - * @member {object} [outboundRule] Gets outbound rules that use this backend - * address pool. - * @member {string} [outboundRule.id] Resource ID. - * @member {string} [provisioningState] Get provisioning state of the public - * IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {object} [outboundRule] Gets outbound rules that use this + * backend address pool. + * @property {string} [outboundRule.id] Resource ID. + * @property {string} [provisioningState] Get provisioning state of the + * public IP resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + * @property {string} [name] Gets name of the resource that is unique within + * a resource group. This name can be used to access the resource. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/bgpPeerStatus.js b/lib/services/networkManagement2/lib/models/bgpPeerStatus.js index 1bd7bbb91b..d0b7cbae4b 100644 --- a/lib/services/networkManagement2/lib/models/bgpPeerStatus.js +++ b/lib/services/networkManagement2/lib/models/bgpPeerStatus.js @@ -17,17 +17,19 @@ class BgpPeerStatus { /** * Create a BgpPeerStatus. - * @member {string} [localAddress] The virtual network gateway's local + * @property {string} [localAddress] The virtual network gateway's local * address - * @member {string} [neighbor] The remote BGP peer - * @member {number} [asn] The autonomous system number of the remote BGP peer - * @member {string} [state] The BGP peer state. Possible values include: + * @property {string} [neighbor] The remote BGP peer + * @property {number} [asn] The autonomous system number of the remote BGP + * peer + * @property {string} [state] The BGP peer state. Possible values include: * 'Unknown', 'Stopped', 'Idle', 'Connecting', 'Connected' - * @member {string} [connectedDuration] For how long the peering has been up - * @member {number} [routesReceived] The number of routes learned from this + * @property {string} [connectedDuration] For how long the peering has been + * up + * @property {number} [routesReceived] The number of routes learned from this * peer - * @member {number} [messagesSent] The number of BGP messages sent - * @member {number} [messagesReceived] The number of BGP messages received + * @property {number} [messagesSent] The number of BGP messages sent + * @property {number} [messagesReceived] The number of BGP messages received */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/bgpPeerStatusListResult.js b/lib/services/networkManagement2/lib/models/bgpPeerStatusListResult.js index 6f88edd3bc..53008c42f3 100644 --- a/lib/services/networkManagement2/lib/models/bgpPeerStatusListResult.js +++ b/lib/services/networkManagement2/lib/models/bgpPeerStatusListResult.js @@ -17,7 +17,7 @@ class BgpPeerStatusListResult { /** * Create a BgpPeerStatusListResult. - * @member {array} [value] List of BGP peers + * @property {array} [value] List of BGP peers */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/bgpServiceCommunity.js b/lib/services/networkManagement2/lib/models/bgpServiceCommunity.js index 4a174fe080..c9c2ae3dc1 100644 --- a/lib/services/networkManagement2/lib/models/bgpServiceCommunity.js +++ b/lib/services/networkManagement2/lib/models/bgpServiceCommunity.js @@ -20,8 +20,9 @@ const models = require('./index'); class BgpServiceCommunity extends models['Resource'] { /** * Create a BgpServiceCommunity. - * @member {string} [serviceName] The name of the bgp community. e.g. Skype. - * @member {array} [bgpCommunities] Get a list of bgp communities. + * @property {string} [serviceName] The name of the bgp community. e.g. + * Skype. + * @property {array} [bgpCommunities] Get a list of bgp communities. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/bgpServiceCommunityListResult.js b/lib/services/networkManagement2/lib/models/bgpServiceCommunityListResult.js index 7db298d442..b7699fc2fa 100644 --- a/lib/services/networkManagement2/lib/models/bgpServiceCommunityListResult.js +++ b/lib/services/networkManagement2/lib/models/bgpServiceCommunityListResult.js @@ -16,7 +16,7 @@ class BgpServiceCommunityListResult extends Array { /** * Create a BgpServiceCommunityListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/bgpSettings.js b/lib/services/networkManagement2/lib/models/bgpSettings.js index dca7b0f07c..331a92538f 100644 --- a/lib/services/networkManagement2/lib/models/bgpSettings.js +++ b/lib/services/networkManagement2/lib/models/bgpSettings.js @@ -17,11 +17,11 @@ class BgpSettings { /** * Create a BgpSettings. - * @member {number} [asn] The BGP speaker's ASN. - * @member {string} [bgpPeeringAddress] The BGP peering address and BGP + * @property {number} [asn] The BGP speaker's ASN. + * @property {string} [bgpPeeringAddress] The BGP peering address and BGP * identifier of this BGP speaker. - * @member {number} [peerWeight] The weight added to routes learned from this - * BGP speaker. + * @property {number} [peerWeight] The weight added to routes learned from + * this BGP speaker. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/connectionMonitor.js b/lib/services/networkManagement2/lib/models/connectionMonitor.js index b06a91828f..a1bffd79e1 100644 --- a/lib/services/networkManagement2/lib/models/connectionMonitor.js +++ b/lib/services/networkManagement2/lib/models/connectionMonitor.js @@ -17,22 +17,23 @@ class ConnectionMonitor { /** * Create a ConnectionMonitor. - * @member {string} [location] Connection monitor location. - * @member {object} [tags] Connection monitor tags. - * @member {object} source - * @member {string} [source.resourceId] The ID of the resource used as the + * @property {string} [location] Connection monitor location. + * @property {object} [tags] Connection monitor tags. + * @property {object} source + * @property {string} [source.resourceId] The ID of the resource used as the * source by connection monitor. - * @member {number} [source.port] The source port used by connection monitor. - * @member {object} destination - * @member {string} [destination.resourceId] The ID of the resource used as + * @property {number} [source.port] The source port used by connection + * monitor. + * @property {object} destination + * @property {string} [destination.resourceId] The ID of the resource used as * the destination by connection monitor. - * @member {string} [destination.address] Address of the connection monitor + * @property {string} [destination.address] Address of the connection monitor * destination (IP or domain name). - * @member {number} [destination.port] The destination port used by + * @property {number} [destination.port] The destination port used by * connection monitor. - * @member {boolean} [autoStart] Determines if the connection monitor will + * @property {boolean} [autoStart] Determines if the connection monitor will * start automatically once created. Default value: true . - * @member {number} [monitoringIntervalInSeconds] Monitoring interval in + * @property {number} [monitoringIntervalInSeconds] Monitoring interval in * seconds. Default value: 60 . */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/connectionMonitorDestination.js b/lib/services/networkManagement2/lib/models/connectionMonitorDestination.js index 063b721c85..4d4244d8e8 100644 --- a/lib/services/networkManagement2/lib/models/connectionMonitorDestination.js +++ b/lib/services/networkManagement2/lib/models/connectionMonitorDestination.js @@ -17,11 +17,11 @@ class ConnectionMonitorDestination { /** * Create a ConnectionMonitorDestination. - * @member {string} [resourceId] The ID of the resource used as the + * @property {string} [resourceId] The ID of the resource used as the * destination by connection monitor. - * @member {string} [address] Address of the connection monitor destination + * @property {string} [address] Address of the connection monitor destination * (IP or domain name). - * @member {number} [port] The destination port used by connection monitor. + * @property {number} [port] The destination port used by connection monitor. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/connectionMonitorParameters.js b/lib/services/networkManagement2/lib/models/connectionMonitorParameters.js index 03420b8a79..7aa5127e9e 100644 --- a/lib/services/networkManagement2/lib/models/connectionMonitorParameters.js +++ b/lib/services/networkManagement2/lib/models/connectionMonitorParameters.js @@ -17,20 +17,21 @@ class ConnectionMonitorParameters { /** * Create a ConnectionMonitorParameters. - * @member {object} source - * @member {string} [source.resourceId] The ID of the resource used as the + * @property {object} source + * @property {string} [source.resourceId] The ID of the resource used as the * source by connection monitor. - * @member {number} [source.port] The source port used by connection monitor. - * @member {object} destination - * @member {string} [destination.resourceId] The ID of the resource used as + * @property {number} [source.port] The source port used by connection + * monitor. + * @property {object} destination + * @property {string} [destination.resourceId] The ID of the resource used as * the destination by connection monitor. - * @member {string} [destination.address] Address of the connection monitor + * @property {string} [destination.address] Address of the connection monitor * destination (IP or domain name). - * @member {number} [destination.port] The destination port used by + * @property {number} [destination.port] The destination port used by * connection monitor. - * @member {boolean} [autoStart] Determines if the connection monitor will + * @property {boolean} [autoStart] Determines if the connection monitor will * start automatically once created. Default value: true . - * @member {number} [monitoringIntervalInSeconds] Monitoring interval in + * @property {number} [monitoringIntervalInSeconds] Monitoring interval in * seconds. Default value: 60 . */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/connectionMonitorQueryResult.js b/lib/services/networkManagement2/lib/models/connectionMonitorQueryResult.js index 1e0ab5b2d4..5bc4876daf 100644 --- a/lib/services/networkManagement2/lib/models/connectionMonitorQueryResult.js +++ b/lib/services/networkManagement2/lib/models/connectionMonitorQueryResult.js @@ -17,9 +17,9 @@ class ConnectionMonitorQueryResult { /** * Create a ConnectionMonitorQueryResult. - * @member {string} [sourceStatus] Status of connection monitor source. + * @property {string} [sourceStatus] Status of connection monitor source. * Possible values include: 'Uknown', 'Active', 'Inactive' - * @member {array} [states] Information about connection states. + * @property {array} [states] Information about connection states. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/connectionMonitorResult.js b/lib/services/networkManagement2/lib/models/connectionMonitorResult.js index a26ce4b8f8..8ab04ca112 100644 --- a/lib/services/networkManagement2/lib/models/connectionMonitorResult.js +++ b/lib/services/networkManagement2/lib/models/connectionMonitorResult.js @@ -20,34 +20,35 @@ const models = require('./index'); class ConnectionMonitorResult extends models['BaseResource'] { /** * Create a ConnectionMonitorResult. - * @member {string} [name] Name of the connection monitor. - * @member {string} [id] ID of the connection monitor. - * @member {string} [etag] Default value: 'A unique read-only string that + * @property {string} [name] Name of the connection monitor. + * @property {string} [id] ID of the connection monitor. + * @property {string} [etag] Default value: 'A unique read-only string that * changes whenever the resource is updated.' . - * @member {string} [type] Connection monitor type. - * @member {string} [location] Connection monitor location. - * @member {object} [tags] Connection monitor tags. - * @member {object} source - * @member {string} [source.resourceId] The ID of the resource used as the + * @property {string} [type] Connection monitor type. + * @property {string} [location] Connection monitor location. + * @property {object} [tags] Connection monitor tags. + * @property {object} source + * @property {string} [source.resourceId] The ID of the resource used as the * source by connection monitor. - * @member {number} [source.port] The source port used by connection monitor. - * @member {object} destination - * @member {string} [destination.resourceId] The ID of the resource used as + * @property {number} [source.port] The source port used by connection + * monitor. + * @property {object} destination + * @property {string} [destination.resourceId] The ID of the resource used as * the destination by connection monitor. - * @member {string} [destination.address] Address of the connection monitor + * @property {string} [destination.address] Address of the connection monitor * destination (IP or domain name). - * @member {number} [destination.port] The destination port used by + * @property {number} [destination.port] The destination port used by * connection monitor. - * @member {boolean} [autoStart] Determines if the connection monitor will + * @property {boolean} [autoStart] Determines if the connection monitor will * start automatically once created. Default value: true . - * @member {number} [monitoringIntervalInSeconds] Monitoring interval in + * @property {number} [monitoringIntervalInSeconds] Monitoring interval in * seconds. Default value: 60 . - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * connection monitor. Possible values include: 'Succeeded', 'Updating', * 'Deleting', 'Failed' - * @member {date} [startTime] The date and time when the connection monitor + * @property {date} [startTime] The date and time when the connection monitor * was started. - * @member {string} [monitoringStatus] The monitoring status of the + * @property {string} [monitoringStatus] The monitoring status of the * connection monitor. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/connectionMonitorSource.js b/lib/services/networkManagement2/lib/models/connectionMonitorSource.js index 135c604d84..9d4eda3dd0 100644 --- a/lib/services/networkManagement2/lib/models/connectionMonitorSource.js +++ b/lib/services/networkManagement2/lib/models/connectionMonitorSource.js @@ -17,9 +17,9 @@ class ConnectionMonitorSource { /** * Create a ConnectionMonitorSource. - * @member {string} resourceId The ID of the resource used as the source by + * @property {string} resourceId The ID of the resource used as the source by * connection monitor. - * @member {number} [port] The source port used by connection monitor. + * @property {number} [port] The source port used by connection monitor. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/connectionResetSharedKey.js b/lib/services/networkManagement2/lib/models/connectionResetSharedKey.js index 1e6a955c42..e415344c6a 100644 --- a/lib/services/networkManagement2/lib/models/connectionResetSharedKey.js +++ b/lib/services/networkManagement2/lib/models/connectionResetSharedKey.js @@ -17,8 +17,8 @@ class ConnectionResetSharedKey { /** * Create a ConnectionResetSharedKey. - * @member {number} keyLength The virtual network connection reset shared key - * length, should between 1 and 128. + * @property {number} keyLength The virtual network connection reset shared + * key length, should between 1 and 128. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/connectionSharedKey.js b/lib/services/networkManagement2/lib/models/connectionSharedKey.js index ad71412918..b40c68ad81 100644 --- a/lib/services/networkManagement2/lib/models/connectionSharedKey.js +++ b/lib/services/networkManagement2/lib/models/connectionSharedKey.js @@ -20,7 +20,7 @@ const models = require('./index'); class ConnectionSharedKey extends models['SubResource'] { /** * Create a ConnectionSharedKey. - * @member {string} value The virtual network connection shared key value. + * @property {string} value The virtual network connection shared key value. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/connectionStateSnapshot.js b/lib/services/networkManagement2/lib/models/connectionStateSnapshot.js index a2cd99c87a..b085793cc7 100644 --- a/lib/services/networkManagement2/lib/models/connectionStateSnapshot.js +++ b/lib/services/networkManagement2/lib/models/connectionStateSnapshot.js @@ -17,18 +17,18 @@ class ConnectionStateSnapshot { /** * Create a ConnectionStateSnapshot. - * @member {string} [connectionState] The connection state. Possible values + * @property {string} [connectionState] The connection state. Possible values * include: 'Reachable', 'Unreachable', 'Unknown' - * @member {date} [startTime] The start time of the connection snapshot. - * @member {date} [endTime] The end time of the connection snapshot. - * @member {string} [evaluationState] Connectivity analysis evaluation state. - * Possible values include: 'NotStarted', 'InProgress', 'Completed' - * @member {number} [avgLatencyInMs] Average latency in ms. - * @member {number} [minLatencyInMs] Minimum latency in ms. - * @member {number} [maxLatencyInMs] Maximum latency in ms. - * @member {number} [probesSent] The number of sent probes. - * @member {number} [probesFailed] The number of failed probes. - * @member {array} [hops] List of hops between the source and the + * @property {date} [startTime] The start time of the connection snapshot. + * @property {date} [endTime] The end time of the connection snapshot. + * @property {string} [evaluationState] Connectivity analysis evaluation + * state. Possible values include: 'NotStarted', 'InProgress', 'Completed' + * @property {number} [avgLatencyInMs] Average latency in ms. + * @property {number} [minLatencyInMs] Minimum latency in ms. + * @property {number} [maxLatencyInMs] Maximum latency in ms. + * @property {number} [probesSent] The number of sent probes. + * @property {number} [probesFailed] The number of failed probes. + * @property {array} [hops] List of hops between the source and the * destination. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/connectivityDestination.js b/lib/services/networkManagement2/lib/models/connectivityDestination.js index e5fa257881..ab5bea2890 100644 --- a/lib/services/networkManagement2/lib/models/connectivityDestination.js +++ b/lib/services/networkManagement2/lib/models/connectivityDestination.js @@ -17,11 +17,11 @@ class ConnectivityDestination { /** * Create a ConnectivityDestination. - * @member {string} [resourceId] The ID of the resource to which a connection - * attempt will be made. - * @member {string} [address] The IP address or URI the resource to which a + * @property {string} [resourceId] The ID of the resource to which a * connection attempt will be made. - * @member {number} [port] Port on which check connectivity will be + * @property {string} [address] The IP address or URI the resource to which a + * connection attempt will be made. + * @property {number} [port] Port on which check connectivity will be * performed. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/connectivityHop.js b/lib/services/networkManagement2/lib/models/connectivityHop.js index 0d5bd5b0e4..6e53507d69 100644 --- a/lib/services/networkManagement2/lib/models/connectivityHop.js +++ b/lib/services/networkManagement2/lib/models/connectivityHop.js @@ -17,13 +17,13 @@ class ConnectivityHop { /** * Create a ConnectivityHop. - * @member {string} [type] The type of the hop. - * @member {string} [id] The ID of the hop. - * @member {string} [address] The IP address of the hop. - * @member {string} [resourceId] The ID of the resource corresponding to this - * hop. - * @member {array} [nextHopIds] List of next hop identifiers. - * @member {array} [issues] List of issues. + * @property {string} [type] The type of the hop. + * @property {string} [id] The ID of the hop. + * @property {string} [address] The IP address of the hop. + * @property {string} [resourceId] The ID of the resource corresponding to + * this hop. + * @property {array} [nextHopIds] List of next hop identifiers. + * @property {array} [issues] List of issues. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/connectivityInformation.js b/lib/services/networkManagement2/lib/models/connectivityInformation.js index f94db0d997..9f95640699 100644 --- a/lib/services/networkManagement2/lib/models/connectivityInformation.js +++ b/lib/services/networkManagement2/lib/models/connectivityInformation.js @@ -17,15 +17,15 @@ class ConnectivityInformation { /** * Create a ConnectivityInformation. - * @member {array} [hops] List of hops between the source and the + * @property {array} [hops] List of hops between the source and the * destination. - * @member {string} [connectionStatus] The connection status. Possible values - * include: 'Unknown', 'Connected', 'Disconnected', 'Degraded' - * @member {number} [avgLatencyInMs] Average latency in milliseconds. - * @member {number} [minLatencyInMs] Minimum latency in milliseconds. - * @member {number} [maxLatencyInMs] Maximum latency in milliseconds. - * @member {number} [probesSent] Total number of probes sent. - * @member {number} [probesFailed] Number of failed probes. + * @property {string} [connectionStatus] The connection status. Possible + * values include: 'Unknown', 'Connected', 'Disconnected', 'Degraded' + * @property {number} [avgLatencyInMs] Average latency in milliseconds. + * @property {number} [minLatencyInMs] Minimum latency in milliseconds. + * @property {number} [maxLatencyInMs] Maximum latency in milliseconds. + * @property {number} [probesSent] Total number of probes sent. + * @property {number} [probesFailed] Number of failed probes. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/connectivityIssue.js b/lib/services/networkManagement2/lib/models/connectivityIssue.js index 573c4f2c17..b2b557f0d5 100644 --- a/lib/services/networkManagement2/lib/models/connectivityIssue.js +++ b/lib/services/networkManagement2/lib/models/connectivityIssue.js @@ -18,14 +18,14 @@ class ConnectivityIssue { /** * Create a ConnectivityIssue. - * @member {string} [origin] The origin of the issue. Possible values + * @property {string} [origin] The origin of the issue. Possible values * include: 'Local', 'Inbound', 'Outbound' - * @member {string} [severity] The severity of the issue. Possible values + * @property {string} [severity] The severity of the issue. Possible values * include: 'Error', 'Warning' - * @member {string} [type] The type of issue. Possible values include: + * @property {string} [type] The type of issue. Possible values include: * 'Unknown', 'AgentStopped', 'GuestFirewall', 'DnsResolution', 'SocketBind', * 'NetworkSecurityRule', 'UserDefinedRoute', 'PortThrottled', 'Platform' - * @member {array} [context] Provides additional context on the issue. + * @property {array} [context] Provides additional context on the issue. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/connectivityParameters.js b/lib/services/networkManagement2/lib/models/connectivityParameters.js index fc29ad6778..3892d2b8b5 100644 --- a/lib/services/networkManagement2/lib/models/connectivityParameters.js +++ b/lib/services/networkManagement2/lib/models/connectivityParameters.js @@ -17,28 +17,29 @@ class ConnectivityParameters { /** * Create a ConnectivityParameters. - * @member {object} source - * @member {string} [source.resourceId] The ID of the resource from which a + * @property {object} source + * @property {string} [source.resourceId] The ID of the resource from which a * connectivity check will be initiated. - * @member {number} [source.port] The source port from which a connectivity + * @property {number} [source.port] The source port from which a connectivity * check will be performed. - * @member {object} destination - * @member {string} [destination.resourceId] The ID of the resource to which - * a connection attempt will be made. - * @member {string} [destination.address] The IP address or URI the resource - * to which a connection attempt will be made. - * @member {number} [destination.port] Port on which check connectivity will - * be performed. - * @member {string} [protocol] Network protocol. Possible values include: + * @property {object} destination + * @property {string} [destination.resourceId] The ID of the resource to + * which a connection attempt will be made. + * @property {string} [destination.address] The IP address or URI the + * resource to which a connection attempt will be made. + * @property {number} [destination.port] Port on which check connectivity + * will be performed. + * @property {string} [protocol] Network protocol. Possible values include: * 'Tcp', 'Http', 'Https', 'Icmp' - * @member {object} [protocolConfiguration] - * @member {object} [protocolConfiguration.hTTPConfiguration] - * @member {string} [protocolConfiguration.hTTPConfiguration.method] HTTP + * @property {object} [protocolConfiguration] + * @property {object} [protocolConfiguration.hTTPConfiguration] + * @property {string} [protocolConfiguration.hTTPConfiguration.method] HTTP * method. Possible values include: 'Get' - * @member {array} [protocolConfiguration.hTTPConfiguration.headers] List of - * HTTP headers. - * @member {array} [protocolConfiguration.hTTPConfiguration.validStatusCodes] - * Valid status codes. + * @property {array} [protocolConfiguration.hTTPConfiguration.headers] List + * of HTTP headers. + * @property {array} + * [protocolConfiguration.hTTPConfiguration.validStatusCodes] Valid status + * codes. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/connectivitySource.js b/lib/services/networkManagement2/lib/models/connectivitySource.js index a27b2ab62e..9f86790764 100644 --- a/lib/services/networkManagement2/lib/models/connectivitySource.js +++ b/lib/services/networkManagement2/lib/models/connectivitySource.js @@ -17,9 +17,9 @@ class ConnectivitySource { /** * Create a ConnectivitySource. - * @member {string} resourceId The ID of the resource from which a + * @property {string} resourceId The ID of the resource from which a * connectivity check will be initiated. - * @member {number} [port] The source port from which a connectivity check + * @property {number} [port] The source port from which a connectivity check * will be performed. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/containerNetworkInterface.js b/lib/services/networkManagement2/lib/models/containerNetworkInterface.js index 9d4761f79d..8daec95b31 100644 --- a/lib/services/networkManagement2/lib/models/containerNetworkInterface.js +++ b/lib/services/networkManagement2/lib/models/containerNetworkInterface.js @@ -20,35 +20,35 @@ const models = require('./index'); class ContainerNetworkInterface extends models['SubResource'] { /** * Create a ContainerNetworkInterface. - * @member {object} [containerNetworkInterfaceConfiguration] Container + * @property {object} [containerNetworkInterfaceConfiguration] Container * network interface configuration from which this container network * interface is created. - * @member {array} [containerNetworkInterfaceConfiguration.ipConfigurations] - * A list of ip configurations of the container network interface - * configuration. - * @member {array} + * @property {array} + * [containerNetworkInterfaceConfiguration.ipConfigurations] A list of ip + * configurations of the container network interface configuration. + * @property {array} * [containerNetworkInterfaceConfiguration.containerNetworkInterfaces] A list * of container network interfaces created from this container network * interface configuration. - * @member {string} + * @property {string} * [containerNetworkInterfaceConfiguration.provisioningState] The * provisioning state of the resource. - * @member {string} [containerNetworkInterfaceConfiguration.name] The name of - * the resource. This name can be used to access the resource. - * @member {string} [containerNetworkInterfaceConfiguration.type] Sub + * @property {string} [containerNetworkInterfaceConfiguration.name] The name + * of the resource. This name can be used to access the resource. + * @property {string} [containerNetworkInterfaceConfiguration.type] Sub * Resource type. - * @member {string} [containerNetworkInterfaceConfiguration.etag] A unique + * @property {string} [containerNetworkInterfaceConfiguration.etag] A unique * read-only string that changes whenever the resource is updated. - * @member {object} [container] Reference to the conatinaer to which this + * @property {object} [container] Reference to the conatinaer to which this * container network interface is attached. - * @member {array} [ipConfigurations] Reference to the ip configuration on + * @property {array} [ipConfigurations] Reference to the ip configuration on * this container nic. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. - * @member {string} [name] The name of the resource. This name can be used to - * access the resource. - * @member {string} [type] Sub Resource type. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] The name of the resource. This name can be used + * to access the resource. + * @property {string} [type] Sub Resource type. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/containerNetworkInterfaceConfiguration.js b/lib/services/networkManagement2/lib/models/containerNetworkInterfaceConfiguration.js index f04d85e6e8..701851a1da 100644 --- a/lib/services/networkManagement2/lib/models/containerNetworkInterfaceConfiguration.js +++ b/lib/services/networkManagement2/lib/models/containerNetworkInterfaceConfiguration.js @@ -20,16 +20,16 @@ const models = require('./index'); class ContainerNetworkInterfaceConfiguration extends models['SubResource'] { /** * Create a ContainerNetworkInterfaceConfiguration. - * @member {array} [ipConfigurations] A list of ip configurations of the + * @property {array} [ipConfigurations] A list of ip configurations of the * container network interface configuration. - * @member {array} [containerNetworkInterfaces] A list of container network + * @property {array} [containerNetworkInterfaces] A list of container network * interfaces created from this container network interface configuration. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. - * @member {string} [name] The name of the resource. This name can be used to - * access the resource. - * @member {string} [type] Sub Resource type. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] The name of the resource. This name can be used + * to access the resource. + * @property {string} [type] Sub Resource type. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { @@ -79,10 +79,10 @@ class ContainerNetworkInterfaceConfiguration extends models['SubResource'] { name: 'Sequence', element: { required: false, - serializedName: 'ContainerNetworkInterfaceElementType', + serializedName: 'SubResourceElementType', type: { name: 'Composite', - className: 'ContainerNetworkInterface' + className: 'SubResource' } } } diff --git a/lib/services/networkManagement2/lib/models/containerNetworkInterfaceIpConfiguration.js b/lib/services/networkManagement2/lib/models/containerNetworkInterfaceIpConfiguration.js index 26abb4593d..4cb277ab55 100644 --- a/lib/services/networkManagement2/lib/models/containerNetworkInterfaceIpConfiguration.js +++ b/lib/services/networkManagement2/lib/models/containerNetworkInterfaceIpConfiguration.js @@ -17,12 +17,12 @@ class ContainerNetworkInterfaceIpConfiguration { /** * Create a ContainerNetworkInterfaceIpConfiguration. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. - * @member {string} [name] The name of the resource. This name can be used to - * access the resource. - * @member {string} [type] Sub Resource type. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] The name of the resource. This name can be used + * to access the resource. + * @property {string} [type] Sub Resource type. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/ddosProtectionPlan.js b/lib/services/networkManagement2/lib/models/ddosProtectionPlan.js index 562069dfc6..dcbd8362bf 100644 --- a/lib/services/networkManagement2/lib/models/ddosProtectionPlan.js +++ b/lib/services/networkManagement2/lib/models/ddosProtectionPlan.js @@ -20,21 +20,21 @@ const models = require('./index'); class DdosProtectionPlan extends models['BaseResource'] { /** * Create a DdosProtectionPlan. - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. - * @member {string} [location] Resource location. - * @member {object} [tags] Resource tags. - * @member {string} [resourceGuid] The resource GUID property of the DDoS + * @property {string} [id] Resource ID. + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. + * @property {string} [location] Resource location. + * @property {object} [tags] Resource tags. + * @property {string} [resourceGuid] The resource GUID property of the DDoS * protection plan resource. It uniquely identifies the resource, even if the * user changes its name or migrate the resource across subscriptions or * resource groups. - * @member {string} [provisioningState] The provisioning state of the DDoS + * @property {string} [provisioningState] The provisioning state of the DDoS * protection plan resource. Possible values are: 'Succeeded', 'Updating', * 'Deleting', and 'Failed'. - * @member {array} [virtualNetworks] The list of virtual networks associated - * with the DDoS protection plan resource. This list is read-only. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {array} [virtualNetworks] The list of virtual networks + * associated with the DDoS protection plan resource. This list is read-only. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/ddosProtectionPlanListResult.js b/lib/services/networkManagement2/lib/models/ddosProtectionPlanListResult.js index 076979f5cd..cdc43f84d2 100644 --- a/lib/services/networkManagement2/lib/models/ddosProtectionPlanListResult.js +++ b/lib/services/networkManagement2/lib/models/ddosProtectionPlanListResult.js @@ -16,7 +16,7 @@ class DdosProtectionPlanListResult extends Array { /** * Create a DdosProtectionPlanListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/delegation.js b/lib/services/networkManagement2/lib/models/delegation.js index 1910cda4c3..9df672a3cb 100644 --- a/lib/services/networkManagement2/lib/models/delegation.js +++ b/lib/services/networkManagement2/lib/models/delegation.js @@ -20,15 +20,15 @@ const models = require('./index'); class Delegation extends models['SubResource'] { /** * Create a Delegation. - * @member {string} [serviceName] The name of the service to whom the subnet - * should be delegated (e.g. Microsoft.Sql/servers) - * @member {array} [actions] Describes the actions permitted to the service + * @property {string} [serviceName] The name of the service to whom the + * subnet should be delegated (e.g. Microsoft.Sql/servers) + * @property {array} [actions] Describes the actions permitted to the service * upon delegation - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * subnet. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/deviceProperties.js b/lib/services/networkManagement2/lib/models/deviceProperties.js index c9652c5cd9..f92d076407 100644 --- a/lib/services/networkManagement2/lib/models/deviceProperties.js +++ b/lib/services/networkManagement2/lib/models/deviceProperties.js @@ -17,9 +17,9 @@ class DeviceProperties { /** * Create a DeviceProperties. - * @member {string} [deviceVendor] Name of the device Vendor. - * @member {string} [deviceModel] Model of the device. - * @member {number} [linkSpeedInMbps] Link speed. + * @property {string} [deviceVendor] Name of the device Vendor. + * @property {string} [deviceModel] Model of the device. + * @property {number} [linkSpeedInMbps] Link speed. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/dhcpOptions.js b/lib/services/networkManagement2/lib/models/dhcpOptions.js index a610247325..cd4ced7c41 100644 --- a/lib/services/networkManagement2/lib/models/dhcpOptions.js +++ b/lib/services/networkManagement2/lib/models/dhcpOptions.js @@ -19,7 +19,7 @@ class DhcpOptions { /** * Create a DhcpOptions. - * @member {array} [dnsServers] The list of DNS servers IP addresses. + * @property {array} [dnsServers] The list of DNS servers IP addresses. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/dimension.js b/lib/services/networkManagement2/lib/models/dimension.js index 2f79fd6dd3..47c4c2a81e 100644 --- a/lib/services/networkManagement2/lib/models/dimension.js +++ b/lib/services/networkManagement2/lib/models/dimension.js @@ -17,9 +17,9 @@ class Dimension { /** * Create a Dimension. - * @member {string} [name] The name of the dimension. - * @member {string} [displayName] The display name of the dimension. - * @member {string} [internalName] The internal name of the dimension. + * @property {string} [name] The name of the dimension. + * @property {string} [displayName] The display name of the dimension. + * @property {string} [internalName] The internal name of the dimension. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/dnsNameAvailabilityResult.js b/lib/services/networkManagement2/lib/models/dnsNameAvailabilityResult.js index 4e6553cf7c..3c73b6c142 100644 --- a/lib/services/networkManagement2/lib/models/dnsNameAvailabilityResult.js +++ b/lib/services/networkManagement2/lib/models/dnsNameAvailabilityResult.js @@ -17,7 +17,7 @@ class DnsNameAvailabilityResult { /** * Create a DnsNameAvailabilityResult. - * @member {boolean} [available] Domain availability (True/False). + * @property {boolean} [available] Domain availability (True/False). */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroup.js b/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroup.js index 579e6f5891..0c3a5ea487 100644 --- a/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroup.js +++ b/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroup.js @@ -17,19 +17,19 @@ class EffectiveNetworkSecurityGroup { /** * Create a EffectiveNetworkSecurityGroup. - * @member {object} [networkSecurityGroup] The ID of network security group + * @property {object} [networkSecurityGroup] The ID of network security group * that is applied. - * @member {string} [networkSecurityGroup.id] Resource ID. - * @member {object} [association] Associated resources. - * @member {object} [association.subnet] The ID of the subnet if assigned. - * @member {string} [association.subnet.id] Resource ID. - * @member {object} [association.networkInterface] The ID of the network + * @property {string} [networkSecurityGroup.id] Resource ID. + * @property {object} [association] Associated resources. + * @property {object} [association.subnet] The ID of the subnet if assigned. + * @property {string} [association.subnet.id] Resource ID. + * @property {object} [association.networkInterface] The ID of the network * interface if assigned. - * @member {string} [association.networkInterface.id] Resource ID. - * @member {array} [effectiveSecurityRules] A collection of effective + * @property {string} [association.networkInterface.id] Resource ID. + * @property {array} [effectiveSecurityRules] A collection of effective * security rules. - * @member {object} [tagMap] Mapping of tags to list of IP Addresses included - * within the tag. + * @property {object} [tagMap] Mapping of tags to list of IP Addresses + * included within the tag. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroupAssociation.js b/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroupAssociation.js index 4be7ab7fd7..080c896d1f 100644 --- a/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroupAssociation.js +++ b/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroupAssociation.js @@ -17,11 +17,11 @@ class EffectiveNetworkSecurityGroupAssociation { /** * Create a EffectiveNetworkSecurityGroupAssociation. - * @member {object} [subnet] The ID of the subnet if assigned. - * @member {string} [subnet.id] Resource ID. - * @member {object} [networkInterface] The ID of the network interface if + * @property {object} [subnet] The ID of the subnet if assigned. + * @property {string} [subnet.id] Resource ID. + * @property {object} [networkInterface] The ID of the network interface if * assigned. - * @member {string} [networkInterface.id] Resource ID. + * @property {string} [networkInterface.id] Resource ID. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroupListResult.js b/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroupListResult.js index 68e7060e7d..0db456ff34 100644 --- a/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroupListResult.js +++ b/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityGroupListResult.js @@ -17,8 +17,8 @@ class EffectiveNetworkSecurityGroupListResult { /** * Create a EffectiveNetworkSecurityGroupListResult. - * @member {array} [value] A list of effective network security groups. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {array} [value] A list of effective network security groups. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityRule.js b/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityRule.js index 736aa984d6..7e443c4728 100644 --- a/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityRule.js +++ b/lib/services/networkManagement2/lib/models/effectiveNetworkSecurityRule.js @@ -17,38 +17,38 @@ class EffectiveNetworkSecurityRule { /** * Create a EffectiveNetworkSecurityRule. - * @member {string} [name] The name of the security rule specified by the + * @property {string} [name] The name of the security rule specified by the * user (if created by the user). - * @member {string} [protocol] The network protocol this rule applies to. + * @property {string} [protocol] The network protocol this rule applies to. * Possible values are: 'Tcp', 'Udp', and 'All'. Possible values include: * 'Tcp', 'Udp', 'All' - * @member {string} [sourcePortRange] The source port or range. - * @member {string} [destinationPortRange] The destination port or range. - * @member {array} [sourcePortRanges] The source port ranges. Expected values - * include a single integer between 0 and 65535, a range using '-' as + * @property {string} [sourcePortRange] The source port or range. + * @property {string} [destinationPortRange] The destination port or range. + * @property {array} [sourcePortRanges] The source port ranges. Expected + * values include a single integer between 0 and 65535, a range using '-' as * seperator (e.g. 100-400), or an asterix (*) - * @member {array} [destinationPortRanges] The destination port ranges. + * @property {array} [destinationPortRanges] The destination port ranges. * Expected values include a single integer between 0 and 65535, a range * using '-' as seperator (e.g. 100-400), or an asterix (*) - * @member {string} [sourceAddressPrefix] The source address prefix. - * @member {string} [destinationAddressPrefix] The destination address + * @property {string} [sourceAddressPrefix] The source address prefix. + * @property {string} [destinationAddressPrefix] The destination address * prefix. - * @member {array} [sourceAddressPrefixes] The source address prefixes. + * @property {array} [sourceAddressPrefixes] The source address prefixes. * Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, * AureLoadBalancer, Internet), System Tags, and the asterix (*). - * @member {array} [destinationAddressPrefixes] The destination address + * @property {array} [destinationAddressPrefixes] The destination address * prefixes. Expected values include CIDR IP ranges, Default Tags * (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix * (*). - * @member {array} [expandedSourceAddressPrefix] The expanded source address - * prefix. - * @member {array} [expandedDestinationAddressPrefix] Expanded destination + * @property {array} [expandedSourceAddressPrefix] The expanded source + * address prefix. + * @property {array} [expandedDestinationAddressPrefix] Expanded destination * address prefix. - * @member {string} [access] Whether network traffic is allowed or denied. + * @property {string} [access] Whether network traffic is allowed or denied. * Possible values are: 'Allow' and 'Deny'. Possible values include: 'Allow', * 'Deny' - * @member {number} [priority] The priority of the rule. - * @member {string} [direction] The direction of the rule. Possible values + * @property {number} [priority] The priority of the rule. + * @property {string} [direction] The direction of the rule. Possible values * are: 'Inbound and Outbound'. Possible values include: 'Inbound', * 'Outbound' */ diff --git a/lib/services/networkManagement2/lib/models/effectiveRoute.js b/lib/services/networkManagement2/lib/models/effectiveRoute.js index 88fde6a540..d4b537f526 100644 --- a/lib/services/networkManagement2/lib/models/effectiveRoute.js +++ b/lib/services/networkManagement2/lib/models/effectiveRoute.js @@ -17,19 +17,19 @@ class EffectiveRoute { /** * Create a EffectiveRoute. - * @member {string} [name] The name of the user defined route. This is + * @property {string} [name] The name of the user defined route. This is * optional. - * @member {string} [source] Who created the route. Possible values are: + * @property {string} [source] Who created the route. Possible values are: * 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'. Possible values * include: 'Unknown', 'User', 'VirtualNetworkGateway', 'Default' - * @member {string} [state] The value of effective route. Possible values + * @property {string} [state] The value of effective route. Possible values * are: 'Active' and 'Invalid'. Possible values include: 'Active', 'Invalid' - * @member {array} [addressPrefix] The address prefixes of the effective + * @property {array} [addressPrefix] The address prefixes of the effective * routes in CIDR notation. - * @member {array} [nextHopIpAddress] The IP address of the next hop of the + * @property {array} [nextHopIpAddress] The IP address of the next hop of the * effective route. - * @member {string} [nextHopType] The type of Azure hop the packet should be - * sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', + * @property {string} [nextHopType] The type of Azure hop the packet should + * be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', * 'Internet', 'VirtualAppliance', and 'None'. Possible values include: * 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', * 'None' diff --git a/lib/services/networkManagement2/lib/models/effectiveRouteListResult.js b/lib/services/networkManagement2/lib/models/effectiveRouteListResult.js index 2e8874f5cd..2cc550a0a5 100644 --- a/lib/services/networkManagement2/lib/models/effectiveRouteListResult.js +++ b/lib/services/networkManagement2/lib/models/effectiveRouteListResult.js @@ -17,8 +17,8 @@ class EffectiveRouteListResult { /** * Create a EffectiveRouteListResult. - * @member {array} [value] A list of effective routes. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {array} [value] A list of effective routes. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/endpointService.js b/lib/services/networkManagement2/lib/models/endpointService.js index 475f85cc4a..46d4534c37 100644 --- a/lib/services/networkManagement2/lib/models/endpointService.js +++ b/lib/services/networkManagement2/lib/models/endpointService.js @@ -17,8 +17,8 @@ class EndpointService { /** * Create a EndpointService. - * @member {string} [id] A unique identifier of the service being referenced - * by the interface endpoint. + * @property {string} [id] A unique identifier of the service being + * referenced by the interface endpoint. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/endpointServiceResult.js b/lib/services/networkManagement2/lib/models/endpointServiceResult.js index eb6b4da846..3b31b7b64f 100644 --- a/lib/services/networkManagement2/lib/models/endpointServiceResult.js +++ b/lib/services/networkManagement2/lib/models/endpointServiceResult.js @@ -20,8 +20,8 @@ const models = require('./index'); class EndpointServiceResult extends models['SubResource'] { /** * Create a EndpointServiceResult. - * @member {string} [name] Name of the endpoint service. - * @member {string} [type] Type of the endpoint service. + * @property {string} [name] Name of the endpoint service. + * @property {string} [type] Type of the endpoint service. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/endpointServicesListResult.js b/lib/services/networkManagement2/lib/models/endpointServicesListResult.js index 4817adf490..5ca88cc914 100644 --- a/lib/services/networkManagement2/lib/models/endpointServicesListResult.js +++ b/lib/services/networkManagement2/lib/models/endpointServicesListResult.js @@ -16,7 +16,7 @@ class EndpointServicesListResult extends Array { /** * Create a EndpointServicesListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/errorDetails.js b/lib/services/networkManagement2/lib/models/errorDetails.js index fcac88503a..7393f66139 100644 --- a/lib/services/networkManagement2/lib/models/errorDetails.js +++ b/lib/services/networkManagement2/lib/models/errorDetails.js @@ -16,9 +16,9 @@ class ErrorDetails { /** * Create a ErrorDetails. - * @member {string} [code] - * @member {string} [target] - * @member {string} [message] + * @property {string} [code] + * @property {string} [target] + * @property {string} [message] */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/errorModel.js b/lib/services/networkManagement2/lib/models/errorModel.js index 955cde1528..6ef42630b7 100644 --- a/lib/services/networkManagement2/lib/models/errorModel.js +++ b/lib/services/networkManagement2/lib/models/errorModel.js @@ -16,11 +16,11 @@ class ErrorModel { /** * Create a ErrorModel. - * @member {string} [code] - * @member {string} [message] - * @member {string} [target] - * @member {array} [details] - * @member {string} [innerError] + * @property {string} [code] + * @property {string} [message] + * @property {string} [target] + * @property {array} [details] + * @property {string} [innerError] */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/errorResponse.js b/lib/services/networkManagement2/lib/models/errorResponse.js index d9336c3297..b0712fc754 100644 --- a/lib/services/networkManagement2/lib/models/errorResponse.js +++ b/lib/services/networkManagement2/lib/models/errorResponse.js @@ -17,10 +17,10 @@ class ErrorResponse { /** * Create a ErrorResponse. - * @member {object} [error] Error. - * @member {string} [error.code] - * @member {string} [error.target] - * @member {string} [error.message] + * @property {object} [error] Error. + * @property {string} [error.code] + * @property {string} [error.target] + * @property {string} [error.message] */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/evaluatedNetworkSecurityGroup.js b/lib/services/networkManagement2/lib/models/evaluatedNetworkSecurityGroup.js index 3eb3d30d22..9bcaf402c7 100644 --- a/lib/services/networkManagement2/lib/models/evaluatedNetworkSecurityGroup.js +++ b/lib/services/networkManagement2/lib/models/evaluatedNetworkSecurityGroup.js @@ -17,15 +17,15 @@ class EvaluatedNetworkSecurityGroup { /** * Create a EvaluatedNetworkSecurityGroup. - * @member {string} [networkSecurityGroupId] Network security group ID. - * @member {string} [appliedTo] Resource ID of nic or subnet to which network - * security group is applied. - * @member {object} [matchedRule] - * @member {string} [matchedRule.ruleName] Name of the matched network + * @property {string} [networkSecurityGroupId] Network security group ID. + * @property {string} [appliedTo] Resource ID of nic or subnet to which + * network security group is applied. + * @property {object} [matchedRule] + * @property {string} [matchedRule.ruleName] Name of the matched network * security rule. - * @member {string} [matchedRule.action] The network traffic is allowed or + * @property {string} [matchedRule.action] The network traffic is allowed or * denied. Possible values are 'Allow' and 'Deny'. - * @member {array} [rulesEvaluationResult] List of network security rules + * @property {array} [rulesEvaluationResult] List of network security rules * evaluation results. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuit.js b/lib/services/networkManagement2/lib/models/expressRouteCircuit.js index 0bade28fa8..fe3414539f 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuit.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuit.js @@ -20,48 +20,49 @@ const models = require('./index'); class ExpressRouteCircuit extends models['Resource'] { /** * Create a ExpressRouteCircuit. - * @member {object} [sku] The SKU. - * @member {string} [sku.name] The name of the SKU. - * @member {string} [sku.tier] The tier of the SKU. Possible values are + * @property {object} [sku] The SKU. + * @property {string} [sku.name] The name of the SKU. + * @property {string} [sku.tier] The tier of the SKU. Possible values are * 'Standard', 'Premium' or 'Basic'. Possible values include: 'Standard', * 'Premium', 'Basic' - * @member {string} [sku.family] The family of the SKU. Possible values are: - * 'UnlimitedData' and 'MeteredData'. Possible values include: + * @property {string} [sku.family] The family of the SKU. Possible values + * are: 'UnlimitedData' and 'MeteredData'. Possible values include: * 'UnlimitedData', 'MeteredData' - * @member {boolean} [allowClassicOperations] Allow classic operations - * @member {string} [circuitProvisioningState] The CircuitProvisioningState + * @property {boolean} [allowClassicOperations] Allow classic operations + * @property {string} [circuitProvisioningState] The CircuitProvisioningState * state of the resource. - * @member {string} [serviceProviderProvisioningState] The + * @property {string} [serviceProviderProvisioningState] The * ServiceProviderProvisioningState state of the resource. Possible values * are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. * Possible values include: 'NotProvisioned', 'Provisioning', 'Provisioned', * 'Deprovisioning' - * @member {array} [authorizations] The list of authorizations. - * @member {array} [peerings] The list of peerings. - * @member {string} [serviceKey] The ServiceKey. - * @member {string} [serviceProviderNotes] The ServiceProviderNotes. - * @member {object} [serviceProviderProperties] The + * @property {array} [authorizations] The list of authorizations. + * @property {array} [peerings] The list of peerings. + * @property {string} [serviceKey] The ServiceKey. + * @property {string} [serviceProviderNotes] The ServiceProviderNotes. + * @property {object} [serviceProviderProperties] The * ServiceProviderProperties. - * @member {string} [serviceProviderProperties.serviceProviderName] The + * @property {string} [serviceProviderProperties.serviceProviderName] The * serviceProviderName. - * @member {string} [serviceProviderProperties.peeringLocation] The peering + * @property {string} [serviceProviderProperties.peeringLocation] The peering * location. - * @member {number} [serviceProviderProperties.bandwidthInMbps] The + * @property {number} [serviceProviderProperties.bandwidthInMbps] The * BandwidthInMbps. - * @member {object} [expressRoutePort] The reference to the ExpressRoutePort - * resource when the circuit is provisioned on an ExpressRoutePort resource. - * @member {string} [expressRoutePort.id] Resource ID. - * @member {number} [bandwidthInGbps] The bandwidth of the circuit when the + * @property {object} [expressRoutePort] The reference to the + * ExpressRoutePort resource when the circuit is provisioned on an + * ExpressRoutePort resource. + * @property {string} [expressRoutePort.id] Resource ID. + * @property {number} [bandwidthInGbps] The bandwidth of the circuit when the * circuit is provisioned on an ExpressRoutePort resource. - * @member {number} [stag] The identifier of the circuit traffic. Outer tag + * @property {number} [stag] The identifier of the circuit traffic. Outer tag * for QinQ encapsulation. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {string} [provisioningState] Gets the provisioning state of the * public IP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [gatewayManagerEtag] The GatewayManager Etag. - * @member {boolean} [allowGlobalReach] Flag to enable Global Reach on the + * @property {string} [gatewayManagerEtag] The GatewayManager Etag. + * @property {boolean} [allowGlobalReach] Flag to enable Global Reach on the * circuit. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitArpTable.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitArpTable.js index 4fc37d0452..74565fa2ea 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitArpTable.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitArpTable.js @@ -17,10 +17,10 @@ class ExpressRouteCircuitArpTable { /** * Create a ExpressRouteCircuitArpTable. - * @member {number} [age] Entry age in minutes - * @member {string} [interfaceProperty] Interface address - * @member {string} [ipAddress] The IP address. - * @member {string} [macAddress] The MAC address. + * @property {number} [age] Entry age in minutes + * @property {string} [interfaceProperty] Interface address + * @property {string} [ipAddress] The IP address. + * @property {string} [macAddress] The MAC address. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitAuthorization.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitAuthorization.js index 84385110c0..cb83e671cd 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitAuthorization.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitAuthorization.js @@ -20,16 +20,16 @@ const models = require('./index'); class ExpressRouteCircuitAuthorization extends models['SubResource'] { /** * Create a ExpressRouteCircuitAuthorization. - * @member {string} [authorizationKey] The authorization key. - * @member {string} [authorizationUseStatus] AuthorizationUseStatus. Possible - * values are: 'Available' and 'InUse'. Possible values include: 'Available', - * 'InUse' - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {string} [authorizationKey] The authorization key. + * @property {string} [authorizationUseStatus] AuthorizationUseStatus. + * Possible values are: 'Available' and 'InUse'. Possible values include: + * 'Available', 'InUse' + * @property {string} [provisioningState] Gets the provisioning state of the * public IP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] Gets name of the resource that is unique within + * a resource group. This name can be used to access the resource. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitConnection.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitConnection.js index 053141896d..f938b80f46 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitConnection.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitConnection.js @@ -20,24 +20,24 @@ const models = require('./index'); class ExpressRouteCircuitConnection extends models['SubResource'] { /** * Create a ExpressRouteCircuitConnection. - * @member {object} [expressRouteCircuitPeering] Reference to Express Route + * @property {object} [expressRouteCircuitPeering] Reference to Express Route * Circuit Private Peering Resource of the circuit initiating connection. - * @member {string} [expressRouteCircuitPeering.id] Resource ID. - * @member {object} [peerExpressRouteCircuitPeering] Reference to Express + * @property {string} [expressRouteCircuitPeering.id] Resource ID. + * @property {object} [peerExpressRouteCircuitPeering] Reference to Express * Route Circuit Private Peering Resource of the peered circuit. - * @member {string} [peerExpressRouteCircuitPeering.id] Resource ID. - * @member {string} [addressPrefix] /29 IP address space to carve out + * @property {string} [peerExpressRouteCircuitPeering.id] Resource ID. + * @property {string} [addressPrefix] /29 IP address space to carve out * Customer addresses for tunnels. - * @member {string} [authorizationKey] The authorization key. - * @member {string} [circuitConnectionStatus] Express Route Circuit + * @property {string} [authorizationKey] The authorization key. + * @property {string} [circuitConnectionStatus] Express Route Circuit * Connection State. Possible values are: 'Connected' and 'Disconnected'. * Possible values include: 'Connected', 'Connecting', 'Disconnected' - * @member {string} [provisioningState] Provisioning state of the circuit + * @property {string} [provisioningState] Provisioning state of the circuit * connection resource. Possible values are: 'Succeded', 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] Gets name of the resource that is unique within + * a resource group. This name can be used to access the resource. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitConnectionListResult.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitConnectionListResult.js new file mode 100644 index 0000000000..d840b34921 --- /dev/null +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitConnectionListResult.js @@ -0,0 +1,68 @@ +/* + * 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'; + +/** + * Response for ListConnections API service call retrieves all global reach + * connections that belongs to a Private Peering for an ExpressRouteCircuit. + */ +class ExpressRouteCircuitConnectionListResult extends Array { + /** + * Create a ExpressRouteCircuitConnectionListResult. + * @property {string} [nextLink] The URL to get the next set of results. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ExpressRouteCircuitConnectionListResult + * + * @returns {object} metadata of ExpressRouteCircuitConnectionListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'ExpressRouteCircuitConnectionListResult', + type: { + name: 'Composite', + className: 'ExpressRouteCircuitConnectionListResult', + modelProperties: { + value: { + required: false, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'ExpressRouteCircuitConnectionElementType', + type: { + name: 'Composite', + className: 'ExpressRouteCircuitConnection' + } + } + } + }, + nextLink: { + required: false, + serializedName: 'nextLink', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = ExpressRouteCircuitConnectionListResult; diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitListResult.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitListResult.js index bc5717df8d..632a0d6505 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitListResult.js @@ -16,7 +16,7 @@ class ExpressRouteCircuitListResult extends Array { /** * Create a ExpressRouteCircuitListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitPeering.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitPeering.js index 2be72862e5..081bc30051 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitPeering.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitPeering.js @@ -20,105 +20,106 @@ const models = require('./index'); class ExpressRouteCircuitPeering extends models['SubResource'] { /** * Create a ExpressRouteCircuitPeering. - * @member {string} [peeringType] The peering type. Possible values include: - * 'AzurePublicPeering', 'AzurePrivatePeering', 'MicrosoftPeering' - * @member {string} [state] The peering state. Possible values include: + * @property {string} [peeringType] The peering type. Possible values + * include: 'AzurePublicPeering', 'AzurePrivatePeering', 'MicrosoftPeering' + * @property {string} [state] The peering state. Possible values include: * 'Disabled', 'Enabled' - * @member {number} [azureASN] The Azure ASN. - * @member {number} [peerASN] The peer ASN. - * @member {string} [primaryPeerAddressPrefix] The primary address prefix. - * @member {string} [secondaryPeerAddressPrefix] The secondary address + * @property {number} [azureASN] The Azure ASN. + * @property {number} [peerASN] The peer ASN. + * @property {string} [primaryPeerAddressPrefix] The primary address prefix. + * @property {string} [secondaryPeerAddressPrefix] The secondary address * prefix. - * @member {string} [primaryAzurePort] The primary port. - * @member {string} [secondaryAzurePort] The secondary port. - * @member {string} [sharedKey] The shared key. - * @member {number} [vlanId] The VLAN ID. - * @member {object} [microsoftPeeringConfig] The Microsoft peering + * @property {string} [primaryAzurePort] The primary port. + * @property {string} [secondaryAzurePort] The secondary port. + * @property {string} [sharedKey] The shared key. + * @property {number} [vlanId] The VLAN ID. + * @property {object} [microsoftPeeringConfig] The Microsoft peering * configuration. - * @member {array} [microsoftPeeringConfig.advertisedPublicPrefixes] The + * @property {array} [microsoftPeeringConfig.advertisedPublicPrefixes] The * reference of AdvertisedPublicPrefixes. - * @member {array} [microsoftPeeringConfig.advertisedCommunities] The + * @property {array} [microsoftPeeringConfig.advertisedCommunities] The * communities of bgp peering. Spepcified for microsoft peering - * @member {string} [microsoftPeeringConfig.advertisedPublicPrefixesState] + * @property {string} [microsoftPeeringConfig.advertisedPublicPrefixesState] * AdvertisedPublicPrefixState of the Peering resource. Possible values are * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. * Possible values include: 'NotConfigured', 'Configuring', 'Configured', * 'ValidationNeeded' - * @member {number} [microsoftPeeringConfig.legacyMode] The legacy mode of + * @property {number} [microsoftPeeringConfig.legacyMode] The legacy mode of * the peering. - * @member {number} [microsoftPeeringConfig.customerASN] The CustomerASN of + * @property {number} [microsoftPeeringConfig.customerASN] The CustomerASN of * the peering. - * @member {string} [microsoftPeeringConfig.routingRegistryName] The + * @property {string} [microsoftPeeringConfig.routingRegistryName] The * RoutingRegistryName of the configuration. - * @member {object} [stats] Gets peering stats. - * @member {number} [stats.primarybytesIn] Gets BytesIn of the peering. - * @member {number} [stats.primarybytesOut] Gets BytesOut of the peering. - * @member {number} [stats.secondarybytesIn] Gets BytesIn of the peering. - * @member {number} [stats.secondarybytesOut] Gets BytesOut of the peering. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {object} [stats] Gets peering stats. + * @property {number} [stats.primarybytesIn] Gets BytesIn of the peering. + * @property {number} [stats.primarybytesOut] Gets BytesOut of the peering. + * @property {number} [stats.secondarybytesIn] Gets BytesIn of the peering. + * @property {number} [stats.secondarybytesOut] Gets BytesOut of the peering. + * @property {string} [provisioningState] Gets the provisioning state of the * public IP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [gatewayManagerEtag] The GatewayManager Etag. - * @member {string} [lastModifiedBy] Gets whether the provider or the + * @property {string} [gatewayManagerEtag] The GatewayManager Etag. + * @property {string} [lastModifiedBy] Gets whether the provider or the * customer last modified the peering. - * @member {object} [routeFilter] The reference of the RouteFilter resource. - * @member {array} [routeFilter.rules] Collection of RouteFilterRules + * @property {object} [routeFilter] The reference of the RouteFilter + * resource. + * @property {array} [routeFilter.rules] Collection of RouteFilterRules * contained within a route filter. - * @member {array} [routeFilter.peerings] A collection of references to + * @property {array} [routeFilter.peerings] A collection of references to * express route circuit peerings. - * @member {string} [routeFilter.provisioningState] The provisioning state of - * the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and - * 'Failed'. - * @member {string} [routeFilter.etag] Gets a unique read-only string that + * @property {string} [routeFilter.provisioningState] The provisioning state + * of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' + * and 'Failed'. + * @property {string} [routeFilter.etag] Gets a unique read-only string that * changes whenever the resource is updated. - * @member {object} [ipv6PeeringConfig] The IPv6 peering configuration. - * @member {string} [ipv6PeeringConfig.primaryPeerAddressPrefix] The primary - * address prefix. - * @member {string} [ipv6PeeringConfig.secondaryPeerAddressPrefix] The + * @property {object} [ipv6PeeringConfig] The IPv6 peering configuration. + * @property {string} [ipv6PeeringConfig.primaryPeerAddressPrefix] The + * primary address prefix. + * @property {string} [ipv6PeeringConfig.secondaryPeerAddressPrefix] The * secondary address prefix. - * @member {object} [ipv6PeeringConfig.microsoftPeeringConfig] The Microsoft - * peering configuration. - * @member {array} + * @property {object} [ipv6PeeringConfig.microsoftPeeringConfig] The + * Microsoft peering configuration. + * @property {array} * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedPublicPrefixes] The * reference of AdvertisedPublicPrefixes. - * @member {array} + * @property {array} * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedCommunities] The * communities of bgp peering. Spepcified for microsoft peering - * @member {string} + * @property {string} * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedPublicPrefixesState] * AdvertisedPublicPrefixState of the Peering resource. Possible values are * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. * Possible values include: 'NotConfigured', 'Configuring', 'Configured', * 'ValidationNeeded' - * @member {number} [ipv6PeeringConfig.microsoftPeeringConfig.legacyMode] The - * legacy mode of the peering. - * @member {number} [ipv6PeeringConfig.microsoftPeeringConfig.customerASN] + * @property {number} [ipv6PeeringConfig.microsoftPeeringConfig.legacyMode] + * The legacy mode of the peering. + * @property {number} [ipv6PeeringConfig.microsoftPeeringConfig.customerASN] * The CustomerASN of the peering. - * @member {string} + * @property {string} * [ipv6PeeringConfig.microsoftPeeringConfig.routingRegistryName] The * RoutingRegistryName of the configuration. - * @member {object} [ipv6PeeringConfig.routeFilter] The reference of the + * @property {object} [ipv6PeeringConfig.routeFilter] The reference of the * RouteFilter resource. - * @member {array} [ipv6PeeringConfig.routeFilter.rules] Collection of + * @property {array} [ipv6PeeringConfig.routeFilter.rules] Collection of * RouteFilterRules contained within a route filter. - * @member {array} [ipv6PeeringConfig.routeFilter.peerings] A collection of + * @property {array} [ipv6PeeringConfig.routeFilter.peerings] A collection of * references to express route circuit peerings. - * @member {string} [ipv6PeeringConfig.routeFilter.provisioningState] The + * @property {string} [ipv6PeeringConfig.routeFilter.provisioningState] The * provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', 'Succeeded' and 'Failed'. - * @member {string} [ipv6PeeringConfig.routeFilter.etag] Gets a unique + * @property {string} [ipv6PeeringConfig.routeFilter.etag] Gets a unique * read-only string that changes whenever the resource is updated. - * @member {string} [ipv6PeeringConfig.state] The state of peering. Possible - * values are: 'Disabled' and 'Enabled'. Possible values include: 'Disabled', - * 'Enabled' - * @member {object} [expressRouteConnection] The ExpressRoute connection. - * @member {string} [expressRouteConnection.id] The ID of the + * @property {string} [ipv6PeeringConfig.state] The state of peering. + * Possible values are: 'Disabled' and 'Enabled'. Possible values include: + * 'Disabled', 'Enabled' + * @property {object} [expressRouteConnection] The ExpressRoute connection. + * @property {string} [expressRouteConnection.id] The ID of the * ExpressRouteConnection. - * @member {array} [connections] The list of circuit connections associated + * @property {array} [connections] The list of circuit connections associated * with Azure Private Peering for this circuit. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] Gets name of the resource that is unique within + * a resource group. This name can be used to access the resource. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringConfig.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringConfig.js index 79a97c813e..d8b599509d 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringConfig.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringConfig.js @@ -17,18 +17,18 @@ class ExpressRouteCircuitPeeringConfig { /** * Create a ExpressRouteCircuitPeeringConfig. - * @member {array} [advertisedPublicPrefixes] The reference of + * @property {array} [advertisedPublicPrefixes] The reference of * AdvertisedPublicPrefixes. - * @member {array} [advertisedCommunities] The communities of bgp peering. + * @property {array} [advertisedCommunities] The communities of bgp peering. * Spepcified for microsoft peering - * @member {string} [advertisedPublicPrefixesState] + * @property {string} [advertisedPublicPrefixesState] * AdvertisedPublicPrefixState of the Peering resource. Possible values are * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. * Possible values include: 'NotConfigured', 'Configuring', 'Configured', * 'ValidationNeeded' - * @member {number} [legacyMode] The legacy mode of the peering. - * @member {number} [customerASN] The CustomerASN of the peering. - * @member {string} [routingRegistryName] The RoutingRegistryName of the + * @property {number} [legacyMode] The legacy mode of the peering. + * @property {number} [customerASN] The CustomerASN of the peering. + * @property {string} [routingRegistryName] The RoutingRegistryName of the * configuration. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringId.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringId.js index dfbfddfe7e..fda100a3ad 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringId.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringId.js @@ -17,7 +17,7 @@ class ExpressRouteCircuitPeeringId { /** * Create a ExpressRouteCircuitPeeringId. - * @member {string} [id] The ID of the ExpressRoute circuit peering. + * @property {string} [id] The ID of the ExpressRoute circuit peering. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringListResult.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringListResult.js index c8c233ee5e..fd93ec4db4 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitPeeringListResult.js @@ -17,7 +17,7 @@ class ExpressRouteCircuitPeeringListResult extends Array { /** * Create a ExpressRouteCircuitPeeringListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitReference.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitReference.js index d7c4e7081c..16b8feba35 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitReference.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitReference.js @@ -16,7 +16,7 @@ class ExpressRouteCircuitReference { /** * Create a ExpressRouteCircuitReference. - * @member {string} [id] Corresponding Express Route Circuit Id. + * @property {string} [id] Corresponding Express Route Circuit Id. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitRoutesTable.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitRoutesTable.js index aca3c55463..45ac0977fa 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitRoutesTable.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitRoutesTable.js @@ -17,12 +17,12 @@ class ExpressRouteCircuitRoutesTable { /** * Create a ExpressRouteCircuitRoutesTable. - * @member {string} [network] IP address of a network entity - * @member {string} [nextHop] NextHop address - * @member {string} [locPrf] Local preference value as set with the set + * @property {string} [network] IP address of a network entity + * @property {string} [nextHop] NextHop address + * @property {string} [locPrf] Local preference value as set with the set * local-preference route-map configuration command - * @member {number} [weight] Route Weight. - * @member {string} [path] Autonomous system paths to the destination + * @property {number} [weight] Route Weight. + * @property {string} [path] Autonomous system paths to the destination * network. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitRoutesTableSummary.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitRoutesTableSummary.js index a7c16eec66..292b7756ba 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitRoutesTableSummary.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitRoutesTableSummary.js @@ -17,13 +17,13 @@ class ExpressRouteCircuitRoutesTableSummary { /** * Create a ExpressRouteCircuitRoutesTableSummary. - * @member {string} [neighbor] IP address of the neighbor. - * @member {number} [v] BGP version number spoken to the neighbor. - * @member {number} [as] Autonomous system number. - * @member {string} [upDown] The length of time that the BGP session has been - * in the Established state, or the current status if not in the Established - * state. - * @member {string} [statePfxRcd] Current state of the BGP session, and the + * @property {string} [neighbor] IP address of the neighbor. + * @property {number} [v] BGP version number spoken to the neighbor. + * @property {number} [as] Autonomous system number. + * @property {string} [upDown] The length of time that the BGP session has + * been in the Established state, or the current status if not in the + * Established state. + * @property {string} [statePfxRcd] Current state of the BGP session, and the * number of prefixes that have been received from a neighbor or peer group. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitServiceProviderProperties.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitServiceProviderProperties.js index 66a96d4d72..32145139c1 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitServiceProviderProperties.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitServiceProviderProperties.js @@ -17,9 +17,9 @@ class ExpressRouteCircuitServiceProviderProperties { /** * Create a ExpressRouteCircuitServiceProviderProperties. - * @member {string} [serviceProviderName] The serviceProviderName. - * @member {string} [peeringLocation] The peering location. - * @member {number} [bandwidthInMbps] The BandwidthInMbps. + * @property {string} [serviceProviderName] The serviceProviderName. + * @property {string} [peeringLocation] The peering location. + * @property {number} [bandwidthInMbps] The BandwidthInMbps. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitSku.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitSku.js index eedc3b28d8..3f1132db46 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitSku.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitSku.js @@ -17,11 +17,11 @@ class ExpressRouteCircuitSku { /** * Create a ExpressRouteCircuitSku. - * @member {string} [name] The name of the SKU. - * @member {string} [tier] The tier of the SKU. Possible values are + * @property {string} [name] The name of the SKU. + * @property {string} [tier] The tier of the SKU. Possible values are * 'Standard', 'Premium' or 'Basic'. Possible values include: 'Standard', * 'Premium', 'Basic' - * @member {string} [family] The family of the SKU. Possible values are: + * @property {string} [family] The family of the SKU. Possible values are: * 'UnlimitedData' and 'MeteredData'. Possible values include: * 'UnlimitedData', 'MeteredData' */ diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitStats.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitStats.js index f2eda96ec4..daafa89198 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitStats.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitStats.js @@ -17,10 +17,10 @@ class ExpressRouteCircuitStats { /** * Create a ExpressRouteCircuitStats. - * @member {number} [primarybytesIn] Gets BytesIn of the peering. - * @member {number} [primarybytesOut] Gets BytesOut of the peering. - * @member {number} [secondarybytesIn] Gets BytesIn of the peering. - * @member {number} [secondarybytesOut] Gets BytesOut of the peering. + * @property {number} [primarybytesIn] Gets BytesIn of the peering. + * @property {number} [primarybytesOut] Gets BytesOut of the peering. + * @property {number} [secondarybytesIn] Gets BytesIn of the peering. + * @property {number} [secondarybytesOut] Gets BytesOut of the peering. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitsArpTableListResult.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitsArpTableListResult.js index ad06e97550..1b6a7cc50e 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitsArpTableListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitsArpTableListResult.js @@ -17,8 +17,8 @@ class ExpressRouteCircuitsArpTableListResult { /** * Create a ExpressRouteCircuitsArpTableListResult. - * @member {array} [value] Gets list of the ARP table. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {array} [value] Gets list of the ARP table. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitsRoutesTableListResult.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitsRoutesTableListResult.js index 9b64fdb82f..cc8258435a 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitsRoutesTableListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitsRoutesTableListResult.js @@ -17,8 +17,8 @@ class ExpressRouteCircuitsRoutesTableListResult { /** * Create a ExpressRouteCircuitsRoutesTableListResult. - * @member {array} [value] The list of routes table. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {array} [value] The list of routes table. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteCircuitsRoutesTableSummaryListResult.js b/lib/services/networkManagement2/lib/models/expressRouteCircuitsRoutesTableSummaryListResult.js index 535d316619..8298b48a6e 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCircuitsRoutesTableSummaryListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCircuitsRoutesTableSummaryListResult.js @@ -17,8 +17,8 @@ class ExpressRouteCircuitsRoutesTableSummaryListResult { /** * Create a ExpressRouteCircuitsRoutesTableSummaryListResult. - * @member {array} [value] A list of the routes table. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {array} [value] A list of the routes table. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteConnection.js b/lib/services/networkManagement2/lib/models/expressRouteConnection.js index 04f3c7cffb..1e865b4d39 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteConnection.js +++ b/lib/services/networkManagement2/lib/models/expressRouteConnection.js @@ -20,18 +20,18 @@ const models = require('./index'); class ExpressRouteConnection extends models['SubResource'] { /** * Create a ExpressRouteConnection. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {object} expressRouteCircuitPeering The ExpressRoute circuit + * @property {object} expressRouteCircuitPeering The ExpressRoute circuit * peering. - * @member {string} [expressRouteCircuitPeering.id] The ID of the + * @property {string} [expressRouteCircuitPeering.id] The ID of the * ExpressRoute circuit peering. - * @member {string} [authorizationKey] Authorization key to establish the + * @property {string} [authorizationKey] Authorization key to establish the * connection. - * @member {number} [routingWeight] The routing weight associated to the + * @property {number} [routingWeight] The routing weight associated to the * connection. - * @member {string} name The name of the resource. + * @property {string} name The name of the resource. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/expressRouteConnectionId.js b/lib/services/networkManagement2/lib/models/expressRouteConnectionId.js index 5b0a95f675..dc09bd0b3e 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteConnectionId.js +++ b/lib/services/networkManagement2/lib/models/expressRouteConnectionId.js @@ -17,7 +17,7 @@ class ExpressRouteConnectionId { /** * Create a ExpressRouteConnectionId. - * @member {string} [id] The ID of the ExpressRouteConnection. + * @property {string} [id] The ID of the ExpressRouteConnection. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteConnectionList.js b/lib/services/networkManagement2/lib/models/expressRouteConnectionList.js index d300f0a1c3..a23abbf089 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteConnectionList.js +++ b/lib/services/networkManagement2/lib/models/expressRouteConnectionList.js @@ -17,7 +17,7 @@ class ExpressRouteConnectionList { /** * Create a ExpressRouteConnectionList. - * @member {array} [value] The list of ExpressRoute connections + * @property {array} [value] The list of ExpressRoute connections */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteCrossConnection.js b/lib/services/networkManagement2/lib/models/expressRouteCrossConnection.js index 180429e70e..6b1891580d 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCrossConnection.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCrossConnection.js @@ -20,26 +20,26 @@ const models = require('./index'); class ExpressRouteCrossConnection extends models['Resource'] { /** * Create a ExpressRouteCrossConnection. - * @member {string} [primaryAzurePort] The name of the primary port. - * @member {string} [secondaryAzurePort] The name of the secondary port. - * @member {number} [sTag] The identifier of the circuit traffic. - * @member {string} [peeringLocation] The peering location of the + * @property {string} [primaryAzurePort] The name of the primary port. + * @property {string} [secondaryAzurePort] The name of the secondary port. + * @property {number} [sTag] The identifier of the circuit traffic. + * @property {string} [peeringLocation] The peering location of the * ExpressRoute circuit. - * @member {number} [bandwidthInMbps] The circuit bandwidth In Mbps. - * @member {object} [expressRouteCircuit] The ExpressRouteCircuit - * @member {string} [expressRouteCircuit.id] Corresponding Express Route + * @property {number} [bandwidthInMbps] The circuit bandwidth In Mbps. + * @property {object} [expressRouteCircuit] The ExpressRouteCircuit + * @property {string} [expressRouteCircuit.id] Corresponding Express Route * Circuit Id. - * @member {string} [serviceProviderProvisioningState] The provisioning state - * of the circuit in the connectivity provider system. Possible values are - * 'NotProvisioned', 'Provisioning', 'Provisioned'. Possible values include: - * 'NotProvisioned', 'Provisioning', 'Provisioned', 'Deprovisioning' - * @member {string} [serviceProviderNotes] Additional read only notes set by - * the connectivity provider. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {string} [serviceProviderProvisioningState] The provisioning + * state of the circuit in the connectivity provider system. Possible values + * are 'NotProvisioned', 'Provisioning', 'Provisioned'. Possible values + * include: 'NotProvisioned', 'Provisioning', 'Provisioned', 'Deprovisioning' + * @property {string} [serviceProviderNotes] Additional read only notes set + * by the connectivity provider. + * @property {string} [provisioningState] Gets the provisioning state of the * public IP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {array} [peerings] The list of peerings. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {array} [peerings] The list of peerings. + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionListResult.js b/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionListResult.js index b96c2712da..e5b983edc5 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionListResult.js @@ -16,7 +16,7 @@ class ExpressRouteCrossConnectionListResult extends Array { /** * Create a ExpressRouteCrossConnectionListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionPeering.js b/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionPeering.js index 1fe2499774..7160299e30 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionPeering.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionPeering.js @@ -20,85 +20,85 @@ const models = require('./index'); class ExpressRouteCrossConnectionPeering extends models['SubResource'] { /** * Create a ExpressRouteCrossConnectionPeering. - * @member {string} [peeringType] The peering type. Possible values include: - * 'AzurePublicPeering', 'AzurePrivatePeering', 'MicrosoftPeering' - * @member {string} [state] The peering state. Possible values include: + * @property {string} [peeringType] The peering type. Possible values + * include: 'AzurePublicPeering', 'AzurePrivatePeering', 'MicrosoftPeering' + * @property {string} [state] The peering state. Possible values include: * 'Disabled', 'Enabled' - * @member {number} [azureASN] The Azure ASN. - * @member {number} [peerASN] The peer ASN. - * @member {string} [primaryPeerAddressPrefix] The primary address prefix. - * @member {string} [secondaryPeerAddressPrefix] The secondary address + * @property {number} [azureASN] The Azure ASN. + * @property {number} [peerASN] The peer ASN. + * @property {string} [primaryPeerAddressPrefix] The primary address prefix. + * @property {string} [secondaryPeerAddressPrefix] The secondary address * prefix. - * @member {string} [primaryAzurePort] The primary port. - * @member {string} [secondaryAzurePort] The secondary port. - * @member {string} [sharedKey] The shared key. - * @member {number} [vlanId] The VLAN ID. - * @member {object} [microsoftPeeringConfig] The Microsoft peering + * @property {string} [primaryAzurePort] The primary port. + * @property {string} [secondaryAzurePort] The secondary port. + * @property {string} [sharedKey] The shared key. + * @property {number} [vlanId] The VLAN ID. + * @property {object} [microsoftPeeringConfig] The Microsoft peering * configuration. - * @member {array} [microsoftPeeringConfig.advertisedPublicPrefixes] The + * @property {array} [microsoftPeeringConfig.advertisedPublicPrefixes] The * reference of AdvertisedPublicPrefixes. - * @member {array} [microsoftPeeringConfig.advertisedCommunities] The + * @property {array} [microsoftPeeringConfig.advertisedCommunities] The * communities of bgp peering. Spepcified for microsoft peering - * @member {string} [microsoftPeeringConfig.advertisedPublicPrefixesState] + * @property {string} [microsoftPeeringConfig.advertisedPublicPrefixesState] * AdvertisedPublicPrefixState of the Peering resource. Possible values are * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. * Possible values include: 'NotConfigured', 'Configuring', 'Configured', * 'ValidationNeeded' - * @member {number} [microsoftPeeringConfig.legacyMode] The legacy mode of + * @property {number} [microsoftPeeringConfig.legacyMode] The legacy mode of * the peering. - * @member {number} [microsoftPeeringConfig.customerASN] The CustomerASN of + * @property {number} [microsoftPeeringConfig.customerASN] The CustomerASN of * the peering. - * @member {string} [microsoftPeeringConfig.routingRegistryName] The + * @property {string} [microsoftPeeringConfig.routingRegistryName] The * RoutingRegistryName of the configuration. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {string} [provisioningState] Gets the provisioning state of the * public IP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [gatewayManagerEtag] The GatewayManager Etag. - * @member {string} [lastModifiedBy] Gets whether the provider or the + * @property {string} [gatewayManagerEtag] The GatewayManager Etag. + * @property {string} [lastModifiedBy] Gets whether the provider or the * customer last modified the peering. - * @member {object} [ipv6PeeringConfig] The IPv6 peering configuration. - * @member {string} [ipv6PeeringConfig.primaryPeerAddressPrefix] The primary - * address prefix. - * @member {string} [ipv6PeeringConfig.secondaryPeerAddressPrefix] The + * @property {object} [ipv6PeeringConfig] The IPv6 peering configuration. + * @property {string} [ipv6PeeringConfig.primaryPeerAddressPrefix] The + * primary address prefix. + * @property {string} [ipv6PeeringConfig.secondaryPeerAddressPrefix] The * secondary address prefix. - * @member {object} [ipv6PeeringConfig.microsoftPeeringConfig] The Microsoft - * peering configuration. - * @member {array} + * @property {object} [ipv6PeeringConfig.microsoftPeeringConfig] The + * Microsoft peering configuration. + * @property {array} * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedPublicPrefixes] The * reference of AdvertisedPublicPrefixes. - * @member {array} + * @property {array} * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedCommunities] The * communities of bgp peering. Spepcified for microsoft peering - * @member {string} + * @property {string} * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedPublicPrefixesState] * AdvertisedPublicPrefixState of the Peering resource. Possible values are * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. * Possible values include: 'NotConfigured', 'Configuring', 'Configured', * 'ValidationNeeded' - * @member {number} [ipv6PeeringConfig.microsoftPeeringConfig.legacyMode] The - * legacy mode of the peering. - * @member {number} [ipv6PeeringConfig.microsoftPeeringConfig.customerASN] + * @property {number} [ipv6PeeringConfig.microsoftPeeringConfig.legacyMode] + * The legacy mode of the peering. + * @property {number} [ipv6PeeringConfig.microsoftPeeringConfig.customerASN] * The CustomerASN of the peering. - * @member {string} + * @property {string} * [ipv6PeeringConfig.microsoftPeeringConfig.routingRegistryName] The * RoutingRegistryName of the configuration. - * @member {object} [ipv6PeeringConfig.routeFilter] The reference of the + * @property {object} [ipv6PeeringConfig.routeFilter] The reference of the * RouteFilter resource. - * @member {array} [ipv6PeeringConfig.routeFilter.rules] Collection of + * @property {array} [ipv6PeeringConfig.routeFilter.rules] Collection of * RouteFilterRules contained within a route filter. - * @member {array} [ipv6PeeringConfig.routeFilter.peerings] A collection of + * @property {array} [ipv6PeeringConfig.routeFilter.peerings] A collection of * references to express route circuit peerings. - * @member {string} [ipv6PeeringConfig.routeFilter.provisioningState] The + * @property {string} [ipv6PeeringConfig.routeFilter.provisioningState] The * provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', 'Succeeded' and 'Failed'. - * @member {string} [ipv6PeeringConfig.routeFilter.etag] Gets a unique + * @property {string} [ipv6PeeringConfig.routeFilter.etag] Gets a unique * read-only string that changes whenever the resource is updated. - * @member {string} [ipv6PeeringConfig.state] The state of peering. Possible - * values are: 'Disabled' and 'Enabled'. Possible values include: 'Disabled', - * 'Enabled' - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [ipv6PeeringConfig.state] The state of peering. + * Possible values are: 'Disabled' and 'Enabled'. Possible values include: + * 'Disabled', 'Enabled' + * @property {string} [name] Gets name of the resource that is unique within + * a resource group. This name can be used to access the resource. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionPeeringList.js b/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionPeeringList.js index 5f35071118..195fa08301 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionPeeringList.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionPeeringList.js @@ -17,7 +17,7 @@ class ExpressRouteCrossConnectionPeeringList extends Array { /** * Create a ExpressRouteCrossConnectionPeeringList. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionRoutesTableSummary.js b/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionRoutesTableSummary.js index 20f7e76770..bade51057f 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionRoutesTableSummary.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionRoutesTableSummary.js @@ -17,12 +17,12 @@ class ExpressRouteCrossConnectionRoutesTableSummary { /** * Create a ExpressRouteCrossConnectionRoutesTableSummary. - * @member {string} [neighbor] IP address of Neighbor router - * @member {number} [asn] Autonomous system number. - * @member {string} [upDown] The length of time that the BGP session has been - * in the Established state, or the current status if not in the Established - * state. - * @member {string} [stateOrPrefixesReceived] Current state of the BGP + * @property {string} [neighbor] IP address of Neighbor router + * @property {number} [asn] Autonomous system number. + * @property {string} [upDown] The length of time that the BGP session has + * been in the Established state, or the current status if not in the + * Established state. + * @property {string} [stateOrPrefixesReceived] Current state of the BGP * session, and the number of prefixes that have been received from a * neighbor or peer group. */ diff --git a/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionsRoutesTableSummaryListResult.js b/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionsRoutesTableSummaryListResult.js index 937440cf10..8d232042b9 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionsRoutesTableSummaryListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRouteCrossConnectionsRoutesTableSummaryListResult.js @@ -18,8 +18,8 @@ class ExpressRouteCrossConnectionsRoutesTableSummaryListResult { /** * Create a ExpressRouteCrossConnectionsRoutesTableSummaryListResult. - * @member {array} [value] A list of the routes table. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {array} [value] A list of the routes table. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteGateway.js b/lib/services/networkManagement2/lib/models/expressRouteGateway.js index e760663d60..3ba9059ef0 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteGateway.js +++ b/lib/services/networkManagement2/lib/models/expressRouteGateway.js @@ -20,25 +20,26 @@ const models = require('./index'); class ExpressRouteGateway extends models['Resource'] { /** * Create a ExpressRouteGateway. - * @member {object} [autoScaleConfiguration] Configuration for auto scaling. - * @member {object} [autoScaleConfiguration.bounds] Minimum and maximum + * @property {object} [autoScaleConfiguration] Configuration for auto + * scaling. + * @property {object} [autoScaleConfiguration.bounds] Minimum and maximum * number of scale units to deploy. - * @member {number} [autoScaleConfiguration.bounds.min] Minimum number of + * @property {number} [autoScaleConfiguration.bounds.min] Minimum number of * scale units deployed for ExpressRoute gateway. - * @member {number} [autoScaleConfiguration.bounds.max] Maximum number of + * @property {number} [autoScaleConfiguration.bounds.max] Maximum number of * scale units deployed for ExpressRoute gateway. - * @member {array} [expressRouteConnections] List of ExpressRoute connections - * to the ExpressRoute gateway. - * @member {string} [provisioningState] The provisioning state of the + * @property {array} [expressRouteConnections] List of ExpressRoute + * connections to the ExpressRoute gateway. + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {object} virtualHub The Virtual Hub where the ExpressRoute gateway - * is or will be deployed. - * @member {string} [virtualHub.id] The resource URI for the Virtual Hub + * @property {object} virtualHub The Virtual Hub where the ExpressRoute + * gateway is or will be deployed. + * @property {string} [virtualHub.id] The resource URI for the Virtual Hub * where the ExpressRoute gateway is or will be deployed. The Virtual Hub * resource and the ExpressRoute gateway resource reside in the same * subscription. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteGatewayList.js b/lib/services/networkManagement2/lib/models/expressRouteGatewayList.js index bb2c59519b..71f0937a3c 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteGatewayList.js +++ b/lib/services/networkManagement2/lib/models/expressRouteGatewayList.js @@ -17,7 +17,7 @@ class ExpressRouteGatewayList { /** * Create a ExpressRouteGatewayList. - * @member {array} [value] List of ExpressRoute gateways. + * @property {array} [value] List of ExpressRoute gateways. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteGatewayPropertiesAutoScaleConfiguration.js b/lib/services/networkManagement2/lib/models/expressRouteGatewayPropertiesAutoScaleConfiguration.js index 2470d6d3f4..a3f7a11974 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteGatewayPropertiesAutoScaleConfiguration.js +++ b/lib/services/networkManagement2/lib/models/expressRouteGatewayPropertiesAutoScaleConfiguration.js @@ -17,11 +17,11 @@ class ExpressRouteGatewayPropertiesAutoScaleConfiguration { /** * Create a ExpressRouteGatewayPropertiesAutoScaleConfiguration. - * @member {object} [bounds] Minimum and maximum number of scale units to + * @property {object} [bounds] Minimum and maximum number of scale units to * deploy. - * @member {number} [bounds.min] Minimum number of scale units deployed for + * @property {number} [bounds.min] Minimum number of scale units deployed for * ExpressRoute gateway. - * @member {number} [bounds.max] Maximum number of scale units deployed for + * @property {number} [bounds.max] Maximum number of scale units deployed for * ExpressRoute gateway. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteGatewayPropertiesAutoScaleConfigurationBounds.js b/lib/services/networkManagement2/lib/models/expressRouteGatewayPropertiesAutoScaleConfigurationBounds.js index 10ad71522e..6a508544db 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteGatewayPropertiesAutoScaleConfigurationBounds.js +++ b/lib/services/networkManagement2/lib/models/expressRouteGatewayPropertiesAutoScaleConfigurationBounds.js @@ -17,9 +17,9 @@ class ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds { /** * Create a ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds. - * @member {number} [min] Minimum number of scale units deployed for + * @property {number} [min] Minimum number of scale units deployed for * ExpressRoute gateway. - * @member {number} [max] Maximum number of scale units deployed for + * @property {number} [max] Maximum number of scale units deployed for * ExpressRoute gateway. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteLink.js b/lib/services/networkManagement2/lib/models/expressRouteLink.js index 0311621c4d..aecc4482c4 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteLink.js +++ b/lib/services/networkManagement2/lib/models/expressRouteLink.js @@ -22,22 +22,22 @@ const models = require('./index'); class ExpressRouteLink extends models['SubResource'] { /** * Create a ExpressRouteLink. - * @member {string} [routerName] Name of Azure router associated with + * @property {string} [routerName] Name of Azure router associated with * physical port. - * @member {string} [interfaceName] Name of Azure router interface. - * @member {string} [patchPanelId] Mapping between physical port to patch + * @property {string} [interfaceName] Name of Azure router interface. + * @property {string} [patchPanelId] Mapping between physical port to patch * panel port. - * @member {string} [rackId] Mapping of physical patch panel to rack. - * @member {string} [connectorType] Physical fiber port type. Possible values - * include: 'LC', 'SC' - * @member {string} [adminState] Administrative state of the physical port. + * @property {string} [rackId] Mapping of physical patch panel to rack. + * @property {string} [connectorType] Physical fiber port type. Possible + * values include: 'LC', 'SC' + * @property {string} [adminState] Administrative state of the physical port. * Possible values include: 'Enabled', 'Disabled' - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [name] Name of child port resource that is unique among + * @property {string} [name] Name of child port resource that is unique among * child port resources of the parent. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteLinkListResult.js b/lib/services/networkManagement2/lib/models/expressRouteLinkListResult.js index 178bd4ed00..c846fd7c9a 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteLinkListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRouteLinkListResult.js @@ -17,7 +17,7 @@ class ExpressRouteLinkListResult extends Array { /** * Create a ExpressRouteLinkListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/expressRoutePort.js b/lib/services/networkManagement2/lib/models/expressRoutePort.js index 46ace40229..825da5b272 100644 --- a/lib/services/networkManagement2/lib/models/expressRoutePort.js +++ b/lib/services/networkManagement2/lib/models/expressRoutePort.js @@ -22,28 +22,28 @@ const models = require('./index'); class ExpressRoutePort extends models['Resource'] { /** * Create a ExpressRoutePort. - * @member {string} [peeringLocation] The name of the peering location that + * @property {string} [peeringLocation] The name of the peering location that * the ExpressRoutePort is mapped to physically. - * @member {number} [bandwidthInGbps] Bandwidth of procured ports in Gbps - * @member {number} [provisionedBandwidthInGbps] Aggregate Gbps of associated - * circuit bandwidths. - * @member {string} [mtu] Maximum transmission unit of the physical port + * @property {number} [bandwidthInGbps] Bandwidth of procured ports in Gbps + * @property {number} [provisionedBandwidthInGbps] Aggregate Gbps of + * associated circuit bandwidths. + * @property {string} [mtu] Maximum transmission unit of the physical port * pair(s) - * @member {string} [encapsulation] Encapsulation method on physical ports. + * @property {string} [encapsulation] Encapsulation method on physical ports. * Possible values include: 'Dot1Q', 'QinQ' - * @member {string} [etherType] Ethertype of the physical port. - * @member {string} [allocationDate] Date of the physical port allocation to - * be used in Letter of Authorization. - * @member {array} [links] ExpressRouteLink Sub-Resources. The set of + * @property {string} [etherType] Ethertype of the physical port. + * @property {string} [allocationDate] Date of the physical port allocation + * to be used in Letter of Authorization. + * @property {array} [links] ExpressRouteLink Sub-Resources. The set of * physical links of the ExpressRoutePort resource - * @member {array} [circuits] Reference the ExpressRoute circuit(s) that are - * provisioned on this ExpressRoutePort resource. - * @member {string} [provisioningState] The provisioning state of the + * @property {array} [circuits] Reference the ExpressRoute circuit(s) that + * are provisioned on this ExpressRoutePort resource. + * @property {string} [provisioningState] The provisioning state of the * ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [resourceGuid] The resource GUID property of the + * @property {string} [resourceGuid] The resource GUID property of the * ExpressRoutePort resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRoutePortListResult.js b/lib/services/networkManagement2/lib/models/expressRoutePortListResult.js index c4ad9707fb..1453a2c1ae 100644 --- a/lib/services/networkManagement2/lib/models/expressRoutePortListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRoutePortListResult.js @@ -17,7 +17,7 @@ class ExpressRoutePortListResult extends Array { /** * Create a ExpressRoutePortListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/expressRoutePortsLocation.js b/lib/services/networkManagement2/lib/models/expressRoutePortsLocation.js index a49e41befc..e1098643a5 100644 --- a/lib/services/networkManagement2/lib/models/expressRoutePortsLocation.js +++ b/lib/services/networkManagement2/lib/models/expressRoutePortsLocation.js @@ -22,11 +22,11 @@ const models = require('./index'); class ExpressRoutePortsLocation extends models['Resource'] { /** * Create a ExpressRoutePortsLocation. - * @member {string} [address] Address of peering location. - * @member {string} [contact] Contact details of peering locations. - * @member {array} [availableBandwidths] The inventory of available + * @property {string} [address] Address of peering location. + * @property {string} [contact] Contact details of peering locations. + * @property {array} [availableBandwidths] The inventory of available * ExpressRoutePort bandwidths. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * ExpressRoutePortLocation resource. Possible values are: 'Succeeded', * 'Updating', 'Deleting', and 'Failed'. */ diff --git a/lib/services/networkManagement2/lib/models/expressRoutePortsLocationBandwidths.js b/lib/services/networkManagement2/lib/models/expressRoutePortsLocationBandwidths.js index fa3078f127..bb158bcd29 100644 --- a/lib/services/networkManagement2/lib/models/expressRoutePortsLocationBandwidths.js +++ b/lib/services/networkManagement2/lib/models/expressRoutePortsLocationBandwidths.js @@ -19,8 +19,8 @@ class ExpressRoutePortsLocationBandwidths { /** * Create a ExpressRoutePortsLocationBandwidths. - * @member {string} [offerName] Bandwidth descriptive name - * @member {number} [valueInGbps] Bandwidth value in Gbps + * @property {string} [offerName] Bandwidth descriptive name + * @property {number} [valueInGbps] Bandwidth value in Gbps */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRoutePortsLocationListResult.js b/lib/services/networkManagement2/lib/models/expressRoutePortsLocationListResult.js index 4cb4f4d510..d7eeba384b 100644 --- a/lib/services/networkManagement2/lib/models/expressRoutePortsLocationListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRoutePortsLocationListResult.js @@ -17,7 +17,7 @@ class ExpressRoutePortsLocationListResult extends Array { /** * Create a ExpressRoutePortsLocationListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/expressRouteServiceProvider.js b/lib/services/networkManagement2/lib/models/expressRouteServiceProvider.js index 43bb5d2474..45a6ab231d 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteServiceProvider.js +++ b/lib/services/networkManagement2/lib/models/expressRouteServiceProvider.js @@ -20,9 +20,9 @@ const models = require('./index'); class ExpressRouteServiceProvider extends models['Resource'] { /** * Create a ExpressRouteServiceProvider. - * @member {array} [peeringLocations] Get a list of peering locations. - * @member {array} [bandwidthsOffered] Gets bandwidths offered. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {array} [peeringLocations] Get a list of peering locations. + * @property {array} [bandwidthsOffered] Gets bandwidths offered. + * @property {string} [provisioningState] Gets the provisioning state of the * resource. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/expressRouteServiceProviderBandwidthsOffered.js b/lib/services/networkManagement2/lib/models/expressRouteServiceProviderBandwidthsOffered.js index 5cdb44d2c0..9504fed980 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteServiceProviderBandwidthsOffered.js +++ b/lib/services/networkManagement2/lib/models/expressRouteServiceProviderBandwidthsOffered.js @@ -17,8 +17,8 @@ class ExpressRouteServiceProviderBandwidthsOffered { /** * Create a ExpressRouteServiceProviderBandwidthsOffered. - * @member {string} [offerName] The OfferName. - * @member {number} [valueInMbps] The ValueInMbps. + * @property {string} [offerName] The OfferName. + * @property {number} [valueInMbps] The ValueInMbps. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/expressRouteServiceProviderListResult.js b/lib/services/networkManagement2/lib/models/expressRouteServiceProviderListResult.js index cf04035185..9c9cde4ded 100644 --- a/lib/services/networkManagement2/lib/models/expressRouteServiceProviderListResult.js +++ b/lib/services/networkManagement2/lib/models/expressRouteServiceProviderListResult.js @@ -16,7 +16,7 @@ class ExpressRouteServiceProviderListResult extends Array { /** * Create a ExpressRouteServiceProviderListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/flowLogFormatParameters.js b/lib/services/networkManagement2/lib/models/flowLogFormatParameters.js new file mode 100644 index 0000000000..3a57e9cc68 --- /dev/null +++ b/lib/services/networkManagement2/lib/models/flowLogFormatParameters.js @@ -0,0 +1,63 @@ +/* + * 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'; + +/** + * Parameters that define the flow log format. + * + */ +class FlowLogFormatParameters { + /** + * Create a FlowLogFormatParameters. + * @property {string} [type] The file type of flow log. Possible values + * include: 'JSON' + * @property {number} [version] The version (revision) of the flow log. + * Default value: 0 . + */ + constructor() { + } + + /** + * Defines the metadata of FlowLogFormatParameters + * + * @returns {object} metadata of FlowLogFormatParameters + * + */ + mapper() { + return { + required: false, + serializedName: 'FlowLogFormatParameters', + type: { + name: 'Composite', + className: 'FlowLogFormatParameters', + modelProperties: { + type: { + required: false, + serializedName: 'type', + type: { + name: 'String' + } + }, + version: { + required: false, + serializedName: 'version', + defaultValue: 0, + type: { + name: 'Number' + } + } + } + } + }; + } +} + +module.exports = FlowLogFormatParameters; diff --git a/lib/services/networkManagement2/lib/models/flowLogInformation.js b/lib/services/networkManagement2/lib/models/flowLogInformation.js index d7161fb690..20bbb0b7f4 100644 --- a/lib/services/networkManagement2/lib/models/flowLogInformation.js +++ b/lib/services/networkManagement2/lib/models/flowLogInformation.js @@ -18,31 +18,40 @@ class FlowLogInformation { /** * Create a FlowLogInformation. - * @member {string} targetResourceId The ID of the resource to configure for - * flow log and traffic analytics (optional) . - * @member {string} storageId ID of the storage account which is used to + * @property {string} targetResourceId The ID of the resource to configure + * for flow log and traffic analytics (optional) . + * @property {string} storageId ID of the storage account which is used to * store the flow log. - * @member {boolean} enabled Flag to enable/disable flow logging. - * @member {object} [retentionPolicy] - * @member {number} [retentionPolicy.days] Number of days to retain flow log - * records. - * @member {boolean} [retentionPolicy.enabled] Flag to enable/disable + * @property {boolean} enabled Flag to enable/disable flow logging. + * @property {object} [retentionPolicy] + * @property {number} [retentionPolicy.days] Number of days to retain flow + * log records. + * @property {boolean} [retentionPolicy.enabled] Flag to enable/disable * retention. - * @member {object} [flowAnalyticsConfiguration] - * @member {object} + * @property {object} [format] + * @property {string} [format.type] The file type of flow log. Possible + * values include: 'JSON' + * @property {number} [format.version] The version (revision) of the flow + * log. + * @property {object} [flowAnalyticsConfiguration] + * @property {object} * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration] - * @member {boolean} + * @property {boolean} * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.enabled] * Flag to enable/disable traffic analytics. - * @member {string} + * @property {string} * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceId] * The resource guid of the attached workspace - * @member {string} + * @property {string} * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceRegion] * The location of the attached workspace - * @member {string} + * @property {string} * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId] * Resource Id of the attached workspace + * @property {number} + * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service + * should do flow analytics */ constructor() { } @@ -90,6 +99,14 @@ class FlowLogInformation { className: 'RetentionPolicyParameters' } }, + format: { + required: false, + serializedName: 'properties.format', + type: { + name: 'Composite', + className: 'FlowLogFormatParameters' + } + }, flowAnalyticsConfiguration: { required: false, serializedName: 'flowAnalyticsConfiguration', diff --git a/lib/services/networkManagement2/lib/models/flowLogStatusParameters.js b/lib/services/networkManagement2/lib/models/flowLogStatusParameters.js index f3ebc41d6e..111c451ce4 100644 --- a/lib/services/networkManagement2/lib/models/flowLogStatusParameters.js +++ b/lib/services/networkManagement2/lib/models/flowLogStatusParameters.js @@ -18,7 +18,7 @@ class FlowLogStatusParameters { /** * Create a FlowLogStatusParameters. - * @member {string} targetResourceId The target resource where getting the + * @property {string} targetResourceId The target resource where getting the * flow log and traffic analytics (optional) status. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/frontendIPConfiguration.js b/lib/services/networkManagement2/lib/models/frontendIPConfiguration.js index f263c5e10c..935a6e5dfe 100644 --- a/lib/services/networkManagement2/lib/models/frontendIPConfiguration.js +++ b/lib/services/networkManagement2/lib/models/frontendIPConfiguration.js @@ -20,235 +20,238 @@ const models = require('./index'); class FrontendIPConfiguration extends models['SubResource'] { /** * Create a FrontendIPConfiguration. - * @member {array} [inboundNatRules] Read only. Inbound rules URIs that use + * @property {array} [inboundNatRules] Read only. Inbound rules URIs that use * this frontend IP. - * @member {array} [inboundNatPools] Read only. Inbound pools URIs that use + * @property {array} [inboundNatPools] Read only. Inbound pools URIs that use * this frontend IP. - * @member {array} [outboundRules] Read only. Outbound rules URIs that use + * @property {array} [outboundRules] Read only. Outbound rules URIs that use * this frontend IP. - * @member {array} [loadBalancingRules] Gets load balancing rules URIs that + * @property {array} [loadBalancingRules] Gets load balancing rules URIs that * use this frontend IP. - * @member {string} [privateIPAddress] The private IP address of the IP + * @property {string} [privateIPAddress] The private IP address of the IP * configuration. - * @member {string} [privateIPAllocationMethod] The Private IP allocation + * @property {string} [privateIPAllocationMethod] The Private IP allocation * method. Possible values are: 'Static' and 'Dynamic'. Possible values * include: 'Static', 'Dynamic' - * @member {object} [subnet] The reference of the subnet resource. - * @member {string} [subnet.addressPrefix] The address prefix for the subnet. - * @member {array} [subnet.addressPrefixes] List of address prefixes for the + * @property {object} [subnet] The reference of the subnet resource. + * @property {string} [subnet.addressPrefix] The address prefix for the * subnet. - * @member {object} [subnet.networkSecurityGroup] The reference of the + * @property {array} [subnet.addressPrefixes] List of address prefixes for + * the subnet. + * @property {object} [subnet.networkSecurityGroup] The reference of the * NetworkSecurityGroup resource. - * @member {array} [subnet.networkSecurityGroup.securityRules] A collection + * @property {array} [subnet.networkSecurityGroup.securityRules] A collection * of security rules of the network security group. - * @member {array} [subnet.networkSecurityGroup.defaultSecurityRules] The + * @property {array} [subnet.networkSecurityGroup.defaultSecurityRules] The * default security rules of network security group. - * @member {array} [subnet.networkSecurityGroup.networkInterfaces] A + * @property {array} [subnet.networkSecurityGroup.networkInterfaces] A * collection of references to network interfaces. - * @member {array} [subnet.networkSecurityGroup.subnets] A collection of + * @property {array} [subnet.networkSecurityGroup.subnets] A collection of * references to subnets. - * @member {string} [subnet.networkSecurityGroup.resourceGuid] The resource + * @property {string} [subnet.networkSecurityGroup.resourceGuid] The resource * GUID property of the network security group resource. - * @member {string} [subnet.networkSecurityGroup.provisioningState] The + * @property {string} [subnet.networkSecurityGroup.provisioningState] The * provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [subnet.networkSecurityGroup.etag] A unique read-only + * @property {string} [subnet.networkSecurityGroup.etag] A unique read-only * string that changes whenever the resource is updated. - * @member {object} [subnet.routeTable] The reference of the RouteTable + * @property {object} [subnet.routeTable] The reference of the RouteTable * resource. - * @member {array} [subnet.routeTable.routes] Collection of routes contained - * within a route table. - * @member {array} [subnet.routeTable.subnets] A collection of references to - * subnets. - * @member {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or + * @property {array} [subnet.routeTable.routes] Collection of routes + * contained within a route table. + * @property {array} [subnet.routeTable.subnets] A collection of references + * to subnets. + * @property {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or * sets whether to disable the routes learned by BGP on that route table. * True means disable. - * @member {string} [subnet.routeTable.provisioningState] The provisioning + * @property {string} [subnet.routeTable.provisioningState] The provisioning * state of the resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [subnet.routeTable.etag] Gets a unique read-only string + * @property {string} [subnet.routeTable.etag] Gets a unique read-only string * that changes whenever the resource is updated. - * @member {array} [subnet.serviceEndpoints] An array of service endpoints. - * @member {array} [subnet.serviceEndpointPolicies] An array of service + * @property {array} [subnet.serviceEndpoints] An array of service endpoints. + * @property {array} [subnet.serviceEndpointPolicies] An array of service * endpoint policies. - * @member {array} [subnet.interfaceEndpoints] An array of references to + * @property {array} [subnet.interfaceEndpoints] An array of references to * interface endpoints - * @member {array} [subnet.ipConfigurations] Gets an array of references to + * @property {array} [subnet.ipConfigurations] Gets an array of references to * the network interface IP configurations using subnet. - * @member {array} [subnet.ipConfigurationProfiles] Array of IP configuration - * profiles which reference this subnet. - * @member {array} [subnet.resourceNavigationLinks] Gets an array of + * @property {array} [subnet.ipConfigurationProfiles] Array of IP + * configuration profiles which reference this subnet. + * @property {array} [subnet.resourceNavigationLinks] Gets an array of * references to the external resources using subnet. - * @member {array} [subnet.serviceAssociationLinks] Gets an array of + * @property {array} [subnet.serviceAssociationLinks] Gets an array of * references to services injecting into this subnet. - * @member {array} [subnet.delegations] Gets an array of references to the + * @property {array} [subnet.delegations] Gets an array of references to the * delegations on the subnet. - * @member {string} [subnet.purpose] A read-only string identifying the + * @property {string} [subnet.purpose] A read-only string identifying the * intention of use for this subnet based on delegations and other * user-defined properties. - * @member {string} [subnet.provisioningState] The provisioning state of the - * resource. - * @member {string} [subnet.name] The name of the resource that is unique + * @property {string} [subnet.provisioningState] The provisioning state of + * the resource. + * @property {string} [subnet.name] The name of the resource that is unique * within a resource group. This name can be used to access the resource. - * @member {string} [subnet.etag] A unique read-only string that changes + * @property {string} [subnet.etag] A unique read-only string that changes * whenever the resource is updated. - * @member {object} [publicIPAddress] The reference of the Public IP + * @property {object} [publicIPAddress] The reference of the Public IP * resource. - * @member {object} [publicIPAddress.sku] The public IP address SKU. - * @member {string} [publicIPAddress.sku.name] Name of a public IP address + * @property {object} [publicIPAddress.sku] The public IP address SKU. + * @property {string} [publicIPAddress.sku.name] Name of a public IP address * SKU. Possible values include: 'Basic', 'Standard' - * @member {string} [publicIPAddress.publicIPAllocationMethod] The public IP - * allocation method. Possible values are: 'Static' and 'Dynamic'. Possible - * values include: 'Static', 'Dynamic' - * @member {string} [publicIPAddress.publicIPAddressVersion] The public IP + * @property {string} [publicIPAddress.publicIPAllocationMethod] The public + * IP allocation method. Possible values are: 'Static' and 'Dynamic'. + * Possible values include: 'Static', 'Dynamic' + * @property {string} [publicIPAddress.publicIPAddressVersion] The public IP * address version. Possible values are: 'IPv4' and 'IPv6'. Possible values * include: 'IPv4', 'IPv6' - * @member {object} [publicIPAddress.ipConfiguration] The IP configuration + * @property {object} [publicIPAddress.ipConfiguration] The IP configuration * associated with the public IP address. - * @member {string} [publicIPAddress.ipConfiguration.privateIPAddress] The + * @property {string} [publicIPAddress.ipConfiguration.privateIPAddress] The * private IP address of the IP configuration. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.privateIPAllocationMethod] The private IP * allocation method. Possible values are 'Static' and 'Dynamic'. Possible * values include: 'Static', 'Dynamic' - * @member {object} [publicIPAddress.ipConfiguration.subnet] The reference of - * the subnet resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.addressPrefix] + * @property {object} [publicIPAddress.ipConfiguration.subnet] The reference + * of the subnet resource. + * @property {string} [publicIPAddress.ipConfiguration.subnet.addressPrefix] * The address prefix for the subnet. - * @member {array} [publicIPAddress.ipConfiguration.subnet.addressPrefixes] + * @property {array} [publicIPAddress.ipConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] The * reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] A * collection of references to subnets. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.ipConfiguration.subnet.routeTable] The + * @property {object} [publicIPAddress.ipConfiguration.subnet.routeTable] The * reference of the RouteTable resource. - * @member {array} [publicIPAddress.ipConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} + * @property {array} + * [publicIPAddress.ipConfiguration.subnet.routeTable.routes] Collection of + * routes contained within a route table. + * @property {array} * [publicIPAddress.ipConfiguration.subnet.routeTable.subnets] A collection * of references to subnets. - * @member {boolean} + * @property {boolean} * [publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] The * provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.ipConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} [publicIPAddress.ipConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * @member {array} + * @property {string} + * [publicIPAddress.ipConfiguration.subnet.routeTable.etag] Gets a unique + * read-only string that changes whenever the resource is updated. + * @property {array} + * [publicIPAddress.ipConfiguration.subnet.serviceEndpoints] An array of + * service endpoints. + * @property {array} * [publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] An array * of service endpoint policies. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] An array of * references to interface endpoints - * @member {array} [publicIPAddress.ipConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations - * using subnet. - * @member {array} + * @property {array} + * [publicIPAddress.ipConfiguration.subnet.ipConfigurations] Gets an array of + * references to the network interface IP configurations using subnet. + * @property {array} * [publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] Array of * IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] Gets an * array of references to the external resources using subnet. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] Gets an * array of references to services injecting into this subnet. - * @member {array} [publicIPAddress.ipConfiguration.subnet.delegations] Gets - * an array of references to the delegations on the subnet. - * @member {string} [publicIPAddress.ipConfiguration.subnet.purpose] A + * @property {array} [publicIPAddress.ipConfiguration.subnet.delegations] + * Gets an array of references to the delegations on the subnet. + * @property {string} [publicIPAddress.ipConfiguration.subnet.purpose] A * read-only string identifying the intention of use for this subnet based on * delegations and other user-defined properties. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.subnet.provisioningState] The * provisioning state of the resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.name] The name of - * the resource that is unique within a resource group. This name can be used - * to access the resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.etag] A unique + * @property {string} [publicIPAddress.ipConfiguration.subnet.name] The name + * of the resource that is unique within a resource group. This name can be + * used to access the resource. + * @property {string} [publicIPAddress.ipConfiguration.subnet.etag] A unique * read-only string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.ipConfiguration.publicIPAddress] The + * @property {object} [publicIPAddress.ipConfiguration.publicIPAddress] The * reference of the public IP resource. - * @member {string} [publicIPAddress.ipConfiguration.provisioningState] Gets - * the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.ipConfiguration.name] The name of the + * @property {string} [publicIPAddress.ipConfiguration.provisioningState] + * Gets the provisioning state of the public IP resource. Possible values + * are: 'Updating', 'Deleting', and 'Failed'. + * @property {string} [publicIPAddress.ipConfiguration.name] The name of the * resource that is unique within a resource group. This name can be used to * access the resource. - * @member {string} [publicIPAddress.ipConfiguration.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.dnsSettings] The FQDN of the DNS record - * associated with the public IP address. - * @member {string} [publicIPAddress.dnsSettings.domainNameLabel] Gets or + * @property {string} [publicIPAddress.ipConfiguration.etag] A unique + * read-only string that changes whenever the resource is updated. + * @property {object} [publicIPAddress.dnsSettings] The FQDN of the DNS + * record associated with the public IP address. + * @property {string} [publicIPAddress.dnsSettings.domainNameLabel] Gets or * sets the Domain name label.The concatenation of the domain name label and * the regionalized DNS zone make up the fully qualified domain name * associated with the public IP address. If a domain name label is * specified, an A DNS record is created for the public IP in the Microsoft * Azure DNS system. - * @member {string} [publicIPAddress.dnsSettings.fqdn] Gets the FQDN, Fully + * @property {string} [publicIPAddress.dnsSettings.fqdn] Gets the FQDN, Fully * qualified domain name of the A DNS record associated with the public IP. * This is the concatenation of the domainNameLabel and the regionalized DNS * zone. - * @member {string} [publicIPAddress.dnsSettings.reverseFqdn] Gets or Sets + * @property {string} [publicIPAddress.dnsSettings.reverseFqdn] Gets or Sets * the Reverse FQDN. A user-visible, fully qualified domain name that * resolves to this public IP address. If the reverseFqdn is specified, then * a PTR DNS record is created pointing from the IP address in the * in-addr.arpa domain to the reverse FQDN. - * @member {array} [publicIPAddress.ipTags] The list of tags associated with - * the public IP address. - * @member {string} [publicIPAddress.ipAddress] The IP address associated + * @property {array} [publicIPAddress.ipTags] The list of tags associated + * with the public IP address. + * @property {string} [publicIPAddress.ipAddress] The IP address associated * with the public IP address resource. - * @member {object} [publicIPAddress.publicIPPrefix] The Public IP Prefix + * @property {object} [publicIPAddress.publicIPPrefix] The Public IP Prefix * this Public IP Address should be allocated from. - * @member {string} [publicIPAddress.publicIPPrefix.id] Resource ID. - * @member {number} [publicIPAddress.idleTimeoutInMinutes] The idle timeout + * @property {string} [publicIPAddress.publicIPPrefix.id] Resource ID. + * @property {number} [publicIPAddress.idleTimeoutInMinutes] The idle timeout * of the public IP address. - * @member {string} [publicIPAddress.resourceGuid] The resource GUID property - * of the public IP resource. - * @member {string} [publicIPAddress.provisioningState] The provisioning + * @property {string} [publicIPAddress.resourceGuid] The resource GUID + * property of the public IP resource. + * @property {string} [publicIPAddress.provisioningState] The provisioning * state of the PublicIP resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.etag] A unique read-only string that + * @property {string} [publicIPAddress.etag] A unique read-only string that * changes whenever the resource is updated. - * @member {array} [publicIPAddress.zones] A list of availability zones + * @property {array} [publicIPAddress.zones] A list of availability zones * denoting the IP allocated for the resource needs to come from. - * @member {object} [publicIPPrefix] The reference of the Public IP Prefix + * @property {object} [publicIPPrefix] The reference of the Public IP Prefix * resource. - * @member {string} [publicIPPrefix.id] Resource ID. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {string} [publicIPPrefix.id] Resource ID. + * @property {string} [provisioningState] Gets the provisioning state of the * public IP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {array} [zones] A list of availability zones denoting the IP + * @property {array} [zones] A list of availability zones denoting the IP * allocated for the resource needs to come from. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/gatewayRoute.js b/lib/services/networkManagement2/lib/models/gatewayRoute.js index 4f2a9526a6..129e19d69e 100644 --- a/lib/services/networkManagement2/lib/models/gatewayRoute.js +++ b/lib/services/networkManagement2/lib/models/gatewayRoute.js @@ -17,13 +17,13 @@ class GatewayRoute { /** * Create a GatewayRoute. - * @member {string} [localAddress] The gateway's local address - * @member {string} [network] The route's network prefix - * @member {string} [nextHop] The route's next hop - * @member {string} [sourcePeer] The peer this route was learned from - * @member {string} [origin] The source this route was learned from - * @member {string} [asPath] The route's AS path sequence - * @member {number} [weight] The route's weight + * @property {string} [localAddress] The gateway's local address + * @property {string} [network] The route's network prefix + * @property {string} [nextHop] The route's next hop + * @property {string} [sourcePeer] The peer this route was learned from + * @property {string} [origin] The source this route was learned from + * @property {string} [asPath] The route's AS path sequence + * @property {number} [weight] The route's weight */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/gatewayRouteListResult.js b/lib/services/networkManagement2/lib/models/gatewayRouteListResult.js index a666239430..4dbc779825 100644 --- a/lib/services/networkManagement2/lib/models/gatewayRouteListResult.js +++ b/lib/services/networkManagement2/lib/models/gatewayRouteListResult.js @@ -17,7 +17,7 @@ class GatewayRouteListResult { /** * Create a GatewayRouteListResult. - * @member {array} [value] List of gateway routes + * @property {array} [value] List of gateway routes */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/getVpnSitesConfigurationRequest.js b/lib/services/networkManagement2/lib/models/getVpnSitesConfigurationRequest.js index 4ce96099c5..26d9b83235 100644 --- a/lib/services/networkManagement2/lib/models/getVpnSitesConfigurationRequest.js +++ b/lib/services/networkManagement2/lib/models/getVpnSitesConfigurationRequest.js @@ -17,9 +17,9 @@ class GetVpnSitesConfigurationRequest { /** * Create a GetVpnSitesConfigurationRequest. - * @member {array} [vpnSites] List of resource-ids of the vpn-sites for which - * config is to be downloaded. - * @member {string} [outputBlobSasUrl] The sas-url to download the + * @property {array} [vpnSites] List of resource-ids of the vpn-sites for + * which config is to be downloaded. + * @property {string} [outputBlobSasUrl] The sas-url to download the * configurations for vpn-sites */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/hTTPConfiguration.js b/lib/services/networkManagement2/lib/models/hTTPConfiguration.js index 1cf98671ac..cca495db78 100644 --- a/lib/services/networkManagement2/lib/models/hTTPConfiguration.js +++ b/lib/services/networkManagement2/lib/models/hTTPConfiguration.js @@ -17,9 +17,9 @@ class HTTPConfiguration { /** * Create a HTTPConfiguration. - * @member {string} [method] HTTP method. Possible values include: 'Get' - * @member {array} [headers] List of HTTP headers. - * @member {array} [validStatusCodes] Valid status codes. + * @property {string} [method] HTTP method. Possible values include: 'Get' + * @property {array} [headers] List of HTTP headers. + * @property {array} [validStatusCodes] Valid status codes. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/hTTPHeader.js b/lib/services/networkManagement2/lib/models/hTTPHeader.js index fd5ca3516c..82feacb939 100644 --- a/lib/services/networkManagement2/lib/models/hTTPHeader.js +++ b/lib/services/networkManagement2/lib/models/hTTPHeader.js @@ -17,8 +17,8 @@ class HTTPHeader { /** * Create a HTTPHeader. - * @member {string} [name] The name in HTTP header. - * @member {string} [value] The value in HTTP header. + * @property {string} [name] The name in HTTP header. + * @property {string} [value] The value in HTTP header. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/hubVirtualNetworkConnection.js b/lib/services/networkManagement2/lib/models/hubVirtualNetworkConnection.js index de3551178d..15bca23ebf 100644 --- a/lib/services/networkManagement2/lib/models/hubVirtualNetworkConnection.js +++ b/lib/services/networkManagement2/lib/models/hubVirtualNetworkConnection.js @@ -20,20 +20,20 @@ const models = require('./index'); class HubVirtualNetworkConnection extends models['SubResource'] { /** * Create a HubVirtualNetworkConnection. - * @member {object} [remoteVirtualNetwork] Reference to the remote virtual + * @property {object} [remoteVirtualNetwork] Reference to the remote virtual * network. - * @member {string} [remoteVirtualNetwork.id] Resource ID. - * @member {boolean} [allowHubToRemoteVnetTransit] VirtualHub to RemoteVnet + * @property {string} [remoteVirtualNetwork.id] Resource ID. + * @property {boolean} [allowHubToRemoteVnetTransit] VirtualHub to RemoteVnet * transit to enabled or not. - * @member {boolean} [allowRemoteVnetToUseHubVnetGateways] Allow RemoteVnet + * @property {boolean} [allowRemoteVnetToUseHubVnetGateways] Allow RemoteVnet * to use Virtual Hub's gateways. - * @member {boolean} [enableInternetSecurity] Enable internet security - * @member {string} [provisioningState] The provisioning state of the + * @property {boolean} [enableInternetSecurity] Enable internet security + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/iPAddressAvailabilityResult.js b/lib/services/networkManagement2/lib/models/iPAddressAvailabilityResult.js index ceedaeb386..c5df5c58a8 100644 --- a/lib/services/networkManagement2/lib/models/iPAddressAvailabilityResult.js +++ b/lib/services/networkManagement2/lib/models/iPAddressAvailabilityResult.js @@ -17,9 +17,9 @@ class IPAddressAvailabilityResult { /** * Create a IPAddressAvailabilityResult. - * @member {boolean} [available] Private IP address availability. - * @member {array} [availableIPAddresses] Contains other available private IP - * addresses if the asked for address is taken. + * @property {boolean} [available] Private IP address availability. + * @property {array} [availableIPAddresses] Contains other available private + * IP addresses if the asked for address is taken. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/iPConfiguration.js b/lib/services/networkManagement2/lib/models/iPConfiguration.js index bdeb1e7d3f..8fb1f9cc92 100644 --- a/lib/services/networkManagement2/lib/models/iPConfiguration.js +++ b/lib/services/networkManagement2/lib/models/iPConfiguration.js @@ -20,124 +20,125 @@ const models = require('./index'); class IPConfiguration extends models['SubResource'] { /** * Create a IPConfiguration. - * @member {string} [privateIPAddress] The private IP address of the IP + * @property {string} [privateIPAddress] The private IP address of the IP * configuration. - * @member {string} [privateIPAllocationMethod] The private IP allocation + * @property {string} [privateIPAllocationMethod] The private IP allocation * method. Possible values are 'Static' and 'Dynamic'. Possible values * include: 'Static', 'Dynamic' - * @member {object} [subnet] The reference of the subnet resource. - * @member {string} [subnet.addressPrefix] The address prefix for the subnet. - * @member {array} [subnet.addressPrefixes] List of address prefixes for the + * @property {object} [subnet] The reference of the subnet resource. + * @property {string} [subnet.addressPrefix] The address prefix for the * subnet. - * @member {object} [subnet.networkSecurityGroup] The reference of the + * @property {array} [subnet.addressPrefixes] List of address prefixes for + * the subnet. + * @property {object} [subnet.networkSecurityGroup] The reference of the * NetworkSecurityGroup resource. - * @member {array} [subnet.networkSecurityGroup.securityRules] A collection + * @property {array} [subnet.networkSecurityGroup.securityRules] A collection * of security rules of the network security group. - * @member {array} [subnet.networkSecurityGroup.defaultSecurityRules] The + * @property {array} [subnet.networkSecurityGroup.defaultSecurityRules] The * default security rules of network security group. - * @member {array} [subnet.networkSecurityGroup.networkInterfaces] A + * @property {array} [subnet.networkSecurityGroup.networkInterfaces] A * collection of references to network interfaces. - * @member {array} [subnet.networkSecurityGroup.subnets] A collection of + * @property {array} [subnet.networkSecurityGroup.subnets] A collection of * references to subnets. - * @member {string} [subnet.networkSecurityGroup.resourceGuid] The resource + * @property {string} [subnet.networkSecurityGroup.resourceGuid] The resource * GUID property of the network security group resource. - * @member {string} [subnet.networkSecurityGroup.provisioningState] The + * @property {string} [subnet.networkSecurityGroup.provisioningState] The * provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [subnet.networkSecurityGroup.etag] A unique read-only + * @property {string} [subnet.networkSecurityGroup.etag] A unique read-only * string that changes whenever the resource is updated. - * @member {object} [subnet.routeTable] The reference of the RouteTable + * @property {object} [subnet.routeTable] The reference of the RouteTable * resource. - * @member {array} [subnet.routeTable.routes] Collection of routes contained - * within a route table. - * @member {array} [subnet.routeTable.subnets] A collection of references to - * subnets. - * @member {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or + * @property {array} [subnet.routeTable.routes] Collection of routes + * contained within a route table. + * @property {array} [subnet.routeTable.subnets] A collection of references + * to subnets. + * @property {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or * sets whether to disable the routes learned by BGP on that route table. * True means disable. - * @member {string} [subnet.routeTable.provisioningState] The provisioning + * @property {string} [subnet.routeTable.provisioningState] The provisioning * state of the resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [subnet.routeTable.etag] Gets a unique read-only string + * @property {string} [subnet.routeTable.etag] Gets a unique read-only string * that changes whenever the resource is updated. - * @member {array} [subnet.serviceEndpoints] An array of service endpoints. - * @member {array} [subnet.serviceEndpointPolicies] An array of service + * @property {array} [subnet.serviceEndpoints] An array of service endpoints. + * @property {array} [subnet.serviceEndpointPolicies] An array of service * endpoint policies. - * @member {array} [subnet.interfaceEndpoints] An array of references to + * @property {array} [subnet.interfaceEndpoints] An array of references to * interface endpoints - * @member {array} [subnet.ipConfigurations] Gets an array of references to + * @property {array} [subnet.ipConfigurations] Gets an array of references to * the network interface IP configurations using subnet. - * @member {array} [subnet.ipConfigurationProfiles] Array of IP configuration - * profiles which reference this subnet. - * @member {array} [subnet.resourceNavigationLinks] Gets an array of + * @property {array} [subnet.ipConfigurationProfiles] Array of IP + * configuration profiles which reference this subnet. + * @property {array} [subnet.resourceNavigationLinks] Gets an array of * references to the external resources using subnet. - * @member {array} [subnet.serviceAssociationLinks] Gets an array of + * @property {array} [subnet.serviceAssociationLinks] Gets an array of * references to services injecting into this subnet. - * @member {array} [subnet.delegations] Gets an array of references to the + * @property {array} [subnet.delegations] Gets an array of references to the * delegations on the subnet. - * @member {string} [subnet.purpose] A read-only string identifying the + * @property {string} [subnet.purpose] A read-only string identifying the * intention of use for this subnet based on delegations and other * user-defined properties. - * @member {string} [subnet.provisioningState] The provisioning state of the - * resource. - * @member {string} [subnet.name] The name of the resource that is unique + * @property {string} [subnet.provisioningState] The provisioning state of + * the resource. + * @property {string} [subnet.name] The name of the resource that is unique * within a resource group. This name can be used to access the resource. - * @member {string} [subnet.etag] A unique read-only string that changes + * @property {string} [subnet.etag] A unique read-only string that changes * whenever the resource is updated. - * @member {object} [publicIPAddress] The reference of the public IP + * @property {object} [publicIPAddress] The reference of the public IP * resource. - * @member {object} [publicIPAddress.sku] The public IP address SKU. - * @member {string} [publicIPAddress.sku.name] Name of a public IP address + * @property {object} [publicIPAddress.sku] The public IP address SKU. + * @property {string} [publicIPAddress.sku.name] Name of a public IP address * SKU. Possible values include: 'Basic', 'Standard' - * @member {string} [publicIPAddress.publicIPAllocationMethod] The public IP - * allocation method. Possible values are: 'Static' and 'Dynamic'. Possible - * values include: 'Static', 'Dynamic' - * @member {string} [publicIPAddress.publicIPAddressVersion] The public IP + * @property {string} [publicIPAddress.publicIPAllocationMethod] The public + * IP allocation method. Possible values are: 'Static' and 'Dynamic'. + * Possible values include: 'Static', 'Dynamic' + * @property {string} [publicIPAddress.publicIPAddressVersion] The public IP * address version. Possible values are: 'IPv4' and 'IPv6'. Possible values * include: 'IPv4', 'IPv6' - * @member {object} [publicIPAddress.ipConfiguration] The IP configuration - * associated with the public IP address. - * @member {object} [publicIPAddress.dnsSettings] The FQDN of the DNS record + * @property {object} [publicIPAddress.ipConfiguration] The IP configuration * associated with the public IP address. - * @member {string} [publicIPAddress.dnsSettings.domainNameLabel] Gets or + * @property {object} [publicIPAddress.dnsSettings] The FQDN of the DNS + * record associated with the public IP address. + * @property {string} [publicIPAddress.dnsSettings.domainNameLabel] Gets or * sets the Domain name label.The concatenation of the domain name label and * the regionalized DNS zone make up the fully qualified domain name * associated with the public IP address. If a domain name label is * specified, an A DNS record is created for the public IP in the Microsoft * Azure DNS system. - * @member {string} [publicIPAddress.dnsSettings.fqdn] Gets the FQDN, Fully + * @property {string} [publicIPAddress.dnsSettings.fqdn] Gets the FQDN, Fully * qualified domain name of the A DNS record associated with the public IP. * This is the concatenation of the domainNameLabel and the regionalized DNS * zone. - * @member {string} [publicIPAddress.dnsSettings.reverseFqdn] Gets or Sets + * @property {string} [publicIPAddress.dnsSettings.reverseFqdn] Gets or Sets * the Reverse FQDN. A user-visible, fully qualified domain name that * resolves to this public IP address. If the reverseFqdn is specified, then * a PTR DNS record is created pointing from the IP address in the * in-addr.arpa domain to the reverse FQDN. - * @member {array} [publicIPAddress.ipTags] The list of tags associated with - * the public IP address. - * @member {string} [publicIPAddress.ipAddress] The IP address associated + * @property {array} [publicIPAddress.ipTags] The list of tags associated + * with the public IP address. + * @property {string} [publicIPAddress.ipAddress] The IP address associated * with the public IP address resource. - * @member {object} [publicIPAddress.publicIPPrefix] The Public IP Prefix + * @property {object} [publicIPAddress.publicIPPrefix] The Public IP Prefix * this Public IP Address should be allocated from. - * @member {string} [publicIPAddress.publicIPPrefix.id] Resource ID. - * @member {number} [publicIPAddress.idleTimeoutInMinutes] The idle timeout + * @property {string} [publicIPAddress.publicIPPrefix.id] Resource ID. + * @property {number} [publicIPAddress.idleTimeoutInMinutes] The idle timeout * of the public IP address. - * @member {string} [publicIPAddress.resourceGuid] The resource GUID property - * of the public IP resource. - * @member {string} [publicIPAddress.provisioningState] The provisioning + * @property {string} [publicIPAddress.resourceGuid] The resource GUID + * property of the public IP resource. + * @property {string} [publicIPAddress.provisioningState] The provisioning * state of the PublicIP resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.etag] A unique read-only string that + * @property {string} [publicIPAddress.etag] A unique read-only string that * changes whenever the resource is updated. - * @member {array} [publicIPAddress.zones] A list of availability zones + * @property {array} [publicIPAddress.zones] A list of availability zones * denoting the IP allocated for the resource needs to come from. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {string} [provisioningState] Gets the provisioning state of the * public IP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/iPConfigurationProfile.js b/lib/services/networkManagement2/lib/models/iPConfigurationProfile.js index 2e553c3d6e..8099172bba 100644 --- a/lib/services/networkManagement2/lib/models/iPConfigurationProfile.js +++ b/lib/services/networkManagement2/lib/models/iPConfigurationProfile.js @@ -20,72 +20,73 @@ const models = require('./index'); class IPConfigurationProfile extends models['SubResource'] { /** * Create a IPConfigurationProfile. - * @member {object} [subnet] The reference of the subnet resource to create a - * contatainer network interface ip configruation. - * @member {string} [subnet.addressPrefix] The address prefix for the subnet. - * @member {array} [subnet.addressPrefixes] List of address prefixes for the + * @property {object} [subnet] The reference of the subnet resource to create + * a contatainer network interface ip configruation. + * @property {string} [subnet.addressPrefix] The address prefix for the * subnet. - * @member {object} [subnet.networkSecurityGroup] The reference of the + * @property {array} [subnet.addressPrefixes] List of address prefixes for + * the subnet. + * @property {object} [subnet.networkSecurityGroup] The reference of the * NetworkSecurityGroup resource. - * @member {array} [subnet.networkSecurityGroup.securityRules] A collection + * @property {array} [subnet.networkSecurityGroup.securityRules] A collection * of security rules of the network security group. - * @member {array} [subnet.networkSecurityGroup.defaultSecurityRules] The + * @property {array} [subnet.networkSecurityGroup.defaultSecurityRules] The * default security rules of network security group. - * @member {array} [subnet.networkSecurityGroup.networkInterfaces] A + * @property {array} [subnet.networkSecurityGroup.networkInterfaces] A * collection of references to network interfaces. - * @member {array} [subnet.networkSecurityGroup.subnets] A collection of + * @property {array} [subnet.networkSecurityGroup.subnets] A collection of * references to subnets. - * @member {string} [subnet.networkSecurityGroup.resourceGuid] The resource + * @property {string} [subnet.networkSecurityGroup.resourceGuid] The resource * GUID property of the network security group resource. - * @member {string} [subnet.networkSecurityGroup.provisioningState] The + * @property {string} [subnet.networkSecurityGroup.provisioningState] The * provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [subnet.networkSecurityGroup.etag] A unique read-only + * @property {string} [subnet.networkSecurityGroup.etag] A unique read-only * string that changes whenever the resource is updated. - * @member {object} [subnet.routeTable] The reference of the RouteTable + * @property {object} [subnet.routeTable] The reference of the RouteTable * resource. - * @member {array} [subnet.routeTable.routes] Collection of routes contained - * within a route table. - * @member {array} [subnet.routeTable.subnets] A collection of references to - * subnets. - * @member {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or + * @property {array} [subnet.routeTable.routes] Collection of routes + * contained within a route table. + * @property {array} [subnet.routeTable.subnets] A collection of references + * to subnets. + * @property {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or * sets whether to disable the routes learned by BGP on that route table. * True means disable. - * @member {string} [subnet.routeTable.provisioningState] The provisioning + * @property {string} [subnet.routeTable.provisioningState] The provisioning * state of the resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [subnet.routeTable.etag] Gets a unique read-only string + * @property {string} [subnet.routeTable.etag] Gets a unique read-only string * that changes whenever the resource is updated. - * @member {array} [subnet.serviceEndpoints] An array of service endpoints. - * @member {array} [subnet.serviceEndpointPolicies] An array of service + * @property {array} [subnet.serviceEndpoints] An array of service endpoints. + * @property {array} [subnet.serviceEndpointPolicies] An array of service * endpoint policies. - * @member {array} [subnet.interfaceEndpoints] An array of references to + * @property {array} [subnet.interfaceEndpoints] An array of references to * interface endpoints - * @member {array} [subnet.ipConfigurations] Gets an array of references to + * @property {array} [subnet.ipConfigurations] Gets an array of references to * the network interface IP configurations using subnet. - * @member {array} [subnet.ipConfigurationProfiles] Array of IP configuration - * profiles which reference this subnet. - * @member {array} [subnet.resourceNavigationLinks] Gets an array of + * @property {array} [subnet.ipConfigurationProfiles] Array of IP + * configuration profiles which reference this subnet. + * @property {array} [subnet.resourceNavigationLinks] Gets an array of * references to the external resources using subnet. - * @member {array} [subnet.serviceAssociationLinks] Gets an array of + * @property {array} [subnet.serviceAssociationLinks] Gets an array of * references to services injecting into this subnet. - * @member {array} [subnet.delegations] Gets an array of references to the + * @property {array} [subnet.delegations] Gets an array of references to the * delegations on the subnet. - * @member {string} [subnet.purpose] A read-only string identifying the + * @property {string} [subnet.purpose] A read-only string identifying the * intention of use for this subnet based on delegations and other * user-defined properties. - * @member {string} [subnet.provisioningState] The provisioning state of the - * resource. - * @member {string} [subnet.name] The name of the resource that is unique + * @property {string} [subnet.provisioningState] The provisioning state of + * the resource. + * @property {string} [subnet.name] The name of the resource that is unique * within a resource group. This name can be used to access the resource. - * @member {string} [subnet.etag] A unique read-only string that changes + * @property {string} [subnet.etag] A unique read-only string that changes * whenever the resource is updated. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. - * @member {string} [name] The name of the resource. This name can be used to - * access the resource. - * @member {string} [type] Sub Resource type. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] The name of the resource. This name can be used + * to access the resource. + * @property {string} [type] Sub Resource type. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/inboundNatPool.js b/lib/services/networkManagement2/lib/models/inboundNatPool.js index 3e4166e3e1..230aa8e08a 100644 --- a/lib/services/networkManagement2/lib/models/inboundNatPool.js +++ b/lib/services/networkManagement2/lib/models/inboundNatPool.js @@ -20,37 +20,38 @@ const models = require('./index'); class InboundNatPool extends models['SubResource'] { /** * Create a InboundNatPool. - * @member {object} [frontendIPConfiguration] A reference to frontend IP + * @property {object} [frontendIPConfiguration] A reference to frontend IP * addresses. - * @member {string} [frontendIPConfiguration.id] Resource ID. - * @member {string} protocol Possible values include: 'Udp', 'Tcp', 'All' - * @member {number} frontendPortRangeStart The first port number in the range - * of external ports that will be used to provide Inbound Nat to NICs + * @property {string} [frontendIPConfiguration.id] Resource ID. + * @property {string} protocol Possible values include: 'Udp', 'Tcp', 'All' + * @property {number} frontendPortRangeStart The first port number in the + * range of external ports that will be used to provide Inbound Nat to NICs * associated with a load balancer. Acceptable values range between 1 and * 65534. - * @member {number} frontendPortRangeEnd The last port number in the range of - * external ports that will be used to provide Inbound Nat to NICs associated - * with a load balancer. Acceptable values range between 1 and 65535. - * @member {number} backendPort The port used for internal connections on the - * endpoint. Acceptable values are between 1 and 65535. - * @member {number} [idleTimeoutInMinutes] The timeout for the TCP idle + * @property {number} frontendPortRangeEnd The last port number in the range + * of external ports that will be used to provide Inbound Nat to NICs + * associated with a load balancer. Acceptable values range between 1 and + * 65535. + * @property {number} backendPort The port used for internal connections on + * the endpoint. Acceptable values are between 1 and 65535. + * @property {number} [idleTimeoutInMinutes] The timeout for the TCP idle * connection. The value can be set between 4 and 30 minutes. The default * value is 4 minutes. This element is only used when the protocol is set to * TCP. - * @member {boolean} [enableFloatingIP] Configures a virtual machine's + * @property {boolean} [enableFloatingIP] Configures a virtual machine's * endpoint for the floating IP capability required to configure a SQL * AlwaysOn Availability Group. This setting is required when using the SQL * AlwaysOn Availability Groups in SQL server. This setting can't be changed * after you create the endpoint. - * @member {boolean} [enableTcpReset] Receive bidirectional TCP Reset on TCP - * flow idle timeout or unexpected connection termination. This element is - * only used when the protocol is set to TCP. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {boolean} [enableTcpReset] Receive bidirectional TCP Reset on + * TCP flow idle timeout or unexpected connection termination. This element + * is only used when the protocol is set to TCP. + * @property {string} [provisioningState] Gets the provisioning state of the * PublicIP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/inboundNatRule.js b/lib/services/networkManagement2/lib/models/inboundNatRule.js index 60f93c940c..691ac8beac 100644 --- a/lib/services/networkManagement2/lib/models/inboundNatRule.js +++ b/lib/services/networkManagement2/lib/models/inboundNatRule.js @@ -20,312 +20,315 @@ const models = require('./index'); class InboundNatRule extends models['SubResource'] { /** * Create a InboundNatRule. - * @member {object} [frontendIPConfiguration] A reference to frontend IP + * @property {object} [frontendIPConfiguration] A reference to frontend IP * addresses. - * @member {string} [frontendIPConfiguration.id] Resource ID. - * @member {object} [backendIPConfiguration] A reference to a private IP + * @property {string} [frontendIPConfiguration.id] Resource ID. + * @property {object} [backendIPConfiguration] A reference to a private IP * address defined on a network interface of a VM. Traffic sent to the * frontend port of each of the frontend IP configurations is forwarded to * the backend IP. - * @member {array} [backendIPConfiguration.virtualNetworkTaps] The reference - * to Virtual Network Taps. - * @member {array} + * @property {array} [backendIPConfiguration.virtualNetworkTaps] The + * reference to Virtual Network Taps. + * @property {array} * [backendIPConfiguration.applicationGatewayBackendAddressPools] The * reference of ApplicationGatewayBackendAddressPool resource. - * @member {array} [backendIPConfiguration.loadBalancerBackendAddressPools] + * @property {array} [backendIPConfiguration.loadBalancerBackendAddressPools] * The reference of LoadBalancerBackendAddressPool resource. - * @member {array} [backendIPConfiguration.loadBalancerInboundNatRules] A + * @property {array} [backendIPConfiguration.loadBalancerInboundNatRules] A * list of references of LoadBalancerInboundNatRules. - * @member {string} [backendIPConfiguration.privateIPAddress] Private IP + * @property {string} [backendIPConfiguration.privateIPAddress] Private IP * address of the IP configuration. - * @member {string} [backendIPConfiguration.privateIPAllocationMethod] + * @property {string} [backendIPConfiguration.privateIPAllocationMethod] * Defines how a private IP address is assigned. Possible values are: * 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} [backendIPConfiguration.privateIPAddressVersion] + * @property {string} [backendIPConfiguration.privateIPAddressVersion] * Available from Api-Version 2016-03-30 onwards, it represents whether the * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', * 'IPv6' - * @member {object} [backendIPConfiguration.subnet] Subnet bound to the IP + * @property {object} [backendIPConfiguration.subnet] Subnet bound to the IP * configuration. - * @member {string} [backendIPConfiguration.subnet.addressPrefix] The address - * prefix for the subnet. - * @member {array} [backendIPConfiguration.subnet.addressPrefixes] List of + * @property {string} [backendIPConfiguration.subnet.addressPrefix] The + * address prefix for the subnet. + * @property {array} [backendIPConfiguration.subnet.addressPrefixes] List of * address prefixes for the subnet. - * @member {object} [backendIPConfiguration.subnet.networkSecurityGroup] The - * reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {object} [backendIPConfiguration.subnet.networkSecurityGroup] + * The reference of the NetworkSecurityGroup resource. + * @property {array} * [backendIPConfiguration.subnet.networkSecurityGroup.securityRules] A * collection of security rules of the network security group. - * @member {array} + * @property {array} * [backendIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [backendIPConfiguration.subnet.networkSecurityGroup.networkInterfaces] A * collection of references to network interfaces. - * @member {array} + * @property {array} * [backendIPConfiguration.subnet.networkSecurityGroup.subnets] A collection * of references to subnets. - * @member {string} + * @property {string} * [backendIPConfiguration.subnet.networkSecurityGroup.resourceGuid] The * resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [backendIPConfiguration.subnet.networkSecurityGroup.provisioningState] The * provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [backendIPConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} [backendIPConfiguration.subnet.routeTable] The reference - * of the RouteTable resource. - * @member {array} [backendIPConfiguration.subnet.routeTable.routes] + * @property {string} + * [backendIPConfiguration.subnet.networkSecurityGroup.etag] A unique + * read-only string that changes whenever the resource is updated. + * @property {object} [backendIPConfiguration.subnet.routeTable] The + * reference of the RouteTable resource. + * @property {array} [backendIPConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} [backendIPConfiguration.subnet.routeTable.subnets] A + * @property {array} [backendIPConfiguration.subnet.routeTable.subnets] A * collection of references to subnets. - * @member {boolean} + * @property {boolean} * [backendIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] Gets * or sets whether to disable the routes learned by BGP on that route table. * True means disable. - * @member {string} + * @property {string} * [backendIPConfiguration.subnet.routeTable.provisioningState] The * provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [backendIPConfiguration.subnet.routeTable.etag] Gets a + * @property {string} [backendIPConfiguration.subnet.routeTable.etag] Gets a * unique read-only string that changes whenever the resource is updated. - * @member {array} [backendIPConfiguration.subnet.serviceEndpoints] An array - * of service endpoints. - * @member {array} [backendIPConfiguration.subnet.serviceEndpointPolicies] An - * array of service endpoint policies. - * @member {array} [backendIPConfiguration.subnet.interfaceEndpoints] An + * @property {array} [backendIPConfiguration.subnet.serviceEndpoints] An + * array of service endpoints. + * @property {array} [backendIPConfiguration.subnet.serviceEndpointPolicies] + * An array of service endpoint policies. + * @property {array} [backendIPConfiguration.subnet.interfaceEndpoints] An * array of references to interface endpoints - * @member {array} [backendIPConfiguration.subnet.ipConfigurations] Gets an + * @property {array} [backendIPConfiguration.subnet.ipConfigurations] Gets an * array of references to the network interface IP configurations using * subnet. - * @member {array} [backendIPConfiguration.subnet.ipConfigurationProfiles] + * @property {array} [backendIPConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} [backendIPConfiguration.subnet.resourceNavigationLinks] + * @property {array} [backendIPConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} [backendIPConfiguration.subnet.serviceAssociationLinks] + * @property {array} [backendIPConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} [backendIPConfiguration.subnet.delegations] Gets an array - * of references to the delegations on the subnet. - * @member {string} [backendIPConfiguration.subnet.purpose] A read-only + * @property {array} [backendIPConfiguration.subnet.delegations] Gets an + * array of references to the delegations on the subnet. + * @property {string} [backendIPConfiguration.subnet.purpose] A read-only * string identifying the intention of use for this subnet based on * delegations and other user-defined properties. - * @member {string} [backendIPConfiguration.subnet.provisioningState] The + * @property {string} [backendIPConfiguration.subnet.provisioningState] The * provisioning state of the resource. - * @member {string} [backendIPConfiguration.subnet.name] The name of the + * @property {string} [backendIPConfiguration.subnet.name] The name of the * resource that is unique within a resource group. This name can be used to * access the resource. - * @member {string} [backendIPConfiguration.subnet.etag] A unique read-only + * @property {string} [backendIPConfiguration.subnet.etag] A unique read-only * string that changes whenever the resource is updated. - * @member {boolean} [backendIPConfiguration.primary] Gets whether this is a - * primary customer address on the network interface. - * @member {object} [backendIPConfiguration.publicIPAddress] Public IP + * @property {boolean} [backendIPConfiguration.primary] Gets whether this is + * a primary customer address on the network interface. + * @property {object} [backendIPConfiguration.publicIPAddress] Public IP * address bound to the IP configuration. - * @member {object} [backendIPConfiguration.publicIPAddress.sku] The public + * @property {object} [backendIPConfiguration.publicIPAddress.sku] The public * IP address SKU. - * @member {string} [backendIPConfiguration.publicIPAddress.sku.name] Name of - * a public IP address SKU. Possible values include: 'Basic', 'Standard' - * @member {string} + * @property {string} [backendIPConfiguration.publicIPAddress.sku.name] Name + * of a public IP address SKU. Possible values include: 'Basic', 'Standard' + * @property {string} * [backendIPConfiguration.publicIPAddress.publicIPAllocationMethod] The * public IP allocation method. Possible values are: 'Static' and 'Dynamic'. * Possible values include: 'Static', 'Dynamic' - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.publicIPAddressVersion] The public * IP address version. Possible values are: 'IPv4' and 'IPv6'. Possible * values include: 'IPv4', 'IPv6' - * @member {object} [backendIPConfiguration.publicIPAddress.ipConfiguration] - * The IP configuration associated with the public IP address. - * @member {string} + * @property {object} + * [backendIPConfiguration.publicIPAddress.ipConfiguration] The IP + * configuration associated with the public IP address. + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] * The private IP address of the IP configuration. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] * The private IP allocation method. Possible values are 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} + * @property {object} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet] The * reference of the subnet resource. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] * The address prefix for the subnet. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] * The reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] * A collection of references to subnets. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] * The reference of the RouteTable resource. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] * A collection of references to subnets. - * @member {boolean} + * @property {boolean} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] * Gets a unique read-only string that changes whenever the resource is * updated. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] * An array of service endpoints. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] * An array of service endpoint policies. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] * An array of references to interface endpoints - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] * Gets an array of references to the network interface IP configurations * using subnet. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} + * @property {array} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] * Gets an array of references to the delegations on the subnet. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] A * read-only string identifying the intention of use for this subnet based on * delegations and other user-defined properties. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] * The provisioning state of the resource. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.name] The * name of the resource that is unique within a resource group. This name can * be used to access the resource. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [backendIPConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] * The reference of the public IP resource. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.provisioningState] * Gets the provisioning state of the public IP resource. Possible values * are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.name] The name of * the resource that is unique within a resource group. This name can be used * to access the resource. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.ipConfiguration.etag] A unique * read-only string that changes whenever the resource is updated. - * @member {object} [backendIPConfiguration.publicIPAddress.dnsSettings] The - * FQDN of the DNS record associated with the public IP address. - * @member {string} + * @property {object} [backendIPConfiguration.publicIPAddress.dnsSettings] + * The FQDN of the DNS record associated with the public IP address. + * @property {string} * [backendIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] Gets * or sets the Domain name label.The concatenation of the domain name label * and the regionalized DNS zone make up the fully qualified domain name * associated with the public IP address. If a domain name label is * specified, an A DNS record is created for the public IP in the Microsoft * Azure DNS system. - * @member {string} [backendIPConfiguration.publicIPAddress.dnsSettings.fqdn] - * Gets the FQDN, Fully qualified domain name of the A DNS record associated - * with the public IP. This is the concatenation of the domainNameLabel and - * the regionalized DNS zone. - * @member {string} + * @property {string} + * [backendIPConfiguration.publicIPAddress.dnsSettings.fqdn] Gets the FQDN, + * Fully qualified domain name of the A DNS record associated with the public + * IP. This is the concatenation of the domainNameLabel and the regionalized + * DNS zone. + * @property {string} * [backendIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] Gets or * Sets the Reverse FQDN. A user-visible, fully qualified domain name that * resolves to this public IP address. If the reverseFqdn is specified, then * a PTR DNS record is created pointing from the IP address in the * in-addr.arpa domain to the reverse FQDN. - * @member {array} [backendIPConfiguration.publicIPAddress.ipTags] The list + * @property {array} [backendIPConfiguration.publicIPAddress.ipTags] The list * of tags associated with the public IP address. - * @member {string} [backendIPConfiguration.publicIPAddress.ipAddress] The IP - * address associated with the public IP address resource. - * @member {object} [backendIPConfiguration.publicIPAddress.publicIPPrefix] + * @property {string} [backendIPConfiguration.publicIPAddress.ipAddress] The + * IP address associated with the public IP address resource. + * @property {object} [backendIPConfiguration.publicIPAddress.publicIPPrefix] * The Public IP Prefix this Public IP Address should be allocated from. - * @member {string} + * @property {string} * [backendIPConfiguration.publicIPAddress.publicIPPrefix.id] Resource ID. - * @member {number} + * @property {number} * [backendIPConfiguration.publicIPAddress.idleTimeoutInMinutes] The idle * timeout of the public IP address. - * @member {string} [backendIPConfiguration.publicIPAddress.resourceGuid] The - * resource GUID property of the public IP resource. - * @member {string} + * @property {string} [backendIPConfiguration.publicIPAddress.resourceGuid] + * The resource GUID property of the public IP resource. + * @property {string} * [backendIPConfiguration.publicIPAddress.provisioningState] The * provisioning state of the PublicIP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [backendIPConfiguration.publicIPAddress.etag] A unique + * @property {string} [backendIPConfiguration.publicIPAddress.etag] A unique * read-only string that changes whenever the resource is updated. - * @member {array} [backendIPConfiguration.publicIPAddress.zones] A list of + * @property {array} [backendIPConfiguration.publicIPAddress.zones] A list of * availability zones denoting the IP allocated for the resource needs to * come from. - * @member {array} [backendIPConfiguration.applicationSecurityGroups] + * @property {array} [backendIPConfiguration.applicationSecurityGroups] * Application security groups in which the IP configuration is included. - * @member {string} [backendIPConfiguration.provisioningState] The + * @property {string} [backendIPConfiguration.provisioningState] The * provisioning state of the network interface IP configuration. Possible * values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [backendIPConfiguration.name] The name of the resource + * @property {string} [backendIPConfiguration.name] The name of the resource * that is unique within a resource group. This name can be used to access * the resource. - * @member {string} [backendIPConfiguration.etag] A unique read-only string + * @property {string} [backendIPConfiguration.etag] A unique read-only string * that changes whenever the resource is updated. - * @member {string} [protocol] Possible values include: 'Udp', 'Tcp', 'All' - * @member {number} [frontendPort] The port for the external endpoint. Port + * @property {string} [protocol] Possible values include: 'Udp', 'Tcp', 'All' + * @property {number} [frontendPort] The port for the external endpoint. Port * numbers for each rule must be unique within the Load Balancer. Acceptable * values range from 1 to 65534. - * @member {number} [backendPort] The port used for the internal endpoint. + * @property {number} [backendPort] The port used for the internal endpoint. * Acceptable values range from 1 to 65535. - * @member {number} [idleTimeoutInMinutes] The timeout for the TCP idle + * @property {number} [idleTimeoutInMinutes] The timeout for the TCP idle * connection. The value can be set between 4 and 30 minutes. The default * value is 4 minutes. This element is only used when the protocol is set to * TCP. - * @member {boolean} [enableFloatingIP] Configures a virtual machine's + * @property {boolean} [enableFloatingIP] Configures a virtual machine's * endpoint for the floating IP capability required to configure a SQL * AlwaysOn Availability Group. This setting is required when using the SQL * AlwaysOn Availability Groups in SQL server. This setting can't be changed * after you create the endpoint. - * @member {boolean} [enableTcpReset] Receive bidirectional TCP Reset on TCP - * flow idle timeout or unexpected connection termination. This element is - * only used when the protocol is set to TCP. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {boolean} [enableTcpReset] Receive bidirectional TCP Reset on + * TCP flow idle timeout or unexpected connection termination. This element + * is only used when the protocol is set to TCP. + * @property {string} [provisioningState] Gets the provisioning state of the * public IP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] Gets name of the resource that is unique within + * a resource group. This name can be used to access the resource. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/inboundNatRuleListResult.js b/lib/services/networkManagement2/lib/models/inboundNatRuleListResult.js index 6bc8468b6d..89492f3a01 100644 --- a/lib/services/networkManagement2/lib/models/inboundNatRuleListResult.js +++ b/lib/services/networkManagement2/lib/models/inboundNatRuleListResult.js @@ -16,7 +16,7 @@ class InboundNatRuleListResult extends Array { /** * Create a InboundNatRuleListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/index.d.ts b/lib/services/networkManagement2/lib/models/index.d.ts index 6ef02b5fa0..c0f0b48c60 100644 --- a/lib/services/networkManagement2/lib/models/index.d.ts +++ b/lib/services/networkManagement2/lib/models/index.d.ts @@ -1,6387 +1,4019 @@ /* * 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 SubResource class. - * @constructor * Reference to another subresource. - * - * @member {string} [id] Resource ID. */ export interface SubResource extends BaseResource { + /** + * Resource ID. + */ id?: string; } /** - * @class - * Initializes a new instance of the NetworkInterfaceTapConfiguration class. - * @constructor * Tap configuration in a Network Interface - * - * @member {object} [virtualNetworkTap] The reference of the Virtual Network - * Tap resource. - * @member {array} [virtualNetworkTap.networkInterfaceTapConfigurations] - * Specifies the list of resource IDs for the network interface IP - * configuration that needs to be tapped. - * @member {string} [virtualNetworkTap.resourceGuid] The resourceGuid property - * of the virtual network tap. - * @member {string} [virtualNetworkTap.provisioningState] The provisioning - * state of the virtual network tap. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration] The reference - * to the private IP Address of the collector nic that will receive the tap - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] - * The reference to Virtual Network Taps. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] - * The reference of ApplicationGatewayBackendAddressPool resource. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] - * The reference of LoadBalancerBackendAddressPool resource. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] - * A list of references of LoadBalancerInboundNatRules. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.privateIPAddress] - * Private IP address of the IP configuration. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] - * Defines how a private IP address is assigned. Possible values are: 'Static' - * and 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] - * Available from Api-Version 2016-03-30 onwards, it represents whether the - * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. - * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', - * 'IPv6' - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet] Subnet - * bound to the IP configuration. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable.subnets] - * A collection of references to subnets. - * @member {boolean} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.purpose] - * A read-only string identifying the intention of use for this subnet based on - * delegations and other user-defined properties. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.etag] A - * unique read-only string that changes whenever the resource is updated. - * @member {boolean} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.primary] Gets - * whether this is a primary customer address on the network interface. - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress] - * Public IP address bound to the IP configuration. - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.sku] - * The public IP address SKU. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.sku.name] - * Name of a public IP address SKU. Possible values include: 'Basic', - * 'Standard' - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPAllocationMethod] - * The public IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPAddressVersion] - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - * Possible values include: 'IPv4', 'IPv6' - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration] - * The IP configuration associated with the public IP address. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] - * The private IP address of the IP configuration. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] - * The private IP allocation method. Possible values are 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet] - * The reference of the subnet resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] - * A collection of references to subnets. - * @member {boolean} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] - * A read-only string identifying the intention of use for this subnet based on - * delegations and other user-defined properties. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] - * The reference of the public IP resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.provisioningState] - * Gets the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings] - * The FQDN of the DNS record associated with the public IP address. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] - * Gets or sets the Domain name label.The concatenation of the domain name - * label and the regionalized DNS zone make up the fully qualified domain name - * associated with the public IP address. If a domain name label is specified, - * an A DNS record is created for the public IP in the Microsoft Azure DNS - * system. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.fqdn] - * Gets the FQDN, Fully qualified domain name of the A DNS record associated - * with the public IP. This is the concatenation of the domainNameLabel and the - * regionalized DNS zone. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name - * that resolves to this public IP address. If the reverseFqdn is specified, - * then a PTR DNS record is created pointing from the IP address in the - * in-addr.arpa domain to the reverse FQDN. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipTags] - * The list of tags associated with the public IP address. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipAddress] - * The IP address associated with the public IP address resource. - * @member {object} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPPrefix] - * The Public IP Prefix this Public IP Address should be allocated from. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPPrefix.id] - * Resource ID. - * @member {number} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.idleTimeoutInMinutes] - * The idle timeout of the public IP address. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.resourceGuid] - * The resource GUID property of the public IP resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.provisioningState] - * The provisioning state of the PublicIP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.zones] - * A list of availability zones denoting the IP allocated for the resource - * needs to come from. - * @member {array} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] - * Application security groups in which the IP configuration is included. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.provisioningState] - * The provisioning state of the network interface IP configuration. Possible - * values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.name] The name - * of the resource that is unique within a resource group. This name can be - * used to access the resource. - * @member {string} - * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration] The - * reference to the private IP address on the internal Load Balancer that will - * receive the tap - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.inboundNatRules] - * Read only. Inbound rules URIs that use this frontend IP. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.inboundNatPools] - * Read only. Inbound pools URIs that use this frontend IP. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.outboundRules] - * Read only. Outbound rules URIs that use this frontend IP. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.loadBalancingRules] - * Gets load balancing rules URIs that use this frontend IP. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] - * The private IP address of the IP configuration. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] - * The Private IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet] - * The reference of the subnet resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.subnets] - * A collection of references to subnets. - * @member {boolean} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.purpose] - * A read-only string identifying the intention of use for this subnet based on - * delegations and other user-defined properties. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] - * The reference of the Public IP resource. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] - * The public IP address SKU. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] - * Name of a public IP address SKU. Possible values include: 'Basic', - * 'Standard' - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] - * The public IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - * Possible values include: 'IPv4', 'IPv6' - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration] - * The IP configuration associated with the public IP address. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] - * The private IP address of the IP configuration. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] - * The private IP allocation method. Possible values are 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet] - * The reference of the subnet resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] - * A collection of references to subnets. - * @member {boolean} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] - * A read-only string identifying the intention of use for this subnet based on - * delegations and other user-defined properties. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] - * The reference of the public IP resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.provisioningState] - * Gets the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] - * The FQDN of the DNS record associated with the public IP address. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] - * Gets or sets the Domain name label.The concatenation of the domain name - * label and the regionalized DNS zone make up the fully qualified domain name - * associated with the public IP address. If a domain name label is specified, - * an A DNS record is created for the public IP in the Microsoft Azure DNS - * system. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] - * Gets the FQDN, Fully qualified domain name of the A DNS record associated - * with the public IP. This is the concatenation of the domainNameLabel and the - * regionalized DNS zone. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name - * that resolves to this public IP address. If the reverseFqdn is specified, - * then a PTR DNS record is created pointing from the IP address in the - * in-addr.arpa domain to the reverse FQDN. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] - * The list of tags associated with the public IP address. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] - * The IP address associated with the public IP address resource. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] - * The Public IP Prefix this Public IP Address should be allocated from. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix.id] - * Resource ID. - * @member {number} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] - * The idle timeout of the public IP address. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] - * The resource GUID property of the public IP resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] - * The provisioning state of the PublicIP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] - * A list of availability zones denoting the IP allocated for the resource - * needs to come from. - * @member {object} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] - * The reference of the Public IP Prefix resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] - * Resource ID. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.provisioningState] - * Gets the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.name] The - * name of the resource that is unique within a resource group. This name can - * be used to access the resource. - * @member {string} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.etag] A - * unique read-only string that changes whenever the resource is updated. - * @member {array} - * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.zones] A - * list of availability zones denoting the IP allocated for the resource needs - * to come from. - * @member {number} [virtualNetworkTap.destinationPort] The VXLAN destination - * port that will receive the tapped traffic. - * @member {string} [virtualNetworkTap.etag] Gets a unique read-only string - * that changes whenever the resource is updated. - * @member {string} [provisioningState] The provisioning state of the network - * interface tap configuration. Possible values are: 'Updating', 'Deleting', - * and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Sub Resource type. */ export interface NetworkInterfaceTapConfiguration extends SubResource { + /** + * The reference of the Virtual Network Tap resource. + */ virtualNetworkTap?: VirtualNetworkTap; + /** + * The provisioning state of the network interface tap configuration. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Sub Resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * Common resource representation. - * - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. - * @member {string} [location] Resource location. - * @member {object} [tags] Resource tags. */ export interface Resource extends BaseResource { + /** + * Resource ID. + */ id?: string; + /** + * Resource name. + */ readonly name?: string; + /** + * Resource type. + */ readonly type?: string; + /** + * Resource location. + */ location?: string; + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the ApplicationSecurityGroup class. - * @constructor * An application security group in a resource group. - * - * @member {string} [resourceGuid] The resource GUID property of the - * application security group resource. It uniquely identifies a resource, even - * if the user changes its name or migrate the resource across subscriptions or - * resource groups. - * @member {string} [provisioningState] The provisioning state of the - * application security group resource. Possible values are: 'Succeeded', - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface ApplicationSecurityGroup extends Resource { + /** + * The resource GUID property of the application security group resource. It uniquely identifies + * a resource, even if the user changes its name or migrate the resource across subscriptions or + * resource groups. + */ readonly resourceGuid?: string; + /** + * The provisioning state of the application security group resource. Possible values are: + * 'Succeeded', 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the SecurityRule class. - * @constructor * Network security rule. - * - * @member {string} [description] A description for this rule. Restricted to - * 140 chars. - * @member {string} protocol Network protocol this rule applies to. Possible - * values are 'Tcp', 'Udp', and '*'. Possible values include: 'Tcp', 'Udp', '*' - * @member {string} [sourcePortRange] The source port or range. Integer or - * range between 0 and 65535. Asterix '*' can also be used to match all ports. - * @member {string} [destinationPortRange] The destination port or range. - * Integer or range between 0 and 65535. Asterix '*' can also be used to match - * all ports. - * @member {string} [sourceAddressPrefix] The CIDR or source IP range. Asterix - * '*' can also be used to match all source IPs. Default tags such as - * 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If - * this is an ingress rule, specifies where network traffic originates from. - * @member {array} [sourceAddressPrefixes] The CIDR or source IP ranges. - * @member {array} [sourceApplicationSecurityGroups] The application security - * group specified as source. - * @member {string} [destinationAddressPrefix] The destination address prefix. - * CIDR or destination IP range. Asterix '*' can also be used to match all - * source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and - * 'Internet' can also be used. - * @member {array} [destinationAddressPrefixes] The destination address - * prefixes. CIDR or destination IP ranges. - * @member {array} [destinationApplicationSecurityGroups] The application - * security group specified as destination. - * @member {array} [sourcePortRanges] The source port ranges. - * @member {array} [destinationPortRanges] The destination port ranges. - * @member {string} access The network traffic is allowed or denied. Possible - * values are: 'Allow' and 'Deny'. Possible values include: 'Allow', 'Deny' - * @member {number} [priority] The priority of the rule. The value can be - * between 100 and 4096. The priority number must be unique for each rule in - * the collection. The lower the priority number, the higher the priority of - * the rule. - * @member {string} direction The direction of the rule. The direction - * specifies if rule will be evaluated on incoming or outcoming traffic. - * Possible values are: 'Inbound' and 'Outbound'. Possible values include: - * 'Inbound', 'Outbound' - * @member {string} [provisioningState] The provisioning state of the public IP - * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface SecurityRule extends SubResource { + /** + * A description for this rule. Restricted to 140 chars. + */ description?: string; + /** + * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. Possible + * values include: 'Tcp', 'Udp', '*' + */ protocol: string; + /** + * The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used + * to match all ports. + */ sourcePortRange?: string; + /** + * The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be + * used to match all ports. + */ destinationPortRange?: string; + /** + * The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default + * tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is + * an ingress rule, specifies where network traffic originates from. + */ sourceAddressPrefix?: string; + /** + * The CIDR or source IP ranges. + */ sourceAddressPrefixes?: string[]; + /** + * The application security group specified as source. + */ sourceApplicationSecurityGroups?: ApplicationSecurityGroup[]; + /** + * The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to + * match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and + * 'Internet' can also be used. + */ destinationAddressPrefix?: string; + /** + * The destination address prefixes. CIDR or destination IP ranges. + */ destinationAddressPrefixes?: string[]; + /** + * The application security group specified as destination. + */ destinationApplicationSecurityGroups?: ApplicationSecurityGroup[]; + /** + * The source port ranges. + */ sourcePortRanges?: string[]; + /** + * The destination port ranges. + */ destinationPortRanges?: string[]; + /** + * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. Possible + * values include: 'Allow', 'Deny' + */ access: string; + /** + * The priority of the rule. The value can be between 100 and 4096. The priority number must be + * unique for each rule in the collection. The lower the priority number, the higher the priority + * of the rule. + */ priority?: number; + /** + * The direction of the rule. The direction specifies if rule will be evaluated on incoming or + * outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. Possible values include: + * 'Inbound', 'Outbound' + */ direction: string; + /** + * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the EndpointService class. - * @constructor * Identifies the service being brought into the virtual network. - * - * @member {string} [id] A unique identifier of the service being referenced by - * the interface endpoint. */ export interface EndpointService { + /** + * A unique identifier of the service being referenced by the interface endpoint. + */ id?: string; } /** - * @class - * Initializes a new instance of the InterfaceEndpoint class. - * @constructor * Interface endpoint resource. - * - * @member {string} [fqdn] A first-party service's FQDN that is mapped to the - * private IP allocated via this interface endpoint. - * @member {object} [endpointService] A reference to the service being brought - * into the virtual network. - * @member {string} [endpointService.id] A unique identifier of the service - * being referenced by the interface endpoint. - * @member {object} [subnet] The ID of the subnet from which the private IP - * will be allocated. - * @member {string} [subnet.addressPrefix] The address prefix for the subnet. - * @member {array} [subnet.addressPrefixes] List of address prefixes for the - * subnet. - * @member {object} [subnet.networkSecurityGroup] The reference of the - * NetworkSecurityGroup resource. - * @member {array} [subnet.networkSecurityGroup.securityRules] A collection of - * security rules of the network security group. - * @member {array} [subnet.networkSecurityGroup.defaultSecurityRules] The - * default security rules of network security group. - * @member {array} [subnet.networkSecurityGroup.networkInterfaces] A collection - * of references to network interfaces. - * @member {array} [subnet.networkSecurityGroup.subnets] A collection of - * references to subnets. - * @member {string} [subnet.networkSecurityGroup.resourceGuid] The resource - * GUID property of the network security group resource. - * @member {string} [subnet.networkSecurityGroup.provisioningState] The - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [subnet.networkSecurityGroup.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {object} [subnet.routeTable] The reference of the RouteTable - * resource. - * @member {array} [subnet.routeTable.routes] Collection of routes contained - * within a route table. - * @member {array} [subnet.routeTable.subnets] A collection of references to - * subnets. - * @member {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or - * sets whether to disable the routes learned by BGP on that route table. True - * means disable. - * @member {string} [subnet.routeTable.provisioningState] The provisioning - * state of the resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [subnet.routeTable.etag] Gets a unique read-only string - * that changes whenever the resource is updated. - * @member {array} [subnet.serviceEndpoints] An array of service endpoints. - * @member {array} [subnet.serviceEndpointPolicies] An array of service - * endpoint policies. - * @member {array} [subnet.interfaceEndpoints] An array of references to - * interface endpoints - * @member {array} [subnet.ipConfigurations] Gets an array of references to the - * network interface IP configurations using subnet. - * @member {array} [subnet.ipConfigurationProfiles] Array of IP configuration - * profiles which reference this subnet. - * @member {array} [subnet.resourceNavigationLinks] Gets an array of references - * to the external resources using subnet. - * @member {array} [subnet.serviceAssociationLinks] Gets an array of references - * to services injecting into this subnet. - * @member {array} [subnet.delegations] Gets an array of references to the - * delegations on the subnet. - * @member {string} [subnet.purpose] A read-only string identifying the - * intention of use for this subnet based on delegations and other user-defined - * properties. - * @member {string} [subnet.provisioningState] The provisioning state of the - * resource. - * @member {string} [subnet.name] The name of the resource that is unique - * within a resource group. This name can be used to access the resource. - * @member {string} [subnet.etag] A unique read-only string that changes - * whenever the resource is updated. - * @member {array} [networkInterfaces] Gets an array of references to the - * network interfaces created for this interface endpoint. - * @member {string} [owner] A read-only property that identifies who created - * this interface endpoint. - * @member {string} [provisioningState] The provisioning state of the interface - * endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. */ export interface InterfaceEndpoint extends Resource { + /** + * A first-party service's FQDN that is mapped to the private IP allocated via this interface + * endpoint. + */ fqdn?: string; + /** + * A reference to the service being brought into the virtual network. + */ endpointService?: EndpointService; + /** + * The ID of the subnet from which the private IP will be allocated. + */ subnet?: Subnet; + /** + * Gets an array of references to the network interfaces created for this interface endpoint. + */ readonly networkInterfaces?: NetworkInterface[]; + /** + * A read-only property that identifies who created this interface endpoint. + */ readonly owner?: string; + /** + * The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + */ readonly provisioningState?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the NetworkInterfaceDnsSettings class. - * @constructor * DNS settings of a network interface. - * - * @member {array} [dnsServers] List of DNS servers IP addresses. Use - * 'AzureProvidedDNS' to switch to azure provided DNS resolution. - * 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the - * only value in dnsServers collection. - * @member {array} [appliedDnsServers] If the VM that uses this NIC is part of - * an Availability Set, then this list will have the union of all DNS servers - * from all NICs that are part of the Availability Set. This property is what - * is configured on each of those VMs. - * @member {string} [internalDnsNameLabel] Relative DNS name for this NIC used - * for internal communications between VMs in the same virtual network. - * @member {string} [internalFqdn] Fully qualified DNS name supporting internal - * communications between VMs in the same virtual network. - * @member {string} [internalDomainNameSuffix] Even if internalDnsNameLabel is - * not specified, a DNS entry is created for the primary NIC of the VM. This - * DNS name can be constructed by concatenating the VM name with the value of - * internalDomainNameSuffix. */ export interface NetworkInterfaceDnsSettings { + /** + * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS + * resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only + * value in dnsServers collection. + */ dnsServers?: string[]; + /** + * If the VM that uses this NIC is part of an Availability Set, then this list will have the + * union of all DNS servers from all NICs that are part of the Availability Set. This property is + * what is configured on each of those VMs. + */ appliedDnsServers?: string[]; + /** + * Relative DNS name for this NIC used for internal communications between VMs in the same + * virtual network. + */ internalDnsNameLabel?: string; + /** + * Fully qualified DNS name supporting internal communications between VMs in the same virtual + * network. + */ internalFqdn?: string; + /** + * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of + * the VM. This DNS name can be constructed by concatenating the VM name with the value of + * internalDomainNameSuffix. + */ internalDomainNameSuffix?: string; } /** - * @class - * Initializes a new instance of the NetworkInterface class. - * @constructor * A network interface in a resource group. - * - * @member {object} [virtualMachine] The reference of a virtual machine. - * @member {string} [virtualMachine.id] Resource ID. - * @member {object} [networkSecurityGroup] The reference of the - * NetworkSecurityGroup resource. - * @member {array} [networkSecurityGroup.securityRules] A collection of - * security rules of the network security group. - * @member {array} [networkSecurityGroup.defaultSecurityRules] The default - * security rules of network security group. - * @member {array} [networkSecurityGroup.networkInterfaces] A collection of - * references to network interfaces. - * @member {array} [networkSecurityGroup.subnets] A collection of references to - * subnets. - * @member {string} [networkSecurityGroup.resourceGuid] The resource GUID - * property of the network security group resource. - * @member {string} [networkSecurityGroup.provisioningState] The provisioning - * state of the public IP resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [networkSecurityGroup.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {object} [interfaceEndpoint] A reference to the interface endpoint - * to which the network interface is linked. - * @member {string} [interfaceEndpoint.fqdn] A first-party service's FQDN that - * is mapped to the private IP allocated via this interface endpoint. - * @member {object} [interfaceEndpoint.endpointService] A reference to the - * service being brought into the virtual network. - * @member {string} [interfaceEndpoint.endpointService.id] A unique identifier - * of the service being referenced by the interface endpoint. - * @member {object} [interfaceEndpoint.subnet] The ID of the subnet from which - * the private IP will be allocated. - * @member {string} [interfaceEndpoint.subnet.addressPrefix] The address prefix - * for the subnet. - * @member {array} [interfaceEndpoint.subnet.addressPrefixes] List of address - * prefixes for the subnet. - * @member {object} [interfaceEndpoint.subnet.networkSecurityGroup] The - * reference of the NetworkSecurityGroup resource. - * @member {array} - * [interfaceEndpoint.subnet.networkSecurityGroup.securityRules] A collection - * of security rules of the network security group. - * @member {array} - * [interfaceEndpoint.subnet.networkSecurityGroup.defaultSecurityRules] The - * default security rules of network security group. - * @member {array} - * [interfaceEndpoint.subnet.networkSecurityGroup.networkInterfaces] A - * collection of references to network interfaces. - * @member {array} [interfaceEndpoint.subnet.networkSecurityGroup.subnets] A - * collection of references to subnets. - * @member {string} - * [interfaceEndpoint.subnet.networkSecurityGroup.resourceGuid] The resource - * GUID property of the network security group resource. - * @member {string} - * [interfaceEndpoint.subnet.networkSecurityGroup.provisioningState] The - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [interfaceEndpoint.subnet.networkSecurityGroup.etag] A - * unique read-only string that changes whenever the resource is updated. - * @member {object} [interfaceEndpoint.subnet.routeTable] The reference of the - * RouteTable resource. - * @member {array} [interfaceEndpoint.subnet.routeTable.routes] Collection of - * routes contained within a route table. - * @member {array} [interfaceEndpoint.subnet.routeTable.subnets] A collection - * of references to subnets. - * @member {boolean} - * [interfaceEndpoint.subnet.routeTable.disableBgpRoutePropagation] Gets or - * sets whether to disable the routes learned by BGP on that route table. True - * means disable. - * @member {string} [interfaceEndpoint.subnet.routeTable.provisioningState] The - * provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [interfaceEndpoint.subnet.routeTable.etag] Gets a unique - * read-only string that changes whenever the resource is updated. - * @member {array} [interfaceEndpoint.subnet.serviceEndpoints] An array of - * service endpoints. - * @member {array} [interfaceEndpoint.subnet.serviceEndpointPolicies] An array - * of service endpoint policies. - * @member {array} [interfaceEndpoint.subnet.interfaceEndpoints] An array of - * references to interface endpoints - * @member {array} [interfaceEndpoint.subnet.ipConfigurations] Gets an array of - * references to the network interface IP configurations using subnet. - * @member {array} [interfaceEndpoint.subnet.ipConfigurationProfiles] Array of - * IP configuration profiles which reference this subnet. - * @member {array} [interfaceEndpoint.subnet.resourceNavigationLinks] Gets an - * array of references to the external resources using subnet. - * @member {array} [interfaceEndpoint.subnet.serviceAssociationLinks] Gets an - * array of references to services injecting into this subnet. - * @member {array} [interfaceEndpoint.subnet.delegations] Gets an array of - * references to the delegations on the subnet. - * @member {string} [interfaceEndpoint.subnet.purpose] A read-only string - * identifying the intention of use for this subnet based on delegations and - * other user-defined properties. - * @member {string} [interfaceEndpoint.subnet.provisioningState] The - * provisioning state of the resource. - * @member {string} [interfaceEndpoint.subnet.name] The name of the resource - * that is unique within a resource group. This name can be used to access the - * resource. - * @member {string} [interfaceEndpoint.subnet.etag] A unique read-only string - * that changes whenever the resource is updated. - * @member {array} [interfaceEndpoint.networkInterfaces] Gets an array of - * references to the network interfaces created for this interface endpoint. - * @member {string} [interfaceEndpoint.owner] A read-only property that - * identifies who created this interface endpoint. - * @member {string} [interfaceEndpoint.provisioningState] The provisioning - * state of the interface endpoint. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [interfaceEndpoint.etag] Gets a unique read-only string - * that changes whenever the resource is updated. - * @member {array} [ipConfigurations] A list of IPConfigurations of the network - * interface. - * @member {array} [tapConfigurations] A list of TapConfigurations of the - * network interface. - * @member {object} [dnsSettings] The DNS settings in network interface. - * @member {array} [dnsSettings.dnsServers] List of DNS servers IP addresses. - * Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. - * 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the - * only value in dnsServers collection. - * @member {array} [dnsSettings.appliedDnsServers] If the VM that uses this NIC - * is part of an Availability Set, then this list will have the union of all - * DNS servers from all NICs that are part of the Availability Set. This - * property is what is configured on each of those VMs. - * @member {string} [dnsSettings.internalDnsNameLabel] Relative DNS name for - * this NIC used for internal communications between VMs in the same virtual - * network. - * @member {string} [dnsSettings.internalFqdn] Fully qualified DNS name - * supporting internal communications between VMs in the same virtual network. - * @member {string} [dnsSettings.internalDomainNameSuffix] Even if - * internalDnsNameLabel is not specified, a DNS entry is created for the - * primary NIC of the VM. This DNS name can be constructed by concatenating the - * VM name with the value of internalDomainNameSuffix. - * @member {string} [macAddress] The MAC address of the network interface. - * @member {boolean} [primary] Gets whether this is a primary network interface - * on a virtual machine. - * @member {boolean} [enableAcceleratedNetworking] If the network interface is - * accelerated networking enabled. - * @member {boolean} [enableIPForwarding] Indicates whether IP forwarding is - * enabled on this network interface. - * @member {array} [hostedWorkloads] A list of references to linked BareMetal - * resources - * @member {string} [resourceGuid] The resource GUID property of the network - * interface resource. - * @member {string} [provisioningState] The provisioning state of the public IP - * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface NetworkInterface extends Resource { + /** + * The reference of a virtual machine. + */ readonly virtualMachine?: SubResource; + /** + * The reference of the NetworkSecurityGroup resource. + */ networkSecurityGroup?: NetworkSecurityGroup; + /** + * A reference to the interface endpoint to which the network interface is linked. + */ readonly interfaceEndpoint?: InterfaceEndpoint; + /** + * A list of IPConfigurations of the network interface. + */ ipConfigurations?: NetworkInterfaceIPConfiguration[]; + /** + * A list of TapConfigurations of the network interface. + */ tapConfigurations?: NetworkInterfaceTapConfiguration[]; + /** + * The DNS settings in network interface. + */ dnsSettings?: NetworkInterfaceDnsSettings; + /** + * The MAC address of the network interface. + */ macAddress?: string; + /** + * Gets whether this is a primary network interface on a virtual machine. + */ primary?: boolean; + /** + * If the network interface is accelerated networking enabled. + */ enableAcceleratedNetworking?: boolean; + /** + * Indicates whether IP forwarding is enabled on this network interface. + */ enableIPForwarding?: boolean; + /** + * A list of references to linked BareMetal resources + */ readonly hostedWorkloads?: string[]; + /** + * The resource GUID property of the network interface resource. + */ resourceGuid?: string; + /** + * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + */ provisioningState?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the NetworkSecurityGroup class. - * @constructor * NetworkSecurityGroup resource. - * - * @member {array} [securityRules] A collection of security rules of the - * network security group. - * @member {array} [defaultSecurityRules] The default security rules of network - * security group. - * @member {array} [networkInterfaces] A collection of references to network - * interfaces. - * @member {array} [subnets] A collection of references to subnets. - * @member {string} [resourceGuid] The resource GUID property of the network - * security group resource. - * @member {string} [provisioningState] The provisioning state of the public IP - * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface NetworkSecurityGroup extends Resource { + /** + * A collection of security rules of the network security group. + */ securityRules?: SecurityRule[]; + /** + * The default security rules of network security group. + */ defaultSecurityRules?: SecurityRule[]; + /** + * A collection of references to network interfaces. + */ readonly networkInterfaces?: NetworkInterface[]; + /** + * A collection of references to subnets. + */ readonly subnets?: Subnet[]; + /** + * The resource GUID property of the network security group resource. + */ resourceGuid?: string; + /** + * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + */ provisioningState?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the Route class. - * @constructor * Route resource - * - * @member {string} [addressPrefix] The destination CIDR to which the route - * applies. - * @member {string} nextHopType The type of Azure hop the packet should be sent - * to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', - * 'VirtualAppliance', and 'None'. Possible values include: - * 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', 'None' - * @member {string} [nextHopIpAddress] The IP address packets should be - * forwarded to. Next hop values are only allowed in routes where the next hop - * type is VirtualAppliance. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface Route extends SubResource { + /** + * The destination CIDR to which the route applies. + */ addressPrefix?: string; + /** + * The type of Azure hop the packet should be sent to. Possible values are: + * 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. Possible + * values include: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', 'None' + */ nextHopType: string; + /** + * The IP address packets should be forwarded to. Next hop values are only allowed in routes + * where the next hop type is VirtualAppliance. + */ nextHopIpAddress?: string; + /** + * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the RouteTable class. - * @constructor * Route table resource. - * - * @member {array} [routes] Collection of routes contained within a route - * table. - * @member {array} [subnets] A collection of references to subnets. - * @member {boolean} [disableBgpRoutePropagation] Gets or sets whether to - * disable the routes learned by BGP on that route table. True means disable. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. */ export interface RouteTable extends Resource { + /** + * Collection of routes contained within a route table. + */ routes?: Route[]; + /** + * A collection of references to subnets. + */ readonly subnets?: Subnet[]; + /** + * Gets or sets whether to disable the routes learned by BGP on that route table. True means + * disable. + */ disableBgpRoutePropagation?: boolean; + /** + * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + */ provisioningState?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the ServiceEndpointPropertiesFormat class. - * @constructor * The service endpoint properties. - * - * @member {string} [service] The type of the endpoint service. - * @member {array} [locations] A list of locations. - * @member {string} [provisioningState] The provisioning state of the resource. */ export interface ServiceEndpointPropertiesFormat { + /** + * The type of the endpoint service. + */ service?: string; + /** + * A list of locations. + */ locations?: string[]; + /** + * The provisioning state of the resource. + */ provisioningState?: string; } /** - * @class - * Initializes a new instance of the ServiceEndpointPolicyDefinition class. - * @constructor * Service Endpoint policy definitions. - * - * @member {string} [description] A description for this rule. Restricted to - * 140 chars. - * @member {string} [service] service endpoint name. - * @member {array} [serviceResources] A list of service resources. - * @member {string} [provisioningState] The provisioning state of the service - * end point policy definition. Possible values are: 'Updating', 'Deleting', - * and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface ServiceEndpointPolicyDefinition extends SubResource { + /** + * A description for this rule. Restricted to 140 chars. + */ description?: string; + /** + * service endpoint name. + */ service?: string; + /** + * A list of service resources. + */ serviceResources?: string[]; + /** + * The provisioning state of the service end point policy definition. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the ServiceEndpointPolicy class. - * @constructor * Service End point policy resource. - * - * @member {array} [serviceEndpointPolicyDefinitions] A collection of service - * endpoint policy definitions of the service endpoint policy. - * @member {array} [subnets] A collection of references to subnets. - * @member {string} [resourceGuid] The resource GUID property of the service - * endpoint policy resource. - * @member {string} [provisioningState] The provisioning state of the service - * endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface ServiceEndpointPolicy extends Resource { + /** + * A collection of service endpoint policy definitions of the service endpoint policy. + */ serviceEndpointPolicyDefinitions?: ServiceEndpointPolicyDefinition[]; + /** + * A collection of references to subnets. + */ readonly subnets?: Subnet[]; + /** + * The resource GUID property of the service endpoint policy resource. + */ readonly resourceGuid?: string; + /** + * The provisioning state of the service endpoint policy. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the PublicIPAddressSku class. - * @constructor * SKU of a public IP address - * - * @member {string} [name] Name of a public IP address SKU. Possible values - * include: 'Basic', 'Standard' */ export interface PublicIPAddressSku { + /** + * Name of a public IP address SKU. Possible values include: 'Basic', 'Standard' + */ name?: string; } /** - * @class - * Initializes a new instance of the PublicIPAddressDnsSettings class. - * @constructor * Contains FQDN of the DNS record associated with the public IP address - * - * @member {string} [domainNameLabel] Gets or sets the Domain name label.The - * concatenation of the domain name label and the regionalized DNS zone make up - * the fully qualified domain name associated with the public IP address. If a - * domain name label is specified, an A DNS record is created for the public IP - * in the Microsoft Azure DNS system. - * @member {string} [fqdn] Gets the FQDN, Fully qualified domain name of the A - * DNS record associated with the public IP. This is the concatenation of the - * domainNameLabel and the regionalized DNS zone. - * @member {string} [reverseFqdn] Gets or Sets the Reverse FQDN. A - * user-visible, fully qualified domain name that resolves to this public IP - * address. If the reverseFqdn is specified, then a PTR DNS record is created - * pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. */ export interface PublicIPAddressDnsSettings { + /** + * Gets or sets the Domain name label.The concatenation of the domain name label and the + * regionalized DNS zone make up the fully qualified domain name associated with the public IP + * address. If a domain name label is specified, an A DNS record is created for the public IP in + * the Microsoft Azure DNS system. + */ domainNameLabel?: string; + /** + * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. + * This is the concatenation of the domainNameLabel and the regionalized DNS zone. + */ fqdn?: string; + /** + * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to + * this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created + * pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. + */ reverseFqdn?: string; } /** - * @class - * Initializes a new instance of the IpTag class. - * @constructor * Contains the IpTag associated with the object - * - * @member {string} [ipTagType] Gets or sets the ipTag type: Example - * FirstPartyUsage. - * @member {string} [tag] Gets or sets value of the IpTag associated with the - * public IP. Example SQL, Storage etc */ export interface IpTag { + /** + * Gets or sets the ipTag type: Example FirstPartyUsage. + */ ipTagType?: string; + /** + * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc + */ tag?: string; } /** - * @class - * Initializes a new instance of the PublicIPAddress class. - * @constructor * Public IP address resource. - * - * @member {object} [sku] The public IP address SKU. - * @member {string} [sku.name] Name of a public IP address SKU. Possible values - * include: 'Basic', 'Standard' - * @member {string} [publicIPAllocationMethod] The public IP allocation method. - * Possible values are: 'Static' and 'Dynamic'. Possible values include: - * 'Static', 'Dynamic' - * @member {string} [publicIPAddressVersion] The public IP address version. - * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', - * 'IPv6' - * @member {object} [ipConfiguration] The IP configuration associated with the - * public IP address. - * @member {string} [ipConfiguration.privateIPAddress] The private IP address - * of the IP configuration. - * @member {string} [ipConfiguration.privateIPAllocationMethod] The private IP - * allocation method. Possible values are 'Static' and 'Dynamic'. Possible - * values include: 'Static', 'Dynamic' - * @member {object} [ipConfiguration.subnet] The reference of the subnet - * resource. - * @member {string} [ipConfiguration.subnet.addressPrefix] The address prefix - * for the subnet. - * @member {array} [ipConfiguration.subnet.addressPrefixes] List of address - * prefixes for the subnet. - * @member {object} [ipConfiguration.subnet.networkSecurityGroup] The reference - * of the NetworkSecurityGroup resource. - * @member {array} [ipConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] The - * default security rules of network security group. - * @member {array} - * [ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] A collection - * of references to network interfaces. - * @member {array} [ipConfiguration.subnet.networkSecurityGroup.subnets] A - * collection of references to subnets. - * @member {string} [ipConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [ipConfiguration.subnet.networkSecurityGroup.provisioningState] The - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.subnet.networkSecurityGroup.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} [ipConfiguration.subnet.routeTable] The reference of the - * RouteTable resource. - * @member {array} [ipConfiguration.subnet.routeTable.routes] Collection of - * routes contained within a route table. - * @member {array} [ipConfiguration.subnet.routeTable.subnets] A collection of - * references to subnets. - * @member {boolean} - * [ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] Gets or sets - * whether to disable the routes learned by BGP on that route table. True means - * disable. - * @member {string} [ipConfiguration.subnet.routeTable.provisioningState] The - * provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.subnet.routeTable.etag] Gets a unique - * read-only string that changes whenever the resource is updated. - * @member {array} [ipConfiguration.subnet.serviceEndpoints] An array of - * service endpoints. - * @member {array} [ipConfiguration.subnet.serviceEndpointPolicies] An array of - * service endpoint policies. - * @member {array} [ipConfiguration.subnet.interfaceEndpoints] An array of - * references to interface endpoints - * @member {array} [ipConfiguration.subnet.ipConfigurations] Gets an array of - * references to the network interface IP configurations using subnet. - * @member {array} [ipConfiguration.subnet.ipConfigurationProfiles] Array of IP - * configuration profiles which reference this subnet. - * @member {array} [ipConfiguration.subnet.resourceNavigationLinks] Gets an - * array of references to the external resources using subnet. - * @member {array} [ipConfiguration.subnet.serviceAssociationLinks] Gets an - * array of references to services injecting into this subnet. - * @member {array} [ipConfiguration.subnet.delegations] Gets an array of - * references to the delegations on the subnet. - * @member {string} [ipConfiguration.subnet.purpose] A read-only string - * identifying the intention of use for this subnet based on delegations and - * other user-defined properties. - * @member {string} [ipConfiguration.subnet.provisioningState] The provisioning - * state of the resource. - * @member {string} [ipConfiguration.subnet.name] The name of the resource that - * is unique within a resource group. This name can be used to access the - * resource. - * @member {string} [ipConfiguration.subnet.etag] A unique read-only string - * that changes whenever the resource is updated. - * @member {object} [ipConfiguration.publicIPAddress] The reference of the - * public IP resource. - * @member {string} [ipConfiguration.provisioningState] Gets the provisioning - * state of the public IP resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.name] The name of the resource that is - * unique within a resource group. This name can be used to access the - * resource. - * @member {string} [ipConfiguration.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {object} [dnsSettings] The FQDN of the DNS record associated with - * the public IP address. - * @member {string} [dnsSettings.domainNameLabel] Gets or sets the Domain name - * label.The concatenation of the domain name label and the regionalized DNS - * zone make up the fully qualified domain name associated with the public IP - * address. If a domain name label is specified, an A DNS record is created for - * the public IP in the Microsoft Azure DNS system. - * @member {string} [dnsSettings.fqdn] Gets the FQDN, Fully qualified domain - * name of the A DNS record associated with the public IP. This is the - * concatenation of the domainNameLabel and the regionalized DNS zone. - * @member {string} [dnsSettings.reverseFqdn] Gets or Sets the Reverse FQDN. A - * user-visible, fully qualified domain name that resolves to this public IP - * address. If the reverseFqdn is specified, then a PTR DNS record is created - * pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. - * @member {array} [ipTags] The list of tags associated with the public IP - * address. - * @member {string} [ipAddress] The IP address associated with the public IP - * address resource. - * @member {object} [publicIPPrefix] The Public IP Prefix this Public IP - * Address should be allocated from. - * @member {string} [publicIPPrefix.id] Resource ID. - * @member {number} [idleTimeoutInMinutes] The idle timeout of the public IP - * address. - * @member {string} [resourceGuid] The resource GUID property of the public IP - * resource. - * @member {string} [provisioningState] The provisioning state of the PublicIP - * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {array} [zones] A list of availability zones denoting the IP - * allocated for the resource needs to come from. */ export interface PublicIPAddress extends Resource { + /** + * The public IP address SKU. + */ sku?: PublicIPAddressSku; + /** + * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. Possible values + * include: 'Static', 'Dynamic' + */ publicIPAllocationMethod?: string; + /** + * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. Possible values + * include: 'IPv4', 'IPv6' + */ publicIPAddressVersion?: string; + /** + * The IP configuration associated with the public IP address. + */ readonly ipConfiguration?: IPConfiguration; + /** + * The FQDN of the DNS record associated with the public IP address. + */ dnsSettings?: PublicIPAddressDnsSettings; + /** + * The list of tags associated with the public IP address. + */ ipTags?: IpTag[]; + /** + * The IP address associated with the public IP address resource. + */ ipAddress?: string; + /** + * The Public IP Prefix this Public IP Address should be allocated from. + */ publicIPPrefix?: SubResource; + /** + * The idle timeout of the public IP address. + */ idleTimeoutInMinutes?: number; + /** + * The resource GUID property of the public IP resource. + */ resourceGuid?: string; + /** + * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + */ provisioningState?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * A list of availability zones denoting the IP allocated for the resource needs to come from. + */ zones?: string[]; } /** - * @class - * Initializes a new instance of the IPConfiguration class. - * @constructor * IP configuration - * - * @member {string} [privateIPAddress] The private IP address of the IP - * configuration. - * @member {string} [privateIPAllocationMethod] The private IP allocation - * method. Possible values are 'Static' and 'Dynamic'. Possible values include: - * 'Static', 'Dynamic' - * @member {object} [subnet] The reference of the subnet resource. - * @member {string} [subnet.addressPrefix] The address prefix for the subnet. - * @member {array} [subnet.addressPrefixes] List of address prefixes for the - * subnet. - * @member {object} [subnet.networkSecurityGroup] The reference of the - * NetworkSecurityGroup resource. - * @member {array} [subnet.networkSecurityGroup.securityRules] A collection of - * security rules of the network security group. - * @member {array} [subnet.networkSecurityGroup.defaultSecurityRules] The - * default security rules of network security group. - * @member {array} [subnet.networkSecurityGroup.networkInterfaces] A collection - * of references to network interfaces. - * @member {array} [subnet.networkSecurityGroup.subnets] A collection of - * references to subnets. - * @member {string} [subnet.networkSecurityGroup.resourceGuid] The resource - * GUID property of the network security group resource. - * @member {string} [subnet.networkSecurityGroup.provisioningState] The - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [subnet.networkSecurityGroup.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {object} [subnet.routeTable] The reference of the RouteTable - * resource. - * @member {array} [subnet.routeTable.routes] Collection of routes contained - * within a route table. - * @member {array} [subnet.routeTable.subnets] A collection of references to - * subnets. - * @member {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or - * sets whether to disable the routes learned by BGP on that route table. True - * means disable. - * @member {string} [subnet.routeTable.provisioningState] The provisioning - * state of the resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [subnet.routeTable.etag] Gets a unique read-only string - * that changes whenever the resource is updated. - * @member {array} [subnet.serviceEndpoints] An array of service endpoints. - * @member {array} [subnet.serviceEndpointPolicies] An array of service - * endpoint policies. - * @member {array} [subnet.interfaceEndpoints] An array of references to - * interface endpoints - * @member {array} [subnet.ipConfigurations] Gets an array of references to the - * network interface IP configurations using subnet. - * @member {array} [subnet.ipConfigurationProfiles] Array of IP configuration - * profiles which reference this subnet. - * @member {array} [subnet.resourceNavigationLinks] Gets an array of references - * to the external resources using subnet. - * @member {array} [subnet.serviceAssociationLinks] Gets an array of references - * to services injecting into this subnet. - * @member {array} [subnet.delegations] Gets an array of references to the - * delegations on the subnet. - * @member {string} [subnet.purpose] A read-only string identifying the - * intention of use for this subnet based on delegations and other user-defined - * properties. - * @member {string} [subnet.provisioningState] The provisioning state of the - * resource. - * @member {string} [subnet.name] The name of the resource that is unique - * within a resource group. This name can be used to access the resource. - * @member {string} [subnet.etag] A unique read-only string that changes - * whenever the resource is updated. - * @member {object} [publicIPAddress] The reference of the public IP resource. - * @member {object} [publicIPAddress.sku] The public IP address SKU. - * @member {string} [publicIPAddress.sku.name] Name of a public IP address SKU. - * Possible values include: 'Basic', 'Standard' - * @member {string} [publicIPAddress.publicIPAllocationMethod] The public IP - * allocation method. Possible values are: 'Static' and 'Dynamic'. Possible - * values include: 'Static', 'Dynamic' - * @member {string} [publicIPAddress.publicIPAddressVersion] The public IP - * address version. Possible values are: 'IPv4' and 'IPv6'. Possible values - * include: 'IPv4', 'IPv6' - * @member {object} [publicIPAddress.ipConfiguration] The IP configuration - * associated with the public IP address. - * @member {object} [publicIPAddress.dnsSettings] The FQDN of the DNS record - * associated with the public IP address. - * @member {string} [publicIPAddress.dnsSettings.domainNameLabel] Gets or sets - * the Domain name label.The concatenation of the domain name label and the - * regionalized DNS zone make up the fully qualified domain name associated - * with the public IP address. If a domain name label is specified, an A DNS - * record is created for the public IP in the Microsoft Azure DNS system. - * @member {string} [publicIPAddress.dnsSettings.fqdn] Gets the FQDN, Fully - * qualified domain name of the A DNS record associated with the public IP. - * This is the concatenation of the domainNameLabel and the regionalized DNS - * zone. - * @member {string} [publicIPAddress.dnsSettings.reverseFqdn] Gets or Sets the - * Reverse FQDN. A user-visible, fully qualified domain name that resolves to - * this public IP address. If the reverseFqdn is specified, then a PTR DNS - * record is created pointing from the IP address in the in-addr.arpa domain to - * the reverse FQDN. - * @member {array} [publicIPAddress.ipTags] The list of tags associated with - * the public IP address. - * @member {string} [publicIPAddress.ipAddress] The IP address associated with - * the public IP address resource. - * @member {object} [publicIPAddress.publicIPPrefix] The Public IP Prefix this - * Public IP Address should be allocated from. - * @member {string} [publicIPAddress.publicIPPrefix.id] Resource ID. - * @member {number} [publicIPAddress.idleTimeoutInMinutes] The idle timeout of - * the public IP address. - * @member {string} [publicIPAddress.resourceGuid] The resource GUID property - * of the public IP resource. - * @member {string} [publicIPAddress.provisioningState] The provisioning state - * of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [publicIPAddress.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {array} [publicIPAddress.zones] A list of availability zones - * denoting the IP allocated for the resource needs to come from. - * @member {string} [provisioningState] Gets the provisioning state of the - * public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface IPConfiguration extends SubResource { + /** + * The private IP address of the IP configuration. + */ privateIPAddress?: string; + /** + * The private IP allocation method. Possible values are 'Static' and 'Dynamic'. Possible values + * include: 'Static', 'Dynamic' + */ privateIPAllocationMethod?: string; + /** + * The reference of the subnet resource. + */ subnet?: Subnet; + /** + * The reference of the public IP resource. + */ publicIPAddress?: PublicIPAddress; + /** + * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the IPConfigurationProfile class. - * @constructor * IP configuration profile child resource. - * - * @member {object} [subnet] The reference of the subnet resource to create a - * contatainer network interface ip configruation. - * @member {string} [subnet.addressPrefix] The address prefix for the subnet. - * @member {array} [subnet.addressPrefixes] List of address prefixes for the - * subnet. - * @member {object} [subnet.networkSecurityGroup] The reference of the - * NetworkSecurityGroup resource. - * @member {array} [subnet.networkSecurityGroup.securityRules] A collection of - * security rules of the network security group. - * @member {array} [subnet.networkSecurityGroup.defaultSecurityRules] The - * default security rules of network security group. - * @member {array} [subnet.networkSecurityGroup.networkInterfaces] A collection - * of references to network interfaces. - * @member {array} [subnet.networkSecurityGroup.subnets] A collection of - * references to subnets. - * @member {string} [subnet.networkSecurityGroup.resourceGuid] The resource - * GUID property of the network security group resource. - * @member {string} [subnet.networkSecurityGroup.provisioningState] The - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [subnet.networkSecurityGroup.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {object} [subnet.routeTable] The reference of the RouteTable - * resource. - * @member {array} [subnet.routeTable.routes] Collection of routes contained - * within a route table. - * @member {array} [subnet.routeTable.subnets] A collection of references to - * subnets. - * @member {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or - * sets whether to disable the routes learned by BGP on that route table. True - * means disable. - * @member {string} [subnet.routeTable.provisioningState] The provisioning - * state of the resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [subnet.routeTable.etag] Gets a unique read-only string - * that changes whenever the resource is updated. - * @member {array} [subnet.serviceEndpoints] An array of service endpoints. - * @member {array} [subnet.serviceEndpointPolicies] An array of service - * endpoint policies. - * @member {array} [subnet.interfaceEndpoints] An array of references to - * interface endpoints - * @member {array} [subnet.ipConfigurations] Gets an array of references to the - * network interface IP configurations using subnet. - * @member {array} [subnet.ipConfigurationProfiles] Array of IP configuration - * profiles which reference this subnet. - * @member {array} [subnet.resourceNavigationLinks] Gets an array of references - * to the external resources using subnet. - * @member {array} [subnet.serviceAssociationLinks] Gets an array of references - * to services injecting into this subnet. - * @member {array} [subnet.delegations] Gets an array of references to the - * delegations on the subnet. - * @member {string} [subnet.purpose] A read-only string identifying the - * intention of use for this subnet based on delegations and other user-defined - * properties. - * @member {string} [subnet.provisioningState] The provisioning state of the - * resource. - * @member {string} [subnet.name] The name of the resource that is unique - * within a resource group. This name can be used to access the resource. - * @member {string} [subnet.etag] A unique read-only string that changes - * whenever the resource is updated. - * @member {string} [provisioningState] The provisioning state of the resource. - * @member {string} [name] The name of the resource. This name can be used to - * access the resource. - * @member {string} [type] Sub Resource type. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface IPConfigurationProfile extends SubResource { + /** + * The reference of the subnet resource to create a contatainer network interface ip + * configruation. + */ subnet?: Subnet; + /** + * The provisioning state of the resource. + */ readonly provisioningState?: string; + /** + * The name of the resource. This name can be used to access the resource. + */ name?: string; + /** + * Sub Resource type. + */ readonly type?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the ResourceNavigationLink class. - * @constructor - * ResourceNavigationLink resource. - * - * @member {string} [linkedResourceType] Resource type of the linked resource. - * @member {string} [link] Link to the external resource - * @member {string} [provisioningState] Provisioning state of the * ResourceNavigationLink resource. - * @member {string} [name] Name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface ResourceNavigationLink extends SubResource { + /** + * Resource type of the linked resource. + */ linkedResourceType?: string; + /** + * Link to the external resource + */ link?: string; + /** + * Provisioning state of the ResourceNavigationLink resource. + */ readonly provisioningState?: string; + /** + * Name of the resource that is unique within a resource group. This name can be used to access + * the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the ServiceAssociationLink class. - * @constructor - * ServiceAssociationLink resource. - * - * @member {string} [linkedResourceType] Resource type of the linked resource. - * @member {string} [link] Link to the external resource. - * @member {string} [provisioningState] Provisioning state of the * ServiceAssociationLink resource. - * @member {string} [name] Name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface ServiceAssociationLink extends SubResource { + /** + * Resource type of the linked resource. + */ linkedResourceType?: string; + /** + * Link to the external resource. + */ link?: string; + /** + * Provisioning state of the ServiceAssociationLink resource. + */ readonly provisioningState?: string; + /** + * Name of the resource that is unique within a resource group. This name can be used to access + * the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the Delegation class. - * @constructor * Details the service to which the subnet is delegated. - * - * @member {string} [serviceName] The name of the service to whom the subnet - * should be delegated (e.g. Microsoft.Sql/servers) - * @member {array} [actions] Describes the actions permitted to the service - * upon delegation - * @member {string} [provisioningState] The provisioning state of the resource. - * @member {string} [name] The name of the resource that is unique within a - * subnet. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface Delegation extends SubResource { + /** + * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) + */ serviceName?: string; + /** + * Describes the actions permitted to the service upon delegation + */ actions?: string[]; + /** + * The provisioning state of the resource. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a subnet. This name can be used to access the + * resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the Subnet class. - * @constructor * Subnet in a virtual network resource. - * - * @member {string} [addressPrefix] The address prefix for the subnet. - * @member {array} [addressPrefixes] List of address prefixes for the subnet. - * @member {object} [networkSecurityGroup] The reference of the - * NetworkSecurityGroup resource. - * @member {array} [networkSecurityGroup.securityRules] A collection of - * security rules of the network security group. - * @member {array} [networkSecurityGroup.defaultSecurityRules] The default - * security rules of network security group. - * @member {array} [networkSecurityGroup.networkInterfaces] A collection of - * references to network interfaces. - * @member {array} [networkSecurityGroup.subnets] A collection of references to - * subnets. - * @member {string} [networkSecurityGroup.resourceGuid] The resource GUID - * property of the network security group resource. - * @member {string} [networkSecurityGroup.provisioningState] The provisioning - * state of the public IP resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [networkSecurityGroup.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {object} [routeTable] The reference of the RouteTable resource. - * @member {array} [routeTable.routes] Collection of routes contained within a - * route table. - * @member {array} [routeTable.subnets] A collection of references to subnets. - * @member {boolean} [routeTable.disableBgpRoutePropagation] Gets or sets - * whether to disable the routes learned by BGP on that route table. True means - * disable. - * @member {string} [routeTable.provisioningState] The provisioning state of - * the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [routeTable.etag] Gets a unique read-only string that - * changes whenever the resource is updated. - * @member {array} [serviceEndpoints] An array of service endpoints. - * @member {array} [serviceEndpointPolicies] An array of service endpoint - * policies. - * @member {array} [interfaceEndpoints] An array of references to interface - * endpoints - * @member {array} [ipConfigurations] Gets an array of references to the - * network interface IP configurations using subnet. - * @member {array} [ipConfigurationProfiles] Array of IP configuration profiles - * which reference this subnet. - * @member {array} [resourceNavigationLinks] Gets an array of references to the - * external resources using subnet. - * @member {array} [serviceAssociationLinks] Gets an array of references to - * services injecting into this subnet. - * @member {array} [delegations] Gets an array of references to the delegations - * on the subnet. - * @member {string} [purpose] A read-only string identifying the intention of - * use for this subnet based on delegations and other user-defined properties. - * @member {string} [provisioningState] The provisioning state of the resource. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface Subnet extends SubResource { + /** + * The address prefix for the subnet. + */ addressPrefix?: string; + /** + * List of address prefixes for the subnet. + */ addressPrefixes?: string[]; + /** + * The reference of the NetworkSecurityGroup resource. + */ networkSecurityGroup?: NetworkSecurityGroup; + /** + * The reference of the RouteTable resource. + */ routeTable?: RouteTable; + /** + * An array of service endpoints. + */ serviceEndpoints?: ServiceEndpointPropertiesFormat[]; + /** + * An array of service endpoint policies. + */ serviceEndpointPolicies?: ServiceEndpointPolicy[]; + /** + * An array of references to interface endpoints + */ readonly interfaceEndpoints?: InterfaceEndpoint[]; + /** + * Gets an array of references to the network interface IP configurations using subnet. + */ readonly ipConfigurations?: IPConfiguration[]; + /** + * Array of IP configuration profiles which reference this subnet. + */ readonly ipConfigurationProfiles?: IPConfigurationProfile[]; + /** + * Gets an array of references to the external resources using subnet. + */ resourceNavigationLinks?: ResourceNavigationLink[]; + /** + * Gets an array of references to services injecting into this subnet. + */ serviceAssociationLinks?: ServiceAssociationLink[]; + /** + * Gets an array of references to the delegations on the subnet. + */ delegations?: Delegation[]; + /** + * A read-only string identifying the intention of use for this subnet based on delegations and + * other user-defined properties. + */ readonly purpose?: string; + /** + * The provisioning state of the resource. + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the FrontendIPConfiguration class. - * @constructor * Frontend IP address of the load balancer. - * - * @member {array} [inboundNatRules] Read only. Inbound rules URIs that use - * this frontend IP. - * @member {array} [inboundNatPools] Read only. Inbound pools URIs that use - * this frontend IP. - * @member {array} [outboundRules] Read only. Outbound rules URIs that use this - * frontend IP. - * @member {array} [loadBalancingRules] Gets load balancing rules URIs that use - * this frontend IP. - * @member {string} [privateIPAddress] The private IP address of the IP - * configuration. - * @member {string} [privateIPAllocationMethod] The Private IP allocation - * method. Possible values are: 'Static' and 'Dynamic'. Possible values - * include: 'Static', 'Dynamic' - * @member {object} [subnet] The reference of the subnet resource. - * @member {string} [subnet.addressPrefix] The address prefix for the subnet. - * @member {array} [subnet.addressPrefixes] List of address prefixes for the - * subnet. - * @member {object} [subnet.networkSecurityGroup] The reference of the - * NetworkSecurityGroup resource. - * @member {array} [subnet.networkSecurityGroup.securityRules] A collection of - * security rules of the network security group. - * @member {array} [subnet.networkSecurityGroup.defaultSecurityRules] The - * default security rules of network security group. - * @member {array} [subnet.networkSecurityGroup.networkInterfaces] A collection - * of references to network interfaces. - * @member {array} [subnet.networkSecurityGroup.subnets] A collection of - * references to subnets. - * @member {string} [subnet.networkSecurityGroup.resourceGuid] The resource - * GUID property of the network security group resource. - * @member {string} [subnet.networkSecurityGroup.provisioningState] The - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [subnet.networkSecurityGroup.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {object} [subnet.routeTable] The reference of the RouteTable - * resource. - * @member {array} [subnet.routeTable.routes] Collection of routes contained - * within a route table. - * @member {array} [subnet.routeTable.subnets] A collection of references to - * subnets. - * @member {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or - * sets whether to disable the routes learned by BGP on that route table. True - * means disable. - * @member {string} [subnet.routeTable.provisioningState] The provisioning - * state of the resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [subnet.routeTable.etag] Gets a unique read-only string - * that changes whenever the resource is updated. - * @member {array} [subnet.serviceEndpoints] An array of service endpoints. - * @member {array} [subnet.serviceEndpointPolicies] An array of service - * endpoint policies. - * @member {array} [subnet.interfaceEndpoints] An array of references to - * interface endpoints - * @member {array} [subnet.ipConfigurations] Gets an array of references to the - * network interface IP configurations using subnet. - * @member {array} [subnet.ipConfigurationProfiles] Array of IP configuration - * profiles which reference this subnet. - * @member {array} [subnet.resourceNavigationLinks] Gets an array of references - * to the external resources using subnet. - * @member {array} [subnet.serviceAssociationLinks] Gets an array of references - * to services injecting into this subnet. - * @member {array} [subnet.delegations] Gets an array of references to the - * delegations on the subnet. - * @member {string} [subnet.purpose] A read-only string identifying the - * intention of use for this subnet based on delegations and other user-defined - * properties. - * @member {string} [subnet.provisioningState] The provisioning state of the - * resource. - * @member {string} [subnet.name] The name of the resource that is unique - * within a resource group. This name can be used to access the resource. - * @member {string} [subnet.etag] A unique read-only string that changes - * whenever the resource is updated. - * @member {object} [publicIPAddress] The reference of the Public IP resource. - * @member {object} [publicIPAddress.sku] The public IP address SKU. - * @member {string} [publicIPAddress.sku.name] Name of a public IP address SKU. - * Possible values include: 'Basic', 'Standard' - * @member {string} [publicIPAddress.publicIPAllocationMethod] The public IP - * allocation method. Possible values are: 'Static' and 'Dynamic'. Possible - * values include: 'Static', 'Dynamic' - * @member {string} [publicIPAddress.publicIPAddressVersion] The public IP - * address version. Possible values are: 'IPv4' and 'IPv6'. Possible values - * include: 'IPv4', 'IPv6' - * @member {object} [publicIPAddress.ipConfiguration] The IP configuration - * associated with the public IP address. - * @member {string} [publicIPAddress.ipConfiguration.privateIPAddress] The - * private IP address of the IP configuration. - * @member {string} [publicIPAddress.ipConfiguration.privateIPAllocationMethod] - * The private IP allocation method. Possible values are 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} [publicIPAddress.ipConfiguration.subnet] The reference of - * the subnet resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.addressPrefix] The - * address prefix for the subnet. - * @member {array} [publicIPAddress.ipConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * @member {object} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] The reference - * of the NetworkSecurityGroup resource. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] A - * collection of references to subnets. - * @member {string} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.ipConfiguration.subnet.routeTable] The - * reference of the RouteTable resource. - * @member {array} [publicIPAddress.ipConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} [publicIPAddress.ipConfiguration.subnet.routeTable.subnets] - * A collection of references to subnets. - * @member {boolean} - * [publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] The - * provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.ipConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} [publicIPAddress.ipConfiguration.subnet.serviceEndpoints] An - * array of service endpoints. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] An array of - * service endpoint policies. - * @member {array} [publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} [publicIPAddress.ipConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] Array of IP - * configuration profiles which reference this subnet. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] Gets an - * array of references to the external resources using subnet. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] Gets an - * array of references to services injecting into this subnet. - * @member {array} [publicIPAddress.ipConfiguration.subnet.delegations] Gets an - * array of references to the delegations on the subnet. - * @member {string} [publicIPAddress.ipConfiguration.subnet.purpose] A - * read-only string identifying the intention of use for this subnet based on - * delegations and other user-defined properties. - * @member {string} [publicIPAddress.ipConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.name] The name of - * the resource that is unique within a resource group. This name can be used - * to access the resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.ipConfiguration.publicIPAddress] The - * reference of the public IP resource. - * @member {string} [publicIPAddress.ipConfiguration.provisioningState] Gets - * the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.ipConfiguration.name] The name of the - * resource that is unique within a resource group. This name can be used to - * access the resource. - * @member {string} [publicIPAddress.ipConfiguration.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.dnsSettings] The FQDN of the DNS record - * associated with the public IP address. - * @member {string} [publicIPAddress.dnsSettings.domainNameLabel] Gets or sets - * the Domain name label.The concatenation of the domain name label and the - * regionalized DNS zone make up the fully qualified domain name associated - * with the public IP address. If a domain name label is specified, an A DNS - * record is created for the public IP in the Microsoft Azure DNS system. - * @member {string} [publicIPAddress.dnsSettings.fqdn] Gets the FQDN, Fully - * qualified domain name of the A DNS record associated with the public IP. - * This is the concatenation of the domainNameLabel and the regionalized DNS - * zone. - * @member {string} [publicIPAddress.dnsSettings.reverseFqdn] Gets or Sets the - * Reverse FQDN. A user-visible, fully qualified domain name that resolves to - * this public IP address. If the reverseFqdn is specified, then a PTR DNS - * record is created pointing from the IP address in the in-addr.arpa domain to - * the reverse FQDN. - * @member {array} [publicIPAddress.ipTags] The list of tags associated with - * the public IP address. - * @member {string} [publicIPAddress.ipAddress] The IP address associated with - * the public IP address resource. - * @member {object} [publicIPAddress.publicIPPrefix] The Public IP Prefix this - * Public IP Address should be allocated from. - * @member {string} [publicIPAddress.publicIPPrefix.id] Resource ID. - * @member {number} [publicIPAddress.idleTimeoutInMinutes] The idle timeout of - * the public IP address. - * @member {string} [publicIPAddress.resourceGuid] The resource GUID property - * of the public IP resource. - * @member {string} [publicIPAddress.provisioningState] The provisioning state - * of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [publicIPAddress.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {array} [publicIPAddress.zones] A list of availability zones - * denoting the IP allocated for the resource needs to come from. - * @member {object} [publicIPPrefix] The reference of the Public IP Prefix - * resource. - * @member {string} [publicIPPrefix.id] Resource ID. - * @member {string} [provisioningState] Gets the provisioning state of the - * public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {array} [zones] A list of availability zones denoting the IP - * allocated for the resource needs to come from. */ export interface FrontendIPConfiguration extends SubResource { + /** + * Read only. Inbound rules URIs that use this frontend IP. + */ readonly inboundNatRules?: SubResource[]; + /** + * Read only. Inbound pools URIs that use this frontend IP. + */ readonly inboundNatPools?: SubResource[]; + /** + * Read only. Outbound rules URIs that use this frontend IP. + */ readonly outboundRules?: SubResource[]; + /** + * Gets load balancing rules URIs that use this frontend IP. + */ readonly loadBalancingRules?: SubResource[]; + /** + * The private IP address of the IP configuration. + */ privateIPAddress?: string; + /** + * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'. Possible values + * include: 'Static', 'Dynamic' + */ privateIPAllocationMethod?: string; + /** + * The reference of the subnet resource. + */ subnet?: Subnet; + /** + * The reference of the Public IP resource. + */ publicIPAddress?: PublicIPAddress; + /** + * The reference of the Public IP Prefix resource. + */ publicIPPrefix?: SubResource; + /** + * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * A list of availability zones denoting the IP allocated for the resource needs to come from. + */ zones?: string[]; } /** - * @class - * Initializes a new instance of the VirtualNetworkTap class. - * @constructor * Virtual Network Tap resource - * - * @member {array} [networkInterfaceTapConfigurations] Specifies the list of - * resource IDs for the network interface IP configuration that needs to be - * tapped. - * @member {string} [resourceGuid] The resourceGuid property of the virtual - * network tap. - * @member {string} [provisioningState] The provisioning state of the virtual - * network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {object} [destinationNetworkInterfaceIPConfiguration] The reference - * to the private IP Address of the collector nic that will receive the tap - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] The - * reference to Virtual Network Taps. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] - * The reference of ApplicationGatewayBackendAddressPool resource. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] - * The reference of LoadBalancerBackendAddressPool resource. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] A - * list of references of LoadBalancerInboundNatRules. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.privateIPAddress] Private IP - * address of the IP configuration. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] - * Defines how a private IP address is assigned. Possible values are: 'Static' - * and 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] - * Available from Api-Version 2016-03-30 onwards, it represents whether the - * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. - * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', - * 'IPv6' - * @member {object} [destinationNetworkInterfaceIPConfiguration.subnet] Subnet - * bound to the IP configuration. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.subnet.addressPrefix] The - * address prefix for the subnet. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.addressPrefixes] List of - * address prefixes for the subnet. - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup] The - * reference of the NetworkSecurityGroup resource. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable] The reference - * of the RouteTable resource. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable.subnets] A - * collection of references to subnets. - * @member {boolean} - * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable.etag] Gets a - * unique read-only string that changes whenever the resource is updated. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.serviceEndpoints] An - * array of service endpoints. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.interfaceEndpoints] An - * array of references to interface endpoints - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.ipConfigurations] Gets an - * array of references to the network interface IP configurations using subnet. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.subnet.delegations] Gets an - * array of references to the delegations on the subnet. - * @member {string} [destinationNetworkInterfaceIPConfiguration.subnet.purpose] - * A read-only string identifying the intention of use for this subnet based on - * delegations and other user-defined properties. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.subnet.provisioningState] The - * provisioning state of the resource. - * @member {string} [destinationNetworkInterfaceIPConfiguration.subnet.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} [destinationNetworkInterfaceIPConfiguration.subnet.etag] A - * unique read-only string that changes whenever the resource is updated. - * @member {boolean} [destinationNetworkInterfaceIPConfiguration.primary] Gets - * whether this is a primary customer address on the network interface. - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress] Public IP - * address bound to the IP configuration. - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.sku] The public - * IP address SKU. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.sku.name] Name - * of a public IP address SKU. Possible values include: 'Basic', 'Standard' - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPAllocationMethod] - * The public IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPAddressVersion] - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - * Possible values include: 'IPv4', 'IPv6' - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration] - * The IP configuration associated with the public IP address. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] - * The private IP address of the IP configuration. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] - * The private IP allocation method. Possible values are 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet] - * The reference of the subnet resource. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] - * A collection of references to subnets. - * @member {boolean} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] - * A read-only string identifying the intention of use for this subnet based on - * delegations and other user-defined properties. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] - * The reference of the public IP resource. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.provisioningState] - * Gets the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings] The - * FQDN of the DNS record associated with the public IP address. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] - * Gets or sets the Domain name label.The concatenation of the domain name - * label and the regionalized DNS zone make up the fully qualified domain name - * associated with the public IP address. If a domain name label is specified, - * an A DNS record is created for the public IP in the Microsoft Azure DNS - * system. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.fqdn] - * Gets the FQDN, Fully qualified domain name of the A DNS record associated - * with the public IP. This is the concatenation of the domainNameLabel and the - * regionalized DNS zone. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name - * that resolves to this public IP address. If the reverseFqdn is specified, - * then a PTR DNS record is created pointing from the IP address in the - * in-addr.arpa domain to the reverse FQDN. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipTags] The list - * of tags associated with the public IP address. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipAddress] The - * IP address associated with the public IP address resource. - * @member {object} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPPrefix] - * The Public IP Prefix this Public IP Address should be allocated from. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPPrefix.id] - * Resource ID. - * @member {number} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.idleTimeoutInMinutes] - * The idle timeout of the public IP address. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.resourceGuid] - * The resource GUID property of the public IP resource. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.provisioningState] - * The provisioning state of the PublicIP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.zones] A list of - * availability zones denoting the IP allocated for the resource needs to come - * from. - * @member {array} - * [destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] - * Application security groups in which the IP configuration is included. - * @member {string} - * [destinationNetworkInterfaceIPConfiguration.provisioningState] The - * provisioning state of the network interface IP configuration. Possible - * values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [destinationNetworkInterfaceIPConfiguration.name] The name - * of the resource that is unique within a resource group. This name can be - * used to access the resource. - * @member {string} [destinationNetworkInterfaceIPConfiguration.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} [destinationLoadBalancerFrontEndIPConfiguration] The - * reference to the private IP address on the internal Load Balancer that will - * receive the tap - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.inboundNatRules] Read only. - * Inbound rules URIs that use this frontend IP. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.inboundNatPools] Read only. - * Inbound pools URIs that use this frontend IP. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.outboundRules] Read only. - * Outbound rules URIs that use this frontend IP. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.loadBalancingRules] Gets - * load balancing rules URIs that use this frontend IP. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] The - * private IP address of the IP configuration. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] - * The Private IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} [destinationLoadBalancerFrontEndIPConfiguration.subnet] The - * reference of the subnet resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] The - * address prefix for the subnet. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] List - * of address prefixes for the subnet. - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] The - * reference of the RouteTable resource. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.subnets] A - * collection of references to subnets. - * @member {boolean} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] Gets - * a unique read-only string that changes whenever the resource is updated. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] An - * array of service endpoints. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] Gets an - * array of references to the delegations on the subnet. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.purpose] A read-only - * string identifying the intention of use for this subnet based on delegations - * and other user-defined properties. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.name] The name of the - * resource that is unique within a resource group. This name can be used to - * access the resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] The - * reference of the Public IP resource. - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] The - * public IP address SKU. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] - * Name of a public IP address SKU. Possible values include: 'Basic', - * 'Standard' - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] - * The public IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - * Possible values include: 'IPv4', 'IPv6' - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration] - * The IP configuration associated with the public IP address. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] - * The private IP address of the IP configuration. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] - * The private IP allocation method. Possible values are 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet] - * The reference of the subnet resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] - * A collection of references to subnets. - * @member {boolean} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] - * A read-only string identifying the intention of use for this subnet based on - * delegations and other user-defined properties. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] - * The reference of the public IP resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.provisioningState] - * Gets the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] - * The FQDN of the DNS record associated with the public IP address. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] - * Gets or sets the Domain name label.The concatenation of the domain name - * label and the regionalized DNS zone make up the fully qualified domain name - * associated with the public IP address. If a domain name label is specified, - * an A DNS record is created for the public IP in the Microsoft Azure DNS - * system. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] - * Gets the FQDN, Fully qualified domain name of the A DNS record associated - * with the public IP. This is the concatenation of the domainNameLabel and the - * regionalized DNS zone. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name - * that resolves to this public IP address. If the reverseFqdn is specified, - * then a PTR DNS record is created pointing from the IP address in the - * in-addr.arpa domain to the reverse FQDN. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] The - * list of tags associated with the public IP address. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] - * The IP address associated with the public IP address resource. - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] - * The Public IP Prefix this Public IP Address should be allocated from. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix.id] - * Resource ID. - * @member {number} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] - * The idle timeout of the public IP address. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] - * The resource GUID property of the public IP resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] - * The provisioning state of the PublicIP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] A - * unique read-only string that changes whenever the resource is updated. - * @member {array} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] A - * list of availability zones denoting the IP allocated for the resource needs - * to come from. - * @member {object} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] The - * reference of the Public IP Prefix resource. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] Resource - * ID. - * @member {string} - * [destinationLoadBalancerFrontEndIPConfiguration.provisioningState] Gets the - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [destinationLoadBalancerFrontEndIPConfiguration.name] The - * name of the resource that is unique within a resource group. This name can - * be used to access the resource. - * @member {string} [destinationLoadBalancerFrontEndIPConfiguration.etag] A - * unique read-only string that changes whenever the resource is updated. - * @member {array} [destinationLoadBalancerFrontEndIPConfiguration.zones] A - * list of availability zones denoting the IP allocated for the resource needs - * to come from. - * @member {number} [destinationPort] The VXLAN destination port that will - * receive the tapped traffic. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. */ export interface VirtualNetworkTap extends Resource { + /** + * Specifies the list of resource IDs for the network interface IP configuration that needs to be + * tapped. + */ readonly networkInterfaceTapConfigurations?: NetworkInterfaceTapConfiguration[]; + /** + * The resourceGuid property of the virtual network tap. + */ readonly resourceGuid?: string; + /** + * The provisioning state of the virtual network tap. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The reference to the private IP Address of the collector nic that will receive the tap + */ destinationNetworkInterfaceIPConfiguration?: NetworkInterfaceIPConfiguration; + /** + * The reference to the private IP address on the internal Load Balancer that will receive the + * tap + */ destinationLoadBalancerFrontEndIPConfiguration?: FrontendIPConfiguration; + /** + * The VXLAN destination port that will receive the tapped traffic. + */ destinationPort?: number; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the BackendAddressPool class. - * @constructor * Pool of backend IP addresses. - * - * @member {array} [backendIPConfigurations] Gets collection of references to - * IP addresses defined in network interfaces. - * @member {array} [loadBalancingRules] Gets load balancing rules that use this - * backend address pool. - * @member {object} [outboundRule] Gets outbound rules that use this backend - * address pool. - * @member {string} [outboundRule.id] Resource ID. - * @member {string} [provisioningState] Get provisioning state of the public IP - * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface BackendAddressPool extends SubResource { + /** + * Gets collection of references to IP addresses defined in network interfaces. + */ readonly backendIPConfigurations?: NetworkInterfaceIPConfiguration[]; + /** + * Gets load balancing rules that use this backend address pool. + */ readonly loadBalancingRules?: SubResource[]; + /** + * Gets outbound rules that use this backend address pool. + */ readonly outboundRule?: SubResource; + /** + * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + */ provisioningState?: string; + /** + * Gets name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the InboundNatRule class. - * @constructor * Inbound NAT rule of the load balancer. - * - * @member {object} [frontendIPConfiguration] A reference to frontend IP - * addresses. - * @member {string} [frontendIPConfiguration.id] Resource ID. - * @member {object} [backendIPConfiguration] A reference to a private IP - * address defined on a network interface of a VM. Traffic sent to the frontend - * port of each of the frontend IP configurations is forwarded to the backend - * IP. - * @member {array} [backendIPConfiguration.virtualNetworkTaps] The reference to - * Virtual Network Taps. - * @member {array} - * [backendIPConfiguration.applicationGatewayBackendAddressPools] The reference - * of ApplicationGatewayBackendAddressPool resource. - * @member {array} [backendIPConfiguration.loadBalancerBackendAddressPools] The - * reference of LoadBalancerBackendAddressPool resource. - * @member {array} [backendIPConfiguration.loadBalancerInboundNatRules] A list - * of references of LoadBalancerInboundNatRules. - * @member {string} [backendIPConfiguration.privateIPAddress] Private IP - * address of the IP configuration. - * @member {string} [backendIPConfiguration.privateIPAllocationMethod] Defines - * how a private IP address is assigned. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} [backendIPConfiguration.privateIPAddressVersion] Available - * from Api-Version 2016-03-30 onwards, it represents whether the specific - * ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values - * are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', 'IPv6' - * @member {object} [backendIPConfiguration.subnet] Subnet bound to the IP - * configuration. - * @member {string} [backendIPConfiguration.subnet.addressPrefix] The address - * prefix for the subnet. - * @member {array} [backendIPConfiguration.subnet.addressPrefixes] List of - * address prefixes for the subnet. - * @member {object} [backendIPConfiguration.subnet.networkSecurityGroup] The - * reference of the NetworkSecurityGroup resource. - * @member {array} - * [backendIPConfiguration.subnet.networkSecurityGroup.securityRules] A - * collection of security rules of the network security group. - * @member {array} - * [backendIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [backendIPConfiguration.subnet.networkSecurityGroup.networkInterfaces] A - * collection of references to network interfaces. - * @member {array} [backendIPConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [backendIPConfiguration.subnet.networkSecurityGroup.resourceGuid] The - * resource GUID property of the network security group resource. - * @member {string} - * [backendIPConfiguration.subnet.networkSecurityGroup.provisioningState] The - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [backendIPConfiguration.subnet.networkSecurityGroup.etag] A - * unique read-only string that changes whenever the resource is updated. - * @member {object} [backendIPConfiguration.subnet.routeTable] The reference of - * the RouteTable resource. - * @member {array} [backendIPConfiguration.subnet.routeTable.routes] Collection - * of routes contained within a route table. - * @member {array} [backendIPConfiguration.subnet.routeTable.subnets] A - * collection of references to subnets. - * @member {boolean} - * [backendIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] Gets - * or sets whether to disable the routes learned by BGP on that route table. - * True means disable. - * @member {string} - * [backendIPConfiguration.subnet.routeTable.provisioningState] The - * provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [backendIPConfiguration.subnet.routeTable.etag] Gets a - * unique read-only string that changes whenever the resource is updated. - * @member {array} [backendIPConfiguration.subnet.serviceEndpoints] An array of - * service endpoints. - * @member {array} [backendIPConfiguration.subnet.serviceEndpointPolicies] An - * array of service endpoint policies. - * @member {array} [backendIPConfiguration.subnet.interfaceEndpoints] An array - * of references to interface endpoints - * @member {array} [backendIPConfiguration.subnet.ipConfigurations] Gets an - * array of references to the network interface IP configurations using subnet. - * @member {array} [backendIPConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} [backendIPConfiguration.subnet.resourceNavigationLinks] Gets - * an array of references to the external resources using subnet. - * @member {array} [backendIPConfiguration.subnet.serviceAssociationLinks] Gets - * an array of references to services injecting into this subnet. - * @member {array} [backendIPConfiguration.subnet.delegations] Gets an array of - * references to the delegations on the subnet. - * @member {string} [backendIPConfiguration.subnet.purpose] A read-only string - * identifying the intention of use for this subnet based on delegations and - * other user-defined properties. - * @member {string} [backendIPConfiguration.subnet.provisioningState] The - * provisioning state of the resource. - * @member {string} [backendIPConfiguration.subnet.name] The name of the - * resource that is unique within a resource group. This name can be used to - * access the resource. - * @member {string} [backendIPConfiguration.subnet.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {boolean} [backendIPConfiguration.primary] Gets whether this is a - * primary customer address on the network interface. - * @member {object} [backendIPConfiguration.publicIPAddress] Public IP address - * bound to the IP configuration. - * @member {object} [backendIPConfiguration.publicIPAddress.sku] The public IP - * address SKU. - * @member {string} [backendIPConfiguration.publicIPAddress.sku.name] Name of a - * public IP address SKU. Possible values include: 'Basic', 'Standard' - * @member {string} - * [backendIPConfiguration.publicIPAddress.publicIPAllocationMethod] The public - * IP allocation method. Possible values are: 'Static' and 'Dynamic'. Possible - * values include: 'Static', 'Dynamic' - * @member {string} - * [backendIPConfiguration.publicIPAddress.publicIPAddressVersion] The public - * IP address version. Possible values are: 'IPv4' and 'IPv6'. Possible values - * include: 'IPv4', 'IPv6' - * @member {object} [backendIPConfiguration.publicIPAddress.ipConfiguration] - * The IP configuration associated with the public IP address. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] - * The private IP address of the IP configuration. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] - * The private IP allocation method. Possible values are 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet] The - * reference of the subnet resource. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * @member {object} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] - * A collection of references to subnets. - * @member {boolean} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * @member {array} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] A - * read-only string identifying the intention of use for this subnet based on - * delegations and other user-defined properties. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.name] The - * name of the resource that is unique within a resource group. This name can - * be used to access the resource. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.subnet.etag] A - * unique read-only string that changes whenever the resource is updated. - * @member {object} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] The - * reference of the public IP resource. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.provisioningState] - * Gets the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.name] The name of - * the resource that is unique within a resource group. This name can be used - * to access the resource. - * @member {string} - * [backendIPConfiguration.publicIPAddress.ipConfiguration.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} [backendIPConfiguration.publicIPAddress.dnsSettings] The - * FQDN of the DNS record associated with the public IP address. - * @member {string} - * [backendIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] Gets or - * sets the Domain name label.The concatenation of the domain name label and - * the regionalized DNS zone make up the fully qualified domain name associated - * with the public IP address. If a domain name label is specified, an A DNS - * record is created for the public IP in the Microsoft Azure DNS system. - * @member {string} [backendIPConfiguration.publicIPAddress.dnsSettings.fqdn] - * Gets the FQDN, Fully qualified domain name of the A DNS record associated - * with the public IP. This is the concatenation of the domainNameLabel and the - * regionalized DNS zone. - * @member {string} - * [backendIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] Gets or - * Sets the Reverse FQDN. A user-visible, fully qualified domain name that - * resolves to this public IP address. If the reverseFqdn is specified, then a - * PTR DNS record is created pointing from the IP address in the in-addr.arpa - * domain to the reverse FQDN. - * @member {array} [backendIPConfiguration.publicIPAddress.ipTags] The list of - * tags associated with the public IP address. - * @member {string} [backendIPConfiguration.publicIPAddress.ipAddress] The IP - * address associated with the public IP address resource. - * @member {object} [backendIPConfiguration.publicIPAddress.publicIPPrefix] The - * Public IP Prefix this Public IP Address should be allocated from. - * @member {string} [backendIPConfiguration.publicIPAddress.publicIPPrefix.id] - * Resource ID. - * @member {number} - * [backendIPConfiguration.publicIPAddress.idleTimeoutInMinutes] The idle - * timeout of the public IP address. - * @member {string} [backendIPConfiguration.publicIPAddress.resourceGuid] The - * resource GUID property of the public IP resource. - * @member {string} [backendIPConfiguration.publicIPAddress.provisioningState] - * The provisioning state of the PublicIP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [backendIPConfiguration.publicIPAddress.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {array} [backendIPConfiguration.publicIPAddress.zones] A list of - * availability zones denoting the IP allocated for the resource needs to come - * from. - * @member {array} [backendIPConfiguration.applicationSecurityGroups] - * Application security groups in which the IP configuration is included. - * @member {string} [backendIPConfiguration.provisioningState] The provisioning - * state of the network interface IP configuration. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [backendIPConfiguration.name] The name of the resource that - * is unique within a resource group. This name can be used to access the - * resource. - * @member {string} [backendIPConfiguration.etag] A unique read-only string - * that changes whenever the resource is updated. - * @member {string} [protocol] Possible values include: 'Udp', 'Tcp', 'All' - * @member {number} [frontendPort] The port for the external endpoint. Port - * numbers for each rule must be unique within the Load Balancer. Acceptable - * values range from 1 to 65534. - * @member {number} [backendPort] The port used for the internal endpoint. - * Acceptable values range from 1 to 65535. - * @member {number} [idleTimeoutInMinutes] The timeout for the TCP idle - * connection. The value can be set between 4 and 30 minutes. The default value - * is 4 minutes. This element is only used when the protocol is set to TCP. - * @member {boolean} [enableFloatingIP] Configures a virtual machine's endpoint - * for the floating IP capability required to configure a SQL AlwaysOn - * Availability Group. This setting is required when using the SQL AlwaysOn - * Availability Groups in SQL server. This setting can't be changed after you - * create the endpoint. - * @member {boolean} [enableTcpReset] Receive bidirectional TCP Reset on TCP - * flow idle timeout or unexpected connection termination. This element is only - * used when the protocol is set to TCP. - * @member {string} [provisioningState] Gets the provisioning state of the - * public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface InboundNatRule extends SubResource { + /** + * A reference to frontend IP addresses. + */ frontendIPConfiguration?: SubResource; + /** + * A reference to a private IP address defined on a network interface of a VM. Traffic sent to + * the frontend port of each of the frontend IP configurations is forwarded to the backend IP. + */ readonly backendIPConfiguration?: NetworkInterfaceIPConfiguration; + /** + * Possible values include: 'Udp', 'Tcp', 'All' + */ protocol?: string; + /** + * The port for the external endpoint. Port numbers for each rule must be unique within the Load + * Balancer. Acceptable values range from 1 to 65534. + */ frontendPort?: number; + /** + * The port used for the internal endpoint. Acceptable values range from 1 to 65535. + */ backendPort?: number; + /** + * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The + * default value is 4 minutes. This element is only used when the protocol is set to TCP. + */ idleTimeoutInMinutes?: number; + /** + * Configures a virtual machine's endpoint for the floating IP capability required to configure a + * SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn + * Availability Groups in SQL server. This setting can't be changed after you create the + * endpoint. + */ enableFloatingIP?: boolean; + /** + * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. + * This element is only used when the protocol is set to TCP. + */ enableTcpReset?: boolean; + /** + * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Gets name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the NetworkInterfaceIPConfiguration class. - * @constructor * IPConfiguration in a network interface. - * - * @member {array} [virtualNetworkTaps] The reference to Virtual Network Taps. - * @member {array} [applicationGatewayBackendAddressPools] The reference of - * ApplicationGatewayBackendAddressPool resource. - * @member {array} [loadBalancerBackendAddressPools] The reference of - * LoadBalancerBackendAddressPool resource. - * @member {array} [loadBalancerInboundNatRules] A list of references of - * LoadBalancerInboundNatRules. - * @member {string} [privateIPAddress] Private IP address of the IP - * configuration. - * @member {string} [privateIPAllocationMethod] Defines how a private IP - * address is assigned. Possible values are: 'Static' and 'Dynamic'. Possible - * values include: 'Static', 'Dynamic' - * @member {string} [privateIPAddressVersion] Available from Api-Version - * 2016-03-30 onwards, it represents whether the specific ipconfiguration is - * IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and - * 'IPv6'. Possible values include: 'IPv4', 'IPv6' - * @member {object} [subnet] Subnet bound to the IP configuration. - * @member {string} [subnet.addressPrefix] The address prefix for the subnet. - * @member {array} [subnet.addressPrefixes] List of address prefixes for the - * subnet. - * @member {object} [subnet.networkSecurityGroup] The reference of the - * NetworkSecurityGroup resource. - * @member {array} [subnet.networkSecurityGroup.securityRules] A collection of - * security rules of the network security group. - * @member {array} [subnet.networkSecurityGroup.defaultSecurityRules] The - * default security rules of network security group. - * @member {array} [subnet.networkSecurityGroup.networkInterfaces] A collection - * of references to network interfaces. - * @member {array} [subnet.networkSecurityGroup.subnets] A collection of - * references to subnets. - * @member {string} [subnet.networkSecurityGroup.resourceGuid] The resource - * GUID property of the network security group resource. - * @member {string} [subnet.networkSecurityGroup.provisioningState] The - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [subnet.networkSecurityGroup.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {object} [subnet.routeTable] The reference of the RouteTable - * resource. - * @member {array} [subnet.routeTable.routes] Collection of routes contained - * within a route table. - * @member {array} [subnet.routeTable.subnets] A collection of references to - * subnets. - * @member {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or - * sets whether to disable the routes learned by BGP on that route table. True - * means disable. - * @member {string} [subnet.routeTable.provisioningState] The provisioning - * state of the resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [subnet.routeTable.etag] Gets a unique read-only string - * that changes whenever the resource is updated. - * @member {array} [subnet.serviceEndpoints] An array of service endpoints. - * @member {array} [subnet.serviceEndpointPolicies] An array of service - * endpoint policies. - * @member {array} [subnet.interfaceEndpoints] An array of references to - * interface endpoints - * @member {array} [subnet.ipConfigurations] Gets an array of references to the - * network interface IP configurations using subnet. - * @member {array} [subnet.ipConfigurationProfiles] Array of IP configuration - * profiles which reference this subnet. - * @member {array} [subnet.resourceNavigationLinks] Gets an array of references - * to the external resources using subnet. - * @member {array} [subnet.serviceAssociationLinks] Gets an array of references - * to services injecting into this subnet. - * @member {array} [subnet.delegations] Gets an array of references to the - * delegations on the subnet. - * @member {string} [subnet.purpose] A read-only string identifying the - * intention of use for this subnet based on delegations and other user-defined - * properties. - * @member {string} [subnet.provisioningState] The provisioning state of the - * resource. - * @member {string} [subnet.name] The name of the resource that is unique - * within a resource group. This name can be used to access the resource. - * @member {string} [subnet.etag] A unique read-only string that changes - * whenever the resource is updated. - * @member {boolean} [primary] Gets whether this is a primary customer address - * on the network interface. - * @member {object} [publicIPAddress] Public IP address bound to the IP - * configuration. - * @member {object} [publicIPAddress.sku] The public IP address SKU. - * @member {string} [publicIPAddress.sku.name] Name of a public IP address SKU. - * Possible values include: 'Basic', 'Standard' - * @member {string} [publicIPAddress.publicIPAllocationMethod] The public IP - * allocation method. Possible values are: 'Static' and 'Dynamic'. Possible - * values include: 'Static', 'Dynamic' - * @member {string} [publicIPAddress.publicIPAddressVersion] The public IP - * address version. Possible values are: 'IPv4' and 'IPv6'. Possible values - * include: 'IPv4', 'IPv6' - * @member {object} [publicIPAddress.ipConfiguration] The IP configuration - * associated with the public IP address. - * @member {string} [publicIPAddress.ipConfiguration.privateIPAddress] The - * private IP address of the IP configuration. - * @member {string} [publicIPAddress.ipConfiguration.privateIPAllocationMethod] - * The private IP allocation method. Possible values are 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} [publicIPAddress.ipConfiguration.subnet] The reference of - * the subnet resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.addressPrefix] The - * address prefix for the subnet. - * @member {array} [publicIPAddress.ipConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * @member {object} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] The reference - * of the NetworkSecurityGroup resource. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] A - * collection of references to subnets. - * @member {string} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.ipConfiguration.subnet.routeTable] The - * reference of the RouteTable resource. - * @member {array} [publicIPAddress.ipConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} [publicIPAddress.ipConfiguration.subnet.routeTable.subnets] - * A collection of references to subnets. - * @member {boolean} - * [publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] The - * provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.ipConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} [publicIPAddress.ipConfiguration.subnet.serviceEndpoints] An - * array of service endpoints. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] An array of - * service endpoint policies. - * @member {array} [publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} [publicIPAddress.ipConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] Array of IP - * configuration profiles which reference this subnet. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] Gets an - * array of references to the external resources using subnet. - * @member {array} - * [publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] Gets an - * array of references to services injecting into this subnet. - * @member {array} [publicIPAddress.ipConfiguration.subnet.delegations] Gets an - * array of references to the delegations on the subnet. - * @member {string} [publicIPAddress.ipConfiguration.subnet.purpose] A - * read-only string identifying the intention of use for this subnet based on - * delegations and other user-defined properties. - * @member {string} [publicIPAddress.ipConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.name] The name of - * the resource that is unique within a resource group. This name can be used - * to access the resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.ipConfiguration.publicIPAddress] The - * reference of the public IP resource. - * @member {string} [publicIPAddress.ipConfiguration.provisioningState] Gets - * the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.ipConfiguration.name] The name of the - * resource that is unique within a resource group. This name can be used to - * access the resource. - * @member {string} [publicIPAddress.ipConfiguration.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.dnsSettings] The FQDN of the DNS record - * associated with the public IP address. - * @member {string} [publicIPAddress.dnsSettings.domainNameLabel] Gets or sets - * the Domain name label.The concatenation of the domain name label and the - * regionalized DNS zone make up the fully qualified domain name associated - * with the public IP address. If a domain name label is specified, an A DNS - * record is created for the public IP in the Microsoft Azure DNS system. - * @member {string} [publicIPAddress.dnsSettings.fqdn] Gets the FQDN, Fully - * qualified domain name of the A DNS record associated with the public IP. - * This is the concatenation of the domainNameLabel and the regionalized DNS - * zone. - * @member {string} [publicIPAddress.dnsSettings.reverseFqdn] Gets or Sets the - * Reverse FQDN. A user-visible, fully qualified domain name that resolves to - * this public IP address. If the reverseFqdn is specified, then a PTR DNS - * record is created pointing from the IP address in the in-addr.arpa domain to - * the reverse FQDN. - * @member {array} [publicIPAddress.ipTags] The list of tags associated with - * the public IP address. - * @member {string} [publicIPAddress.ipAddress] The IP address associated with - * the public IP address resource. - * @member {object} [publicIPAddress.publicIPPrefix] The Public IP Prefix this - * Public IP Address should be allocated from. - * @member {string} [publicIPAddress.publicIPPrefix.id] Resource ID. - * @member {number} [publicIPAddress.idleTimeoutInMinutes] The idle timeout of - * the public IP address. - * @member {string} [publicIPAddress.resourceGuid] The resource GUID property - * of the public IP resource. - * @member {string} [publicIPAddress.provisioningState] The provisioning state - * of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [publicIPAddress.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {array} [publicIPAddress.zones] A list of availability zones - * denoting the IP allocated for the resource needs to come from. - * @member {array} [applicationSecurityGroups] Application security groups in - * which the IP configuration is included. - * @member {string} [provisioningState] The provisioning state of the network - * interface IP configuration. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. */ export interface NetworkInterfaceIPConfiguration extends SubResource { + /** + * The reference to Virtual Network Taps. + */ virtualNetworkTaps?: VirtualNetworkTap[]; + /** + * The reference of ApplicationGatewayBackendAddressPool resource. + */ applicationGatewayBackendAddressPools?: ApplicationGatewayBackendAddressPool[]; + /** + * The reference of LoadBalancerBackendAddressPool resource. + */ loadBalancerBackendAddressPools?: BackendAddressPool[]; + /** + * A list of references of LoadBalancerInboundNatRules. + */ loadBalancerInboundNatRules?: InboundNatRule[]; + /** + * Private IP address of the IP configuration. + */ privateIPAddress?: string; + /** + * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. + * Possible values include: 'Static', 'Dynamic' + */ privateIPAllocationMethod?: string; + /** + * Available from Api-Version 2016-03-30 onwards, it represents whether the specific + * ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and + * 'IPv6'. Possible values include: 'IPv4', 'IPv6' + */ privateIPAddressVersion?: string; + /** + * Subnet bound to the IP configuration. + */ subnet?: Subnet; + /** + * Gets whether this is a primary customer address on the network interface. + */ primary?: boolean; + /** + * Public IP address bound to the IP configuration. + */ publicIPAddress?: PublicIPAddress; + /** + * Application security groups in which the IP configuration is included. + */ applicationSecurityGroups?: ApplicationSecurityGroup[]; + /** + * The provisioning state of the network interface IP configuration. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayBackendAddress class. - * @constructor * Backend address of an application gateway. - * - * @member {string} [fqdn] Fully qualified domain name (FQDN). - * @member {string} [ipAddress] IP address */ export interface ApplicationGatewayBackendAddress { + /** + * Fully qualified domain name (FQDN). + */ fqdn?: string; + /** + * IP address + */ ipAddress?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayBackendAddressPool class. - * @constructor * Backend Address Pool of an application gateway. - * - * @member {array} [backendIPConfigurations] Collection of references to IPs - * defined in network interfaces. - * @member {array} [backendAddresses] Backend addresses - * @member {string} [provisioningState] Provisioning state of the backend - * address pool resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Name of the backend address pool that is unique - * within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. */ export interface ApplicationGatewayBackendAddressPool extends SubResource { + /** + * Collection of references to IPs defined in network interfaces. + */ backendIPConfigurations?: NetworkInterfaceIPConfiguration[]; + /** + * Backend addresses + */ backendAddresses?: ApplicationGatewayBackendAddress[]; + /** + * Provisioning state of the backend address pool resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Name of the backend address pool that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayConnectionDraining class. - * @constructor - * Connection draining allows open connections to a backend server to be active - * for a specified time after the backend server got removed from the - * configuration. - * - * @member {boolean} enabled Whether connection draining is enabled or not. - * @member {number} drainTimeoutInSec The number of seconds connection draining - * is active. Acceptable values are from 1 second to 3600 seconds. + * Connection draining allows open connections to a backend server to be active for a specified + * time after the backend server got removed from the configuration. */ export interface ApplicationGatewayConnectionDraining { + /** + * Whether connection draining is enabled or not. + */ enabled: boolean; + /** + * The number of seconds connection draining is active. Acceptable values are from 1 second to + * 3600 seconds. + */ drainTimeoutInSec: number; } /** - * @class - * Initializes a new instance of the ApplicationGatewayBackendHttpSettings class. - * @constructor * Backend address pool settings of an application gateway. - * - * @member {number} [port] The destination port on the backend. - * @member {string} [protocol] The protocol used to communicate with the - * backend. Possible values are 'Http' and 'Https'. Possible values include: - * 'Http', 'Https' - * @member {string} [cookieBasedAffinity] Cookie based affinity. Possible - * values include: 'Enabled', 'Disabled' - * @member {number} [requestTimeout] Request timeout in seconds. Application - * Gateway will fail the request if response is not received within - * RequestTimeout. Acceptable values are from 1 second to 86400 seconds. - * @member {object} [probe] Probe resource of an application gateway. - * @member {string} [probe.id] Resource ID. - * @member {array} [authenticationCertificates] Array of references to - * application gateway authentication certificates. - * @member {array} [trustedRootCertificates] Array of references to application - * gateway trusted root certificates. - * @member {object} [connectionDraining] Connection draining of the backend - * http settings resource. - * @member {boolean} [connectionDraining.enabled] Whether connection draining - * is enabled or not. - * @member {number} [connectionDraining.drainTimeoutInSec] The number of - * seconds connection draining is active. Acceptable values are from 1 second - * to 3600 seconds. - * @member {string} [hostName] Host header to be sent to the backend servers. - * @member {boolean} [pickHostNameFromBackendAddress] Whether to pick host - * header should be picked from the host name of the backend server. Default - * value is false. - * @member {string} [affinityCookieName] Cookie name to use for the affinity - * cookie. - * @member {boolean} [probeEnabled] Whether the probe is enabled. Default value - * is false. - * @member {string} [path] Path which should be used as a prefix for all HTTP - * requests. Null means no path will be prefixed. Default value is null. - * @member {string} [provisioningState] Provisioning state of the backend http - * settings resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Name of the backend http settings that is unique - * within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. */ export interface ApplicationGatewayBackendHttpSettings extends SubResource { + /** + * The destination port on the backend. + */ port?: number; + /** + * The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. + * Possible values include: 'Http', 'Https' + */ protocol?: string; + /** + * Cookie based affinity. Possible values include: 'Enabled', 'Disabled' + */ cookieBasedAffinity?: string; + /** + * Request timeout in seconds. Application Gateway will fail the request if response is not + * received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds. + */ requestTimeout?: number; + /** + * Probe resource of an application gateway. + */ probe?: SubResource; + /** + * Array of references to application gateway authentication certificates. + */ authenticationCertificates?: SubResource[]; + /** + * Array of references to application gateway trusted root certificates. + */ trustedRootCertificates?: SubResource[]; + /** + * Connection draining of the backend http settings resource. + */ connectionDraining?: ApplicationGatewayConnectionDraining; + /** + * Host header to be sent to the backend servers. + */ hostName?: string; + /** + * Whether to pick host header should be picked from the host name of the backend server. Default + * value is false. + */ pickHostNameFromBackendAddress?: boolean; + /** + * Cookie name to use for the affinity cookie. + */ affinityCookieName?: string; + /** + * Whether the probe is enabled. Default value is false. + */ probeEnabled?: boolean; + /** + * Path which should be used as a prefix for all HTTP requests. Null means no path will be + * prefixed. Default value is null. + */ path?: string; + /** + * Provisioning state of the backend http settings resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Name of the backend http settings that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayBackendHealthServer class. - * @constructor * Application gateway backendhealth http settings. - * - * @member {string} [address] IP address or FQDN of backend server. - * @member {object} [ipConfiguration] Reference of IP configuration of backend - * server. - * @member {array} [ipConfiguration.virtualNetworkTaps] The reference to - * Virtual Network Taps. - * @member {array} [ipConfiguration.applicationGatewayBackendAddressPools] The - * reference of ApplicationGatewayBackendAddressPool resource. - * @member {array} [ipConfiguration.loadBalancerBackendAddressPools] The - * reference of LoadBalancerBackendAddressPool resource. - * @member {array} [ipConfiguration.loadBalancerInboundNatRules] A list of - * references of LoadBalancerInboundNatRules. - * @member {string} [ipConfiguration.privateIPAddress] Private IP address of - * the IP configuration. - * @member {string} [ipConfiguration.privateIPAllocationMethod] Defines how a - * private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - * Possible values include: 'Static', 'Dynamic' - * @member {string} [ipConfiguration.privateIPAddressVersion] Available from - * Api-Version 2016-03-30 onwards, it represents whether the specific - * ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values - * are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', 'IPv6' - * @member {object} [ipConfiguration.subnet] Subnet bound to the IP - * configuration. - * @member {string} [ipConfiguration.subnet.addressPrefix] The address prefix - * for the subnet. - * @member {array} [ipConfiguration.subnet.addressPrefixes] List of address - * prefixes for the subnet. - * @member {object} [ipConfiguration.subnet.networkSecurityGroup] The reference - * of the NetworkSecurityGroup resource. - * @member {array} [ipConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] The - * default security rules of network security group. - * @member {array} - * [ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] A collection - * of references to network interfaces. - * @member {array} [ipConfiguration.subnet.networkSecurityGroup.subnets] A - * collection of references to subnets. - * @member {string} [ipConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [ipConfiguration.subnet.networkSecurityGroup.provisioningState] The - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.subnet.networkSecurityGroup.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} [ipConfiguration.subnet.routeTable] The reference of the - * RouteTable resource. - * @member {array} [ipConfiguration.subnet.routeTable.routes] Collection of - * routes contained within a route table. - * @member {array} [ipConfiguration.subnet.routeTable.subnets] A collection of - * references to subnets. - * @member {boolean} - * [ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] Gets or sets - * whether to disable the routes learned by BGP on that route table. True means - * disable. - * @member {string} [ipConfiguration.subnet.routeTable.provisioningState] The - * provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.subnet.routeTable.etag] Gets a unique - * read-only string that changes whenever the resource is updated. - * @member {array} [ipConfiguration.subnet.serviceEndpoints] An array of - * service endpoints. - * @member {array} [ipConfiguration.subnet.serviceEndpointPolicies] An array of - * service endpoint policies. - * @member {array} [ipConfiguration.subnet.interfaceEndpoints] An array of - * references to interface endpoints - * @member {array} [ipConfiguration.subnet.ipConfigurations] Gets an array of - * references to the network interface IP configurations using subnet. - * @member {array} [ipConfiguration.subnet.ipConfigurationProfiles] Array of IP - * configuration profiles which reference this subnet. - * @member {array} [ipConfiguration.subnet.resourceNavigationLinks] Gets an - * array of references to the external resources using subnet. - * @member {array} [ipConfiguration.subnet.serviceAssociationLinks] Gets an - * array of references to services injecting into this subnet. - * @member {array} [ipConfiguration.subnet.delegations] Gets an array of - * references to the delegations on the subnet. - * @member {string} [ipConfiguration.subnet.purpose] A read-only string - * identifying the intention of use for this subnet based on delegations and - * other user-defined properties. - * @member {string} [ipConfiguration.subnet.provisioningState] The provisioning - * state of the resource. - * @member {string} [ipConfiguration.subnet.name] The name of the resource that - * is unique within a resource group. This name can be used to access the - * resource. - * @member {string} [ipConfiguration.subnet.etag] A unique read-only string - * that changes whenever the resource is updated. - * @member {boolean} [ipConfiguration.primary] Gets whether this is a primary - * customer address on the network interface. - * @member {object} [ipConfiguration.publicIPAddress] Public IP address bound - * to the IP configuration. - * @member {object} [ipConfiguration.publicIPAddress.sku] The public IP address - * SKU. - * @member {string} [ipConfiguration.publicIPAddress.sku.name] Name of a public - * IP address SKU. Possible values include: 'Basic', 'Standard' - * @member {string} [ipConfiguration.publicIPAddress.publicIPAllocationMethod] - * The public IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} [ipConfiguration.publicIPAddress.publicIPAddressVersion] - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - * Possible values include: 'IPv4', 'IPv6' - * @member {object} [ipConfiguration.publicIPAddress.ipConfiguration] The IP - * configuration associated with the public IP address. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] The - * private IP address of the IP configuration. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] - * The private IP allocation method. Possible values are 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} [ipConfiguration.publicIPAddress.ipConfiguration.subnet] - * The reference of the subnet resource. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] The - * address prefix for the subnet. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * @member {object} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] - * A collection of references to network interfaces. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] - * A collection of references to subnets. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {object} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] The - * reference of the RouteTable resource. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] - * A collection of references to subnets. - * @member {boolean} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] An - * array of service endpoints. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] - * An array of references to interface endpoints - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations using - * subnet. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] - * Array of IP configuration profiles which reference this subnet. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * @member {array} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] Gets an - * array of references to the delegations on the subnet. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] A read-only - * string identifying the intention of use for this subnet based on delegations - * and other user-defined properties. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.name] The name of - * the resource that is unique within a resource group. This name can be used - * to access the resource. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.subnet.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} - * [ipConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] The - * reference of the public IP resource. - * @member {string} - * [ipConfiguration.publicIPAddress.ipConfiguration.provisioningState] Gets the - * provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.publicIPAddress.ipConfiguration.name] The - * name of the resource that is unique within a resource group. This name can - * be used to access the resource. - * @member {string} [ipConfiguration.publicIPAddress.ipConfiguration.etag] A - * unique read-only string that changes whenever the resource is updated. - * @member {object} [ipConfiguration.publicIPAddress.dnsSettings] The FQDN of - * the DNS record associated with the public IP address. - * @member {string} - * [ipConfiguration.publicIPAddress.dnsSettings.domainNameLabel] Gets or sets - * the Domain name label.The concatenation of the domain name label and the - * regionalized DNS zone make up the fully qualified domain name associated - * with the public IP address. If a domain name label is specified, an A DNS - * record is created for the public IP in the Microsoft Azure DNS system. - * @member {string} [ipConfiguration.publicIPAddress.dnsSettings.fqdn] Gets the - * FQDN, Fully qualified domain name of the A DNS record associated with the - * public IP. This is the concatenation of the domainNameLabel and the - * regionalized DNS zone. - * @member {string} [ipConfiguration.publicIPAddress.dnsSettings.reverseFqdn] - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name - * that resolves to this public IP address. If the reverseFqdn is specified, - * then a PTR DNS record is created pointing from the IP address in the - * in-addr.arpa domain to the reverse FQDN. - * @member {array} [ipConfiguration.publicIPAddress.ipTags] The list of tags - * associated with the public IP address. - * @member {string} [ipConfiguration.publicIPAddress.ipAddress] The IP address - * associated with the public IP address resource. - * @member {object} [ipConfiguration.publicIPAddress.publicIPPrefix] The Public - * IP Prefix this Public IP Address should be allocated from. - * @member {string} [ipConfiguration.publicIPAddress.publicIPPrefix.id] - * Resource ID. - * @member {number} [ipConfiguration.publicIPAddress.idleTimeoutInMinutes] The - * idle timeout of the public IP address. - * @member {string} [ipConfiguration.publicIPAddress.resourceGuid] The resource - * GUID property of the public IP resource. - * @member {string} [ipConfiguration.publicIPAddress.provisioningState] The - * provisioning state of the PublicIP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.publicIPAddress.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {array} [ipConfiguration.publicIPAddress.zones] A list of - * availability zones denoting the IP allocated for the resource needs to come - * from. - * @member {array} [ipConfiguration.applicationSecurityGroups] Application - * security groups in which the IP configuration is included. - * @member {string} [ipConfiguration.provisioningState] The provisioning state - * of the network interface IP configuration. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.name] The name of the resource that is - * unique within a resource group. This name can be used to access the - * resource. - * @member {string} [ipConfiguration.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {string} [health] Health of backend server. Possible values include: - * 'Unknown', 'Up', 'Down', 'Partial', 'Draining' */ export interface ApplicationGatewayBackendHealthServer { + /** + * IP address or FQDN of backend server. + */ address?: string; + /** + * Reference of IP configuration of backend server. + */ ipConfiguration?: NetworkInterfaceIPConfiguration; + /** + * Health of backend server. Possible values include: 'Unknown', 'Up', 'Down', 'Partial', + * 'Draining' + */ health?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayBackendHealthHttpSettings class. - * @constructor * Application gateway BackendHealthHttp settings. - * - * @member {object} [backendHttpSettings] Reference of an - * ApplicationGatewayBackendHttpSettings resource. - * @member {number} [backendHttpSettings.port] The destination port on the - * backend. - * @member {string} [backendHttpSettings.protocol] The protocol used to - * communicate with the backend. Possible values are 'Http' and 'Https'. - * Possible values include: 'Http', 'Https' - * @member {string} [backendHttpSettings.cookieBasedAffinity] Cookie based - * affinity. Possible values include: 'Enabled', 'Disabled' - * @member {number} [backendHttpSettings.requestTimeout] Request timeout in - * seconds. Application Gateway will fail the request if response is not - * received within RequestTimeout. Acceptable values are from 1 second to 86400 - * seconds. - * @member {object} [backendHttpSettings.probe] Probe resource of an - * application gateway. - * @member {string} [backendHttpSettings.probe.id] Resource ID. - * @member {array} [backendHttpSettings.authenticationCertificates] Array of - * references to application gateway authentication certificates. - * @member {array} [backendHttpSettings.trustedRootCertificates] Array of - * references to application gateway trusted root certificates. - * @member {object} [backendHttpSettings.connectionDraining] Connection - * draining of the backend http settings resource. - * @member {boolean} [backendHttpSettings.connectionDraining.enabled] Whether - * connection draining is enabled or not. - * @member {number} [backendHttpSettings.connectionDraining.drainTimeoutInSec] - * The number of seconds connection draining is active. Acceptable values are - * from 1 second to 3600 seconds. - * @member {string} [backendHttpSettings.hostName] Host header to be sent to - * the backend servers. - * @member {boolean} [backendHttpSettings.pickHostNameFromBackendAddress] - * Whether to pick host header should be picked from the host name of the - * backend server. Default value is false. - * @member {string} [backendHttpSettings.affinityCookieName] Cookie name to use - * for the affinity cookie. - * @member {boolean} [backendHttpSettings.probeEnabled] Whether the probe is - * enabled. Default value is false. - * @member {string} [backendHttpSettings.path] Path which should be used as a - * prefix for all HTTP requests. Null means no path will be prefixed. Default - * value is null. - * @member {string} [backendHttpSettings.provisioningState] Provisioning state - * of the backend http settings resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [backendHttpSettings.name] Name of the backend http - * settings that is unique within an Application Gateway. - * @member {string} [backendHttpSettings.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {string} [backendHttpSettings.type] Type of the resource. - * @member {array} [servers] List of ApplicationGatewayBackendHealthServer - * resources. */ export interface ApplicationGatewayBackendHealthHttpSettings { + /** + * Reference of an ApplicationGatewayBackendHttpSettings resource. + */ backendHttpSettings?: ApplicationGatewayBackendHttpSettings; + /** + * List of ApplicationGatewayBackendHealthServer resources. + */ servers?: ApplicationGatewayBackendHealthServer[]; } /** - * @class - * Initializes a new instance of the ApplicationGatewayBackendHealthPool class. - * @constructor * Application gateway BackendHealth pool. - * - * @member {object} [backendAddressPool] Reference of an - * ApplicationGatewayBackendAddressPool resource. - * @member {array} [backendAddressPool.backendIPConfigurations] Collection of - * references to IPs defined in network interfaces. - * @member {array} [backendAddressPool.backendAddresses] Backend addresses - * @member {string} [backendAddressPool.provisioningState] Provisioning state - * of the backend address pool resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [backendAddressPool.name] Name of the backend address pool - * that is unique within an Application Gateway. - * @member {string} [backendAddressPool.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {string} [backendAddressPool.type] Type of the resource. - * @member {array} [backendHttpSettingsCollection] List of - * ApplicationGatewayBackendHealthHttpSettings resources. */ export interface ApplicationGatewayBackendHealthPool { + /** + * Reference of an ApplicationGatewayBackendAddressPool resource. + */ backendAddressPool?: ApplicationGatewayBackendAddressPool; + /** + * List of ApplicationGatewayBackendHealthHttpSettings resources. + */ backendHttpSettingsCollection?: ApplicationGatewayBackendHealthHttpSettings[]; } /** - * @class - * Initializes a new instance of the ApplicationGatewayBackendHealth class. - * @constructor * List of ApplicationGatewayBackendHealthPool resources. - * - * @member {array} [backendAddressPools] */ export interface ApplicationGatewayBackendHealth { backendAddressPools?: ApplicationGatewayBackendHealthPool[]; } /** - * @class - * Initializes a new instance of the ApplicationGatewaySku class. - * @constructor * SKU of an application gateway - * - * @member {string} [name] Name of an application gateway SKU. Possible values - * include: 'Standard_Small', 'Standard_Medium', 'Standard_Large', - * 'WAF_Medium', 'WAF_Large', 'Standard_v2', 'WAF_v2' - * @member {string} [tier] Tier of an application gateway. Possible values - * include: 'Standard', 'WAF', 'Standard_v2', 'WAF_v2' - * @member {number} [capacity] Capacity (instance count) of an application - * gateway. - */ +*/ export interface ApplicationGatewaySku { + /** + * Name of an application gateway SKU. Possible values include: 'Standard_Small', + * 'Standard_Medium', 'Standard_Large', 'WAF_Medium', 'WAF_Large', 'Standard_v2', 'WAF_v2' + */ name?: string; + /** + * Tier of an application gateway. Possible values include: 'Standard', 'WAF', 'Standard_v2', + * 'WAF_v2' + */ tier?: string; + /** + * Capacity (instance count) of an application gateway. + */ capacity?: number; } /** - * @class - * Initializes a new instance of the ApplicationGatewaySslPolicy class. - * @constructor * Application Gateway Ssl policy. - * - * @member {array} [disabledSslProtocols] Ssl protocols to be disabled on - * application gateway. - * @member {string} [policyType] Type of Ssl Policy. Possible values include: - * 'Predefined', 'Custom' - * @member {string} [policyName] Name of Ssl predefined policy. Possible values - * include: 'AppGwSslPolicy20150501', 'AppGwSslPolicy20170401', - * 'AppGwSslPolicy20170401S' - * @member {array} [cipherSuites] Ssl cipher suites to be enabled in the - * specified order to application gateway. - * @member {string} [minProtocolVersion] Minimum version of Ssl protocol to be - * supported on application gateway. Possible values include: 'TLSv1_0', - * 'TLSv1_1', 'TLSv1_2' - */ +*/ export interface ApplicationGatewaySslPolicy { + /** + * Ssl protocols to be disabled on application gateway. + */ disabledSslProtocols?: string[]; + /** + * Type of Ssl Policy. Possible values include: 'Predefined', 'Custom' + */ policyType?: string; + /** + * Name of Ssl predefined policy. Possible values include: 'AppGwSslPolicy20150501', + * 'AppGwSslPolicy20170401', 'AppGwSslPolicy20170401S' + */ policyName?: string; + /** + * Ssl cipher suites to be enabled in the specified order to application gateway. + */ cipherSuites?: string[]; + /** + * Minimum version of Ssl protocol to be supported on application gateway. Possible values + * include: 'TLSv1_0', 'TLSv1_1', 'TLSv1_2' + */ minProtocolVersion?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayIPConfiguration class. - * @constructor - * IP configuration of an application gateway. Currently 1 public and 1 private - * IP configuration is allowed. - * - * @member {object} [subnet] Reference of the subnet resource. A subnet from - * where application gateway gets its private address. - * @member {string} [subnet.id] Resource ID. - * @member {string} [provisioningState] Provisioning state of the application - * gateway subnet resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Name of the IP configuration that is unique within - * an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ + * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is + * allowed. +*/ export interface ApplicationGatewayIPConfiguration extends SubResource { + /** + * Reference of the subnet resource. A subnet from where application gateway gets its private + * address. + */ subnet?: SubResource; + /** + * Provisioning state of the application gateway subnet resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Name of the IP configuration that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayAuthenticationCertificate class. - * @constructor * Authentication certificates of an application gateway. - * - * @member {string} [data] Certificate public data. - * @member {string} [provisioningState] Provisioning state of the - * authentication certificate resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [name] Name of the authentication certificate that is - * unique within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ +*/ export interface ApplicationGatewayAuthenticationCertificate extends SubResource { + /** + * Certificate public data. + */ data?: string; + /** + * Provisioning state of the authentication certificate resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Name of the authentication certificate that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayTrustedRootCertificate class. - * @constructor * Trusted Root certificates of an application gateway. - * - * @member {string} [data] Certificate public data. - * @member {string} [keyvaultSecretId] KeyVault Secret Id for certificate. - * @member {string} [provisioningState] Provisioning state of the trusted root - * certificate resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Name of the trusted root certificate that is unique - * within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ +*/ export interface ApplicationGatewayTrustedRootCertificate extends SubResource { + /** + * Certificate public data. + */ data?: string; - keyvaultSecretId?: string; + /** + * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in + * KeyVault. + */ + keyVaultSecretId?: string; + /** + * Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Name of the trusted root certificate that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewaySslCertificate class. - * @constructor * SSL certificates of an application gateway. - * - * @member {string} [data] Base-64 encoded pfx certificate. Only applicable in - * PUT Request. - * @member {string} [password] Password for the pfx file specified in data. - * Only applicable in PUT request. - * @member {string} [publicCertData] Base-64 encoded Public cert data - * corresponding to pfx specified in data. Only applicable in GET request. - * @member {string} [provisioningState] Provisioning state of the SSL - * certificate resource Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Name of the SSL certificate that is unique within an - * Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ +*/ export interface ApplicationGatewaySslCertificate extends SubResource { + /** + * Base-64 encoded pfx certificate. Only applicable in PUT Request. + */ data?: string; + /** + * Password for the pfx file specified in data. Only applicable in PUT request. + */ password?: string; + /** + * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in + * GET request. + */ publicCertData?: string; + /** + * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in + * KeyVault. + */ + keyVaultSecretId?: string; + /** + * Provisioning state of the SSL certificate resource Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Name of the SSL certificate that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayFrontendIPConfiguration class. - * @constructor * Frontend IP configuration of an application gateway. - * - * @member {string} [privateIPAddress] PrivateIPAddress of the network - * interface IP Configuration. - * @member {string} [privateIPAllocationMethod] PrivateIP allocation method. - * Possible values include: 'Static', 'Dynamic' - * @member {object} [subnet] Reference of the subnet resource. - * @member {string} [subnet.id] Resource ID. - * @member {object} [publicIPAddress] Reference of the PublicIP resource. - * @member {string} [publicIPAddress.id] Resource ID. - * @member {string} [provisioningState] Provisioning state of the public IP - * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] Name of the frontend IP configuration that is unique - * within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ +*/ export interface ApplicationGatewayFrontendIPConfiguration extends SubResource { + /** + * PrivateIPAddress of the network interface IP Configuration. + */ privateIPAddress?: string; + /** + * PrivateIP allocation method. Possible values include: 'Static', 'Dynamic' + */ privateIPAllocationMethod?: string; + /** + * Reference of the subnet resource. + */ subnet?: SubResource; + /** + * Reference of the PublicIP resource. + */ publicIPAddress?: SubResource; + /** + * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + */ provisioningState?: string; + /** + * Name of the frontend IP configuration that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayFrontendPort class. - * @constructor * Frontend port of an application gateway. - * - * @member {number} [port] Frontend port - * @member {string} [provisioningState] Provisioning state of the frontend port - * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] Name of the frontend port that is unique within an - * Application Gateway - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ +*/ export interface ApplicationGatewayFrontendPort extends SubResource { + /** + * Frontend port + */ port?: number; + /** + * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + */ provisioningState?: string; + /** + * Name of the frontend port that is unique within an Application Gateway + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayCustomError class. - * @constructor * Customer error of an application gateway. - * - * @member {string} [statusCode] Status code of the application gateway - * customer error. Possible values include: 'HttpStatus403', 'HttpStatus502' - * @member {string} [customErrorPageUrl] Error page URL of the application - * gateway customer error. - */ +*/ export interface ApplicationGatewayCustomError { + /** + * Status code of the application gateway customer error. Possible values include: + * 'HttpStatus403', 'HttpStatus502' + */ statusCode?: string; + /** + * Error page URL of the application gateway customer error. + */ customErrorPageUrl?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayHttpListener class. - * @constructor * Http listener of an application gateway. - * - * @member {object} [frontendIPConfiguration] Frontend IP configuration - * resource of an application gateway. - * @member {string} [frontendIPConfiguration.id] Resource ID. - * @member {object} [frontendPort] Frontend port resource of an application - * gateway. - * @member {string} [frontendPort.id] Resource ID. - * @member {string} [protocol] Protocol of the HTTP listener. Possible values - * are 'Http' and 'Https'. Possible values include: 'Http', 'Https' - * @member {string} [hostName] Host name of HTTP listener. - * @member {object} [sslCertificate] SSL certificate resource of an application - * gateway. - * @member {string} [sslCertificate.id] Resource ID. - * @member {boolean} [requireServerNameIndication] Applicable only if protocol - * is https. Enables SNI for multi-hosting. - * @member {string} [provisioningState] Provisioning state of the HTTP listener - * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {array} [customErrorConfigurations] Custom error configurations of - * the HTTP listener. - * @member {string} [name] Name of the HTTP listener that is unique within an - * Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ +*/ export interface ApplicationGatewayHttpListener extends SubResource { + /** + * Frontend IP configuration resource of an application gateway. + */ frontendIPConfiguration?: SubResource; + /** + * Frontend port resource of an application gateway. + */ frontendPort?: SubResource; + /** + * Protocol of the HTTP listener. Possible values are 'Http' and 'Https'. Possible values + * include: 'Http', 'Https' + */ protocol?: string; + /** + * Host name of HTTP listener. + */ hostName?: string; + /** + * SSL certificate resource of an application gateway. + */ sslCertificate?: SubResource; + /** + * Applicable only if protocol is https. Enables SNI for multi-hosting. + */ requireServerNameIndication?: boolean; + /** + * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + */ provisioningState?: string; + /** + * Custom error configurations of the HTTP listener. + */ customErrorConfigurations?: ApplicationGatewayCustomError[]; + /** + * Name of the HTTP listener that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayPathRule class. - * @constructor * Path rule of URL path map of an application gateway. - * - * @member {array} [paths] Path rules of URL path map. - * @member {object} [backendAddressPool] Backend address pool resource of URL - * path map path rule. - * @member {string} [backendAddressPool.id] Resource ID. - * @member {object} [backendHttpSettings] Backend http settings resource of URL - * path map path rule. - * @member {string} [backendHttpSettings.id] Resource ID. - * @member {object} [redirectConfiguration] Redirect configuration resource of - * URL path map path rule. - * @member {string} [redirectConfiguration.id] Resource ID. - * @member {string} [provisioningState] Path rule of URL path map resource. - * Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] Name of the path rule that is unique within an - * Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ +*/ export interface ApplicationGatewayPathRule extends SubResource { + /** + * Path rules of URL path map. + */ paths?: string[]; + /** + * Backend address pool resource of URL path map path rule. + */ backendAddressPool?: SubResource; + /** + * Backend http settings resource of URL path map path rule. + */ backendHttpSettings?: SubResource; + /** + * Redirect configuration resource of URL path map path rule. + */ redirectConfiguration?: SubResource; + /** + * Rewrite rule set resource of URL path map path rule. + */ + rewriteRuleSet?: SubResource; + /** + * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Name of the path rule that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayProbeHealthResponseMatch class. - * @constructor * Application gateway probe health response match - * - * @member {string} [body] Body that must be contained in the health response. - * Default value is empty. - * @member {array} [statusCodes] Allowed ranges of healthy status codes. - * Default range of healthy status codes is 200-399. - */ +*/ export interface ApplicationGatewayProbeHealthResponseMatch { + /** + * Body that must be contained in the health response. Default value is empty. + */ body?: string; + /** + * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. + */ statusCodes?: string[]; } /** - * @class - * Initializes a new instance of the ApplicationGatewayProbe class. - * @constructor * Probe of the application gateway. - * - * @member {string} [protocol] The protocol used for the probe. Possible values - * are 'Http' and 'Https'. Possible values include: 'Http', 'Https' - * @member {string} [host] Host name to send the probe to. - * @member {string} [path] Relative path of probe. Valid path starts from '/'. - * Probe is sent to ://: - * @member {number} [interval] The probing interval in seconds. This is the - * time interval between two consecutive probes. Acceptable values are from 1 - * second to 86400 seconds. - * @member {number} [timeout] the probe timeout in seconds. Probe marked as - * failed if valid response is not received with this timeout period. - * Acceptable values are from 1 second to 86400 seconds. - * @member {number} [unhealthyThreshold] The probe retry count. Backend server - * is marked down after consecutive probe failure count reaches - * UnhealthyThreshold. Acceptable values are from 1 second to 20. - * @member {boolean} [pickHostNameFromBackendHttpSettings] Whether the host - * header should be picked from the backend http settings. Default value is - * false. - * @member {number} [minServers] Minimum number of servers that are always - * marked healthy. Default value is 0. - * @member {object} [match] Criterion for classifying a healthy probe response. - * @member {string} [match.body] Body that must be contained in the health - * response. Default value is empty. - * @member {array} [match.statusCodes] Allowed ranges of healthy status codes. - * Default range of healthy status codes is 200-399. - * @member {string} [provisioningState] Provisioning state of the backend http - * settings resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Name of the probe that is unique within an - * Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ +*/ export interface ApplicationGatewayProbe extends SubResource { + /** + * The protocol used for the probe. Possible values are 'Http' and 'Https'. Possible values + * include: 'Http', 'Https' + */ protocol?: string; + /** + * Host name to send the probe to. + */ host?: string; + /** + * Relative path of probe. Valid path starts from '/'. Probe is sent to + * ://: + */ path?: string; + /** + * The probing interval in seconds. This is the time interval between two consecutive probes. + * Acceptable values are from 1 second to 86400 seconds. + */ interval?: number; + /** + * the probe timeout in seconds. Probe marked as failed if valid response is not received with + * this timeout period. Acceptable values are from 1 second to 86400 seconds. + */ timeout?: number; + /** + * The probe retry count. Backend server is marked down after consecutive probe failure count + * reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. + */ unhealthyThreshold?: number; + /** + * Whether the host header should be picked from the backend http settings. Default value is + * false. + */ pickHostNameFromBackendHttpSettings?: boolean; + /** + * Minimum number of servers that are always marked healthy. Default value is 0. + */ minServers?: number; + /** + * Criterion for classifying a healthy probe response. + */ match?: ApplicationGatewayProbeHealthResponseMatch; + /** + * Provisioning state of the backend http settings resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Name of the probe that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayRequestRoutingRule class. - * @constructor * Request routing rule of an application gateway. - * - * @member {string} [ruleType] Rule type. Possible values include: 'Basic', - * 'PathBasedRouting' - * @member {object} [backendAddressPool] Backend address pool resource of the - * application gateway. - * @member {string} [backendAddressPool.id] Resource ID. - * @member {object} [backendHttpSettings] Backend http settings resource of the - * application gateway. - * @member {string} [backendHttpSettings.id] Resource ID. - * @member {object} [httpListener] Http listener resource of the application - * gateway. - * @member {string} [httpListener.id] Resource ID. - * @member {object} [urlPathMap] URL path map resource of the application - * gateway. - * @member {string} [urlPathMap.id] Resource ID. - * @member {object} [redirectConfiguration] Redirect configuration resource of - * the application gateway. - * @member {string} [redirectConfiguration.id] Resource ID. - * @member {string} [provisioningState] Provisioning state of the request - * routing rule resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Name of the request routing rule that is unique - * within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ +*/ export interface ApplicationGatewayRequestRoutingRule extends SubResource { + /** + * Rule type. Possible values include: 'Basic', 'PathBasedRouting' + */ ruleType?: string; + /** + * Backend address pool resource of the application gateway. + */ backendAddressPool?: SubResource; + /** + * Backend http settings resource of the application gateway. + */ backendHttpSettings?: SubResource; + /** + * Http listener resource of the application gateway. + */ httpListener?: SubResource; + /** + * URL path map resource of the application gateway. + */ urlPathMap?: SubResource; + /** + * Rewrite Rule Set resource in Basic rule of the application gateway. + */ + rewriteRuleSet?: SubResource; + /** + * Redirect configuration resource of the application gateway. + */ redirectConfiguration?: SubResource; + /** + * Provisioning state of the request routing rule resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Name of the request routing rule that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayRedirectConfiguration class. - * @constructor + * Header configuration of the Actions set in Application Gateway. +*/ +export interface ApplicationGatewayHeaderConfiguration { + /** + * Header name of the header configuration + */ + headerName?: string; + /** + * Header value of the header configuration + */ + headerValue?: string; +} + +/** + * Set of actions in the Rewrite Rule in Application Gateway. +*/ +export interface ApplicationGatewayRewriteRuleActionSet { + /** + * Request Header Actions in the Action Set + */ + requestHeaderConfigurations?: ApplicationGatewayHeaderConfiguration[]; + /** + * Response Header Actions in the Action Set + */ + responseHeaderConfigurations?: ApplicationGatewayHeaderConfiguration[]; +} + +/** + * Rewrite rule of an application gateway. +*/ +export interface ApplicationGatewayRewriteRule { + /** + * Name of the rewrite rule that is unique within an Application Gateway. + */ + name?: string; + /** + * Set of actions to be done as part of the rewrite Rule. + */ + actionSet?: ApplicationGatewayRewriteRuleActionSet; +} + +/** + * Rewrite rule set of an application gateway. +*/ +export interface ApplicationGatewayRewriteRuleSet extends SubResource { + /** + * Rewrite rules in the rewrite rule set. + */ + rewriteRules?: ApplicationGatewayRewriteRule[]; + /** + * Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ + readonly provisioningState?: string; + /** + * Name of the rewrite rule set that is unique within an Application Gateway. + */ + name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ + readonly etag?: string; +} + +/** * Redirect configuration of an application gateway. - * - * @member {string} [redirectType] Supported http redirection types - - * Permanent, Temporary, Found, SeeOther. Possible values include: 'Permanent', - * 'Found', 'SeeOther', 'Temporary' - * @member {object} [targetListener] Reference to a listener to redirect the - * request to. - * @member {string} [targetListener.id] Resource ID. - * @member {string} [targetUrl] Url to redirect the request to. - * @member {boolean} [includePath] Include path in the redirected url. - * @member {boolean} [includeQueryString] Include query string in the - * redirected url. - * @member {array} [requestRoutingRules] Request routing specifying redirect - * configuration. - * @member {array} [urlPathMaps] Url path maps specifying default redirect - * configuration. - * @member {array} [pathRules] Path rules specifying redirect configuration. - * @member {string} [name] Name of the redirect configuration that is unique - * within an Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ +*/ export interface ApplicationGatewayRedirectConfiguration extends SubResource { + /** + * Supported http redirection types - Permanent, Temporary, Found, SeeOther. Possible values + * include: 'Permanent', 'Found', 'SeeOther', 'Temporary' + */ redirectType?: string; + /** + * Reference to a listener to redirect the request to. + */ targetListener?: SubResource; + /** + * Url to redirect the request to. + */ targetUrl?: string; + /** + * Include path in the redirected url. + */ includePath?: boolean; + /** + * Include query string in the redirected url. + */ includeQueryString?: boolean; + /** + * Request routing specifying redirect configuration. + */ requestRoutingRules?: SubResource[]; + /** + * Url path maps specifying default redirect configuration. + */ urlPathMaps?: SubResource[]; + /** + * Path rules specifying redirect configuration. + */ pathRules?: SubResource[]; + /** + * Name of the redirect configuration that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayUrlPathMap class. - * @constructor - * UrlPathMaps give a url path to the backend mapping information for - * PathBasedRouting. - * - * @member {object} [defaultBackendAddressPool] Default backend address pool - * resource of URL path map. - * @member {string} [defaultBackendAddressPool.id] Resource ID. - * @member {object} [defaultBackendHttpSettings] Default backend http settings - * resource of URL path map. - * @member {string} [defaultBackendHttpSettings.id] Resource ID. - * @member {object} [defaultRedirectConfiguration] Default redirect - * configuration resource of URL path map. - * @member {string} [defaultRedirectConfiguration.id] Resource ID. - * @member {array} [pathRules] Path rule of URL path map resource. - * @member {string} [provisioningState] Provisioning state of the backend http - * settings resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Name of the URL path map that is unique within an - * Application Gateway. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Type of the resource. - */ + * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting. +*/ export interface ApplicationGatewayUrlPathMap extends SubResource { + /** + * Default backend address pool resource of URL path map. + */ defaultBackendAddressPool?: SubResource; + /** + * Default backend http settings resource of URL path map. + */ defaultBackendHttpSettings?: SubResource; + /** + * Default Rewrite rule set resource of URL path map. + */ + defaultRewriteRuleSet?: SubResource; + /** + * Default redirect configuration resource of URL path map. + */ defaultRedirectConfiguration?: SubResource; + /** + * Path rule of URL path map resource. + */ pathRules?: ApplicationGatewayPathRule[]; + /** + * Provisioning state of the backend http settings resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Name of the URL path map that is unique within an Application Gateway. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * Type of the resource. + */ type?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayFirewallDisabledRuleGroup class. - * @constructor * Allows to disable rules within a rule group or an entire rule group. - * - * @member {string} ruleGroupName The name of the rule group that will be - * disabled. - * @member {array} [rules] The list of rules that will be disabled. If null, - * all rules of the rule group will be disabled. - */ +*/ export interface ApplicationGatewayFirewallDisabledRuleGroup { + /** + * The name of the rule group that will be disabled. + */ ruleGroupName: string; + /** + * The list of rules that will be disabled. If null, all rules of the rule group will be + * disabled. + */ rules?: number[]; } /** - * @class - * Initializes a new instance of the ApplicationGatewayFirewallExclusion class. - * @constructor * Allow to exclude some variable satisfy the condition for the WAF check - * - * @member {string} matchVariable The variable to be excluded. - * @member {string} selectorMatchOperator When matchVariable is a collection, - * operate on the selector to specify which elements in the collection this - * exclusion applies to. - * @member {string} selector When matchVariable is a collection, operator used - * to specify which elements in the collection this exclusion applies to. - */ +*/ export interface ApplicationGatewayFirewallExclusion { + /** + * The variable to be excluded. + */ matchVariable: string; + /** + * When matchVariable is a collection, operate on the selector to specify which elements in the + * collection this exclusion applies to. + */ selectorMatchOperator: string; + /** + * When matchVariable is a collection, operator used to specify which elements in the collection + * this exclusion applies to. + */ selector: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayWebApplicationFirewallConfiguration class. - * @constructor * Application gateway web application firewall configuration. - * - * @member {boolean} enabled Whether the web application firewall is enabled or - * not. - * @member {string} firewallMode Web application firewall mode. Possible values - * include: 'Detection', 'Prevention' - * @member {string} ruleSetType The type of the web application firewall rule - * set. Possible values are: 'OWASP'. - * @member {string} ruleSetVersion The version of the rule set type. - * @member {array} [disabledRuleGroups] The disabled rule groups. - * @member {boolean} [requestBodyCheck] Whether allow WAF to check request - * Body. - * @member {number} [maxRequestBodySize] Maxium request body size for WAF. - * @member {number} [maxRequestBodySizeInKb] Maxium request body size in Kb for - * WAF. - * @member {number} [fileUploadLimitInMb] Maxium file upload size in Mb for - * WAF. - * @member {array} [exclusions] The exclusion list. - */ +*/ export interface ApplicationGatewayWebApplicationFirewallConfiguration { + /** + * Whether the web application firewall is enabled or not. + */ enabled: boolean; + /** + * Web application firewall mode. Possible values include: 'Detection', 'Prevention' + */ firewallMode: string; + /** + * The type of the web application firewall rule set. Possible values are: 'OWASP'. + */ ruleSetType: string; + /** + * The version of the rule set type. + */ ruleSetVersion: string; + /** + * The disabled rule groups. + */ disabledRuleGroups?: ApplicationGatewayFirewallDisabledRuleGroup[]; + /** + * Whether allow WAF to check request Body. + */ requestBodyCheck?: boolean; + /** + * Maxium request body size for WAF. + */ maxRequestBodySize?: number; + /** + * Maxium request body size in Kb for WAF. + */ maxRequestBodySizeInKb?: number; + /** + * Maxium file upload size in Mb for WAF. + */ fileUploadLimitInMb?: number; + /** + * The exclusion list. + */ exclusions?: ApplicationGatewayFirewallExclusion[]; } /** - * @class - * Initializes a new instance of the ApplicationGatewayAutoscaleConfiguration class. - * @constructor * Application Gateway autoscale configuration. - * - * @member {number} minCapacity Lower bound on number of Application Gateway - * instances - */ +*/ export interface ApplicationGatewayAutoscaleConfiguration { + /** + * Lower bound on number of Application Gateway instances + */ minCapacity: number; } +export interface ManagedServiceIdentityUserAssignedIdentitiesValue { + /** + * The principal id of user assigned identity. + */ + readonly principalId?: string; + /** + * The client id of user assigned identity. + */ + readonly clientId?: string; +} + +/** + * Identity for the resource. +*/ +export interface ManagedServiceIdentity { + /** + * The principal id of the system assigned identity. This property will only be provided for a + * system assigned identity. + */ + readonly principalId?: string; + /** + * The tenant id of the system assigned identity. This property will only be provided for a + * system assigned identity. + */ + readonly tenantId?: string; + /** + * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes + * both an implicitly created identity and a set of user assigned identities. The type 'None' + * will remove any identities from the virtual machine. Possible values include: + * 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + */ + type?: string; + /** + * The list of user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + */ + userAssignedIdentities?: { [propertyName: string]: + ManagedServiceIdentityUserAssignedIdentitiesValue }; +} + /** - * @class - * Initializes a new instance of the ApplicationGateway class. - * @constructor * Application gateway resource - * - * @member {object} [sku] SKU of the application gateway resource. - * @member {string} [sku.name] Name of an application gateway SKU. Possible - * values include: 'Standard_Small', 'Standard_Medium', 'Standard_Large', - * 'WAF_Medium', 'WAF_Large', 'Standard_v2', 'WAF_v2' - * @member {string} [sku.tier] Tier of an application gateway. Possible values - * include: 'Standard', 'WAF', 'Standard_v2', 'WAF_v2' - * @member {number} [sku.capacity] Capacity (instance count) of an application - * gateway. - * @member {object} [sslPolicy] SSL policy of the application gateway resource. - * @member {array} [sslPolicy.disabledSslProtocols] Ssl protocols to be - * disabled on application gateway. - * @member {string} [sslPolicy.policyType] Type of Ssl Policy. Possible values - * include: 'Predefined', 'Custom' - * @member {string} [sslPolicy.policyName] Name of Ssl predefined policy. - * Possible values include: 'AppGwSslPolicy20150501', 'AppGwSslPolicy20170401', - * 'AppGwSslPolicy20170401S' - * @member {array} [sslPolicy.cipherSuites] Ssl cipher suites to be enabled in - * the specified order to application gateway. - * @member {string} [sslPolicy.minProtocolVersion] Minimum version of Ssl - * protocol to be supported on application gateway. Possible values include: - * 'TLSv1_0', 'TLSv1_1', 'TLSv1_2' - * @member {string} [operationalState] Operational state of the application - * gateway resource. Possible values include: 'Stopped', 'Starting', 'Running', - * 'Stopping' - * @member {array} [gatewayIPConfigurations] Subnets of application the gateway - * resource. - * @member {array} [authenticationCertificates] Authentication certificates of - * the application gateway resource. - * @member {array} [trustedRootCertificates] Trusted Root certificates of the - * application gateway resource. - * @member {array} [sslCertificates] SSL certificates of the application - * gateway resource. - * @member {array} [frontendIPConfigurations] Frontend IP addresses of the - * application gateway resource. - * @member {array} [frontendPorts] Frontend ports of the application gateway - * resource. - * @member {array} [probes] Probes of the application gateway resource. - * @member {array} [backendAddressPools] Backend address pool of the - * application gateway resource. - * @member {array} [backendHttpSettingsCollection] Backend http settings of the - * application gateway resource. - * @member {array} [httpListeners] Http listeners of the application gateway - * resource. - * @member {array} [urlPathMaps] URL path map of the application gateway - * resource. - * @member {array} [requestRoutingRules] Request routing rules of the - * application gateway resource. - * @member {array} [redirectConfigurations] Redirect configurations of the - * application gateway resource. - * @member {object} [webApplicationFirewallConfiguration] Web application - * firewall configuration. - * @member {boolean} [webApplicationFirewallConfiguration.enabled] Whether the - * web application firewall is enabled or not. - * @member {string} [webApplicationFirewallConfiguration.firewallMode] Web - * application firewall mode. Possible values include: 'Detection', - * 'Prevention' - * @member {string} [webApplicationFirewallConfiguration.ruleSetType] The type - * of the web application firewall rule set. Possible values are: 'OWASP'. - * @member {string} [webApplicationFirewallConfiguration.ruleSetVersion] The - * version of the rule set type. - * @member {array} [webApplicationFirewallConfiguration.disabledRuleGroups] The - * disabled rule groups. - * @member {boolean} [webApplicationFirewallConfiguration.requestBodyCheck] - * Whether allow WAF to check request Body. - * @member {number} [webApplicationFirewallConfiguration.maxRequestBodySize] - * Maxium request body size for WAF. - * @member {number} - * [webApplicationFirewallConfiguration.maxRequestBodySizeInKb] Maxium request - * body size in Kb for WAF. - * @member {number} [webApplicationFirewallConfiguration.fileUploadLimitInMb] - * Maxium file upload size in Mb for WAF. - * @member {array} [webApplicationFirewallConfiguration.exclusions] The - * exclusion list. - * @member {boolean} [enableHttp2] Whether HTTP2 is enabled on the application - * gateway resource. - * @member {boolean} [enableFips] Whether FIPS is enabled on the application - * gateway resource. - * @member {object} [autoscaleConfiguration] Autoscale Configuration. - * @member {number} [autoscaleConfiguration.minCapacity] Lower bound on number - * of Application Gateway instances - * @member {string} [resourceGuid] Resource GUID property of the application - * gateway resource. - * @member {string} [provisioningState] Provisioning state of the application - * gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {array} [customErrorConfigurations] Custom error configurations of - * the application gateway resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {array} [zones] A list of availability zones denoting where the - * resource needs to come from. - */ +*/ export interface ApplicationGateway extends Resource { + /** + * SKU of the application gateway resource. + */ sku?: ApplicationGatewaySku; + /** + * SSL policy of the application gateway resource. + */ sslPolicy?: ApplicationGatewaySslPolicy; + /** + * Operational state of the application gateway resource. Possible values include: 'Stopped', + * 'Starting', 'Running', 'Stopping' + */ readonly operationalState?: string; + /** + * Subnets of application the gateway resource. + */ gatewayIPConfigurations?: ApplicationGatewayIPConfiguration[]; + /** + * Authentication certificates of the application gateway resource. + */ authenticationCertificates?: ApplicationGatewayAuthenticationCertificate[]; + /** + * Trusted Root certificates of the application gateway resource. + */ trustedRootCertificates?: ApplicationGatewayTrustedRootCertificate[]; + /** + * SSL certificates of the application gateway resource. + */ sslCertificates?: ApplicationGatewaySslCertificate[]; + /** + * Frontend IP addresses of the application gateway resource. + */ frontendIPConfigurations?: ApplicationGatewayFrontendIPConfiguration[]; + /** + * Frontend ports of the application gateway resource. + */ frontendPorts?: ApplicationGatewayFrontendPort[]; + /** + * Probes of the application gateway resource. + */ probes?: ApplicationGatewayProbe[]; + /** + * Backend address pool of the application gateway resource. + */ backendAddressPools?: ApplicationGatewayBackendAddressPool[]; + /** + * Backend http settings of the application gateway resource. + */ backendHttpSettingsCollection?: ApplicationGatewayBackendHttpSettings[]; + /** + * Http listeners of the application gateway resource. + */ httpListeners?: ApplicationGatewayHttpListener[]; + /** + * URL path map of the application gateway resource. + */ urlPathMaps?: ApplicationGatewayUrlPathMap[]; + /** + * Request routing rules of the application gateway resource. + */ requestRoutingRules?: ApplicationGatewayRequestRoutingRule[]; + /** + * Rewrite rules for the application gateway resource. + */ + rewriteRuleSets?: ApplicationGatewayRewriteRuleSet[]; + /** + * Redirect configurations of the application gateway resource. + */ redirectConfigurations?: ApplicationGatewayRedirectConfiguration[]; + /** + * Web application firewall configuration. + */ webApplicationFirewallConfiguration?: ApplicationGatewayWebApplicationFirewallConfiguration; + /** + * Whether HTTP2 is enabled on the application gateway resource. + */ enableHttp2?: boolean; + /** + * Whether FIPS is enabled on the application gateway resource. + */ enableFips?: boolean; + /** + * Autoscale Configuration. + */ autoscaleConfiguration?: ApplicationGatewayAutoscaleConfiguration; + /** + * Resource GUID property of the application gateway resource. + */ resourceGuid?: string; + /** + * Provisioning state of the application gateway resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Custom error configurations of the application gateway resource. + */ customErrorConfigurations?: ApplicationGatewayCustomError[]; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * A list of availability zones denoting where the resource needs to come from. + */ zones?: string[]; + /** + * The identity of the application gateway, if configured. + */ + identity?: ManagedServiceIdentity; } /** - * @class - * Initializes a new instance of the ApplicationGatewayFirewallRule class. - * @constructor * A web application firewall rule. - * - * @member {number} ruleId The identifier of the web application firewall rule. - * @member {string} [description] The description of the web application - * firewall rule. - */ +*/ export interface ApplicationGatewayFirewallRule { + /** + * The identifier of the web application firewall rule. + */ ruleId: number; + /** + * The description of the web application firewall rule. + */ description?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayFirewallRuleGroup class. - * @constructor * A web application firewall rule group. - * - * @member {string} ruleGroupName The name of the web application firewall rule - * group. - * @member {string} [description] The description of the web application - * firewall rule group. - * @member {array} rules The rules of the web application firewall rule group. - */ +*/ export interface ApplicationGatewayFirewallRuleGroup { + /** + * The name of the web application firewall rule group. + */ ruleGroupName: string; + /** + * The description of the web application firewall rule group. + */ description?: string; + /** + * The rules of the web application firewall rule group. + */ rules: ApplicationGatewayFirewallRule[]; } /** - * @class - * Initializes a new instance of the ApplicationGatewayFirewallRuleSet class. - * @constructor * A web application firewall rule set. - * - * @member {string} [provisioningState] The provisioning state of the web - * application firewall rule set. - * @member {string} ruleSetType The type of the web application firewall rule - * set. - * @member {string} ruleSetVersion The version of the web application firewall - * rule set type. - * @member {array} ruleGroups The rule groups of the web application firewall - * rule set. - */ +*/ export interface ApplicationGatewayFirewallRuleSet extends Resource { + /** + * The provisioning state of the web application firewall rule set. + */ provisioningState?: string; + /** + * The type of the web application firewall rule set. + */ ruleSetType: string; + /** + * The version of the web application firewall rule set type. + */ ruleSetVersion: string; + /** + * The rule groups of the web application firewall rule set. + */ ruleGroups: ApplicationGatewayFirewallRuleGroup[]; } /** - * @class - * Initializes a new instance of the ApplicationGatewayAvailableWafRuleSetsResult class. - * @constructor * Response for ApplicationGatewayAvailableWafRuleSets API service call. - * - * @member {array} [value] The list of application gateway rule sets. - */ +*/ export interface ApplicationGatewayAvailableWafRuleSetsResult { + /** + * The list of application gateway rule sets. + */ value?: ApplicationGatewayFirewallRuleSet[]; } /** - * @class - * Initializes a new instance of the ApplicationGatewayAvailableSslOptions class. - * @constructor * Response for ApplicationGatewayAvailableSslOptions API service call. - * - * @member {array} [predefinedPolicies] List of available Ssl predefined - * policy. - * @member {string} [defaultPolicy] Name of the Ssl predefined policy applied - * by default to application gateway. Possible values include: - * 'AppGwSslPolicy20150501', 'AppGwSslPolicy20170401', - * 'AppGwSslPolicy20170401S' - * @member {array} [availableCipherSuites] List of available Ssl cipher suites. - * @member {array} [availableProtocols] List of available Ssl protocols. - */ +*/ export interface ApplicationGatewayAvailableSslOptions extends Resource { + /** + * List of available Ssl predefined policy. + */ predefinedPolicies?: SubResource[]; + /** + * Name of the Ssl predefined policy applied by default to application gateway. Possible values + * include: 'AppGwSslPolicy20150501', 'AppGwSslPolicy20170401', 'AppGwSslPolicy20170401S' + */ defaultPolicy?: string; + /** + * List of available Ssl cipher suites. + */ availableCipherSuites?: string[]; + /** + * List of available Ssl protocols. + */ availableProtocols?: string[]; } /** - * @class - * Initializes a new instance of the ApplicationGatewaySslPredefinedPolicy class. - * @constructor * An Ssl predefined policy - * - * @member {string} [name] Name of the Ssl predefined policy. - * @member {array} [cipherSuites] Ssl cipher suites to be enabled in the - * specified order for application gateway. - * @member {string} [minProtocolVersion] Minimum version of Ssl protocol to be - * supported on application gateway. Possible values include: 'TLSv1_0', - * 'TLSv1_1', 'TLSv1_2' - */ +*/ export interface ApplicationGatewaySslPredefinedPolicy extends SubResource { + /** + * Name of the Ssl predefined policy. + */ name?: string; + /** + * Ssl cipher suites to be enabled in the specified order for application gateway. + */ cipherSuites?: string[]; + /** + * Minimum version of Ssl protocol to be supported on application gateway. Possible values + * include: 'TLSv1_0', 'TLSv1_1', 'TLSv1_2' + */ minProtocolVersion?: string; } /** - * @class - * Initializes a new instance of the TagsObject class. - * @constructor * Tags object for patch operations. - * - * @member {object} [tags] Resource tags. - */ +*/ export interface TagsObject { + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the AvailableDelegation class. - * @constructor - * The serviceName of an AvailableDelegation indicates a possible delegation - * for a subnet. - * - * @member {string} [name] The name of the AvailableDelegation resource. - * @member {string} [id] A unique identifier of the AvailableDelegation - * resource. - * @member {string} [type] Resource type. - * @member {string} [serviceName] The name of the service and resource - * @member {array} [actions] Describes the actions permitted to the service - * upon delegation - */ + * The serviceName of an AvailableDelegation indicates a possible delegation for a subnet. +*/ export interface AvailableDelegation { + /** + * The name of the AvailableDelegation resource. + */ name?: string; + /** + * A unique identifier of the AvailableDelegation resource. + */ id?: string; + /** + * Resource type. + */ type?: string; + /** + * The name of the service and resource + */ serviceName?: string; + /** + * Describes the actions permitted to the service upon delegation + */ actions?: string[]; } /** - * @class - * Initializes a new instance of the AzureFirewallIPConfiguration class. - * @constructor * IP configuration of an Azure Firewall. - * - * @member {string} [privateIPAddress] The Firewall Internal Load Balancer IP - * to be used as the next hop in User Defined Routes. - * @member {object} [subnet] Reference of the subnet resource. This resource - * must be named 'AzureFirewallSubnet'. - * @member {string} [subnet.id] Resource ID. - * @member {object} [publicIPAddress] Reference of the PublicIP resource. This - * field is a mandatory input if subnet is not null. - * @member {string} [publicIPAddress.id] Resource ID. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {string} [name] Name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface AzureFirewallIPConfiguration extends SubResource { - privateIPAddress?: string; + /** + * The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. + */ + readonly privateIPAddress?: string; + /** + * Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'. + */ subnet?: SubResource; + /** + * Reference of the PublicIP resource. This field is a mandatory input if subnet is not null. + */ publicIPAddress?: SubResource; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * Name of the resource that is unique within a resource group. This name can be used to access + * the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the AzureFirewallRCAction class. - * @constructor * Properties of the AzureFirewallRCAction. - * - * @member {string} [type] The type of action. Possible values include: - * 'Allow', 'Deny' - */ +*/ export interface AzureFirewallRCAction { + /** + * The type of action. Possible values include: 'Allow', 'Deny' + */ type?: string; } /** - * @class - * Initializes a new instance of the AzureFirewallApplicationRuleProtocol class. - * @constructor * Properties of the application rule protocol. - * - * @member {string} [protocolType] Protocol type. Possible values include: - * 'Http', 'Https' - * @member {number} [port] Port number for the protocol, cannot be greater than - * 64000. This field is optional. - */ +*/ export interface AzureFirewallApplicationRuleProtocol { + /** + * Protocol type. Possible values include: 'Http', 'Https' + */ protocolType?: string; + /** + * Port number for the protocol, cannot be greater than 64000. This field is optional. + */ port?: number; } /** - * @class - * Initializes a new instance of the AzureFirewallApplicationRule class. - * @constructor * Properties of an application rule. - * - * @member {string} [name] Name of the application rule. - * @member {string} [description] Description of the rule. - * @member {array} [sourceAddresses] List of source IP addresses for this rule. - * @member {array} [protocols] Array of ApplicationRuleProtocols. - * @member {array} [targetFqdns] List of FQDNs for this rule. - * @member {array} [fqdnTags] List of FQDN Tags for this rule. - */ +*/ export interface AzureFirewallApplicationRule { + /** + * Name of the application rule. + */ name?: string; + /** + * Description of the rule. + */ description?: string; + /** + * List of source IP addresses for this rule. + */ sourceAddresses?: string[]; + /** + * Array of ApplicationRuleProtocols. + */ protocols?: AzureFirewallApplicationRuleProtocol[]; + /** + * List of FQDNs for this rule. + */ targetFqdns?: string[]; + /** + * List of FQDN Tags for this rule. + */ fqdnTags?: string[]; } /** - * @class - * Initializes a new instance of the AzureFirewallApplicationRuleCollection class. - * @constructor * Application rule collection resource - * - * @member {number} [priority] Priority of the application rule collection - * resource. - * @member {object} [action] The action type of a rule collection - * @member {string} [action.type] The type of action. Possible values include: - * 'Allow', 'Deny' - * @member {array} [rules] Collection of rules used by a application rule - * collection. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface AzureFirewallApplicationRuleCollection extends SubResource { + /** + * Priority of the application rule collection resource. + */ priority?: number; + /** + * The action type of a rule collection + */ action?: AzureFirewallRCAction; + /** + * Collection of rules used by a application rule collection. + */ rules?: AzureFirewallApplicationRule[]; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * Gets name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the AzureFirewallNatRCAction class. - * @constructor * AzureFirewall NAT Rule Collection Action. - * - * @member {string} [type] The type of action. Possible values include: 'Snat', - * 'Dnat' - */ +*/ export interface AzureFirewallNatRCAction { + /** + * The type of action. Possible values include: 'Snat', 'Dnat' + */ type?: string; } /** - * @class - * Initializes a new instance of the AzureFirewallNatRule class. - * @constructor * Properties of a NAT rule. - * - * @member {string} [name] Name of the NAT rule. - * @member {string} [description] Description of the rule. - * @member {array} [sourceAddresses] List of source IP addresses for this rule. - * @member {array} [destinationAddresses] List of destination IP addresses for - * this rule. - * @member {array} [destinationPorts] List of destination ports. - * @member {array} [protocols] Array of AzureFirewallNetworkRuleProtocols - * applicable to this NAT rule. - * @member {string} [translatedAddress] The translated address for this NAT - * rule. - * @member {string} [translatedPort] The translated port for this NAT rule. - */ +*/ export interface AzureFirewallNatRule { + /** + * Name of the NAT rule. + */ name?: string; + /** + * Description of the rule. + */ description?: string; + /** + * List of source IP addresses for this rule. + */ sourceAddresses?: string[]; + /** + * List of destination IP addresses for this rule. + */ destinationAddresses?: string[]; + /** + * List of destination ports. + */ destinationPorts?: string[]; + /** + * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. + */ protocols?: string[]; + /** + * The translated address for this NAT rule. + */ translatedAddress?: string; + /** + * The translated port for this NAT rule. + */ translatedPort?: string; } /** - * @class - * Initializes a new instance of the AzureFirewallNatRuleCollection class. - * @constructor * NAT rule collection resource - * - * @member {number} [priority] Priority of the NAT rule collection resource. - * @member {object} [action] The action type of a NAT rule collection - * @member {string} [action.type] The type of action. Possible values include: - * 'Snat', 'Dnat' - * @member {array} [rules] Collection of rules used by a NAT rule collection. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface AzureFirewallNatRuleCollection extends SubResource { + /** + * Priority of the NAT rule collection resource. + */ priority?: number; + /** + * The action type of a NAT rule collection + */ action?: AzureFirewallNatRCAction; + /** + * Collection of rules used by a NAT rule collection. + */ rules?: AzureFirewallNatRule[]; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * Gets name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the AzureFirewallNetworkRule class. - * @constructor * Properties of the network rule. - * - * @member {string} [name] Name of the network rule. - * @member {string} [description] Description of the rule. - * @member {array} [protocols] Array of AzureFirewallNetworkRuleProtocols. - * @member {array} [sourceAddresses] List of source IP addresses for this rule. - * @member {array} [destinationAddresses] List of destination IP addresses. - * @member {array} [destinationPorts] List of destination ports. - */ +*/ export interface AzureFirewallNetworkRule { + /** + * Name of the network rule. + */ name?: string; + /** + * Description of the rule. + */ description?: string; + /** + * Array of AzureFirewallNetworkRuleProtocols. + */ protocols?: string[]; + /** + * List of source IP addresses for this rule. + */ sourceAddresses?: string[]; + /** + * List of destination IP addresses. + */ destinationAddresses?: string[]; + /** + * List of destination ports. + */ destinationPorts?: string[]; } /** - * @class - * Initializes a new instance of the AzureFirewallNetworkRuleCollection class. - * @constructor * Network rule collection resource - * - * @member {number} [priority] Priority of the network rule collection - * resource. - * @member {object} [action] The action type of a rule collection - * @member {string} [action.type] The type of action. Possible values include: - * 'Allow', 'Deny' - * @member {array} [rules] Collection of rules used by a network rule - * collection. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface AzureFirewallNetworkRuleCollection extends SubResource { + /** + * Priority of the network rule collection resource. + */ priority?: number; + /** + * The action type of a rule collection + */ action?: AzureFirewallRCAction; + /** + * Collection of rules used by a network rule collection. + */ rules?: AzureFirewallNetworkRule[]; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * Gets name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the AzureFirewall class. - * @constructor * Azure Firewall resource - * - * @member {array} [applicationRuleCollections] Collection of application rule - * collections used by Azure Firewall. - * @member {array} [natRuleCollections] Collection of NAT rule collections used - * by Azure Firewall. - * @member {array} [networkRuleCollections] Collection of network rule - * collections used by Azure Firewall. - * @member {array} [ipConfigurations] IP configuration of the Azure Firewall - * resource. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface AzureFirewall extends Resource { + /** + * Collection of application rule collections used by Azure Firewall. + */ applicationRuleCollections?: AzureFirewallApplicationRuleCollection[]; + /** + * Collection of NAT rule collections used by Azure Firewall. + */ natRuleCollections?: AzureFirewallNatRuleCollection[]; + /** + * Collection of network rule collections used by Azure Firewall. + */ networkRuleCollections?: AzureFirewallNetworkRuleCollection[]; + /** + * IP configuration of the Azure Firewall resource. + */ ipConfigurations?: AzureFirewallIPConfiguration[]; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the AzureFirewallFqdnTag class. - * @constructor * Azure Firewall FQDN Tag Resource - * - * @member {string} [provisioningState] The provisioning state of the resource. - * @member {string} [fqdnTagName] The name of this FQDN Tag. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface AzureFirewallFqdnTag extends Resource { + /** + * The provisioning state of the resource. + */ readonly provisioningState?: string; + /** + * The name of this FQDN Tag. + */ readonly fqdnTagName?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the DnsNameAvailabilityResult class. - * @constructor * Response for the CheckDnsNameAvailability API service call. - * - * @member {boolean} [available] Domain availability (True/False). - */ +*/ export interface DnsNameAvailabilityResult { + /** + * Domain availability (True/False). + */ available?: boolean; } /** - * @class - * Initializes a new instance of the DdosProtectionPlan class. - * @constructor * A DDoS protection plan in a resource group. - * - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. - * @member {string} [location] Resource location. - * @member {object} [tags] Resource tags. - * @member {string} [resourceGuid] The resource GUID property of the DDoS - * protection plan resource. It uniquely identifies the resource, even if the - * user changes its name or migrate the resource across subscriptions or - * resource groups. - * @member {string} [provisioningState] The provisioning state of the DDoS - * protection plan resource. Possible values are: 'Succeeded', 'Updating', - * 'Deleting', and 'Failed'. - * @member {array} [virtualNetworks] The list of virtual networks associated - * with the DDoS protection plan resource. This list is read-only. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface DdosProtectionPlan extends BaseResource { + /** + * Resource ID. + */ readonly id?: string; + /** + * Resource name. + */ readonly name?: string; + /** + * Resource type. + */ readonly type?: string; + /** + * Resource location. + */ location?: string; + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; + /** + * The resource GUID property of the DDoS protection plan resource. It uniquely identifies the + * resource, even if the user changes its name or migrate the resource across subscriptions or + * resource groups. + */ readonly resourceGuid?: string; + /** + * The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The list of virtual networks associated with the DDoS protection plan resource. This list is + * read-only. + */ readonly virtualNetworks?: SubResource[]; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the EndpointServiceResult class. - * @constructor * Endpoint service. - * - * @member {string} [name] Name of the endpoint service. - * @member {string} [type] Type of the endpoint service. - */ +*/ export interface EndpointServiceResult extends SubResource { + /** + * Name of the endpoint service. + */ readonly name?: string; + /** + * Type of the endpoint service. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitAuthorization class. - * @constructor * Authorization in an ExpressRouteCircuit resource. - * - * @member {string} [authorizationKey] The authorization key. - * @member {string} [authorizationUseStatus] AuthorizationUseStatus. Possible - * values are: 'Available' and 'InUse'. Possible values include: 'Available', - * 'InUse' - * @member {string} [provisioningState] Gets the provisioning state of the - * public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface ExpressRouteCircuitAuthorization extends SubResource { + /** + * The authorization key. + */ authorizationKey?: string; + /** + * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. Possible values include: + * 'Available', 'InUse' + */ authorizationUseStatus?: string; + /** + * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Gets name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitPeeringConfig class. - * @constructor * Specifies the peering configuration. - * - * @member {array} [advertisedPublicPrefixes] The reference of - * AdvertisedPublicPrefixes. - * @member {array} [advertisedCommunities] The communities of bgp peering. - * Spepcified for microsoft peering - * @member {string} [advertisedPublicPrefixesState] AdvertisedPublicPrefixState - * of the Peering resource. Possible values are 'NotConfigured', 'Configuring', - * 'Configured', and 'ValidationNeeded'. Possible values include: - * 'NotConfigured', 'Configuring', 'Configured', 'ValidationNeeded' - * @member {number} [legacyMode] The legacy mode of the peering. - * @member {number} [customerASN] The CustomerASN of the peering. - * @member {string} [routingRegistryName] The RoutingRegistryName of the - * configuration. - */ +*/ export interface ExpressRouteCircuitPeeringConfig { + /** + * The reference of AdvertisedPublicPrefixes. + */ advertisedPublicPrefixes?: string[]; + /** + * The communities of bgp peering. Spepcified for microsoft peering + */ advertisedCommunities?: string[]; + /** + * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', + * 'Configuring', 'Configured', and 'ValidationNeeded'. Possible values include: 'NotConfigured', + * 'Configuring', 'Configured', 'ValidationNeeded' + */ advertisedPublicPrefixesState?: string; + /** + * The legacy mode of the peering. + */ legacyMode?: number; + /** + * The CustomerASN of the peering. + */ customerASN?: number; + /** + * The RoutingRegistryName of the configuration. + */ routingRegistryName?: string; } /** - * @class - * Initializes a new instance of the RouteFilterRule class. - * @constructor * Route Filter Rule Resource - * - * @member {string} access The access type of the rule. Valid values are: - * 'Allow', 'Deny'. Possible values include: 'Allow', 'Deny' - * @member {array} communities The collection for bgp community values to - * filter on. e.g. ['12076:5010','12076:5020'] - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [location] Resource location. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface RouteFilterRule extends SubResource { + /** + * The access type of the rule. Valid values are: 'Allow', 'Deny'. Possible values include: + * 'Allow', 'Deny' + */ access: string; + /** + * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] + */ communities: string[]; + /** + * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', + * 'Succeeded' and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * Resource location. + */ location?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitStats class. - * @constructor * Contains stats associated with the peering. - * - * @member {number} [primarybytesIn] Gets BytesIn of the peering. - * @member {number} [primarybytesOut] Gets BytesOut of the peering. - * @member {number} [secondarybytesIn] Gets BytesIn of the peering. - * @member {number} [secondarybytesOut] Gets BytesOut of the peering. - */ +*/ export interface ExpressRouteCircuitStats { + /** + * Gets BytesIn of the peering. + */ primarybytesIn?: number; + /** + * Gets BytesOut of the peering. + */ primarybytesOut?: number; + /** + * Gets BytesIn of the peering. + */ secondarybytesIn?: number; + /** + * Gets BytesOut of the peering. + */ secondarybytesOut?: number; } /** - * @class - * Initializes a new instance of the ExpressRouteConnectionId class. - * @constructor * The ID of the ExpressRouteConnection. - * - * @member {string} [id] The ID of the ExpressRouteConnection. - */ +*/ export interface ExpressRouteConnectionId { + /** + * The ID of the ExpressRouteConnection. + */ readonly id?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitConnection class. - * @constructor * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource. - * - * @member {object} [expressRouteCircuitPeering] Reference to Express Route - * Circuit Private Peering Resource of the circuit initiating connection. - * @member {string} [expressRouteCircuitPeering.id] Resource ID. - * @member {object} [peerExpressRouteCircuitPeering] Reference to Express Route - * Circuit Private Peering Resource of the peered circuit. - * @member {string} [peerExpressRouteCircuitPeering.id] Resource ID. - * @member {string} [addressPrefix] /29 IP address space to carve out Customer - * addresses for tunnels. - * @member {string} [authorizationKey] The authorization key. - * @member {string} [circuitConnectionStatus] Express Route Circuit Connection - * State. Possible values are: 'Connected' and 'Disconnected'. Possible values - * include: 'Connected', 'Connecting', 'Disconnected' - * @member {string} [provisioningState] Provisioning state of the circuit - * connection resource. Possible values are: 'Succeded', 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface ExpressRouteCircuitConnection extends SubResource { + /** + * Reference to Express Route Circuit Private Peering Resource of the circuit initiating + * connection. + */ expressRouteCircuitPeering?: SubResource; + /** + * Reference to Express Route Circuit Private Peering Resource of the peered circuit. + */ peerExpressRouteCircuitPeering?: SubResource; + /** + * /29 IP address space to carve out Customer addresses for tunnels. + */ addressPrefix?: string; + /** + * The authorization key. + */ authorizationKey?: string; + /** + * Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. + * Possible values include: 'Connected', 'Connecting', 'Disconnected' + */ readonly circuitConnectionStatus?: string; + /** + * Provisioning state of the circuit connection resource. Possible values are: 'Succeded', + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * Gets name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitPeering class. - * @constructor * Peering in an ExpressRouteCircuit resource. - * - * @member {string} [peeringType] The peering type. Possible values include: - * 'AzurePublicPeering', 'AzurePrivatePeering', 'MicrosoftPeering' - * @member {string} [state] The peering state. Possible values include: - * 'Disabled', 'Enabled' - * @member {number} [azureASN] The Azure ASN. - * @member {number} [peerASN] The peer ASN. - * @member {string} [primaryPeerAddressPrefix] The primary address prefix. - * @member {string} [secondaryPeerAddressPrefix] The secondary address prefix. - * @member {string} [primaryAzurePort] The primary port. - * @member {string} [secondaryAzurePort] The secondary port. - * @member {string} [sharedKey] The shared key. - * @member {number} [vlanId] The VLAN ID. - * @member {object} [microsoftPeeringConfig] The Microsoft peering - * configuration. - * @member {array} [microsoftPeeringConfig.advertisedPublicPrefixes] The - * reference of AdvertisedPublicPrefixes. - * @member {array} [microsoftPeeringConfig.advertisedCommunities] The - * communities of bgp peering. Spepcified for microsoft peering - * @member {string} [microsoftPeeringConfig.advertisedPublicPrefixesState] - * AdvertisedPublicPrefixState of the Peering resource. Possible values are - * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - * Possible values include: 'NotConfigured', 'Configuring', 'Configured', - * 'ValidationNeeded' - * @member {number} [microsoftPeeringConfig.legacyMode] The legacy mode of the - * peering. - * @member {number} [microsoftPeeringConfig.customerASN] The CustomerASN of the - * peering. - * @member {string} [microsoftPeeringConfig.routingRegistryName] The - * RoutingRegistryName of the configuration. - * @member {object} [stats] Gets peering stats. - * @member {number} [stats.primarybytesIn] Gets BytesIn of the peering. - * @member {number} [stats.primarybytesOut] Gets BytesOut of the peering. - * @member {number} [stats.secondarybytesIn] Gets BytesIn of the peering. - * @member {number} [stats.secondarybytesOut] Gets BytesOut of the peering. - * @member {string} [provisioningState] Gets the provisioning state of the - * public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [gatewayManagerEtag] The GatewayManager Etag. - * @member {string} [lastModifiedBy] Gets whether the provider or the customer - * last modified the peering. - * @member {object} [routeFilter] The reference of the RouteFilter resource. - * @member {array} [routeFilter.rules] Collection of RouteFilterRules contained - * within a route filter. - * @member {array} [routeFilter.peerings] A collection of references to express - * route circuit peerings. - * @member {string} [routeFilter.provisioningState] The provisioning state of - * the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and - * 'Failed'. - * @member {string} [routeFilter.etag] Gets a unique read-only string that - * changes whenever the resource is updated. - * @member {object} [ipv6PeeringConfig] The IPv6 peering configuration. - * @member {string} [ipv6PeeringConfig.primaryPeerAddressPrefix] The primary - * address prefix. - * @member {string} [ipv6PeeringConfig.secondaryPeerAddressPrefix] The - * secondary address prefix. - * @member {object} [ipv6PeeringConfig.microsoftPeeringConfig] The Microsoft - * peering configuration. - * @member {array} - * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedPublicPrefixes] The - * reference of AdvertisedPublicPrefixes. - * @member {array} - * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedCommunities] The - * communities of bgp peering. Spepcified for microsoft peering - * @member {string} - * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedPublicPrefixesState] - * AdvertisedPublicPrefixState of the Peering resource. Possible values are - * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - * Possible values include: 'NotConfigured', 'Configuring', 'Configured', - * 'ValidationNeeded' - * @member {number} [ipv6PeeringConfig.microsoftPeeringConfig.legacyMode] The - * legacy mode of the peering. - * @member {number} [ipv6PeeringConfig.microsoftPeeringConfig.customerASN] The - * CustomerASN of the peering. - * @member {string} - * [ipv6PeeringConfig.microsoftPeeringConfig.routingRegistryName] The - * RoutingRegistryName of the configuration. - * @member {object} [ipv6PeeringConfig.routeFilter] The reference of the - * RouteFilter resource. - * @member {array} [ipv6PeeringConfig.routeFilter.rules] Collection of - * RouteFilterRules contained within a route filter. - * @member {array} [ipv6PeeringConfig.routeFilter.peerings] A collection of - * references to express route circuit peerings. - * @member {string} [ipv6PeeringConfig.routeFilter.provisioningState] The - * provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', 'Succeeded' and 'Failed'. - * @member {string} [ipv6PeeringConfig.routeFilter.etag] Gets a unique - * read-only string that changes whenever the resource is updated. - * @member {string} [ipv6PeeringConfig.state] The state of peering. Possible - * values are: 'Disabled' and 'Enabled'. Possible values include: 'Disabled', - * 'Enabled' - * @member {object} [expressRouteConnection] The ExpressRoute connection. - * @member {string} [expressRouteConnection.id] The ID of the - * ExpressRouteConnection. - * @member {array} [connections] The list of circuit connections associated - * with Azure Private Peering for this circuit. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface ExpressRouteCircuitPeering extends SubResource { + /** + * The peering type. Possible values include: 'AzurePublicPeering', 'AzurePrivatePeering', + * 'MicrosoftPeering' + */ peeringType?: string; + /** + * The peering state. Possible values include: 'Disabled', 'Enabled' + */ state?: string; + /** + * The Azure ASN. + */ azureASN?: number; + /** + * The peer ASN. + */ peerASN?: number; + /** + * The primary address prefix. + */ primaryPeerAddressPrefix?: string; + /** + * The secondary address prefix. + */ secondaryPeerAddressPrefix?: string; + /** + * The primary port. + */ primaryAzurePort?: string; + /** + * The secondary port. + */ secondaryAzurePort?: string; + /** + * The shared key. + */ sharedKey?: string; + /** + * The VLAN ID. + */ vlanId?: number; + /** + * The Microsoft peering configuration. + */ microsoftPeeringConfig?: ExpressRouteCircuitPeeringConfig; + /** + * Gets peering stats. + */ stats?: ExpressRouteCircuitStats; + /** + * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * The GatewayManager Etag. + */ gatewayManagerEtag?: string; + /** + * Gets whether the provider or the customer last modified the peering. + */ lastModifiedBy?: string; + /** + * The reference of the RouteFilter resource. + */ routeFilter?: RouteFilter; + /** + * The IPv6 peering configuration. + */ ipv6PeeringConfig?: Ipv6ExpressRouteCircuitPeeringConfig; + /** + * The ExpressRoute connection. + */ expressRouteConnection?: ExpressRouteConnectionId; + /** + * The list of circuit connections associated with Azure Private Peering for this circuit. + */ connections?: ExpressRouteCircuitConnection[]; + /** + * Gets name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the RouteFilter class. - * @constructor * Route Filter Resource. - * - * @member {array} [rules] Collection of RouteFilterRules contained within a - * route filter. - * @member {array} [peerings] A collection of references to express route - * circuit peerings. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface RouteFilter extends Resource { + /** + * Collection of RouteFilterRules contained within a route filter. + */ rules?: RouteFilterRule[]; + /** + * A collection of references to express route circuit peerings. + */ peerings?: ExpressRouteCircuitPeering[]; + /** + * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', + * 'Succeeded' and 'Failed'. + */ readonly provisioningState?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the Ipv6ExpressRouteCircuitPeeringConfig class. - * @constructor * Contains IPv6 peering config. - * - * @member {string} [primaryPeerAddressPrefix] The primary address prefix. - * @member {string} [secondaryPeerAddressPrefix] The secondary address prefix. - * @member {object} [microsoftPeeringConfig] The Microsoft peering - * configuration. - * @member {array} [microsoftPeeringConfig.advertisedPublicPrefixes] The - * reference of AdvertisedPublicPrefixes. - * @member {array} [microsoftPeeringConfig.advertisedCommunities] The - * communities of bgp peering. Spepcified for microsoft peering - * @member {string} [microsoftPeeringConfig.advertisedPublicPrefixesState] - * AdvertisedPublicPrefixState of the Peering resource. Possible values are - * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - * Possible values include: 'NotConfigured', 'Configuring', 'Configured', - * 'ValidationNeeded' - * @member {number} [microsoftPeeringConfig.legacyMode] The legacy mode of the - * peering. - * @member {number} [microsoftPeeringConfig.customerASN] The CustomerASN of the - * peering. - * @member {string} [microsoftPeeringConfig.routingRegistryName] The - * RoutingRegistryName of the configuration. - * @member {object} [routeFilter] The reference of the RouteFilter resource. - * @member {array} [routeFilter.rules] Collection of RouteFilterRules contained - * within a route filter. - * @member {array} [routeFilter.peerings] A collection of references to express - * route circuit peerings. - * @member {string} [routeFilter.provisioningState] The provisioning state of - * the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and - * 'Failed'. - * @member {string} [routeFilter.etag] Gets a unique read-only string that - * changes whenever the resource is updated. - * @member {string} [state] The state of peering. Possible values are: - * 'Disabled' and 'Enabled'. Possible values include: 'Disabled', 'Enabled' - */ +*/ export interface Ipv6ExpressRouteCircuitPeeringConfig { + /** + * The primary address prefix. + */ primaryPeerAddressPrefix?: string; + /** + * The secondary address prefix. + */ secondaryPeerAddressPrefix?: string; + /** + * The Microsoft peering configuration. + */ microsoftPeeringConfig?: ExpressRouteCircuitPeeringConfig; + /** + * The reference of the RouteFilter resource. + */ routeFilter?: RouteFilter; + /** + * The state of peering. Possible values are: 'Disabled' and 'Enabled'. Possible values include: + * 'Disabled', 'Enabled' + */ state?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitSku class. - * @constructor * Contains SKU in an ExpressRouteCircuit. - * - * @member {string} [name] The name of the SKU. - * @member {string} [tier] The tier of the SKU. Possible values are 'Standard', - * 'Premium' or 'Basic'. Possible values include: 'Standard', 'Premium', - * 'Basic' - * @member {string} [family] The family of the SKU. Possible values are: - * 'UnlimitedData' and 'MeteredData'. Possible values include: 'UnlimitedData', - * 'MeteredData' - */ +*/ export interface ExpressRouteCircuitSku { + /** + * The name of the SKU. + */ name?: string; + /** + * The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'. Possible values + * include: 'Standard', 'Premium', 'Basic' + */ tier?: string; + /** + * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. Possible values + * include: 'UnlimitedData', 'MeteredData' + */ family?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitServiceProviderProperties class. - * @constructor * Contains ServiceProviderProperties in an ExpressRouteCircuit. - * - * @member {string} [serviceProviderName] The serviceProviderName. - * @member {string} [peeringLocation] The peering location. - * @member {number} [bandwidthInMbps] The BandwidthInMbps. - */ +*/ export interface ExpressRouteCircuitServiceProviderProperties { + /** + * The serviceProviderName. + */ serviceProviderName?: string; + /** + * The peering location. + */ peeringLocation?: string; + /** + * The BandwidthInMbps. + */ bandwidthInMbps?: number; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuit class. - * @constructor * ExpressRouteCircuit resource - * - * @member {object} [sku] The SKU. - * @member {string} [sku.name] The name of the SKU. - * @member {string} [sku.tier] The tier of the SKU. Possible values are - * 'Standard', 'Premium' or 'Basic'. Possible values include: 'Standard', - * 'Premium', 'Basic' - * @member {string} [sku.family] The family of the SKU. Possible values are: - * 'UnlimitedData' and 'MeteredData'. Possible values include: 'UnlimitedData', - * 'MeteredData' - * @member {boolean} [allowClassicOperations] Allow classic operations - * @member {string} [circuitProvisioningState] The CircuitProvisioningState - * state of the resource. - * @member {string} [serviceProviderProvisioningState] The - * ServiceProviderProvisioningState state of the resource. Possible values are - * 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. - * Possible values include: 'NotProvisioned', 'Provisioning', 'Provisioned', - * 'Deprovisioning' - * @member {array} [authorizations] The list of authorizations. - * @member {array} [peerings] The list of peerings. - * @member {string} [serviceKey] The ServiceKey. - * @member {string} [serviceProviderNotes] The ServiceProviderNotes. - * @member {object} [serviceProviderProperties] The ServiceProviderProperties. - * @member {string} [serviceProviderProperties.serviceProviderName] The - * serviceProviderName. - * @member {string} [serviceProviderProperties.peeringLocation] The peering - * location. - * @member {number} [serviceProviderProperties.bandwidthInMbps] The - * BandwidthInMbps. - * @member {object} [expressRoutePort] The reference to the ExpressRoutePort - * resource when the circuit is provisioned on an ExpressRoutePort resource. - * @member {string} [expressRoutePort.id] Resource ID. - * @member {number} [bandwidthInGbps] The bandwidth of the circuit when the - * circuit is provisioned on an ExpressRoutePort resource. - * @member {number} [stag] The identifier of the circuit traffic. Outer tag for - * QinQ encapsulation. - * @member {string} [provisioningState] Gets the provisioning state of the - * public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [gatewayManagerEtag] The GatewayManager Etag. - * @member {boolean} [allowGlobalReach] Flag to enable Global Reach on the - * circuit. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface ExpressRouteCircuit extends Resource { + /** + * The SKU. + */ sku?: ExpressRouteCircuitSku; + /** + * Allow classic operations + */ allowClassicOperations?: boolean; + /** + * The CircuitProvisioningState state of the resource. + */ circuitProvisioningState?: string; + /** + * The ServiceProviderProvisioningState state of the resource. Possible values are + * 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. Possible values + * include: 'NotProvisioned', 'Provisioning', 'Provisioned', 'Deprovisioning' + */ serviceProviderProvisioningState?: string; + /** + * The list of authorizations. + */ authorizations?: ExpressRouteCircuitAuthorization[]; + /** + * The list of peerings. + */ peerings?: ExpressRouteCircuitPeering[]; + /** + * The ServiceKey. + */ serviceKey?: string; + /** + * The ServiceProviderNotes. + */ serviceProviderNotes?: string; + /** + * The ServiceProviderProperties. + */ serviceProviderProperties?: ExpressRouteCircuitServiceProviderProperties; + /** + * The reference to the ExpressRoutePort resource when the circuit is provisioned on an + * ExpressRoutePort resource. + */ expressRoutePort?: SubResource; + /** + * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. + */ bandwidthInGbps?: number; + /** + * The identifier of the circuit traffic. Outer tag for QinQ encapsulation. + */ readonly stag?: number; + /** + * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * The GatewayManager Etag. + */ gatewayManagerEtag?: string; + /** + * Flag to enable Global Reach on the circuit. + */ allowGlobalReach?: boolean; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitArpTable class. - * @constructor * The ARP table associated with the ExpressRouteCircuit. - * - * @member {number} [age] Entry age in minutes - * @member {string} [interfaceProperty] Interface address - * @member {string} [ipAddress] The IP address. - * @member {string} [macAddress] The MAC address. - */ +*/ export interface ExpressRouteCircuitArpTable { + /** + * Entry age in minutes + */ age?: number; + /** + * Interface address + */ interfaceProperty?: string; + /** + * The IP address. + */ ipAddress?: string; + /** + * The MAC address. + */ macAddress?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitsArpTableListResult class. - * @constructor * Response for ListArpTable associated with the Express Route Circuits API. - * - * @member {array} [value] Gets list of the ARP table. - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface ExpressRouteCircuitsArpTableListResult { + /** + * Gets list of the ARP table. + */ value?: ExpressRouteCircuitArpTable[]; + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitRoutesTable class. - * @constructor * The routes table associated with the ExpressRouteCircuit - * - * @member {string} [network] IP address of a network entity - * @member {string} [nextHop] NextHop address - * @member {string} [locPrf] Local preference value as set with the set - * local-preference route-map configuration command - * @member {number} [weight] Route Weight. - * @member {string} [path] Autonomous system paths to the destination network. - */ +*/ export interface ExpressRouteCircuitRoutesTable { + /** + * IP address of a network entity + */ network?: string; + /** + * NextHop address + */ nextHop?: string; + /** + * Local preference value as set with the set local-preference route-map configuration command + */ locPrf?: string; + /** + * Route Weight. + */ weight?: number; + /** + * Autonomous system paths to the destination network. + */ path?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitsRoutesTableListResult class. - * @constructor * Response for ListRoutesTable associated with the Express Route Circuits API. - * - * @member {array} [value] The list of routes table. - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface ExpressRouteCircuitsRoutesTableListResult { + /** + * The list of routes table. + */ value?: ExpressRouteCircuitRoutesTable[]; + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitRoutesTableSummary class. - * @constructor * The routes table associated with the ExpressRouteCircuit. - * - * @member {string} [neighbor] IP address of the neighbor. - * @member {number} [v] BGP version number spoken to the neighbor. - * @member {number} [as] Autonomous system number. - * @member {string} [upDown] The length of time that the BGP session has been - * in the Established state, or the current status if not in the Established - * state. - * @member {string} [statePfxRcd] Current state of the BGP session, and the - * number of prefixes that have been received from a neighbor or peer group. - */ +*/ export interface ExpressRouteCircuitRoutesTableSummary { + /** + * IP address of the neighbor. + */ neighbor?: string; + /** + * BGP version number spoken to the neighbor. + */ v?: number; + /** + * Autonomous system number. + */ as?: number; + /** + * The length of time that the BGP session has been in the Established state, or the current + * status if not in the Established state. + */ upDown?: string; + /** + * Current state of the BGP session, and the number of prefixes that have been received from a + * neighbor or peer group. + */ statePfxRcd?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitsRoutesTableSummaryListResult class. - * @constructor * Response for ListRoutesTable associated with the Express Route Circuits API. - * - * @member {array} [value] A list of the routes table. - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface ExpressRouteCircuitsRoutesTableSummaryListResult { + /** + * A list of the routes table. + */ value?: ExpressRouteCircuitRoutesTableSummary[]; + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteServiceProviderBandwidthsOffered class. - * @constructor * Contains bandwidths offered in ExpressRouteServiceProvider resources. - * - * @member {string} [offerName] The OfferName. - * @member {number} [valueInMbps] The ValueInMbps. - */ +*/ export interface ExpressRouteServiceProviderBandwidthsOffered { + /** + * The OfferName. + */ offerName?: string; + /** + * The ValueInMbps. + */ valueInMbps?: number; } /** - * @class - * Initializes a new instance of the ExpressRouteServiceProvider class. - * @constructor * A ExpressRouteResourceProvider object. - * - * @member {array} [peeringLocations] Get a list of peering locations. - * @member {array} [bandwidthsOffered] Gets bandwidths offered. - * @member {string} [provisioningState] Gets the provisioning state of the - * resource. - */ +*/ export interface ExpressRouteServiceProvider extends Resource { + /** + * Get a list of peering locations. + */ peeringLocations?: string[]; + /** + * Gets bandwidths offered. + */ bandwidthsOffered?: ExpressRouteServiceProviderBandwidthsOffered[]; + /** + * Gets the provisioning state of the resource. + */ provisioningState?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCrossConnectionRoutesTableSummary class. - * @constructor * The routes table associated with the ExpressRouteCircuit. - * - * @member {string} [neighbor] IP address of Neighbor router - * @member {number} [asn] Autonomous system number. - * @member {string} [upDown] The length of time that the BGP session has been - * in the Established state, or the current status if not in the Established - * state. - * @member {string} [stateOrPrefixesReceived] Current state of the BGP session, - * and the number of prefixes that have been received from a neighbor or peer - * group. - */ +*/ export interface ExpressRouteCrossConnectionRoutesTableSummary { + /** + * IP address of Neighbor router + */ neighbor?: string; + /** + * Autonomous system number. + */ asn?: number; + /** + * The length of time that the BGP session has been in the Established state, or the current + * status if not in the Established state. + */ upDown?: string; + /** + * Current state of the BGP session, and the number of prefixes that have been received from a + * neighbor or peer group. + */ stateOrPrefixesReceived?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCrossConnectionsRoutesTableSummaryListResult class. - * @constructor - * Response for ListRoutesTable associated with the Express Route Cross - * Connections. - * - * @member {array} [value] A list of the routes table. - * @member {string} [nextLink] The URL to get the next set of results. - */ + * Response for ListRoutesTable associated with the Express Route Cross Connections. +*/ export interface ExpressRouteCrossConnectionsRoutesTableSummaryListResult { + /** + * A list of the routes table. + */ value?: ExpressRouteCrossConnectionRoutesTableSummary[]; + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } -/** - * @class - * Initializes a new instance of the ExpressRouteCircuitReference class. - * @constructor - * @member {string} [id] Corresponding Express Route Circuit Id. - */ export interface ExpressRouteCircuitReference { + /** + * Corresponding Express Route Circuit Id. + */ id?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCrossConnectionPeering class. - * @constructor * Peering in an ExpressRoute Cross Connection resource. - * - * @member {string} [peeringType] The peering type. Possible values include: - * 'AzurePublicPeering', 'AzurePrivatePeering', 'MicrosoftPeering' - * @member {string} [state] The peering state. Possible values include: - * 'Disabled', 'Enabled' - * @member {number} [azureASN] The Azure ASN. - * @member {number} [peerASN] The peer ASN. - * @member {string} [primaryPeerAddressPrefix] The primary address prefix. - * @member {string} [secondaryPeerAddressPrefix] The secondary address prefix. - * @member {string} [primaryAzurePort] The primary port. - * @member {string} [secondaryAzurePort] The secondary port. - * @member {string} [sharedKey] The shared key. - * @member {number} [vlanId] The VLAN ID. - * @member {object} [microsoftPeeringConfig] The Microsoft peering - * configuration. - * @member {array} [microsoftPeeringConfig.advertisedPublicPrefixes] The - * reference of AdvertisedPublicPrefixes. - * @member {array} [microsoftPeeringConfig.advertisedCommunities] The - * communities of bgp peering. Spepcified for microsoft peering - * @member {string} [microsoftPeeringConfig.advertisedPublicPrefixesState] - * AdvertisedPublicPrefixState of the Peering resource. Possible values are - * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - * Possible values include: 'NotConfigured', 'Configuring', 'Configured', - * 'ValidationNeeded' - * @member {number} [microsoftPeeringConfig.legacyMode] The legacy mode of the - * peering. - * @member {number} [microsoftPeeringConfig.customerASN] The CustomerASN of the - * peering. - * @member {string} [microsoftPeeringConfig.routingRegistryName] The - * RoutingRegistryName of the configuration. - * @member {string} [provisioningState] Gets the provisioning state of the - * public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [gatewayManagerEtag] The GatewayManager Etag. - * @member {string} [lastModifiedBy] Gets whether the provider or the customer - * last modified the peering. - * @member {object} [ipv6PeeringConfig] The IPv6 peering configuration. - * @member {string} [ipv6PeeringConfig.primaryPeerAddressPrefix] The primary - * address prefix. - * @member {string} [ipv6PeeringConfig.secondaryPeerAddressPrefix] The - * secondary address prefix. - * @member {object} [ipv6PeeringConfig.microsoftPeeringConfig] The Microsoft - * peering configuration. - * @member {array} - * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedPublicPrefixes] The - * reference of AdvertisedPublicPrefixes. - * @member {array} - * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedCommunities] The - * communities of bgp peering. Spepcified for microsoft peering - * @member {string} - * [ipv6PeeringConfig.microsoftPeeringConfig.advertisedPublicPrefixesState] - * AdvertisedPublicPrefixState of the Peering resource. Possible values are - * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - * Possible values include: 'NotConfigured', 'Configuring', 'Configured', - * 'ValidationNeeded' - * @member {number} [ipv6PeeringConfig.microsoftPeeringConfig.legacyMode] The - * legacy mode of the peering. - * @member {number} [ipv6PeeringConfig.microsoftPeeringConfig.customerASN] The - * CustomerASN of the peering. - * @member {string} - * [ipv6PeeringConfig.microsoftPeeringConfig.routingRegistryName] The - * RoutingRegistryName of the configuration. - * @member {object} [ipv6PeeringConfig.routeFilter] The reference of the - * RouteFilter resource. - * @member {array} [ipv6PeeringConfig.routeFilter.rules] Collection of - * RouteFilterRules contained within a route filter. - * @member {array} [ipv6PeeringConfig.routeFilter.peerings] A collection of - * references to express route circuit peerings. - * @member {string} [ipv6PeeringConfig.routeFilter.provisioningState] The - * provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', 'Succeeded' and 'Failed'. - * @member {string} [ipv6PeeringConfig.routeFilter.etag] Gets a unique - * read-only string that changes whenever the resource is updated. - * @member {string} [ipv6PeeringConfig.state] The state of peering. Possible - * values are: 'Disabled' and 'Enabled'. Possible values include: 'Disabled', - * 'Enabled' - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface ExpressRouteCrossConnectionPeering extends SubResource { + /** + * The peering type. Possible values include: 'AzurePublicPeering', 'AzurePrivatePeering', + * 'MicrosoftPeering' + */ peeringType?: string; + /** + * The peering state. Possible values include: 'Disabled', 'Enabled' + */ state?: string; + /** + * The Azure ASN. + */ readonly azureASN?: number; + /** + * The peer ASN. + */ peerASN?: number; + /** + * The primary address prefix. + */ primaryPeerAddressPrefix?: string; + /** + * The secondary address prefix. + */ secondaryPeerAddressPrefix?: string; + /** + * The primary port. + */ readonly primaryAzurePort?: string; + /** + * The secondary port. + */ readonly secondaryAzurePort?: string; + /** + * The shared key. + */ sharedKey?: string; + /** + * The VLAN ID. + */ vlanId?: number; + /** + * The Microsoft peering configuration. + */ microsoftPeeringConfig?: ExpressRouteCircuitPeeringConfig; + /** + * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The GatewayManager Etag. + */ gatewayManagerEtag?: string; + /** + * Gets whether the provider or the customer last modified the peering. + */ lastModifiedBy?: string; + /** + * The IPv6 peering configuration. + */ ipv6PeeringConfig?: Ipv6ExpressRouteCircuitPeeringConfig; + /** + * Gets name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCrossConnection class. - * @constructor * ExpressRouteCrossConnection resource - * - * @member {string} [primaryAzurePort] The name of the primary port. - * @member {string} [secondaryAzurePort] The name of the secondary port. - * @member {number} [sTag] The identifier of the circuit traffic. - * @member {string} [peeringLocation] The peering location of the ExpressRoute - * circuit. - * @member {number} [bandwidthInMbps] The circuit bandwidth In Mbps. - * @member {object} [expressRouteCircuit] The ExpressRouteCircuit - * @member {string} [expressRouteCircuit.id] Corresponding Express Route - * Circuit Id. - * @member {string} [serviceProviderProvisioningState] The provisioning state - * of the circuit in the connectivity provider system. Possible values are - * 'NotProvisioned', 'Provisioning', 'Provisioned'. Possible values include: - * 'NotProvisioned', 'Provisioning', 'Provisioned', 'Deprovisioning' - * @member {string} [serviceProviderNotes] Additional read only notes set by - * the connectivity provider. - * @member {string} [provisioningState] Gets the provisioning state of the - * public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {array} [peerings] The list of peerings. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface ExpressRouteCrossConnection extends Resource { + /** + * The name of the primary port. + */ readonly primaryAzurePort?: string; + /** + * The name of the secondary port. + */ readonly secondaryAzurePort?: string; + /** + * The identifier of the circuit traffic. + */ readonly sTag?: number; + /** + * The peering location of the ExpressRoute circuit. + */ peeringLocation?: string; + /** + * The circuit bandwidth In Mbps. + */ bandwidthInMbps?: number; + /** + * The ExpressRouteCircuit + */ expressRouteCircuit?: ExpressRouteCircuitReference; + /** + * The provisioning state of the circuit in the connectivity provider system. Possible values are + * 'NotProvisioned', 'Provisioning', 'Provisioned'. Possible values include: 'NotProvisioned', + * 'Provisioning', 'Provisioned', 'Deprovisioning' + */ serviceProviderProvisioningState?: string; + /** + * Additional read only notes set by the connectivity provider. + */ serviceProviderNotes?: string; + /** + * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The list of peerings. + */ peerings?: ExpressRouteCrossConnectionPeering[]; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the VirtualHubId class. - * @constructor * Virtual Hub identifier. - * - * @member {string} [id] The resource URI for the Virtual Hub where the - * ExpressRoute gateway is or will be deployed. The Virtual Hub resource and - * the ExpressRoute gateway resource reside in the same subscription. - */ +*/ export interface VirtualHubId { + /** + * The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. + * The Virtual Hub resource and the ExpressRoute gateway resource reside in the same + * subscription. + */ id?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitPeeringId class. - * @constructor * ExpressRoute circuit peering identifier. - * - * @member {string} [id] The ID of the ExpressRoute circuit peering. - */ +*/ export interface ExpressRouteCircuitPeeringId { + /** + * The ID of the ExpressRoute circuit peering. + */ id?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds class. - * @constructor * Minimum and maximum number of scale units to deploy. - * - * @member {number} [min] Minimum number of scale units deployed for - * ExpressRoute gateway. - * @member {number} [max] Maximum number of scale units deployed for - * ExpressRoute gateway. - */ +*/ export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds { + /** + * Minimum number of scale units deployed for ExpressRoute gateway. + */ min?: number; + /** + * Maximum number of scale units deployed for ExpressRoute gateway. + */ max?: number; } /** - * @class - * Initializes a new instance of the ExpressRouteGatewayPropertiesAutoScaleConfiguration class. - * @constructor * Configuration for auto scaling. - * - * @member {object} [bounds] Minimum and maximum number of scale units to - * deploy. - * @member {number} [bounds.min] Minimum number of scale units deployed for - * ExpressRoute gateway. - * @member {number} [bounds.max] Maximum number of scale units deployed for - * ExpressRoute gateway. - */ +*/ export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration { + /** + * Minimum and maximum number of scale units to deploy. + */ bounds?: ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds; } /** - * @class - * Initializes a new instance of the ExpressRouteConnection class. - * @constructor * ExpressRouteConnection resource. - * - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {object} expressRouteCircuitPeering The ExpressRoute circuit - * peering. - * @member {string} [expressRouteCircuitPeering.id] The ID of the ExpressRoute - * circuit peering. - * @member {string} [authorizationKey] Authorization key to establish the - * connection. - * @member {number} [routingWeight] The routing weight associated to the - * connection. - * @member {string} name The name of the resource. - */ +*/ export interface ExpressRouteConnection extends SubResource { + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ readonly provisioningState?: string; + /** + * The ExpressRoute circuit peering. + */ expressRouteCircuitPeering: ExpressRouteCircuitPeeringId; + /** + * Authorization key to establish the connection. + */ authorizationKey?: string; + /** + * The routing weight associated to the connection. + */ routingWeight?: number; + /** + * The name of the resource. + */ name: string; } /** - * @class - * Initializes a new instance of the ExpressRouteGateway class. - * @constructor * ExpressRoute gateway resource. - * - * @member {object} [autoScaleConfiguration] Configuration for auto scaling. - * @member {object} [autoScaleConfiguration.bounds] Minimum and maximum number - * of scale units to deploy. - * @member {number} [autoScaleConfiguration.bounds.min] Minimum number of scale - * units deployed for ExpressRoute gateway. - * @member {number} [autoScaleConfiguration.bounds.max] Maximum number of scale - * units deployed for ExpressRoute gateway. - * @member {array} [expressRouteConnections] List of ExpressRoute connections - * to the ExpressRoute gateway. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {object} virtualHub The Virtual Hub where the ExpressRoute gateway - * is or will be deployed. - * @member {string} [virtualHub.id] The resource URI for the Virtual Hub where - * the ExpressRoute gateway is or will be deployed. The Virtual Hub resource - * and the ExpressRoute gateway resource reside in the same subscription. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface ExpressRouteGateway extends Resource { + /** + * Configuration for auto scaling. + */ autoScaleConfiguration?: ExpressRouteGatewayPropertiesAutoScaleConfiguration; + /** + * List of ExpressRoute connections to the ExpressRoute gateway. + */ readonly expressRouteConnections?: ExpressRouteConnection[]; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ readonly provisioningState?: string; + /** + * The Virtual Hub where the ExpressRoute gateway is or will be deployed. + */ virtualHub: VirtualHubId; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteGatewayList class. - * @constructor * List of ExpressRoute gateways. - * - * @member {array} [value] List of ExpressRoute gateways. - */ +*/ export interface ExpressRouteGatewayList { + /** + * List of ExpressRoute gateways. + */ value?: ExpressRouteGateway[]; } /** - * @class - * Initializes a new instance of the ExpressRouteConnectionList class. - * @constructor * ExpressRouteConnection list - * - * @member {array} [value] The list of ExpressRoute connections - */ +*/ export interface ExpressRouteConnectionList { + /** + * The list of ExpressRoute connections + */ value?: ExpressRouteConnection[]; } /** - * @class - * Initializes a new instance of the ExpressRoutePortsLocationBandwidths class. - * @constructor * @summary ExpressRoutePorts Location Bandwidths - * - * Real-time inventory of available ExpressRoute port bandwidths. - * - * @member {string} [offerName] Bandwidth descriptive name - * @member {number} [valueInGbps] Bandwidth value in Gbps - */ + * @description Real-time inventory of available ExpressRoute port bandwidths. +*/ export interface ExpressRoutePortsLocationBandwidths { + /** + * Bandwidth descriptive name + */ readonly offerName?: string; + /** + * Bandwidth value in Gbps + */ readonly valueInGbps?: number; } /** - * @class - * Initializes a new instance of the ExpressRoutePortsLocation class. - * @constructor * @summary ExpressRoutePorts Peering Location - * - * Definition of the ExpressRoutePorts peering location resource. - * - * @member {string} [address] Address of peering location. - * @member {string} [contact] Contact details of peering locations. - * @member {array} [availableBandwidths] The inventory of available - * ExpressRoutePort bandwidths. - * @member {string} [provisioningState] The provisioning state of the - * ExpressRoutePortLocation resource. Possible values are: 'Succeeded', - * 'Updating', 'Deleting', and 'Failed'. - */ + * @description Definition of the ExpressRoutePorts peering location resource. +*/ export interface ExpressRoutePortsLocation extends Resource { + /** + * Address of peering location. + */ readonly address?: string; + /** + * Contact details of peering locations. + */ readonly contact?: string; + /** + * The inventory of available ExpressRoutePort bandwidths. + */ availableBandwidths?: ExpressRoutePortsLocationBandwidths[]; + /** + * The provisioning state of the ExpressRoutePortLocation resource. Possible values are: + * 'Succeeded', 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteLink class. - * @constructor * @summary ExpressRouteLink - * - * ExpressRouteLink child resource definition. - * - * @member {string} [routerName] Name of Azure router associated with physical - * port. - * @member {string} [interfaceName] Name of Azure router interface. - * @member {string} [patchPanelId] Mapping between physical port to patch panel - * port. - * @member {string} [rackId] Mapping of physical patch panel to rack. - * @member {string} [connectorType] Physical fiber port type. Possible values - * include: 'LC', 'SC' - * @member {string} [adminState] Administrative state of the physical port. - * Possible values include: 'Enabled', 'Disabled' - * @member {string} [provisioningState] The provisioning state of the - * ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [name] Name of child port resource that is unique among - * child port resources of the parent. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ + * @description ExpressRouteLink child resource definition. +*/ export interface ExpressRouteLink extends SubResource { + /** + * Name of Azure router associated with physical port. + */ readonly routerName?: string; + /** + * Name of Azure router interface. + */ readonly interfaceName?: string; + /** + * Mapping between physical port to patch panel port. + */ readonly patchPanelId?: string; + /** + * Mapping of physical patch panel to rack. + */ readonly rackId?: string; + /** + * Physical fiber port type. Possible values include: 'LC', 'SC' + */ readonly connectorType?: string; + /** + * Administrative state of the physical port. Possible values include: 'Enabled', 'Disabled' + */ adminState?: string; + /** + * The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * Name of child port resource that is unique among child port resources of the parent. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the ExpressRoutePort class. - * @constructor * @summary ExpressRoute Port - * - * ExpressRoutePort resource definition. - * - * @member {string} [peeringLocation] The name of the peering location that the - * ExpressRoutePort is mapped to physically. - * @member {number} [bandwidthInGbps] Bandwidth of procured ports in Gbps - * @member {number} [provisionedBandwidthInGbps] Aggregate Gbps of associated - * circuit bandwidths. - * @member {string} [mtu] Maximum transmission unit of the physical port - * pair(s) - * @member {string} [encapsulation] Encapsulation method on physical ports. - * Possible values include: 'Dot1Q', 'QinQ' - * @member {string} [etherType] Ethertype of the physical port. - * @member {string} [allocationDate] Date of the physical port allocation to be - * used in Letter of Authorization. - * @member {array} [links] ExpressRouteLink Sub-Resources. The set of physical - * links of the ExpressRoutePort resource - * @member {array} [circuits] Reference the ExpressRoute circuit(s) that are - * provisioned on this ExpressRoutePort resource. - * @member {string} [provisioningState] The provisioning state of the - * ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [resourceGuid] The resource GUID property of the - * ExpressRoutePort resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ + * @description ExpressRoutePort resource definition. +*/ export interface ExpressRoutePort extends Resource { + /** + * The name of the peering location that the ExpressRoutePort is mapped to physically. + */ peeringLocation?: string; + /** + * Bandwidth of procured ports in Gbps + */ bandwidthInGbps?: number; + /** + * Aggregate Gbps of associated circuit bandwidths. + */ readonly provisionedBandwidthInGbps?: number; + /** + * Maximum transmission unit of the physical port pair(s) + */ readonly mtu?: string; + /** + * Encapsulation method on physical ports. Possible values include: 'Dot1Q', 'QinQ' + */ encapsulation?: string; + /** + * Ethertype of the physical port. + */ readonly etherType?: string; + /** + * Date of the physical port allocation to be used in Letter of Authorization. + */ readonly allocationDate?: string; + /** + * @summary ExpressRouteLink Sub-Resources + * @description The set of physical links of the ExpressRoutePort resource + */ links?: ExpressRouteLink[]; + /** + * Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. + */ readonly circuits?: SubResource[]; + /** + * The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The resource GUID property of the ExpressRoutePort resource. + */ resourceGuid?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the LoadBalancerSku class. - * @constructor * SKU of a load balancer - * - * @member {string} [name] Name of a load balancer SKU. Possible values - * include: 'Basic', 'Standard' - */ +*/ export interface LoadBalancerSku { + /** + * Name of a load balancer SKU. Possible values include: 'Basic', 'Standard' + */ name?: string; } /** - * @class - * Initializes a new instance of the LoadBalancingRule class. - * @constructor * A load balancing rule for a load balancer. - * - * @member {object} [frontendIPConfiguration] A reference to frontend IP - * addresses. - * @member {string} [frontendIPConfiguration.id] Resource ID. - * @member {object} [backendAddressPool] A reference to a pool of DIPs. Inbound - * traffic is randomly load balanced across IPs in the backend IPs. - * @member {string} [backendAddressPool.id] Resource ID. - * @member {object} [probe] The reference of the load balancer probe used by - * the load balancing rule. - * @member {string} [probe.id] Resource ID. - * @member {string} protocol Possible values include: 'Udp', 'Tcp', 'All' - * @member {string} [loadDistribution] The load distribution policy for this - * rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. - * Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol' - * @member {number} frontendPort The port for the external endpoint. Port - * numbers for each rule must be unique within the Load Balancer. Acceptable - * values are between 0 and 65534. Note that value 0 enables "Any Port" - * @member {number} [backendPort] The port used for internal connections on the - * endpoint. Acceptable values are between 0 and 65535. Note that value 0 - * enables "Any Port" - * @member {number} [idleTimeoutInMinutes] The timeout for the TCP idle - * connection. The value can be set between 4 and 30 minutes. The default value - * is 4 minutes. This element is only used when the protocol is set to TCP. - * @member {boolean} [enableFloatingIP] Configures a virtual machine's endpoint - * for the floating IP capability required to configure a SQL AlwaysOn - * Availability Group. This setting is required when using the SQL AlwaysOn - * Availability Groups in SQL server. This setting can't be changed after you - * create the endpoint. - * @member {boolean} [enableTcpReset] Receive bidirectional TCP Reset on TCP - * flow idle timeout or unexpected connection termination. This element is only - * used when the protocol is set to TCP. - * @member {boolean} [disableOutboundSnat] Configures SNAT for the VMs in the - * backend pool to use the publicIP address specified in the frontend of the - * load balancing rule. - * @member {string} [provisioningState] Gets the provisioning state of the - * PublicIP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface LoadBalancingRule extends SubResource { + /** + * A reference to frontend IP addresses. + */ frontendIPConfiguration?: SubResource; + /** + * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the + * backend IPs. + */ backendAddressPool?: SubResource; + /** + * The reference of the load balancer probe used by the load balancing rule. + */ probe?: SubResource; + /** + * Possible values include: 'Udp', 'Tcp', 'All' + */ protocol: string; + /** + * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and + * 'SourceIPProtocol'. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol' + */ loadDistribution?: string; + /** + * The port for the external endpoint. Port numbers for each rule must be unique within the Load + * Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port" + */ frontendPort: number; + /** + * The port used for internal connections on the endpoint. Acceptable values are between 0 and + * 65535. Note that value 0 enables "Any Port" + */ backendPort?: number; + /** + * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The + * default value is 4 minutes. This element is only used when the protocol is set to TCP. + */ idleTimeoutInMinutes?: number; + /** + * Configures a virtual machine's endpoint for the floating IP capability required to configure a + * SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn + * Availability Groups in SQL server. This setting can't be changed after you create the + * endpoint. + */ enableFloatingIP?: boolean; + /** + * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. + * This element is only used when the protocol is set to TCP. + */ enableTcpReset?: boolean; + /** + * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the + * frontend of the load balancing rule. + */ disableOutboundSnat?: boolean; + /** + * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the Probe class. - * @constructor * A load balancer probe. - * - * @member {array} [loadBalancingRules] The load balancer rules that use this - * probe. - * @member {string} protocol The protocol of the end point. Possible values - * are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is - * required for the probe to be successful. If 'Http' or 'Https' is specified, - * a 200 OK response from the specifies URI is required for the probe to be - * successful. Possible values include: 'Http', 'Tcp', 'Https' - * @member {number} port The port for communicating the probe. Possible values - * range from 1 to 65535, inclusive. - * @member {number} [intervalInSeconds] The interval, in seconds, for how - * frequently to probe the endpoint for health status. Typically, the interval - * is slightly less than half the allocated timeout period (in seconds) which - * allows two full probes before taking the instance out of rotation. The - * default value is 15, the minimum value is 5. - * @member {number} [numberOfProbes] The number of probes where if no response, - * will result in stopping further traffic from being delivered to the - * endpoint. This values allows endpoints to be taken out of rotation faster or - * slower than the typical times used in Azure. - * @member {string} [requestPath] The URI used for requesting health status - * from the VM. Path is required if a protocol is set to http. Otherwise, it is - * not allowed. There is no default value. - * @member {string} [provisioningState] Gets the provisioning state of the - * public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface Probe extends SubResource { + /** + * The load balancer rules that use this probe. + */ readonly loadBalancingRules?: SubResource[]; + /** + * The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is + * specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is + * specified, a 200 OK response from the specifies URI is required for the probe to be + * successful. Possible values include: 'Http', 'Tcp', 'Https' + */ protocol: string; + /** + * The port for communicating the probe. Possible values range from 1 to 65535, inclusive. + */ port: number; + /** + * The interval, in seconds, for how frequently to probe the endpoint for health status. + * Typically, the interval is slightly less than half the allocated timeout period (in seconds) + * which allows two full probes before taking the instance out of rotation. The default value is + * 15, the minimum value is 5. + */ intervalInSeconds?: number; + /** + * The number of probes where if no response, will result in stopping further traffic from being + * delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or + * slower than the typical times used in Azure. + */ numberOfProbes?: number; + /** + * The URI used for requesting health status from the VM. Path is required if a protocol is set + * to http. Otherwise, it is not allowed. There is no default value. + */ requestPath?: string; + /** + * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Gets name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the InboundNatPool class. - * @constructor * Inbound NAT pool of the load balancer. - * - * @member {object} [frontendIPConfiguration] A reference to frontend IP - * addresses. - * @member {string} [frontendIPConfiguration.id] Resource ID. - * @member {string} protocol Possible values include: 'Udp', 'Tcp', 'All' - * @member {number} frontendPortRangeStart The first port number in the range - * of external ports that will be used to provide Inbound Nat to NICs - * associated with a load balancer. Acceptable values range between 1 and - * 65534. - * @member {number} frontendPortRangeEnd The last port number in the range of - * external ports that will be used to provide Inbound Nat to NICs associated - * with a load balancer. Acceptable values range between 1 and 65535. - * @member {number} backendPort The port used for internal connections on the - * endpoint. Acceptable values are between 1 and 65535. - * @member {number} [idleTimeoutInMinutes] The timeout for the TCP idle - * connection. The value can be set between 4 and 30 minutes. The default value - * is 4 minutes. This element is only used when the protocol is set to TCP. - * @member {boolean} [enableFloatingIP] Configures a virtual machine's endpoint - * for the floating IP capability required to configure a SQL AlwaysOn - * Availability Group. This setting is required when using the SQL AlwaysOn - * Availability Groups in SQL server. This setting can't be changed after you - * create the endpoint. - * @member {boolean} [enableTcpReset] Receive bidirectional TCP Reset on TCP - * flow idle timeout or unexpected connection termination. This element is only - * used when the protocol is set to TCP. - * @member {string} [provisioningState] Gets the provisioning state of the - * PublicIP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface InboundNatPool extends SubResource { + /** + * A reference to frontend IP addresses. + */ frontendIPConfiguration?: SubResource; + /** + * Possible values include: 'Udp', 'Tcp', 'All' + */ protocol: string; + /** + * The first port number in the range of external ports that will be used to provide Inbound Nat + * to NICs associated with a load balancer. Acceptable values range between 1 and 65534. + */ frontendPortRangeStart: number; + /** + * The last port number in the range of external ports that will be used to provide Inbound Nat + * to NICs associated with a load balancer. Acceptable values range between 1 and 65535. + */ frontendPortRangeEnd: number; + /** + * The port used for internal connections on the endpoint. Acceptable values are between 1 and + * 65535. + */ backendPort: number; + /** + * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The + * default value is 4 minutes. This element is only used when the protocol is set to TCP. + */ idleTimeoutInMinutes?: number; + /** + * Configures a virtual machine's endpoint for the floating IP capability required to configure a + * SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn + * Availability Groups in SQL server. This setting can't be changed after you create the + * endpoint. + */ enableFloatingIP?: boolean; + /** + * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. + * This element is only used when the protocol is set to TCP. + */ enableTcpReset?: boolean; + /** + * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the OutboundRule class. - * @constructor * Outbound pool of the load balancer. - * - * @member {number} [allocatedOutboundPorts] The number of outbound ports to be - * used for NAT. - * @member {array} frontendIPConfigurations The Frontend IP addresses of the - * load balancer. - * @member {object} backendAddressPool A reference to a pool of DIPs. Outbound - * traffic is randomly load balanced across IPs in the backend IPs. - * @member {string} [backendAddressPool.id] Resource ID. - * @member {string} [provisioningState] Gets the provisioning state of the - * PublicIP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} protocol Protocol - TCP, UDP or All. Possible values - * include: 'Tcp', 'Udp', 'All' - * @member {boolean} [enableTcpReset] Receive bidirectional TCP Reset on TCP - * flow idle timeout or unexpected connection termination. This element is only - * used when the protocol is set to TCP. - * @member {number} [idleTimeoutInMinutes] The timeout for the TCP idle - * connection - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface OutboundRule extends SubResource { + /** + * The number of outbound ports to be used for NAT. + */ allocatedOutboundPorts?: number; + /** + * The Frontend IP addresses of the load balancer. + */ frontendIPConfigurations: SubResource[]; + /** + * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the + * backend IPs. + */ backendAddressPool: SubResource; + /** + * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * Protocol - TCP, UDP or All. Possible values include: 'Tcp', 'Udp', 'All' + */ protocol: string; + /** + * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. + * This element is only used when the protocol is set to TCP. + */ enableTcpReset?: boolean; + /** + * The timeout for the TCP idle connection + */ idleTimeoutInMinutes?: number; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the LoadBalancer class. - * @constructor * LoadBalancer resource - * - * @member {object} [sku] The load balancer SKU. - * @member {string} [sku.name] Name of a load balancer SKU. Possible values - * include: 'Basic', 'Standard' - * @member {array} [frontendIPConfigurations] Object representing the frontend - * IPs to be used for the load balancer - * @member {array} [backendAddressPools] Collection of backend address pools - * used by a load balancer - * @member {array} [loadBalancingRules] Object collection representing the load - * balancing rules Gets the provisioning - * @member {array} [probes] Collection of probe objects used in the load - * balancer - * @member {array} [inboundNatRules] Collection of inbound NAT Rules used by a - * load balancer. Defining inbound NAT rules on your load balancer is mutually - * exclusive with defining an inbound NAT pool. Inbound NAT pools are - * referenced from virtual machine scale sets. NICs that are associated with - * individual virtual machines cannot reference an Inbound NAT pool. They have - * to reference individual inbound NAT rules. - * @member {array} [inboundNatPools] Defines an external port range for inbound - * NAT to a single backend port on NICs associated with a load balancer. - * Inbound NAT rules are created automatically for each NIC associated with the - * Load Balancer using an external port from this range. Defining an Inbound - * NAT pool on your Load Balancer is mutually exclusive with defining inbound - * Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. - * NICs that are associated with individual virtual machines cannot reference - * an inbound NAT pool. They have to reference individual inbound NAT rules. - * @member {array} [outboundRules] The outbound rules. - * @member {string} [resourceGuid] The resource GUID property of the load - * balancer resource. - * @member {string} [provisioningState] Gets the provisioning state of the - * PublicIP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface LoadBalancer extends Resource { + /** + * The load balancer SKU. + */ sku?: LoadBalancerSku; + /** + * Object representing the frontend IPs to be used for the load balancer + */ frontendIPConfigurations?: FrontendIPConfiguration[]; + /** + * Collection of backend address pools used by a load balancer + */ backendAddressPools?: BackendAddressPool[]; + /** + * Object collection representing the load balancing rules Gets the provisioning + */ loadBalancingRules?: LoadBalancingRule[]; + /** + * Collection of probe objects used in the load balancer + */ probes?: Probe[]; + /** + * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your + * load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are + * referenced from virtual machine scale sets. NICs that are associated with individual virtual + * machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT + * rules. + */ inboundNatRules?: InboundNatRule[]; + /** + * Defines an external port range for inbound NAT to a single backend port on NICs associated + * with a load balancer. Inbound NAT rules are created automatically for each NIC associated with + * the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your + * Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are + * referenced from virtual machine scale sets. NICs that are associated with individual virtual + * machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT + * rules. + */ inboundNatPools?: InboundNatPool[]; + /** + * The outbound rules. + */ outboundRules?: OutboundRule[]; + /** + * The resource GUID property of the load balancer resource. + */ resourceGuid?: string; + /** + * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } -/** - * @class - * Initializes a new instance of the ErrorDetails class. - * @constructor - * @member {string} [code] - * @member {string} [target] - * @member {string} [message] - */ export interface ErrorDetails { code?: string; target?: string; message?: string; } -/** - * @class - * Initializes a new instance of the ErrorModel class. - * @constructor - * @member {string} [code] - * @member {string} [message] - * @member {string} [target] - * @member {array} [details] - * @member {string} [innerError] - */ export interface ErrorModel { code?: string; message?: string; @@ -6391,4457 +4023,4153 @@ export interface ErrorModel { } /** - * @class - * Initializes a new instance of the AzureAsyncOperationResult class. - * @constructor - * The response body contains the status of the specified asynchronous - * operation, indicating whether it has succeeded, is in progress, or has - * failed. Note that this status is distinct from the HTTP status code returned - * for the Get Operation Status operation itself. If the asynchronous operation - * succeeded, the response body includes the HTTP status code for the - * successful request. If the asynchronous operation failed, the response body - * includes the HTTP status code for the failed request and error information - * regarding the failure. - * - * @member {string} [status] Status of the Azure async operation. Possible - * values are: 'InProgress', 'Succeeded', and 'Failed'. Possible values - * include: 'InProgress', 'Succeeded', 'Failed' - * @member {object} [error] - * @member {string} [error.code] - * @member {string} [error.message] - * @member {string} [error.target] - * @member {array} [error.details] - * @member {string} [error.innerError] - */ + * The response body contains the status of the specified asynchronous operation, indicating + * whether it has succeeded, is in progress, or has failed. Note that this status is distinct from + * the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous + * operation succeeded, the response body includes the HTTP status code for the successful request. + * If the asynchronous operation failed, the response body includes the HTTP status code for the + * failed request and error information regarding the failure. +*/ export interface AzureAsyncOperationResult { + /** + * Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and + * 'Failed'. Possible values include: 'InProgress', 'Succeeded', 'Failed' + */ status?: string; error?: ErrorModel; } /** - * @class - * Initializes a new instance of the EffectiveNetworkSecurityGroupAssociation class. - * @constructor * The effective network security group association. - * - * @member {object} [subnet] The ID of the subnet if assigned. - * @member {string} [subnet.id] Resource ID. - * @member {object} [networkInterface] The ID of the network interface if - * assigned. - * @member {string} [networkInterface.id] Resource ID. - */ +*/ export interface EffectiveNetworkSecurityGroupAssociation { + /** + * The ID of the subnet if assigned. + */ subnet?: SubResource; + /** + * The ID of the network interface if assigned. + */ networkInterface?: SubResource; } /** - * @class - * Initializes a new instance of the EffectiveNetworkSecurityRule class. - * @constructor * Effective network security rules. - * - * @member {string} [name] The name of the security rule specified by the user - * (if created by the user). - * @member {string} [protocol] The network protocol this rule applies to. - * Possible values are: 'Tcp', 'Udp', and 'All'. Possible values include: - * 'Tcp', 'Udp', 'All' - * @member {string} [sourcePortRange] The source port or range. - * @member {string} [destinationPortRange] The destination port or range. - * @member {array} [sourcePortRanges] The source port ranges. Expected values - * include a single integer between 0 and 65535, a range using '-' as seperator - * (e.g. 100-400), or an asterix (*) - * @member {array} [destinationPortRanges] The destination port ranges. - * Expected values include a single integer between 0 and 65535, a range using - * '-' as seperator (e.g. 100-400), or an asterix (*) - * @member {string} [sourceAddressPrefix] The source address prefix. - * @member {string} [destinationAddressPrefix] The destination address prefix. - * @member {array} [sourceAddressPrefixes] The source address prefixes. - * Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, - * AureLoadBalancer, Internet), System Tags, and the asterix (*). - * @member {array} [destinationAddressPrefixes] The destination address - * prefixes. Expected values include CIDR IP ranges, Default Tags - * (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix - * (*). - * @member {array} [expandedSourceAddressPrefix] The expanded source address - * prefix. - * @member {array} [expandedDestinationAddressPrefix] Expanded destination - * address prefix. - * @member {string} [access] Whether network traffic is allowed or denied. - * Possible values are: 'Allow' and 'Deny'. Possible values include: 'Allow', - * 'Deny' - * @member {number} [priority] The priority of the rule. - * @member {string} [direction] The direction of the rule. Possible values are: - * 'Inbound and Outbound'. Possible values include: 'Inbound', 'Outbound' - */ +*/ export interface EffectiveNetworkSecurityRule { + /** + * The name of the security rule specified by the user (if created by the user). + */ name?: string; + /** + * The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and 'All'. + * Possible values include: 'Tcp', 'Udp', 'All' + */ protocol?: string; + /** + * The source port or range. + */ sourcePortRange?: string; + /** + * The destination port or range. + */ destinationPortRange?: string; + /** + * The source port ranges. Expected values include a single integer between 0 and 65535, a range + * using '-' as seperator (e.g. 100-400), or an asterix (*) + */ sourcePortRanges?: string[]; + /** + * The destination port ranges. Expected values include a single integer between 0 and 65535, a + * range using '-' as seperator (e.g. 100-400), or an asterix (*) + */ destinationPortRanges?: string[]; + /** + * The source address prefix. + */ sourceAddressPrefix?: string; + /** + * The destination address prefix. + */ destinationAddressPrefix?: string; + /** + * The source address prefixes. Expected values include CIDR IP ranges, Default Tags + * (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*). + */ sourceAddressPrefixes?: string[]; + /** + * The destination address prefixes. Expected values include CIDR IP ranges, Default Tags + * (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*). + */ destinationAddressPrefixes?: string[]; + /** + * The expanded source address prefix. + */ expandedSourceAddressPrefix?: string[]; + /** + * Expanded destination address prefix. + */ expandedDestinationAddressPrefix?: string[]; + /** + * Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. + * Possible values include: 'Allow', 'Deny' + */ access?: string; + /** + * The priority of the rule. + */ priority?: number; + /** + * The direction of the rule. Possible values are: 'Inbound and Outbound'. Possible values + * include: 'Inbound', 'Outbound' + */ direction?: string; } /** - * @class - * Initializes a new instance of the EffectiveNetworkSecurityGroup class. - * @constructor * Effective network security group. - * - * @member {object} [networkSecurityGroup] The ID of network security group - * that is applied. - * @member {string} [networkSecurityGroup.id] Resource ID. - * @member {object} [association] Associated resources. - * @member {object} [association.subnet] The ID of the subnet if assigned. - * @member {string} [association.subnet.id] Resource ID. - * @member {object} [association.networkInterface] The ID of the network - * interface if assigned. - * @member {string} [association.networkInterface.id] Resource ID. - * @member {array} [effectiveSecurityRules] A collection of effective security - * rules. - * @member {object} [tagMap] Mapping of tags to list of IP Addresses included - * within the tag. - */ +*/ export interface EffectiveNetworkSecurityGroup { + /** + * The ID of network security group that is applied. + */ networkSecurityGroup?: SubResource; + /** + * Associated resources. + */ association?: EffectiveNetworkSecurityGroupAssociation; + /** + * A collection of effective security rules. + */ effectiveSecurityRules?: EffectiveNetworkSecurityRule[]; + /** + * Mapping of tags to list of IP Addresses included within the tag. + */ tagMap?: { [propertyName: string]: string[] }; } /** - * @class - * Initializes a new instance of the EffectiveNetworkSecurityGroupListResult class. - * @constructor * Response for list effective network security groups API service call. - * - * @member {array} [value] A list of effective network security groups. - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface EffectiveNetworkSecurityGroupListResult { + /** + * A list of effective network security groups. + */ value?: EffectiveNetworkSecurityGroup[]; + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the EffectiveRoute class. - * @constructor * Effective Route - * - * @member {string} [name] The name of the user defined route. This is - * optional. - * @member {string} [source] Who created the route. Possible values are: - * 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'. Possible values - * include: 'Unknown', 'User', 'VirtualNetworkGateway', 'Default' - * @member {string} [state] The value of effective route. Possible values are: - * 'Active' and 'Invalid'. Possible values include: 'Active', 'Invalid' - * @member {array} [addressPrefix] The address prefixes of the effective routes - * in CIDR notation. - * @member {array} [nextHopIpAddress] The IP address of the next hop of the - * effective route. - * @member {string} [nextHopType] The type of Azure hop the packet should be - * sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', - * 'Internet', 'VirtualAppliance', and 'None'. Possible values include: - * 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', 'None' - */ +*/ export interface EffectiveRoute { + /** + * The name of the user defined route. This is optional. + */ name?: string; + /** + * Who created the route. Possible values are: 'Unknown', 'User', 'VirtualNetworkGateway', and + * 'Default'. Possible values include: 'Unknown', 'User', 'VirtualNetworkGateway', 'Default' + */ source?: string; + /** + * The value of effective route. Possible values are: 'Active' and 'Invalid'. Possible values + * include: 'Active', 'Invalid' + */ state?: string; + /** + * The address prefixes of the effective routes in CIDR notation. + */ addressPrefix?: string[]; + /** + * The IP address of the next hop of the effective route. + */ nextHopIpAddress?: string[]; + /** + * The type of Azure hop the packet should be sent to. Possible values are: + * 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. Possible + * values include: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', 'None' + */ nextHopType?: string; } /** - * @class - * Initializes a new instance of the EffectiveRouteListResult class. - * @constructor * Response for list effective route API service call. - * - * @member {array} [value] A list of effective routes. - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface EffectiveRouteListResult { + /** + * A list of effective routes. + */ value?: EffectiveRoute[]; + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the ContainerNetworkInterfaceConfiguration class. - * @constructor * Container network interface configruation child resource. - * - * @member {array} [ipConfigurations] A list of ip configurations of the - * container network interface configuration. - * @member {array} [containerNetworkInterfaces] A list of container network - * interfaces created from this container network interface configuration. - * @member {string} [provisioningState] The provisioning state of the resource. - * @member {string} [name] The name of the resource. This name can be used to - * access the resource. - * @member {string} [type] Sub Resource type. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface ContainerNetworkInterfaceConfiguration extends SubResource { + /** + * A list of ip configurations of the container network interface configuration. + */ ipConfigurations?: IPConfigurationProfile[]; - containerNetworkInterfaces?: ContainerNetworkInterface[]; + /** + * A list of container network interfaces created from this container network interface + * configuration. + */ + containerNetworkInterfaces?: SubResource[]; + /** + * The provisioning state of the resource. + */ readonly provisioningState?: string; + /** + * The name of the resource. This name can be used to access the resource. + */ name?: string; + /** + * Sub Resource type. + */ readonly type?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the Container class. - * @constructor * Reference to container resource in remote resource provider. - * - */ +*/ export interface Container extends SubResource { } /** - * @class - * Initializes a new instance of the ContainerNetworkInterfaceIpConfiguration class. - * @constructor * The ip configuration for a container network interface. - * - * @member {string} [provisioningState] The provisioning state of the resource. - * @member {string} [name] The name of the resource. This name can be used to - * access the resource. - * @member {string} [type] Sub Resource type. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface ContainerNetworkInterfaceIpConfiguration { + /** + * The provisioning state of the resource. + */ readonly provisioningState?: string; + /** + * The name of the resource. This name can be used to access the resource. + */ name?: string; + /** + * Sub Resource type. + */ readonly type?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the ContainerNetworkInterface class. - * @constructor * Container network interface child resource. - * - * @member {object} [containerNetworkInterfaceConfiguration] Container network - * interface configuration from which this container network interface is - * created. - * @member {array} [containerNetworkInterfaceConfiguration.ipConfigurations] A - * list of ip configurations of the container network interface configuration. - * @member {array} - * [containerNetworkInterfaceConfiguration.containerNetworkInterfaces] A list - * of container network interfaces created from this container network - * interface configuration. - * @member {string} [containerNetworkInterfaceConfiguration.provisioningState] - * The provisioning state of the resource. - * @member {string} [containerNetworkInterfaceConfiguration.name] The name of - * the resource. This name can be used to access the resource. - * @member {string} [containerNetworkInterfaceConfiguration.type] Sub Resource - * type. - * @member {string} [containerNetworkInterfaceConfiguration.etag] A unique - * read-only string that changes whenever the resource is updated. - * @member {object} [container] Reference to the conatinaer to which this - * container network interface is attached. - * @member {array} [ipConfigurations] Reference to the ip configuration on this - * container nic. - * @member {string} [provisioningState] The provisioning state of the resource. - * @member {string} [name] The name of the resource. This name can be used to - * access the resource. - * @member {string} [type] Sub Resource type. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface ContainerNetworkInterface extends SubResource { + /** + * Container network interface configuration from which this container network interface is + * created. + */ containerNetworkInterfaceConfiguration?: ContainerNetworkInterfaceConfiguration; + /** + * Reference to the conatinaer to which this container network interface is attached. + */ container?: Container; + /** + * Reference to the ip configuration on this container nic. + */ ipConfigurations?: ContainerNetworkInterfaceIpConfiguration[]; + /** + * The provisioning state of the resource. + */ readonly provisioningState?: string; + /** + * The name of the resource. This name can be used to access the resource. + */ name?: string; + /** + * Sub Resource type. + */ readonly type?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the NetworkProfile class. - * @constructor * Network profile resource. - * - * @member {array} [containerNetworkInterfaces] List of child container network - * interfaces. - * @member {array} [containerNetworkInterfaceConfigurations] List of chid - * container network interface configurations. - * @member {string} [resourceGuid] The resource GUID property of the network - * interface resource. - * @member {string} [provisioningState] The provisioning state of the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface NetworkProfile extends Resource { + /** + * List of child container network interfaces. + */ containerNetworkInterfaces?: ContainerNetworkInterface[]; + /** + * List of chid container network interface configurations. + */ containerNetworkInterfaceConfigurations?: ContainerNetworkInterfaceConfiguration[]; + /** + * The resource GUID property of the network interface resource. + */ readonly resourceGuid?: string; + /** + * The provisioning state of the resource. + */ readonly provisioningState?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the ErrorResponse class. - * @constructor * The error object. - * - * @member {object} [error] Error. - * @member {string} [error.code] - * @member {string} [error.target] - * @member {string} [error.message] - */ +*/ export interface ErrorResponse { + /** + * @summary Error + */ error?: ErrorDetails; } /** - * @class - * Initializes a new instance of the NetworkWatcher class. - * @constructor * Network watcher in a resource group. - * - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - */ +*/ export interface NetworkWatcher extends Resource { + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ readonly provisioningState?: string; } /** - * @class - * Initializes a new instance of the TopologyParameters class. - * @constructor * Parameters that define the representation of topology. - * - * @member {string} [targetResourceGroupName] The name of the target resource - * group to perform topology on. - * @member {object} [targetVirtualNetwork] The reference of the Virtual Network - * resource. - * @member {string} [targetVirtualNetwork.id] Resource ID. - * @member {object} [targetSubnet] The reference of the Subnet resource. - * @member {string} [targetSubnet.id] Resource ID. - */ +*/ export interface TopologyParameters { + /** + * The name of the target resource group to perform topology on. + */ targetResourceGroupName?: string; + /** + * The reference of the Virtual Network resource. + */ targetVirtualNetwork?: SubResource; + /** + * The reference of the Subnet resource. + */ targetSubnet?: SubResource; } /** - * @class - * Initializes a new instance of the TopologyAssociation class. - * @constructor * Resources that have an association with the parent resource. - * - * @member {string} [name] The name of the resource that is associated with the - * parent resource. - * @member {string} [resourceId] The ID of the resource that is associated with - * the parent resource. - * @member {string} [associationType] The association type of the child - * resource to the parent resource. Possible values include: 'Associated', - * 'Contains' - */ +*/ export interface TopologyAssociation { + /** + * The name of the resource that is associated with the parent resource. + */ name?: string; + /** + * The ID of the resource that is associated with the parent resource. + */ resourceId?: string; + /** + * The association type of the child resource to the parent resource. Possible values include: + * 'Associated', 'Contains' + */ associationType?: string; } /** - * @class - * Initializes a new instance of the TopologyResource class. - * @constructor * The network resource topology information for the given resource group. - * - * @member {string} [name] Name of the resource. - * @member {string} [id] ID of the resource. - * @member {string} [location] Resource location. - * @member {array} [associations] Holds the associations the resource has with - * other resources in the resource group. - */ +*/ export interface TopologyResource { + /** + * Name of the resource. + */ name?: string; + /** + * ID of the resource. + */ id?: string; + /** + * Resource location. + */ location?: string; + /** + * Holds the associations the resource has with other resources in the resource group. + */ associations?: TopologyAssociation[]; } /** - * @class - * Initializes a new instance of the Topology class. - * @constructor * Topology of the specified resource group. - * - * @member {string} [id] GUID representing the operation id. - * @member {date} [createdDateTime] The datetime when the topology was - * initially created for the resource group. - * @member {date} [lastModified] The datetime when the topology was last - * modified. - * @member {array} [resources] - */ +*/ export interface Topology { + /** + * GUID representing the operation id. + */ readonly id?: string; + /** + * The datetime when the topology was initially created for the resource group. + */ readonly createdDateTime?: Date; + /** + * The datetime when the topology was last modified. + */ readonly lastModified?: Date; resources?: TopologyResource[]; } /** - * @class - * Initializes a new instance of the VerificationIPFlowParameters class. - * @constructor * Parameters that define the IP flow to be verified. - * - * @member {string} targetResourceId The ID of the target resource to perform - * next-hop on. - * @member {string} direction The direction of the packet represented as a - * 5-tuple. Possible values include: 'Inbound', 'Outbound' - * @member {string} protocol Protocol to be verified on. Possible values - * include: 'TCP', 'UDP' - * @member {string} localPort The local port. Acceptable values are a single - * integer in the range (0-65535). Support for * for the source port, which - * depends on the direction. - * @member {string} remotePort The remote port. Acceptable values are a single - * integer in the range (0-65535). Support for * for the source port, which - * depends on the direction. - * @member {string} localIPAddress The local IP address. Acceptable values are - * valid IPv4 addresses. - * @member {string} remoteIPAddress The remote IP address. Acceptable values - * are valid IPv4 addresses. - * @member {string} [targetNicResourceId] The NIC ID. (If VM has multiple NICs - * and IP forwarding is enabled on any of them, then this parameter must be - * specified. Otherwise optional). - */ +*/ export interface VerificationIPFlowParameters { + /** + * The ID of the target resource to perform next-hop on. + */ targetResourceId: string; + /** + * The direction of the packet represented as a 5-tuple. Possible values include: 'Inbound', + * 'Outbound' + */ direction: string; + /** + * Protocol to be verified on. Possible values include: 'TCP', 'UDP' + */ protocol: string; + /** + * The local port. Acceptable values are a single integer in the range (0-65535). Support for * + * for the source port, which depends on the direction. + */ localPort: string; + /** + * The remote port. Acceptable values are a single integer in the range (0-65535). Support for * + * for the source port, which depends on the direction. + */ remotePort: string; + /** + * The local IP address. Acceptable values are valid IPv4 addresses. + */ localIPAddress: string; + /** + * The remote IP address. Acceptable values are valid IPv4 addresses. + */ remoteIPAddress: string; + /** + * The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of them, then this + * parameter must be specified. Otherwise optional). + */ targetNicResourceId?: string; } /** - * @class - * Initializes a new instance of the VerificationIPFlowResult class. - * @constructor * Results of IP flow verification on the target resource. - * - * @member {string} [access] Indicates whether the traffic is allowed or - * denied. Possible values include: 'Allow', 'Deny' - * @member {string} [ruleName] Name of the rule. If input is not matched - * against any security rule, it is not displayed. - */ +*/ export interface VerificationIPFlowResult { + /** + * Indicates whether the traffic is allowed or denied. Possible values include: 'Allow', 'Deny' + */ access?: string; + /** + * Name of the rule. If input is not matched against any security rule, it is not displayed. + */ ruleName?: string; } /** - * @class - * Initializes a new instance of the NextHopParameters class. - * @constructor * Parameters that define the source and destination endpoint. - * - * @member {string} targetResourceId The resource identifier of the target - * resource against which the action is to be performed. - * @member {string} sourceIPAddress The source IP address. - * @member {string} destinationIPAddress The destination IP address. - * @member {string} [targetNicResourceId] The NIC ID. (If VM has multiple NICs - * and IP forwarding is enabled on any of the nics, then this parameter must be - * specified. Otherwise optional). - */ +*/ export interface NextHopParameters { + /** + * The resource identifier of the target resource against which the action is to be performed. + */ targetResourceId: string; + /** + * The source IP address. + */ sourceIPAddress: string; + /** + * The destination IP address. + */ destinationIPAddress: string; + /** + * The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then + * this parameter must be specified. Otherwise optional). + */ targetNicResourceId?: string; } /** - * @class - * Initializes a new instance of the NextHopResult class. - * @constructor * The information about next hop from the specified VM. - * - * @member {string} [nextHopType] Next hop type. Possible values include: - * 'Internet', 'VirtualAppliance', 'VirtualNetworkGateway', 'VnetLocal', - * 'HyperNetGateway', 'None' - * @member {string} [nextHopIpAddress] Next hop IP Address - * @member {string} [routeTableId] The resource identifier for the route table - * associated with the route being returned. If the route being returned does - * not correspond to any user created routes then this field will be the string - * 'System Route'. - */ +*/ export interface NextHopResult { + /** + * Next hop type. Possible values include: 'Internet', 'VirtualAppliance', + * 'VirtualNetworkGateway', 'VnetLocal', 'HyperNetGateway', 'None' + */ nextHopType?: string; + /** + * Next hop IP Address + */ nextHopIpAddress?: string; + /** + * The resource identifier for the route table associated with the route being returned. If the + * route being returned does not correspond to any user created routes then this field will be + * the string 'System Route'. + */ routeTableId?: string; } /** - * @class - * Initializes a new instance of the SecurityGroupViewParameters class. - * @constructor * Parameters that define the VM to check security groups for. - * - * @member {string} targetResourceId ID of the target VM. - */ +*/ export interface SecurityGroupViewParameters { + /** + * ID of the target VM. + */ targetResourceId: string; } /** - * @class - * Initializes a new instance of the NetworkInterfaceAssociation class. - * @constructor * Network interface and its custom security rules. - * - * @member {string} [id] Network interface ID. - * @member {array} [securityRules] Collection of custom security rules. - */ +*/ export interface NetworkInterfaceAssociation { + /** + * Network interface ID. + */ readonly id?: string; + /** + * Collection of custom security rules. + */ securityRules?: SecurityRule[]; } /** - * @class - * Initializes a new instance of the SubnetAssociation class. - * @constructor * Network interface and its custom security rules. - * - * @member {string} [id] Subnet ID. - * @member {array} [securityRules] Collection of custom security rules. - */ +*/ export interface SubnetAssociation { + /** + * Subnet ID. + */ readonly id?: string; + /** + * Collection of custom security rules. + */ securityRules?: SecurityRule[]; } /** - * @class - * Initializes a new instance of the SecurityRuleAssociations class. - * @constructor * All security rules associated with the network interface. - * - * @member {object} [networkInterfaceAssociation] - * @member {string} [networkInterfaceAssociation.id] Network interface ID. - * @member {array} [networkInterfaceAssociation.securityRules] Collection of - * custom security rules. - * @member {object} [subnetAssociation] - * @member {string} [subnetAssociation.id] Subnet ID. - * @member {array} [subnetAssociation.securityRules] Collection of custom - * security rules. - * @member {array} [defaultSecurityRules] Collection of default security rules - * of the network security group. - * @member {array} [effectiveSecurityRules] Collection of effective security - * rules. - */ +*/ export interface SecurityRuleAssociations { networkInterfaceAssociation?: NetworkInterfaceAssociation; subnetAssociation?: SubnetAssociation; + /** + * Collection of default security rules of the network security group. + */ defaultSecurityRules?: SecurityRule[]; + /** + * Collection of effective security rules. + */ effectiveSecurityRules?: EffectiveNetworkSecurityRule[]; } /** - * @class - * Initializes a new instance of the SecurityGroupNetworkInterface class. - * @constructor * Network interface and all its associated security rules. - * - * @member {string} [id] ID of the network interface. - * @member {object} [securityRuleAssociations] - * @member {object} [securityRuleAssociations.networkInterfaceAssociation] - * @member {string} [securityRuleAssociations.networkInterfaceAssociation.id] - * Network interface ID. - * @member {array} - * [securityRuleAssociations.networkInterfaceAssociation.securityRules] - * Collection of custom security rules. - * @member {object} [securityRuleAssociations.subnetAssociation] - * @member {string} [securityRuleAssociations.subnetAssociation.id] Subnet ID. - * @member {array} [securityRuleAssociations.subnetAssociation.securityRules] - * Collection of custom security rules. - * @member {array} [securityRuleAssociations.defaultSecurityRules] Collection - * of default security rules of the network security group. - * @member {array} [securityRuleAssociations.effectiveSecurityRules] Collection - * of effective security rules. - */ +*/ export interface SecurityGroupNetworkInterface { + /** + * ID of the network interface. + */ id?: string; securityRuleAssociations?: SecurityRuleAssociations; } /** - * @class - * Initializes a new instance of the SecurityGroupViewResult class. - * @constructor * The information about security rules applied to the specified VM. - * - * @member {array} [networkInterfaces] List of network interfaces on the - * specified VM. - */ +*/ export interface SecurityGroupViewResult { + /** + * List of network interfaces on the specified VM. + */ networkInterfaces?: SecurityGroupNetworkInterface[]; } /** - * @class - * Initializes a new instance of the PacketCaptureStorageLocation class. - * @constructor * Describes the storage location for a packet capture session. - * - * @member {string} [storageId] The ID of the storage account to save the - * packet capture session. Required if no local file path is provided. - * @member {string} [storagePath] The URI of the storage path to save the - * packet capture. Must be a well-formed URI describing the location to save - * the packet capture. - * @member {string} [filePath] A valid local path on the targeting VM. Must - * include the name of the capture file (*.cap). For linux virtual machine it - * must start with /var/captures. Required if no storage ID is provided, - * otherwise optional. - */ +*/ export interface PacketCaptureStorageLocation { + /** + * The ID of the storage account to save the packet capture session. Required if no local file + * path is provided. + */ storageId?: string; + /** + * The URI of the storage path to save the packet capture. Must be a well-formed URI describing + * the location to save the packet capture. + */ storagePath?: string; + /** + * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For + * linux virtual machine it must start with /var/captures. Required if no storage ID is provided, + * otherwise optional. + */ filePath?: string; } /** - * @class - * Initializes a new instance of the PacketCaptureFilter class. - * @constructor - * Filter that is applied to packet capture request. Multiple filters can be - * applied. - * - * @member {string} [protocol] Protocol to be filtered on. Possible values - * include: 'TCP', 'UDP', 'Any'. Default value: 'Any' . - * @member {string} [localIPAddress] Local IP Address to be filtered on. - * Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for - * range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not - * currently supported. Mixing ranges with multiple entries not currently - * supported. Default = null. - * @member {string} [remoteIPAddress] Local IP Address to be filtered on. - * Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for - * range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not - * currently supported. Mixing ranges with multiple entries not currently - * supported. Default = null. - * @member {string} [localPort] Local port to be filtered on. Notation: "80" - * for single port entry."80-85" for range. "80;443;" for multiple entries. - * Multiple ranges not currently supported. Mixing ranges with multiple entries - * not currently supported. Default = null. - * @member {string} [remotePort] Remote port to be filtered on. Notation: "80" - * for single port entry."80-85" for range. "80;443;" for multiple entries. - * Multiple ranges not currently supported. Mixing ranges with multiple entries - * not currently supported. Default = null. - */ + * Filter that is applied to packet capture request. Multiple filters can be applied. +*/ export interface PacketCaptureFilter { + /** + * Protocol to be filtered on. Possible values include: 'TCP', 'UDP', 'Any' + */ protocol?: string; + /** + * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. + * "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple + * ranges not currently supported. Mixing ranges with multiple entries not currently supported. + * Default = null. + */ localIPAddress?: string; + /** + * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. + * "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple + * ranges not currently supported. Mixing ranges with multiple entries not currently supported. + * Default = null. + */ remoteIPAddress?: string; + /** + * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. + * "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with + * multiple entries not currently supported. Default = null. + */ localPort?: string; + /** + * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. + * "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with + * multiple entries not currently supported. Default = null. + */ remotePort?: string; } /** - * @class - * Initializes a new instance of the PacketCaptureParameters class. - * @constructor * Parameters that define the create packet capture operation. - * - * @member {string} target The ID of the targeted resource, only VM is - * currently supported. - * @member {number} [bytesToCapturePerPacket] Number of bytes captured per - * packet, the remaining bytes are truncated. Default value: 0 . - * @member {number} [totalBytesPerSession] Maximum size of the capture output. - * Default value: 1073741824 . - * @member {number} [timeLimitInSeconds] Maximum duration of the capture - * session in seconds. Default value: 18000 . - * @member {object} storageLocation - * @member {string} [storageLocation.storageId] The ID of the storage account - * to save the packet capture session. Required if no local file path is - * provided. - * @member {string} [storageLocation.storagePath] The URI of the storage path - * to save the packet capture. Must be a well-formed URI describing the - * location to save the packet capture. - * @member {string} [storageLocation.filePath] A valid local path on the - * targeting VM. Must include the name of the capture file (*.cap). For linux - * virtual machine it must start with /var/captures. Required if no storage ID - * is provided, otherwise optional. - * @member {array} [filters] - */ +*/ export interface PacketCaptureParameters { + /** + * The ID of the targeted resource, only VM is currently supported. + */ target: string; + /** + * Number of bytes captured per packet, the remaining bytes are truncated. + */ bytesToCapturePerPacket?: number; + /** + * Maximum size of the capture output. + */ totalBytesPerSession?: number; + /** + * Maximum duration of the capture session in seconds. + */ timeLimitInSeconds?: number; storageLocation: PacketCaptureStorageLocation; filters?: PacketCaptureFilter[]; } /** - * @class - * Initializes a new instance of the PacketCapture class. - * @constructor * Parameters that define the create packet capture operation. - * - * @member {string} target The ID of the targeted resource, only VM is - * currently supported. - * @member {number} [bytesToCapturePerPacket] Number of bytes captured per - * packet, the remaining bytes are truncated. Default value: 0 . - * @member {number} [totalBytesPerSession] Maximum size of the capture output. - * Default value: 1073741824 . - * @member {number} [timeLimitInSeconds] Maximum duration of the capture - * session in seconds. Default value: 18000 . - * @member {object} storageLocation - * @member {string} [storageLocation.storageId] The ID of the storage account - * to save the packet capture session. Required if no local file path is - * provided. - * @member {string} [storageLocation.storagePath] The URI of the storage path - * to save the packet capture. Must be a well-formed URI describing the - * location to save the packet capture. - * @member {string} [storageLocation.filePath] A valid local path on the - * targeting VM. Must include the name of the capture file (*.cap). For linux - * virtual machine it must start with /var/captures. Required if no storage ID - * is provided, otherwise optional. - * @member {array} [filters] - */ +*/ export interface PacketCapture { + /** + * The ID of the targeted resource, only VM is currently supported. + */ target: string; + /** + * Number of bytes captured per packet, the remaining bytes are truncated. + */ bytesToCapturePerPacket?: number; + /** + * Maximum size of the capture output. + */ totalBytesPerSession?: number; + /** + * Maximum duration of the capture session in seconds. + */ timeLimitInSeconds?: number; storageLocation: PacketCaptureStorageLocation; filters?: PacketCaptureFilter[]; } /** - * @class - * Initializes a new instance of the PacketCaptureResult class. - * @constructor * Information about packet capture session. - * - * @member {string} [name] Name of the packet capture session. - * @member {string} [id] ID of the packet capture operation. - * @member {string} [etag] Default value: 'A unique read-only string that - * changes whenever the resource is updated.' . - * @member {string} target The ID of the targeted resource, only VM is - * currently supported. - * @member {number} [bytesToCapturePerPacket] Number of bytes captured per - * packet, the remaining bytes are truncated. Default value: 0 . - * @member {number} [totalBytesPerSession] Maximum size of the capture output. - * Default value: 1073741824 . - * @member {number} [timeLimitInSeconds] Maximum duration of the capture - * session in seconds. Default value: 18000 . - * @member {object} storageLocation - * @member {string} [storageLocation.storageId] The ID of the storage account - * to save the packet capture session. Required if no local file path is - * provided. - * @member {string} [storageLocation.storagePath] The URI of the storage path - * to save the packet capture. Must be a well-formed URI describing the - * location to save the packet capture. - * @member {string} [storageLocation.filePath] A valid local path on the - * targeting VM. Must include the name of the capture file (*.cap). For linux - * virtual machine it must start with /var/captures. Required if no storage ID - * is provided, otherwise optional. - * @member {array} [filters] - * @member {string} [provisioningState] The provisioning state of the packet - * capture session. Possible values include: 'Succeeded', 'Updating', - * 'Deleting', 'Failed' - */ +*/ export interface PacketCaptureResult { + /** + * Name of the packet capture session. + */ readonly name?: string; + /** + * ID of the packet capture operation. + */ readonly id?: string; etag?: string; + /** + * The ID of the targeted resource, only VM is currently supported. + */ target: string; + /** + * Number of bytes captured per packet, the remaining bytes are truncated. + */ bytesToCapturePerPacket?: number; + /** + * Maximum size of the capture output. + */ totalBytesPerSession?: number; + /** + * Maximum duration of the capture session in seconds. + */ timeLimitInSeconds?: number; storageLocation: PacketCaptureStorageLocation; filters?: PacketCaptureFilter[]; + /** + * The provisioning state of the packet capture session. Possible values include: 'Succeeded', + * 'Updating', 'Deleting', 'Failed' + */ provisioningState?: string; } /** - * @class - * Initializes a new instance of the PacketCaptureQueryStatusResult class. - * @constructor * Status of packet capture session. - * - * @member {string} [name] The name of the packet capture resource. - * @member {string} [id] The ID of the packet capture resource. - * @member {date} [captureStartTime] The start time of the packet capture - * session. - * @member {string} [packetCaptureStatus] The status of the packet capture - * session. Possible values include: 'NotStarted', 'Running', 'Stopped', - * 'Error', 'Unknown' - * @member {string} [stopReason] The reason the current packet capture session - * was stopped. - * @member {array} [packetCaptureError] List of errors of packet capture - * session. - */ +*/ export interface PacketCaptureQueryStatusResult { + /** + * The name of the packet capture resource. + */ name?: string; + /** + * The ID of the packet capture resource. + */ id?: string; + /** + * The start time of the packet capture session. + */ captureStartTime?: Date; + /** + * The status of the packet capture session. Possible values include: 'NotStarted', 'Running', + * 'Stopped', 'Error', 'Unknown' + */ packetCaptureStatus?: string; + /** + * The reason the current packet capture session was stopped. + */ stopReason?: string; + /** + * List of errors of packet capture session. + */ packetCaptureError?: string[]; } /** - * @class - * Initializes a new instance of the TroubleshootingParameters class. - * @constructor * Parameters that define the resource to troubleshoot. - * - * @member {string} targetResourceId The target resource to troubleshoot. - * @member {string} storageId The ID for the storage account to save the - * troubleshoot result. - * @member {string} storagePath The path to the blob to save the troubleshoot - * result in. - */ +*/ export interface TroubleshootingParameters { + /** + * The target resource to troubleshoot. + */ targetResourceId: string; + /** + * The ID for the storage account to save the troubleshoot result. + */ storageId: string; + /** + * The path to the blob to save the troubleshoot result in. + */ storagePath: string; } /** - * @class - * Initializes a new instance of the QueryTroubleshootingParameters class. - * @constructor * Parameters that define the resource to query the troubleshooting result. - * - * @member {string} targetResourceId The target resource ID to query the - * troubleshooting result. - */ +*/ export interface QueryTroubleshootingParameters { + /** + * The target resource ID to query the troubleshooting result. + */ targetResourceId: string; } /** - * @class - * Initializes a new instance of the TroubleshootingRecommendedActions class. - * @constructor * Recommended actions based on discovered issues. - * - * @member {string} [actionId] ID of the recommended action. - * @member {string} [actionText] Description of recommended actions. - * @member {string} [actionUri] The uri linking to a documentation for the - * recommended troubleshooting actions. - * @member {string} [actionUriText] The information from the URI for the - * recommended troubleshooting actions. - */ +*/ export interface TroubleshootingRecommendedActions { + /** + * ID of the recommended action. + */ actionId?: string; + /** + * Description of recommended actions. + */ actionText?: string; + /** + * The uri linking to a documentation for the recommended troubleshooting actions. + */ actionUri?: string; + /** + * The information from the URI for the recommended troubleshooting actions. + */ actionUriText?: string; } /** - * @class - * Initializes a new instance of the TroubleshootingDetails class. - * @constructor * Information gained from troubleshooting of specified resource. - * - * @member {string} [id] The id of the get troubleshoot operation. - * @member {string} [reasonType] Reason type of failure. - * @member {string} [summary] A summary of troubleshooting. - * @member {string} [detail] Details on troubleshooting results. - * @member {array} [recommendedActions] List of recommended actions. - */ +*/ export interface TroubleshootingDetails { + /** + * The id of the get troubleshoot operation. + */ id?: string; + /** + * Reason type of failure. + */ reasonType?: string; + /** + * A summary of troubleshooting. + */ summary?: string; + /** + * Details on troubleshooting results. + */ detail?: string; + /** + * List of recommended actions. + */ recommendedActions?: TroubleshootingRecommendedActions[]; } /** - * @class - * Initializes a new instance of the TroubleshootingResult class. - * @constructor * Troubleshooting information gained from specified resource. - * - * @member {date} [startTime] The start time of the troubleshooting. - * @member {date} [endTime] The end time of the troubleshooting. - * @member {string} [code] The result code of the troubleshooting. - * @member {array} [results] Information from troubleshooting. - */ +*/ export interface TroubleshootingResult { + /** + * The start time of the troubleshooting. + */ startTime?: Date; + /** + * The end time of the troubleshooting. + */ endTime?: Date; + /** + * The result code of the troubleshooting. + */ code?: string; + /** + * Information from troubleshooting. + */ results?: TroubleshootingDetails[]; } /** - * @class - * Initializes a new instance of the RetentionPolicyParameters class. - * @constructor * Parameters that define the retention policy for flow log. - * - * @member {number} [days] Number of days to retain flow log records. Default - * value: 0 . - * @member {boolean} [enabled] Flag to enable/disable retention. Default value: - * false . - */ +*/ export interface RetentionPolicyParameters { + /** + * Number of days to retain flow log records. + */ days?: number; + /** + * Flag to enable/disable retention. + */ enabled?: boolean; } /** - * @class - * Initializes a new instance of the FlowLogStatusParameters class. - * @constructor - * Parameters that define a resource to query flow log and traffic analytics - * (optional) status. - * - * @member {string} targetResourceId The target resource where getting the flow - * log and traffic analytics (optional) status. - */ + * Parameters that define the flow log format. +*/ +export interface FlowLogFormatParameters { + /** + * The file type of flow log. Possible values include: 'JSON' + */ + type?: string; + /** + * The version (revision) of the flow log. + */ + version?: number; +} + +/** + * Parameters that define a resource to query flow log and traffic analytics (optional) status. +*/ export interface FlowLogStatusParameters { + /** + * The target resource where getting the flow log and traffic analytics (optional) status. + */ targetResourceId: string; } /** - * @class - * Initializes a new instance of the TrafficAnalyticsConfigurationProperties class. - * @constructor * Parameters that define the configuration of traffic analytics. - * - * @member {boolean} enabled Flag to enable/disable traffic analytics. - * @member {string} workspaceId The resource guid of the attached workspace - * @member {string} workspaceRegion The location of the attached workspace - * @member {string} workspaceResourceId Resource Id of the attached workspace - */ +*/ export interface TrafficAnalyticsConfigurationProperties { + /** + * Flag to enable/disable traffic analytics. + */ enabled: boolean; + /** + * The resource guid of the attached workspace + */ workspaceId: string; + /** + * The location of the attached workspace + */ workspaceRegion: string; + /** + * Resource Id of the attached workspace + */ workspaceResourceId: string; + /** + * The interval in minutes which would decide how frequently TA service should do flow analytics + */ + trafficAnalyticsInterval?: number; } /** - * @class - * Initializes a new instance of the TrafficAnalyticsProperties class. - * @constructor * Parameters that define the configuration of traffic analytics. - * - * @member {object} networkWatcherFlowAnalyticsConfiguration - * @member {boolean} [networkWatcherFlowAnalyticsConfiguration.enabled] Flag to - * enable/disable traffic analytics. - * @member {string} [networkWatcherFlowAnalyticsConfiguration.workspaceId] The - * resource guid of the attached workspace - * @member {string} [networkWatcherFlowAnalyticsConfiguration.workspaceRegion] - * The location of the attached workspace - * @member {string} - * [networkWatcherFlowAnalyticsConfiguration.workspaceResourceId] Resource Id - * of the attached workspace - */ +*/ export interface TrafficAnalyticsProperties { networkWatcherFlowAnalyticsConfiguration: TrafficAnalyticsConfigurationProperties; } /** - * @class - * Initializes a new instance of the FlowLogInformation class. - * @constructor - * Information on the configuration of flow log and traffic analytics - * (optional) . - * - * @member {string} targetResourceId The ID of the resource to configure for - * flow log and traffic analytics (optional) . - * @member {string} storageId ID of the storage account which is used to store - * the flow log. - * @member {boolean} enabled Flag to enable/disable flow logging. - * @member {object} [retentionPolicy] - * @member {number} [retentionPolicy.days] Number of days to retain flow log - * records. - * @member {boolean} [retentionPolicy.enabled] Flag to enable/disable - * retention. - * @member {object} [flowAnalyticsConfiguration] - * @member {object} - * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration] - * @member {boolean} - * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.enabled] - * Flag to enable/disable traffic analytics. - * @member {string} - * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceId] - * The resource guid of the attached workspace - * @member {string} - * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceRegion] - * The location of the attached workspace - * @member {string} - * [flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId] - * Resource Id of the attached workspace - */ + * Information on the configuration of flow log and traffic analytics (optional) . +*/ export interface FlowLogInformation { + /** + * The ID of the resource to configure for flow log and traffic analytics (optional) . + */ targetResourceId: string; + /** + * ID of the storage account which is used to store the flow log. + */ storageId: string; + /** + * Flag to enable/disable flow logging. + */ enabled: boolean; retentionPolicy?: RetentionPolicyParameters; + format?: FlowLogFormatParameters; flowAnalyticsConfiguration?: TrafficAnalyticsProperties; } /** - * @class - * Initializes a new instance of the ConnectivitySource class. - * @constructor * Parameters that define the source of the connection. - * - * @member {string} resourceId The ID of the resource from which a connectivity - * check will be initiated. - * @member {number} [port] The source port from which a connectivity check will - * be performed. - */ +*/ export interface ConnectivitySource { + /** + * The ID of the resource from which a connectivity check will be initiated. + */ resourceId: string; + /** + * The source port from which a connectivity check will be performed. + */ port?: number; } /** - * @class - * Initializes a new instance of the ConnectivityDestination class. - * @constructor * Parameters that define destination of connection. - * - * @member {string} [resourceId] The ID of the resource to which a connection - * attempt will be made. - * @member {string} [address] The IP address or URI the resource to which a - * connection attempt will be made. - * @member {number} [port] Port on which check connectivity will be performed. - */ +*/ export interface ConnectivityDestination { + /** + * The ID of the resource to which a connection attempt will be made. + */ resourceId?: string; + /** + * The IP address or URI the resource to which a connection attempt will be made. + */ address?: string; + /** + * Port on which check connectivity will be performed. + */ port?: number; } /** - * @class - * Initializes a new instance of the HTTPHeader class. - * @constructor * Describes the HTTP header. - * - * @member {string} [name] The name in HTTP header. - * @member {string} [value] The value in HTTP header. - */ +*/ export interface HTTPHeader { + /** + * The name in HTTP header. + */ name?: string; + /** + * The value in HTTP header. + */ value?: string; } /** - * @class - * Initializes a new instance of the HTTPConfiguration class. - * @constructor * HTTP configuration of the connectivity check. - * - * @member {string} [method] HTTP method. Possible values include: 'Get' - * @member {array} [headers] List of HTTP headers. - * @member {array} [validStatusCodes] Valid status codes. - */ +*/ export interface HTTPConfiguration { + /** + * HTTP method. Possible values include: 'Get' + */ method?: string; + /** + * List of HTTP headers. + */ headers?: HTTPHeader[]; + /** + * Valid status codes. + */ validStatusCodes?: number[]; } /** - * @class - * Initializes a new instance of the ProtocolConfiguration class. - * @constructor * Configuration of the protocol. - * - * @member {object} [hTTPConfiguration] - * @member {string} [hTTPConfiguration.method] HTTP method. Possible values - * include: 'Get' - * @member {array} [hTTPConfiguration.headers] List of HTTP headers. - * @member {array} [hTTPConfiguration.validStatusCodes] Valid status codes. - */ +*/ export interface ProtocolConfiguration { hTTPConfiguration?: HTTPConfiguration; } /** - * @class - * Initializes a new instance of the ConnectivityParameters class. - * @constructor * Parameters that determine how the connectivity check will be performed. - * - * @member {object} source - * @member {string} [source.resourceId] The ID of the resource from which a - * connectivity check will be initiated. - * @member {number} [source.port] The source port from which a connectivity - * check will be performed. - * @member {object} destination - * @member {string} [destination.resourceId] The ID of the resource to which a - * connection attempt will be made. - * @member {string} [destination.address] The IP address or URI the resource to - * which a connection attempt will be made. - * @member {number} [destination.port] Port on which check connectivity will be - * performed. - * @member {string} [protocol] Network protocol. Possible values include: - * 'Tcp', 'Http', 'Https', 'Icmp' - * @member {object} [protocolConfiguration] - * @member {object} [protocolConfiguration.hTTPConfiguration] - * @member {string} [protocolConfiguration.hTTPConfiguration.method] HTTP - * method. Possible values include: 'Get' - * @member {array} [protocolConfiguration.hTTPConfiguration.headers] List of - * HTTP headers. - * @member {array} [protocolConfiguration.hTTPConfiguration.validStatusCodes] - * Valid status codes. - */ +*/ export interface ConnectivityParameters { source: ConnectivitySource; destination: ConnectivityDestination; + /** + * Network protocol. Possible values include: 'Tcp', 'Http', 'Https', 'Icmp' + */ protocol?: string; protocolConfiguration?: ProtocolConfiguration; } /** - * @class - * Initializes a new instance of the ConnectivityIssue class. - * @constructor - * Information about an issue encountered in the process of checking for - * connectivity. - * - * @member {string} [origin] The origin of the issue. Possible values include: - * 'Local', 'Inbound', 'Outbound' - * @member {string} [severity] The severity of the issue. Possible values - * include: 'Error', 'Warning' - * @member {string} [type] The type of issue. Possible values include: - * 'Unknown', 'AgentStopped', 'GuestFirewall', 'DnsResolution', 'SocketBind', - * 'NetworkSecurityRule', 'UserDefinedRoute', 'PortThrottled', 'Platform' - * @member {array} [context] Provides additional context on the issue. - */ + * Information about an issue encountered in the process of checking for connectivity. +*/ export interface ConnectivityIssue { + /** + * The origin of the issue. Possible values include: 'Local', 'Inbound', 'Outbound' + */ readonly origin?: string; + /** + * The severity of the issue. Possible values include: 'Error', 'Warning' + */ readonly severity?: string; + /** + * The type of issue. Possible values include: 'Unknown', 'AgentStopped', 'GuestFirewall', + * 'DnsResolution', 'SocketBind', 'NetworkSecurityRule', 'UserDefinedRoute', 'PortThrottled', + * 'Platform' + */ readonly type?: string; + /** + * Provides additional context on the issue. + */ readonly context?: { [propertyName: string]: string }[]; } /** - * @class - * Initializes a new instance of the ConnectivityHop class. - * @constructor * Information about a hop between the source and the destination. - * - * @member {string} [type] The type of the hop. - * @member {string} [id] The ID of the hop. - * @member {string} [address] The IP address of the hop. - * @member {string} [resourceId] The ID of the resource corresponding to this - * hop. - * @member {array} [nextHopIds] List of next hop identifiers. - * @member {array} [issues] List of issues. - */ +*/ export interface ConnectivityHop { + /** + * The type of the hop. + */ readonly type?: string; + /** + * The ID of the hop. + */ readonly id?: string; + /** + * The IP address of the hop. + */ readonly address?: string; + /** + * The ID of the resource corresponding to this hop. + */ readonly resourceId?: string; + /** + * List of next hop identifiers. + */ readonly nextHopIds?: string[]; + /** + * List of issues. + */ readonly issues?: ConnectivityIssue[]; } /** - * @class - * Initializes a new instance of the ConnectivityInformation class. - * @constructor * Information on the connectivity status. - * - * @member {array} [hops] List of hops between the source and the destination. - * @member {string} [connectionStatus] The connection status. Possible values - * include: 'Unknown', 'Connected', 'Disconnected', 'Degraded' - * @member {number} [avgLatencyInMs] Average latency in milliseconds. - * @member {number} [minLatencyInMs] Minimum latency in milliseconds. - * @member {number} [maxLatencyInMs] Maximum latency in milliseconds. - * @member {number} [probesSent] Total number of probes sent. - * @member {number} [probesFailed] Number of failed probes. - */ +*/ export interface ConnectivityInformation { + /** + * List of hops between the source and the destination. + */ readonly hops?: ConnectivityHop[]; + /** + * The connection status. Possible values include: 'Unknown', 'Connected', 'Disconnected', + * 'Degraded' + */ readonly connectionStatus?: string; + /** + * Average latency in milliseconds. + */ readonly avgLatencyInMs?: number; + /** + * Minimum latency in milliseconds. + */ readonly minLatencyInMs?: number; + /** + * Maximum latency in milliseconds. + */ readonly maxLatencyInMs?: number; + /** + * Total number of probes sent. + */ readonly probesSent?: number; + /** + * Number of failed probes. + */ readonly probesFailed?: number; } /** - * @class - * Initializes a new instance of the AzureReachabilityReportLocation class. - * @constructor * Parameters that define a geographic location. - * - * @member {string} country The name of the country. - * @member {string} [state] The name of the state. - * @member {string} [city] The name of the city or town. - */ +*/ export interface AzureReachabilityReportLocation { + /** + * The name of the country. + */ country: string; + /** + * The name of the state. + */ state?: string; + /** + * The name of the city or town. + */ city?: string; } /** - * @class - * Initializes a new instance of the AzureReachabilityReportParameters class. - * @constructor * Geographic and time constraints for Azure reachability report. - * - * @member {object} providerLocation - * @member {string} [providerLocation.country] The name of the country. - * @member {string} [providerLocation.state] The name of the state. - * @member {string} [providerLocation.city] The name of the city or town. - * @member {array} [providers] List of Internet service providers. - * @member {array} [azureLocations] Optional Azure regions to scope the query - * to. - * @member {date} startTime The start time for the Azure reachability report. - * @member {date} endTime The end time for the Azure reachability report. - */ +*/ export interface AzureReachabilityReportParameters { providerLocation: AzureReachabilityReportLocation; + /** + * List of Internet service providers. + */ providers?: string[]; + /** + * Optional Azure regions to scope the query to. + */ azureLocations?: string[]; + /** + * The start time for the Azure reachability report. + */ startTime: Date; + /** + * The end time for the Azure reachability report. + */ endTime: Date; } /** - * @class - * Initializes a new instance of the AzureReachabilityReportLatencyInfo class. - * @constructor * Details on latency for a time series. - * - * @member {date} [timeStamp] The time stamp. - * @member {number} [score] The relative latency score between 1 and 100, - * higher values indicating a faster connection. - */ +*/ export interface AzureReachabilityReportLatencyInfo { + /** + * The time stamp. + */ timeStamp?: Date; + /** + * The relative latency score between 1 and 100, higher values indicating a faster connection. + */ score?: number; } /** - * @class - * Initializes a new instance of the AzureReachabilityReportItem class. - * @constructor * Azure reachability report details for a given provider location. - * - * @member {string} [provider] The Internet service provider. - * @member {string} [azureLocation] The Azure region. - * @member {array} [latencies] List of latency details for each of the time - * series. - */ +*/ export interface AzureReachabilityReportItem { + /** + * The Internet service provider. + */ provider?: string; + /** + * The Azure region. + */ azureLocation?: string; + /** + * List of latency details for each of the time series. + */ latencies?: AzureReachabilityReportLatencyInfo[]; } /** - * @class - * Initializes a new instance of the AzureReachabilityReport class. - * @constructor * Azure reachability report details. - * - * @member {string} aggregationLevel The aggregation level of Azure - * reachability report. Can be Country, State or City. - * @member {object} providerLocation - * @member {string} [providerLocation.country] The name of the country. - * @member {string} [providerLocation.state] The name of the state. - * @member {string} [providerLocation.city] The name of the city or town. - * @member {array} reachabilityReport List of Azure reachability report items. - */ +*/ export interface AzureReachabilityReport { + /** + * The aggregation level of Azure reachability report. Can be Country, State or City. + */ aggregationLevel: string; providerLocation: AzureReachabilityReportLocation; + /** + * List of Azure reachability report items. + */ reachabilityReport: AzureReachabilityReportItem[]; } /** - * @class - * Initializes a new instance of the AvailableProvidersListParameters class. - * @constructor * Constraints that determine the list of available Internet service providers. - * - * @member {array} [azureLocations] A list of Azure regions. - * @member {string} [country] The country for available providers list. - * @member {string} [state] The state for available providers list. - * @member {string} [city] The city or town for available providers list. - */ +*/ export interface AvailableProvidersListParameters { + /** + * A list of Azure regions. + */ azureLocations?: string[]; + /** + * The country for available providers list. + */ country?: string; + /** + * The state for available providers list. + */ state?: string; + /** + * The city or town for available providers list. + */ city?: string; } /** - * @class - * Initializes a new instance of the AvailableProvidersListCity class. - * @constructor * City or town details. - * - * @member {string} [cityName] The city or town name. - * @member {array} [providers] A list of Internet service providers. - */ +*/ export interface AvailableProvidersListCity { + /** + * The city or town name. + */ cityName?: string; + /** + * A list of Internet service providers. + */ providers?: string[]; } /** - * @class - * Initializes a new instance of the AvailableProvidersListState class. - * @constructor * State details. - * - * @member {string} [stateName] The state name. - * @member {array} [providers] A list of Internet service providers. - * @member {array} [cities] List of available cities or towns in the state. - */ +*/ export interface AvailableProvidersListState { + /** + * The state name. + */ stateName?: string; + /** + * A list of Internet service providers. + */ providers?: string[]; + /** + * List of available cities or towns in the state. + */ cities?: AvailableProvidersListCity[]; } /** - * @class - * Initializes a new instance of the AvailableProvidersListCountry class. - * @constructor * Country details. - * - * @member {string} [countryName] The country name. - * @member {array} [providers] A list of Internet service providers. - * @member {array} [states] List of available states in the country. - */ +*/ export interface AvailableProvidersListCountry { + /** + * The country name. + */ countryName?: string; + /** + * A list of Internet service providers. + */ providers?: string[]; + /** + * List of available states in the country. + */ states?: AvailableProvidersListState[]; } /** - * @class - * Initializes a new instance of the AvailableProvidersList class. - * @constructor * List of available countries with details. - * - * @member {array} countries List of available countries. - */ +*/ export interface AvailableProvidersList { + /** + * List of available countries. + */ countries: AvailableProvidersListCountry[]; } /** - * @class - * Initializes a new instance of the ConnectionMonitorSource class. - * @constructor * Describes the source of connection monitor. - * - * @member {string} resourceId The ID of the resource used as the source by - * connection monitor. - * @member {number} [port] The source port used by connection monitor. - */ +*/ export interface ConnectionMonitorSource { + /** + * The ID of the resource used as the source by connection monitor. + */ resourceId: string; + /** + * The source port used by connection monitor. + */ port?: number; } /** - * @class - * Initializes a new instance of the ConnectionMonitorDestination class. - * @constructor * Describes the destination of connection monitor. - * - * @member {string} [resourceId] The ID of the resource used as the destination - * by connection monitor. - * @member {string} [address] Address of the connection monitor destination (IP - * or domain name). - * @member {number} [port] The destination port used by connection monitor. - */ +*/ export interface ConnectionMonitorDestination { + /** + * The ID of the resource used as the destination by connection monitor. + */ resourceId?: string; + /** + * Address of the connection monitor destination (IP or domain name). + */ address?: string; + /** + * The destination port used by connection monitor. + */ port?: number; } /** - * @class - * Initializes a new instance of the ConnectionMonitorParameters class. - * @constructor * Parameters that define the operation to create a connection monitor. - * - * @member {object} source - * @member {string} [source.resourceId] The ID of the resource used as the - * source by connection monitor. - * @member {number} [source.port] The source port used by connection monitor. - * @member {object} destination - * @member {string} [destination.resourceId] The ID of the resource used as the - * destination by connection monitor. - * @member {string} [destination.address] Address of the connection monitor - * destination (IP or domain name). - * @member {number} [destination.port] The destination port used by connection - * monitor. - * @member {boolean} [autoStart] Determines if the connection monitor will - * start automatically once created. Default value: true . - * @member {number} [monitoringIntervalInSeconds] Monitoring interval in - * seconds. Default value: 60 . - */ +*/ export interface ConnectionMonitorParameters { source: ConnectionMonitorSource; destination: ConnectionMonitorDestination; + /** + * Determines if the connection monitor will start automatically once created. + */ autoStart?: boolean; + /** + * Monitoring interval in seconds. + */ monitoringIntervalInSeconds?: number; } /** - * @class - * Initializes a new instance of the ConnectionMonitor class. - * @constructor * Parameters that define the operation to create a connection monitor. - * - * @member {string} [location] Connection monitor location. - * @member {object} [tags] Connection monitor tags. - * @member {object} source - * @member {string} [source.resourceId] The ID of the resource used as the - * source by connection monitor. - * @member {number} [source.port] The source port used by connection monitor. - * @member {object} destination - * @member {string} [destination.resourceId] The ID of the resource used as the - * destination by connection monitor. - * @member {string} [destination.address] Address of the connection monitor - * destination (IP or domain name). - * @member {number} [destination.port] The destination port used by connection - * monitor. - * @member {boolean} [autoStart] Determines if the connection monitor will - * start automatically once created. Default value: true . - * @member {number} [monitoringIntervalInSeconds] Monitoring interval in - * seconds. Default value: 60 . - */ +*/ export interface ConnectionMonitor { + /** + * Connection monitor location. + */ location?: string; + /** + * Connection monitor tags. + */ tags?: { [propertyName: string]: string }; source: ConnectionMonitorSource; destination: ConnectionMonitorDestination; + /** + * Determines if the connection monitor will start automatically once created. + */ autoStart?: boolean; + /** + * Monitoring interval in seconds. + */ monitoringIntervalInSeconds?: number; } /** - * @class - * Initializes a new instance of the ConnectionMonitorResult class. - * @constructor * Information about the connection monitor. - * - * @member {string} [name] Name of the connection monitor. - * @member {string} [id] ID of the connection monitor. - * @member {string} [etag] Default value: 'A unique read-only string that - * changes whenever the resource is updated.' . - * @member {string} [type] Connection monitor type. - * @member {string} [location] Connection monitor location. - * @member {object} [tags] Connection monitor tags. - * @member {object} source - * @member {string} [source.resourceId] The ID of the resource used as the - * source by connection monitor. - * @member {number} [source.port] The source port used by connection monitor. - * @member {object} destination - * @member {string} [destination.resourceId] The ID of the resource used as the - * destination by connection monitor. - * @member {string} [destination.address] Address of the connection monitor - * destination (IP or domain name). - * @member {number} [destination.port] The destination port used by connection - * monitor. - * @member {boolean} [autoStart] Determines if the connection monitor will - * start automatically once created. Default value: true . - * @member {number} [monitoringIntervalInSeconds] Monitoring interval in - * seconds. Default value: 60 . - * @member {string} [provisioningState] The provisioning state of the - * connection monitor. Possible values include: 'Succeeded', 'Updating', - * 'Deleting', 'Failed' - * @member {date} [startTime] The date and time when the connection monitor was - * started. - * @member {string} [monitoringStatus] The monitoring status of the connection - * monitor. - */ +*/ export interface ConnectionMonitorResult extends BaseResource { + /** + * Name of the connection monitor. + */ readonly name?: string; + /** + * ID of the connection monitor. + */ readonly id?: string; etag?: string; + /** + * Connection monitor type. + */ readonly type?: string; + /** + * Connection monitor location. + */ location?: string; + /** + * Connection monitor tags. + */ tags?: { [propertyName: string]: string }; source: ConnectionMonitorSource; destination: ConnectionMonitorDestination; + /** + * Determines if the connection monitor will start automatically once created. + */ autoStart?: boolean; + /** + * Monitoring interval in seconds. + */ monitoringIntervalInSeconds?: number; + /** + * The provisioning state of the connection monitor. Possible values include: 'Succeeded', + * 'Updating', 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * The date and time when the connection monitor was started. + */ startTime?: Date; + /** + * The monitoring status of the connection monitor. + */ monitoringStatus?: string; } /** - * @class - * Initializes a new instance of the ConnectionStateSnapshot class. - * @constructor * Connection state snapshot. - * - * @member {string} [connectionState] The connection state. Possible values - * include: 'Reachable', 'Unreachable', 'Unknown' - * @member {date} [startTime] The start time of the connection snapshot. - * @member {date} [endTime] The end time of the connection snapshot. - * @member {string} [evaluationState] Connectivity analysis evaluation state. - * Possible values include: 'NotStarted', 'InProgress', 'Completed' - * @member {number} [avgLatencyInMs] Average latency in ms. - * @member {number} [minLatencyInMs] Minimum latency in ms. - * @member {number} [maxLatencyInMs] Maximum latency in ms. - * @member {number} [probesSent] The number of sent probes. - * @member {number} [probesFailed] The number of failed probes. - * @member {array} [hops] List of hops between the source and the destination. - */ +*/ export interface ConnectionStateSnapshot { + /** + * The connection state. Possible values include: 'Reachable', 'Unreachable', 'Unknown' + */ connectionState?: string; + /** + * The start time of the connection snapshot. + */ startTime?: Date; + /** + * The end time of the connection snapshot. + */ endTime?: Date; + /** + * Connectivity analysis evaluation state. Possible values include: 'NotStarted', 'InProgress', + * 'Completed' + */ evaluationState?: string; + /** + * Average latency in ms. + */ avgLatencyInMs?: number; + /** + * Minimum latency in ms. + */ minLatencyInMs?: number; + /** + * Maximum latency in ms. + */ maxLatencyInMs?: number; + /** + * The number of sent probes. + */ probesSent?: number; + /** + * The number of failed probes. + */ probesFailed?: number; + /** + * List of hops between the source and the destination. + */ readonly hops?: ConnectivityHop[]; } /** - * @class - * Initializes a new instance of the ConnectionMonitorQueryResult class. - * @constructor * List of connection states snaphots. - * - * @member {string} [sourceStatus] Status of connection monitor source. - * Possible values include: 'Uknown', 'Active', 'Inactive' - * @member {array} [states] Information about connection states. - */ +*/ export interface ConnectionMonitorQueryResult { + /** + * Status of connection monitor source. Possible values include: 'Uknown', 'Active', 'Inactive' + */ sourceStatus?: string; + /** + * Information about connection states. + */ states?: ConnectionStateSnapshot[]; } /** - * @class - * Initializes a new instance of the NetworkConfigurationDiagnosticProfile class. - * @constructor * Parameters to compare with network configuration. - * - * @member {string} direction The direction of the traffic. Accepted values are - * 'Inbound' and 'Outbound'. Possible values include: 'Inbound', 'Outbound' - * @member {string} protocol Protocol to be verified on. Accepted values are - * '*', TCP, UDP. - * @member {string} source Traffic source. Accepted values are '*', IP - * Address/CIDR, Service Tag. - * @member {string} destination Traffic destination. Accepted values are: '*', - * IP Address/CIDR, Service Tag. - * @member {string} destinationPort Traffice destination port. Accepted values - * are '*', port (for example, 3389) and port range (for example, 80-100). - */ +*/ export interface NetworkConfigurationDiagnosticProfile { + /** + * The direction of the traffic. Accepted values are 'Inbound' and 'Outbound'. Possible values + * include: 'Inbound', 'Outbound' + */ direction: string; + /** + * Protocol to be verified on. Accepted values are '*', TCP, UDP. + */ protocol: string; + /** + * Traffic source. Accepted values are '*', IP Address/CIDR, Service Tag. + */ source: string; + /** + * Traffic destination. Accepted values are: '*', IP Address/CIDR, Service Tag. + */ destination: string; + /** + * Traffice destination port. Accepted values are '*', port (for example, 3389) and port range + * (for example, 80-100). + */ destinationPort: string; } /** - * @class - * Initializes a new instance of the NetworkConfigurationDiagnosticParameters class. - * @constructor * Parameters to get network configuration diagnostic. - * - * @member {string} targetResourceId The ID of the target resource to perform - * network configuration diagnostic. Valid options are VM, NetworkInterface, - * VMSS/NetworkInterface and Application Gateway. - * @member {string} [verbosityLevel] Verbosity level. Accepted values are - * 'Normal', 'Minimum', 'Full'. Possible values include: 'Normal', 'Minimum', - * 'Full' - * @member {array} profiles List of network configuration diagnostic profiles. - */ +*/ export interface NetworkConfigurationDiagnosticParameters { + /** + * The ID of the target resource to perform network configuration diagnostic. Valid options are + * VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway. + */ targetResourceId: string; + /** + * Verbosity level. Accepted values are 'Normal', 'Minimum', 'Full'. Possible values include: + * 'Normal', 'Minimum', 'Full' + */ verbosityLevel?: string; + /** + * List of network configuration diagnostic profiles. + */ profiles: NetworkConfigurationDiagnosticProfile[]; } /** - * @class - * Initializes a new instance of the MatchedRule class. - * @constructor * Matched rule. - * - * @member {string} [ruleName] Name of the matched network security rule. - * @member {string} [action] The network traffic is allowed or denied. Possible - * values are 'Allow' and 'Deny'. - */ +*/ export interface MatchedRule { + /** + * Name of the matched network security rule. + */ ruleName?: string; + /** + * The network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. + */ action?: string; } /** - * @class - * Initializes a new instance of the NetworkSecurityRulesEvaluationResult class. - * @constructor * Network security rules evaluation result. - * - * @member {string} [name] Name of the network security rule. - * @member {boolean} [protocolMatched] Value indicating whether protocol is - * matched. - * @member {boolean} [sourceMatched] Value indicating whether source is - * matched. - * @member {boolean} [sourcePortMatched] Value indicating whether source port - * is matched. - * @member {boolean} [destinationMatched] Value indicating whether destination - * is matched. - * @member {boolean} [destinationPortMatched] Value indicating whether - * destination port is matched. - */ +*/ export interface NetworkSecurityRulesEvaluationResult { + /** + * Name of the network security rule. + */ name?: string; + /** + * Value indicating whether protocol is matched. + */ protocolMatched?: boolean; + /** + * Value indicating whether source is matched. + */ sourceMatched?: boolean; + /** + * Value indicating whether source port is matched. + */ sourcePortMatched?: boolean; + /** + * Value indicating whether destination is matched. + */ destinationMatched?: boolean; + /** + * Value indicating whether destination port is matched. + */ destinationPortMatched?: boolean; } /** - * @class - * Initializes a new instance of the EvaluatedNetworkSecurityGroup class. - * @constructor * Results of network security group evaluation. - * - * @member {string} [networkSecurityGroupId] Network security group ID. - * @member {string} [appliedTo] Resource ID of nic or subnet to which network - * security group is applied. - * @member {object} [matchedRule] - * @member {string} [matchedRule.ruleName] Name of the matched network security - * rule. - * @member {string} [matchedRule.action] The network traffic is allowed or - * denied. Possible values are 'Allow' and 'Deny'. - * @member {array} [rulesEvaluationResult] List of network security rules - * evaluation results. - */ +*/ export interface EvaluatedNetworkSecurityGroup { + /** + * Network security group ID. + */ networkSecurityGroupId?: string; + /** + * Resource ID of nic or subnet to which network security group is applied. + */ appliedTo?: string; matchedRule?: MatchedRule; + /** + * List of network security rules evaluation results. + */ readonly rulesEvaluationResult?: NetworkSecurityRulesEvaluationResult[]; } /** - * @class - * Initializes a new instance of the NetworkSecurityGroupResult class. - * @constructor * Network configuration diagnostic result corresponded provided traffic query. - * - * @member {string} [securityRuleAccessResult] The network traffic is allowed - * or denied. Possible values are 'Allow' and 'Deny'. Possible values include: - * 'Allow', 'Deny' - * @member {array} [evaluatedNetworkSecurityGroups] List of results network - * security groups diagnostic. - */ +*/ export interface NetworkSecurityGroupResult { + /** + * The network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. Possible + * values include: 'Allow', 'Deny' + */ securityRuleAccessResult?: string; + /** + * List of results network security groups diagnostic. + */ readonly evaluatedNetworkSecurityGroups?: EvaluatedNetworkSecurityGroup[]; } /** - * @class - * Initializes a new instance of the NetworkConfigurationDiagnosticResult class. - * @constructor - * Network configuration diagnostic result corresponded to provided traffic - * query. - * - * @member {object} [profile] - * @member {string} [profile.direction] The direction of the traffic. Accepted - * values are 'Inbound' and 'Outbound'. Possible values include: 'Inbound', - * 'Outbound' - * @member {string} [profile.protocol] Protocol to be verified on. Accepted - * values are '*', TCP, UDP. - * @member {string} [profile.source] Traffic source. Accepted values are '*', - * IP Address/CIDR, Service Tag. - * @member {string} [profile.destination] Traffic destination. Accepted values - * are: '*', IP Address/CIDR, Service Tag. - * @member {string} [profile.destinationPort] Traffice destination port. - * Accepted values are '*', port (for example, 3389) and port range (for - * example, 80-100). - * @member {object} [networkSecurityGroupResult] - * @member {string} [networkSecurityGroupResult.securityRuleAccessResult] The - * network traffic is allowed or denied. Possible values are 'Allow' and - * 'Deny'. Possible values include: 'Allow', 'Deny' - * @member {array} [networkSecurityGroupResult.evaluatedNetworkSecurityGroups] - * List of results network security groups diagnostic. - */ + * Network configuration diagnostic result corresponded to provided traffic query. +*/ export interface NetworkConfigurationDiagnosticResult { profile?: NetworkConfigurationDiagnosticProfile; networkSecurityGroupResult?: NetworkSecurityGroupResult; } /** - * @class - * Initializes a new instance of the NetworkConfigurationDiagnosticResponse class. - * @constructor * Results of network configuration diagnostic on the target resource. - * - * @member {array} [results] List of network configuration diagnostic results. - */ +*/ export interface NetworkConfigurationDiagnosticResponse { + /** + * List of network configuration diagnostic results. + */ readonly results?: NetworkConfigurationDiagnosticResult[]; } /** - * @class - * Initializes a new instance of the OperationDisplay class. - * @constructor * Display metadata associated with the operation. - * - * @member {string} [provider] Service provider: Microsoft Network. - * @member {string} [resource] Resource on which the operation is performed. - * @member {string} [operation] Type of the operation: get, read, delete, etc. - * @member {string} [description] Description of the operation. - */ +*/ export interface OperationDisplay { + /** + * Service provider: Microsoft Network. + */ provider?: string; + /** + * Resource on which the operation is performed. + */ resource?: string; + /** + * Type of the operation: get, read, delete, etc. + */ operation?: string; + /** + * Description of the operation. + */ description?: string; } /** - * @class - * Initializes a new instance of the Availability class. - * @constructor * Availability of the metric. - * - * @member {string} [timeGrain] The time grain of the availability. - * @member {string} [retention] The retention of the availability. - * @member {string} [blobDuration] Duration of the availability blob. - */ +*/ export interface Availability { + /** + * The time grain of the availability. + */ timeGrain?: string; + /** + * The retention of the availability. + */ retention?: string; + /** + * Duration of the availability blob. + */ blobDuration?: string; } /** - * @class - * Initializes a new instance of the Dimension class. - * @constructor * Dimension of the metric. - * - * @member {string} [name] The name of the dimension. - * @member {string} [displayName] The display name of the dimension. - * @member {string} [internalName] The internal name of the dimension. - */ +*/ export interface Dimension { + /** + * The name of the dimension. + */ name?: string; + /** + * The display name of the dimension. + */ displayName?: string; + /** + * The internal name of the dimension. + */ internalName?: string; } /** - * @class - * Initializes a new instance of the MetricSpecification class. - * @constructor * Description of metrics specification. - * - * @member {string} [name] The name of the metric. - * @member {string} [displayName] The display name of the metric. - * @member {string} [displayDescription] The description of the metric. - * @member {string} [unit] Units the metric to be displayed in. - * @member {string} [aggregationType] The aggregation type. - * @member {array} [availabilities] List of availability. - * @member {boolean} [enableRegionalMdmAccount] Whether regional MDM account - * enabled. - * @member {boolean} [fillGapWithZero] Whether gaps would be filled with zeros. - * @member {string} [metricFilterPattern] Pattern for the filter of the metric. - * @member {array} [dimensions] List of dimensions. - * @member {boolean} [isInternal] Whether the metric is internal. - * @member {string} [sourceMdmAccount] The source MDM account. - * @member {string} [sourceMdmNamespace] The source MDM namespace. - * @member {string} [resourceIdDimensionNameOverride] The resource Id dimension - * name override. - */ +*/ export interface MetricSpecification { + /** + * The name of the metric. + */ name?: string; + /** + * The display name of the metric. + */ displayName?: string; + /** + * The description of the metric. + */ displayDescription?: string; + /** + * Units the metric to be displayed in. + */ unit?: string; + /** + * The aggregation type. + */ aggregationType?: string; + /** + * List of availability. + */ availabilities?: Availability[]; + /** + * Whether regional MDM account enabled. + */ enableRegionalMdmAccount?: boolean; + /** + * Whether gaps would be filled with zeros. + */ fillGapWithZero?: boolean; + /** + * Pattern for the filter of the metric. + */ metricFilterPattern?: string; + /** + * List of dimensions. + */ dimensions?: Dimension[]; + /** + * Whether the metric is internal. + */ isInternal?: boolean; + /** + * The source MDM account. + */ sourceMdmAccount?: string; + /** + * The source MDM namespace. + */ sourceMdmNamespace?: string; + /** + * The resource Id dimension name override. + */ resourceIdDimensionNameOverride?: string; } /** - * @class - * Initializes a new instance of the LogSpecification class. - * @constructor * Description of logging specification. - * - * @member {string} [name] The name of the specification. - * @member {string} [displayName] The display name of the specification. - * @member {string} [blobDuration] Duration of the blob. - */ +*/ export interface LogSpecification { + /** + * The name of the specification. + */ name?: string; + /** + * The display name of the specification. + */ displayName?: string; + /** + * Duration of the blob. + */ blobDuration?: string; } /** - * @class - * Initializes a new instance of the OperationPropertiesFormatServiceSpecification class. - * @constructor * Specification of the service. - * - * @member {array} [metricSpecifications] Operation service specification. - * @member {array} [logSpecifications] Operation log specification. - */ +*/ export interface OperationPropertiesFormatServiceSpecification { + /** + * Operation service specification. + */ metricSpecifications?: MetricSpecification[]; + /** + * Operation log specification. + */ logSpecifications?: LogSpecification[]; } /** - * @class - * Initializes a new instance of the Operation class. - * @constructor * Network REST API operation definition. - * - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] Display metadata associated with the operation. - * @member {string} [display.provider] Service provider: Microsoft Network. - * @member {string} [display.resource] Resource on which the operation is - * performed. - * @member {string} [display.operation] Type of the operation: get, read, - * delete, etc. - * @member {string} [display.description] Description of the operation. - * @member {string} [origin] Origin of the operation. - * @member {object} [serviceSpecification] Specification of the service. - * @member {array} [serviceSpecification.metricSpecifications] Operation - * service specification. - * @member {array} [serviceSpecification.logSpecifications] Operation log - * specification. - */ +*/ export interface Operation { + /** + * Operation name: {provider}/{resource}/{operation} + */ name?: string; + /** + * Display metadata associated with the operation. + */ display?: OperationDisplay; + /** + * Origin of the operation. + */ origin?: string; + /** + * Specification of the service. + */ serviceSpecification?: OperationPropertiesFormatServiceSpecification; } /** - * @class - * Initializes a new instance of the PublicIPPrefixSku class. - * @constructor * SKU of a public IP prefix - * - * @member {string} [name] Name of a public IP prefix SKU. Possible values - * include: 'Standard' - */ +*/ export interface PublicIPPrefixSku { + /** + * Name of a public IP prefix SKU. Possible values include: 'Standard' + */ name?: string; } -/** - * @class - * Initializes a new instance of the ReferencedPublicIpAddress class. - * @constructor - * @member {string} [id] The PublicIPAddress Reference - */ export interface ReferencedPublicIpAddress { + /** + * The PublicIPAddress Reference + */ id?: string; } /** - * @class - * Initializes a new instance of the PublicIPPrefix class. - * @constructor * Public IP prefix resource. - * - * @member {object} [sku] The public IP prefix SKU. - * @member {string} [sku.name] Name of a public IP prefix SKU. Possible values - * include: 'Standard' - * @member {string} [publicIPAddressVersion] The public IP address version. - * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', - * 'IPv6' - * @member {array} [ipTags] The list of tags associated with the public IP - * prefix. - * @member {number} [prefixLength] The Length of the Public IP Prefix. - * @member {string} [ipPrefix] The allocated Prefix - * @member {array} [publicIPAddresses] The list of all referenced - * PublicIPAddresses - * @member {string} [resourceGuid] The resource GUID property of the public IP - * prefix resource. - * @member {string} [provisioningState] The provisioning state of the Public IP - * prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {array} [zones] A list of availability zones denoting the IP - * allocated for the resource needs to come from. - */ +*/ export interface PublicIPPrefix extends Resource { + /** + * The public IP prefix SKU. + */ sku?: PublicIPPrefixSku; + /** + * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. Possible values + * include: 'IPv4', 'IPv6' + */ publicIPAddressVersion?: string; + /** + * The list of tags associated with the public IP prefix. + */ ipTags?: IpTag[]; + /** + * The Length of the Public IP Prefix. + */ prefixLength?: number; + /** + * The allocated Prefix + */ ipPrefix?: string; + /** + * The list of all referenced PublicIPAddresses + */ publicIPAddresses?: ReferencedPublicIpAddress[]; + /** + * The resource GUID property of the public IP prefix resource. + */ resourceGuid?: string; + /** + * The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ provisioningState?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; + /** + * A list of availability zones denoting the IP allocated for the resource needs to come from. + */ zones?: string[]; } /** - * @class - * Initializes a new instance of the PatchRouteFilterRule class. - * @constructor * Route Filter Rule Resource - * - * @member {string} access The access type of the rule. Valid values are: - * 'Allow', 'Deny'. Possible values include: 'Allow', 'Deny' - * @member {array} communities The collection for bgp community values to - * filter on. e.g. ['12076:5010','12076:5020'] - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface PatchRouteFilterRule extends SubResource { + /** + * The access type of the rule. Valid values are: 'Allow', 'Deny'. Possible values include: + * 'Allow', 'Deny' + */ access: string; + /** + * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] + */ communities: string[]; + /** + * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', + * 'Succeeded' and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ readonly name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the PatchRouteFilter class. - * @constructor * Route Filter Resource. - * - * @member {array} [rules] Collection of RouteFilterRules contained within a - * route filter. - * @member {array} [peerings] A collection of references to express route - * circuit peerings. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - * @member {string} [type] Resource type. - * @member {object} [tags] Resource tags. - */ +*/ export interface PatchRouteFilter extends SubResource { + /** + * Collection of RouteFilterRules contained within a route filter. + */ rules?: RouteFilterRule[]; + /** + * A collection of references to express route circuit peerings. + */ peerings?: ExpressRouteCircuitPeering[]; + /** + * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', + * 'Succeeded' and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ readonly name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; + /** + * Resource type. + */ readonly type?: string; + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the BGPCommunity class. - * @constructor * Contains bgp community information offered in Service Community resources. - * - * @member {string} [serviceSupportedRegion] The region which the service - * support. e.g. For O365, region is Global. - * @member {string} [communityName] The name of the bgp community. e.g. Skype. - * @member {string} [communityValue] The value of the bgp community. For more - * information: - * https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing. - * @member {array} [communityPrefixes] The prefixes that the bgp community - * contains. - * @member {boolean} [isAuthorizedToUse] Customer is authorized to use bgp - * community or not. - * @member {string} [serviceGroup] The service group of the bgp community - * contains. - */ +*/ export interface BGPCommunity { + /** + * The region which the service support. e.g. For O365, region is Global. + */ serviceSupportedRegion?: string; + /** + * The name of the bgp community. e.g. Skype. + */ communityName?: string; + /** + * The value of the bgp community. For more information: + * https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing. + */ communityValue?: string; + /** + * The prefixes that the bgp community contains. + */ communityPrefixes?: string[]; + /** + * Customer is authorized to use bgp community or not. + */ isAuthorizedToUse?: boolean; + /** + * The service group of the bgp community contains. + */ serviceGroup?: string; } /** - * @class - * Initializes a new instance of the BgpServiceCommunity class. - * @constructor * Service Community Properties. - * - * @member {string} [serviceName] The name of the bgp community. e.g. Skype. - * @member {array} [bgpCommunities] Get a list of bgp communities. - */ +*/ export interface BgpServiceCommunity extends Resource { + /** + * The name of the bgp community. e.g. Skype. + */ serviceName?: string; + /** + * Get a list of bgp communities. + */ bgpCommunities?: BGPCommunity[]; } /** - * @class - * Initializes a new instance of the UsageName class. - * @constructor * The usage names. - * - * @member {string} [value] A string describing the resource name. - * @member {string} [localizedValue] A localized string describing the resource - * name. - */ +*/ export interface UsageName { + /** + * A string describing the resource name. + */ value?: string; + /** + * A localized string describing the resource name. + */ localizedValue?: string; } /** - * @class - * Initializes a new instance of the Usage class. - * @constructor * Describes network resource usage. - * - * @member {string} [id] Resource identifier. - * @member {number} currentValue The current value of the usage. - * @member {number} limit The limit of usage. - * @member {object} name The name of the type of usage. - * @member {string} [name.value] A string describing the resource name. - * @member {string} [name.localizedValue] A localized string describing the - * resource name. - */ +*/ export interface Usage { + /** + * Resource identifier. + */ readonly id?: string; + /** + * The current value of the usage. + */ currentValue: number; + /** + * The limit of usage. + */ limit: number; + /** + * The name of the type of usage. + */ name: UsageName; } /** - * @class - * Initializes a new instance of the AddressSpace class. - * @constructor - * AddressSpace contains an array of IP address ranges that can be used by - * subnets of the virtual network. - * - * @member {array} [addressPrefixes] A list of address blocks reserved for this - * virtual network in CIDR notation. - */ + * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual + * network. +*/ export interface AddressSpace { + /** + * A list of address blocks reserved for this virtual network in CIDR notation. + */ addressPrefixes?: string[]; } /** - * @class - * Initializes a new instance of the VirtualNetworkPeering class. - * @constructor * Peerings in a virtual network resource. - * - * @member {boolean} [allowVirtualNetworkAccess] Whether the VMs in the linked - * virtual network space would be able to access all the VMs in local Virtual - * network space. - * @member {boolean} [allowForwardedTraffic] Whether the forwarded traffic from - * the VMs in the remote virtual network will be allowed/disallowed. - * @member {boolean} [allowGatewayTransit] If gateway links can be used in - * remote virtual networking to link to this virtual network. - * @member {boolean} [useRemoteGateways] If remote gateways can be used on this - * virtual network. If the flag is set to true, and allowGatewayTransit on - * remote peering is also true, virtual network will use gateways of remote - * virtual network for transit. Only one peering can have this flag set to - * true. This flag cannot be set if virtual network already has a gateway. - * @member {object} [remoteVirtualNetwork] The reference of the remote virtual - * network. The remote virtual network can be in the same or different region - * (preview). See here to register for the preview and learn more - * (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). - * @member {string} [remoteVirtualNetwork.id] Resource ID. - * @member {object} [remoteAddressSpace] The reference of the remote virtual - * network address space. - * @member {array} [remoteAddressSpace.addressPrefixes] A list of address - * blocks reserved for this virtual network in CIDR notation. - * @member {string} [peeringState] The status of the virtual network peering. - * Possible values are 'Initiated', 'Connected', and 'Disconnected'. Possible - * values include: 'Initiated', 'Connected', 'Disconnected' - * @member {string} [provisioningState] The provisioning state of the resource. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface VirtualNetworkPeering extends SubResource { + /** + * Whether the VMs in the linked virtual network space would be able to access all the VMs in + * local Virtual network space. + */ allowVirtualNetworkAccess?: boolean; + /** + * Whether the forwarded traffic from the VMs in the remote virtual network will be + * allowed/disallowed. + */ allowForwardedTraffic?: boolean; + /** + * If gateway links can be used in remote virtual networking to link to this virtual network. + */ allowGatewayTransit?: boolean; + /** + * If remote gateways can be used on this virtual network. If the flag is set to true, and + * allowGatewayTransit on remote peering is also true, virtual network will use gateways of + * remote virtual network for transit. Only one peering can have this flag set to true. This flag + * cannot be set if virtual network already has a gateway. + */ useRemoteGateways?: boolean; + /** + * The reference of the remote virtual network. The remote virtual network can be in the same or + * different region (preview). See here to register for the preview and learn more + * (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). + */ remoteVirtualNetwork?: SubResource; + /** + * The reference of the remote virtual network address space. + */ remoteAddressSpace?: AddressSpace; + /** + * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and + * 'Disconnected'. Possible values include: 'Initiated', 'Connected', 'Disconnected' + */ peeringState?: string; + /** + * The provisioning state of the resource. + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the DhcpOptions class. - * @constructor - * DhcpOptions contains an array of DNS servers available to VMs deployed in - * the virtual network. Standard DHCP option for a subnet overrides VNET DHCP - * options. - * - * @member {array} [dnsServers] The list of DNS servers IP addresses. - */ + * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. + * Standard DHCP option for a subnet overrides VNET DHCP options. +*/ export interface DhcpOptions { + /** + * The list of DNS servers IP addresses. + */ dnsServers?: string[]; } /** - * @class - * Initializes a new instance of the VirtualNetwork class. - * @constructor * Virtual Network resource. - * - * @member {object} [addressSpace] The AddressSpace that contains an array of - * IP address ranges that can be used by subnets. - * @member {array} [addressSpace.addressPrefixes] A list of address blocks - * reserved for this virtual network in CIDR notation. - * @member {object} [dhcpOptions] The dhcpOptions that contains an array of DNS - * servers available to VMs deployed in the virtual network. - * @member {array} [dhcpOptions.dnsServers] The list of DNS servers IP - * addresses. - * @member {array} [subnets] A list of subnets in a Virtual Network. - * @member {array} [virtualNetworkPeerings] A list of peerings in a Virtual - * Network. - * @member {string} [resourceGuid] The resourceGuid property of the Virtual - * Network resource. - * @member {string} [provisioningState] The provisioning state of the PublicIP - * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {boolean} [enableDdosProtection] Indicates if DDoS protection is - * enabled for all the protected resources in the virtual network. It requires - * a DDoS protection plan associated with the resource. Default value: false . - * @member {boolean} [enableVmProtection] Indicates if VM protection is enabled - * for all the subnets in the virtual network. Default value: false . - * @member {object} [ddosProtectionPlan] The DDoS protection plan associated - * with the virtual network. - * @member {string} [ddosProtectionPlan.id] Resource ID. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface VirtualNetwork extends Resource { + /** + * The AddressSpace that contains an array of IP address ranges that can be used by subnets. + */ addressSpace?: AddressSpace; + /** + * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual + * network. + */ dhcpOptions?: DhcpOptions; + /** + * A list of subnets in a Virtual Network. + */ subnets?: Subnet[]; + /** + * A list of peerings in a Virtual Network. + */ virtualNetworkPeerings?: VirtualNetworkPeering[]; + /** + * The resourceGuid property of the Virtual Network resource. + */ resourceGuid?: string; + /** + * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + */ provisioningState?: string; + /** + * Indicates if DDoS protection is enabled for all the protected resources in the virtual + * network. It requires a DDoS protection plan associated with the resource. + */ enableDdosProtection?: boolean; + /** + * Indicates if VM protection is enabled for all the subnets in the virtual network. + */ enableVmProtection?: boolean; + /** + * The DDoS protection plan associated with the virtual network. + */ ddosProtectionPlan?: SubResource; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the IPAddressAvailabilityResult class. - * @constructor * Response for CheckIPAddressAvailability API service call - * - * @member {boolean} [available] Private IP address availability. - * @member {array} [availableIPAddresses] Contains other available private IP - * addresses if the asked for address is taken. - */ +*/ export interface IPAddressAvailabilityResult { + /** + * Private IP address availability. + */ available?: boolean; + /** + * Contains other available private IP addresses if the asked for address is taken. + */ availableIPAddresses?: string[]; } /** - * @class - * Initializes a new instance of the VirtualNetworkUsageName class. - * @constructor * Usage strings container. - * - * @member {string} [localizedValue] Localized subnet size and usage string. - * @member {string} [value] Subnet size and usage string. - */ +*/ export interface VirtualNetworkUsageName { + /** + * Localized subnet size and usage string. + */ readonly localizedValue?: string; + /** + * Subnet size and usage string. + */ readonly value?: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkUsage class. - * @constructor * Usage details for subnet. - * - * @member {number} [currentValue] Indicates number of IPs used from the - * Subnet. - * @member {string} [id] Subnet identifier. - * @member {number} [limit] Indicates the size of the subnet. - * @member {object} [name] The name containing common and localized value for - * usage. - * @member {string} [name.localizedValue] Localized subnet size and usage - * string. - * @member {string} [name.value] Subnet size and usage string. - * @member {string} [unit] Usage units. Returns 'Count' - */ +*/ export interface VirtualNetworkUsage { + /** + * Indicates number of IPs used from the Subnet. + */ readonly currentValue?: number; + /** + * Subnet identifier. + */ readonly id?: string; + /** + * Indicates the size of the subnet. + */ readonly limit?: number; + /** + * The name containing common and localized value for usage. + */ readonly name?: VirtualNetworkUsageName; + /** + * Usage units. Returns 'Count' + */ readonly unit?: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkGatewayIPConfiguration class. - * @constructor * IP configuration for virtual network gateway - * - * @member {string} [privateIPAllocationMethod] The private IP allocation - * method. Possible values are: 'Static' and 'Dynamic'. Possible values - * include: 'Static', 'Dynamic' - * @member {object} [subnet] The reference of the subnet resource. - * @member {string} [subnet.id] Resource ID. - * @member {object} [publicIPAddress] The reference of the public IP resource. - * @member {string} [publicIPAddress.id] Resource ID. - * @member {string} [provisioningState] The provisioning state of the public IP - * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface VirtualNetworkGatewayIPConfiguration extends SubResource { + /** + * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. Possible values + * include: 'Static', 'Dynamic' + */ privateIPAllocationMethod?: string; + /** + * The reference of the subnet resource. + */ subnet?: SubResource; + /** + * The reference of the public IP resource. + */ publicIPAddress?: SubResource; + /** + * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkGatewaySku class. - * @constructor * VirtualNetworkGatewaySku details - * - * @member {string} [name] Gateway SKU name. Possible values include: 'Basic', - * 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', 'VpnGw2', - * 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', - * 'ErGw3AZ' - * @member {string} [tier] Gateway SKU tier. Possible values include: 'Basic', - * 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', 'VpnGw2', - * 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', - * 'ErGw3AZ' - * @member {number} [capacity] The capacity. - */ +*/ export interface VirtualNetworkGatewaySku { + /** + * Gateway SKU name. Possible values include: 'Basic', 'HighPerformance', 'Standard', + * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', + * 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + */ name?: string; + /** + * Gateway SKU tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', + * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', + * 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + */ tier?: string; + /** + * The capacity. + */ capacity?: number; } /** - * @class - * Initializes a new instance of the VpnClientRootCertificate class. - * @constructor * VPN client root certificate of virtual network gateway - * - * @member {string} publicCertData The certificate public data. - * @member {string} [provisioningState] The provisioning state of the VPN - * client root certificate resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface VpnClientRootCertificate extends SubResource { + /** + * The certificate public data. + */ publicCertData: string; + /** + * The provisioning state of the VPN client root certificate resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the VpnClientRevokedCertificate class. - * @constructor * VPN client revoked certificate of virtual network gateway. - * - * @member {string} [thumbprint] The revoked VPN client certificate thumbprint. - * @member {string} [provisioningState] The provisioning state of the VPN - * client revoked certificate resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface VpnClientRevokedCertificate extends SubResource { + /** + * The revoked VPN client certificate thumbprint. + */ thumbprint?: string; + /** + * The provisioning state of the VPN client revoked certificate resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the IpsecPolicy class. - * @constructor * An IPSec Policy configuration for a virtual network gateway connection - * - * @member {number} saLifeTimeSeconds The IPSec Security Association (also - * called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN - * tunnel. - * @member {number} saDataSizeKilobytes The IPSec Security Association (also - * called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN - * tunnel. - * @member {string} ipsecEncryption The IPSec encryption algorithm (IKE phase - * 1). Possible values include: 'None', 'DES', 'DES3', 'AES128', 'AES192', - * 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' - * @member {string} ipsecIntegrity The IPSec integrity algorithm (IKE phase 1). - * Possible values include: 'MD5', 'SHA1', 'SHA256', 'GCMAES128', 'GCMAES192', - * 'GCMAES256' - * @member {string} ikeEncryption The IKE encryption algorithm (IKE phase 2). - * Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256', - * 'GCMAES256', 'GCMAES128' - * @member {string} ikeIntegrity The IKE integrity algorithm (IKE phase 2). - * Possible values include: 'MD5', 'SHA1', 'SHA256', 'SHA384', 'GCMAES256', - * 'GCMAES128' - * @member {string} dhGroup The DH Groups used in IKE Phase 1 for initial SA. - * Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', - * 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24' - * @member {string} pfsGroup The Pfs Groups used in IKE Phase 2 for new child - * SA. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', 'ECP256', - * 'ECP384', 'PFS24', 'PFS14', 'PFSMM' - */ +*/ export interface IpsecPolicy { + /** + * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for + * a site to site VPN tunnel. + */ saLifeTimeSeconds: number; + /** + * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a + * site to site VPN tunnel. + */ saDataSizeKilobytes: number; + /** + * The IPSec encryption algorithm (IKE phase 1). Possible values include: 'None', 'DES', 'DES3', + * 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' + */ ipsecEncryption: string; + /** + * The IPSec integrity algorithm (IKE phase 1). Possible values include: 'MD5', 'SHA1', 'SHA256', + * 'GCMAES128', 'GCMAES192', 'GCMAES256' + */ ipsecIntegrity: string; + /** + * The IKE encryption algorithm (IKE phase 2). Possible values include: 'DES', 'DES3', 'AES128', + * 'AES192', 'AES256', 'GCMAES256', 'GCMAES128' + */ ikeEncryption: string; + /** + * The IKE integrity algorithm (IKE phase 2). Possible values include: 'MD5', 'SHA1', 'SHA256', + * 'SHA384', 'GCMAES256', 'GCMAES128' + */ ikeIntegrity: string; + /** + * The DH Groups used in IKE Phase 1 for initial SA. Possible values include: 'None', 'DHGroup1', + * 'DHGroup2', 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24' + */ dhGroup: string; + /** + * The Pfs Groups used in IKE Phase 2 for new child SA. Possible values include: 'None', 'PFS1', + * 'PFS2', 'PFS2048', 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM' + */ pfsGroup: string; } /** - * @class - * Initializes a new instance of the VpnClientConfiguration class. - * @constructor * VpnClientConfiguration for P2S client. - * - * @member {object} [vpnClientAddressPool] The reference of the address space - * resource which represents Address space for P2S VpnClient. - * @member {array} [vpnClientAddressPool.addressPrefixes] A list of address - * blocks reserved for this virtual network in CIDR notation. - * @member {array} [vpnClientRootCertificates] VpnClientRootCertificate for - * virtual network gateway. - * @member {array} [vpnClientRevokedCertificates] VpnClientRevokedCertificate - * for Virtual network gateway. - * @member {array} [vpnClientProtocols] VpnClientProtocols for Virtual network - * gateway. - * @member {array} [vpnClientIpsecPolicies] VpnClientIpsecPolicies for virtual - * network gateway P2S client. - * @member {string} [radiusServerAddress] The radius server address property of - * the VirtualNetworkGateway resource for vpn client connection. - * @member {string} [radiusServerSecret] The radius secret property of the - * VirtualNetworkGateway resource for vpn client connection. - */ +*/ export interface VpnClientConfiguration { + /** + * The reference of the address space resource which represents Address space for P2S VpnClient. + */ vpnClientAddressPool?: AddressSpace; + /** + * VpnClientRootCertificate for virtual network gateway. + */ vpnClientRootCertificates?: VpnClientRootCertificate[]; + /** + * VpnClientRevokedCertificate for Virtual network gateway. + */ vpnClientRevokedCertificates?: VpnClientRevokedCertificate[]; + /** + * VpnClientProtocols for Virtual network gateway. + */ vpnClientProtocols?: string[]; + /** + * VpnClientIpsecPolicies for virtual network gateway P2S client. + */ vpnClientIpsecPolicies?: IpsecPolicy[]; + /** + * The radius server address property of the VirtualNetworkGateway resource for vpn client + * connection. + */ radiusServerAddress?: string; + /** + * The radius secret property of the VirtualNetworkGateway resource for vpn client connection. + */ radiusServerSecret?: string; } /** - * @class - * Initializes a new instance of the BgpSettings class. - * @constructor * BGP settings details - * - * @member {number} [asn] The BGP speaker's ASN. - * @member {string} [bgpPeeringAddress] The BGP peering address and BGP - * identifier of this BGP speaker. - * @member {number} [peerWeight] The weight added to routes learned from this - * BGP speaker. - */ +*/ export interface BgpSettings { + /** + * The BGP speaker's ASN. + */ asn?: number; + /** + * The BGP peering address and BGP identifier of this BGP speaker. + */ bgpPeeringAddress?: string; + /** + * The weight added to routes learned from this BGP speaker. + */ peerWeight?: number; } /** - * @class - * Initializes a new instance of the BgpPeerStatus class. - * @constructor * BGP peer status details - * - * @member {string} [localAddress] The virtual network gateway's local address - * @member {string} [neighbor] The remote BGP peer - * @member {number} [asn] The autonomous system number of the remote BGP peer - * @member {string} [state] The BGP peer state. Possible values include: - * 'Unknown', 'Stopped', 'Idle', 'Connecting', 'Connected' - * @member {string} [connectedDuration] For how long the peering has been up - * @member {number} [routesReceived] The number of routes learned from this - * peer - * @member {number} [messagesSent] The number of BGP messages sent - * @member {number} [messagesReceived] The number of BGP messages received - */ +*/ export interface BgpPeerStatus { + /** + * The virtual network gateway's local address + */ readonly localAddress?: string; + /** + * The remote BGP peer + */ readonly neighbor?: string; + /** + * The autonomous system number of the remote BGP peer + */ readonly asn?: number; + /** + * The BGP peer state. Possible values include: 'Unknown', 'Stopped', 'Idle', 'Connecting', + * 'Connected' + */ readonly state?: string; + /** + * For how long the peering has been up + */ readonly connectedDuration?: string; + /** + * The number of routes learned from this peer + */ readonly routesReceived?: number; + /** + * The number of BGP messages sent + */ readonly messagesSent?: number; + /** + * The number of BGP messages received + */ readonly messagesReceived?: number; } /** - * @class - * Initializes a new instance of the GatewayRoute class. - * @constructor * Gateway routing details - * - * @member {string} [localAddress] The gateway's local address - * @member {string} [network] The route's network prefix - * @member {string} [nextHop] The route's next hop - * @member {string} [sourcePeer] The peer this route was learned from - * @member {string} [origin] The source this route was learned from - * @member {string} [asPath] The route's AS path sequence - * @member {number} [weight] The route's weight - */ +*/ export interface GatewayRoute { + /** + * The gateway's local address + */ readonly localAddress?: string; + /** + * The route's network prefix + */ readonly network?: string; + /** + * The route's next hop + */ readonly nextHop?: string; + /** + * The peer this route was learned from + */ readonly sourcePeer?: string; + /** + * The source this route was learned from + */ readonly origin?: string; + /** + * The route's AS path sequence + */ readonly asPath?: string; + /** + * The route's weight + */ readonly weight?: number; } /** - * @class - * Initializes a new instance of the VirtualNetworkGateway class. - * @constructor * A common class for general resource information - * - * @member {array} [ipConfigurations] IP configurations for virtual network - * gateway. - * @member {string} [gatewayType] The type of this virtual network gateway. - * Possible values are: 'Vpn' and 'ExpressRoute'. Possible values include: - * 'Vpn', 'ExpressRoute' - * @member {string} [vpnType] The type of this virtual network gateway. - * Possible values are: 'PolicyBased' and 'RouteBased'. Possible values - * include: 'PolicyBased', 'RouteBased' - * @member {boolean} [enableBgp] Whether BGP is enabled for this virtual - * network gateway or not. - * @member {boolean} [activeActive] ActiveActive flag - * @member {object} [gatewayDefaultSite] The reference of the - * LocalNetworkGateway resource which represents local network site having - * default routes. Assign Null value in case of removing existing default site - * setting. - * @member {string} [gatewayDefaultSite.id] Resource ID. - * @member {object} [sku] The reference of the VirtualNetworkGatewaySku - * resource which represents the SKU selected for Virtual network gateway. - * @member {string} [sku.name] Gateway SKU name. Possible values include: - * 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', - * 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', - * 'ErGw2AZ', 'ErGw3AZ' - * @member {string} [sku.tier] Gateway SKU tier. Possible values include: - * 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', - * 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', - * 'ErGw2AZ', 'ErGw3AZ' - * @member {number} [sku.capacity] The capacity. - * @member {object} [vpnClientConfiguration] The reference of the - * VpnClientConfiguration resource which represents the P2S VpnClient - * configurations. - * @member {object} [vpnClientConfiguration.vpnClientAddressPool] The reference - * of the address space resource which represents Address space for P2S - * VpnClient. - * @member {array} - * [vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] A list of - * address blocks reserved for this virtual network in CIDR notation. - * @member {array} [vpnClientConfiguration.vpnClientRootCertificates] - * VpnClientRootCertificate for virtual network gateway. - * @member {array} [vpnClientConfiguration.vpnClientRevokedCertificates] - * VpnClientRevokedCertificate for Virtual network gateway. - * @member {array} [vpnClientConfiguration.vpnClientProtocols] - * VpnClientProtocols for Virtual network gateway. - * @member {array} [vpnClientConfiguration.vpnClientIpsecPolicies] - * VpnClientIpsecPolicies for virtual network gateway P2S client. - * @member {string} [vpnClientConfiguration.radiusServerAddress] The radius - * server address property of the VirtualNetworkGateway resource for vpn client - * connection. - * @member {string} [vpnClientConfiguration.radiusServerSecret] The radius - * secret property of the VirtualNetworkGateway resource for vpn client - * connection. - * @member {object} [bgpSettings] Virtual network gateway's BGP speaker - * settings. - * @member {number} [bgpSettings.asn] The BGP speaker's ASN. - * @member {string} [bgpSettings.bgpPeeringAddress] The BGP peering address and - * BGP identifier of this BGP speaker. - * @member {number} [bgpSettings.peerWeight] The weight added to routes learned - * from this BGP speaker. - * @member {string} [resourceGuid] The resource GUID property of the - * VirtualNetworkGateway resource. - * @member {string} [provisioningState] The provisioning state of the - * VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', - * and 'Failed'. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface VirtualNetworkGateway extends Resource { + /** + * IP configurations for virtual network gateway. + */ ipConfigurations?: VirtualNetworkGatewayIPConfiguration[]; + /** + * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. + * Possible values include: 'Vpn', 'ExpressRoute' + */ gatewayType?: string; + /** + * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + * Possible values include: 'PolicyBased', 'RouteBased' + */ vpnType?: string; + /** + * Whether BGP is enabled for this virtual network gateway or not. + */ enableBgp?: boolean; + /** + * ActiveActive flag + */ activeActive?: boolean; + /** + * The reference of the LocalNetworkGateway resource which represents local network site having + * default routes. Assign Null value in case of removing existing default site setting. + */ gatewayDefaultSite?: SubResource; + /** + * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for + * Virtual network gateway. + */ sku?: VirtualNetworkGatewaySku; + /** + * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient + * configurations. + */ vpnClientConfiguration?: VpnClientConfiguration; + /** + * Virtual network gateway's BGP speaker settings. + */ bgpSettings?: BgpSettings; + /** + * The resource GUID property of the VirtualNetworkGateway resource. + */ resourceGuid?: string; + /** + * The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the VpnClientParameters class. - * @constructor * Vpn Client Parameters for package generation - * - * @member {string} [processorArchitecture] VPN client Processor Architecture. - * Possible values are: 'AMD64' and 'X86'. Possible values include: 'Amd64', - * 'X86' - * @member {string} [authenticationMethod] VPN client Authentication Method. - * Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values include: - * 'EAPTLS', 'EAPMSCHAPv2' - * @member {string} [radiusServerAuthCertificate] The public certificate data - * for the radius server authentication certificate as a Base-64 encoded - * string. Required only if external radius authentication has been configured - * with EAPTLS authentication. - * @member {array} [clientRootCertificates] A list of client root certificates - * public certificate data encoded as Base-64 strings. Optional parameter for - * external radius based authentication with EAPTLS. - */ +*/ export interface VpnClientParameters { + /** + * VPN client Processor Architecture. Possible values are: 'AMD64' and 'X86'. Possible values + * include: 'Amd64', 'X86' + */ processorArchitecture?: string; + /** + * VPN client Authentication Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible + * values include: 'EAPTLS', 'EAPMSCHAPv2' + */ authenticationMethod?: string; + /** + * The public certificate data for the radius server authentication certificate as a Base-64 + * encoded string. Required only if external radius authentication has been configured with + * EAPTLS authentication. + */ radiusServerAuthCertificate?: string; + /** + * A list of client root certificates public certificate data encoded as Base-64 strings. + * Optional parameter for external radius based authentication with EAPTLS. + */ clientRootCertificates?: string[]; } /** - * @class - * Initializes a new instance of the BgpPeerStatusListResult class. - * @constructor * Response for list BGP peer status API service call - * - * @member {array} [value] List of BGP peers - */ +*/ export interface BgpPeerStatusListResult { + /** + * List of BGP peers + */ value?: BgpPeerStatus[]; } /** - * @class - * Initializes a new instance of the GatewayRouteListResult class. - * @constructor * List of virtual network gateway routes - * - * @member {array} [value] List of gateway routes - */ +*/ export interface GatewayRouteListResult { + /** + * List of gateway routes + */ value?: GatewayRoute[]; } /** - * @class - * Initializes a new instance of the TunnelConnectionHealth class. - * @constructor * VirtualNetworkGatewayConnection properties - * - * @member {string} [tunnel] Tunnel name. - * @member {string} [connectionStatus] Virtual network Gateway connection - * status. Possible values include: 'Unknown', 'Connecting', 'Connected', - * 'NotConnected' - * @member {number} [ingressBytesTransferred] The Ingress Bytes Transferred in - * this connection - * @member {number} [egressBytesTransferred] The Egress Bytes Transferred in - * this connection - * @member {string} [lastConnectionEstablishedUtcTime] The time at which - * connection was established in Utc format. - */ +*/ export interface TunnelConnectionHealth { + /** + * Tunnel name. + */ readonly tunnel?: string; + /** + * Virtual network Gateway connection status. Possible values include: 'Unknown', 'Connecting', + * 'Connected', 'NotConnected' + */ readonly connectionStatus?: string; + /** + * The Ingress Bytes Transferred in this connection + */ readonly ingressBytesTransferred?: number; + /** + * The Egress Bytes Transferred in this connection + */ readonly egressBytesTransferred?: number; + /** + * The time at which connection was established in Utc format. + */ readonly lastConnectionEstablishedUtcTime?: string; } /** - * @class - * Initializes a new instance of the LocalNetworkGateway class. - * @constructor * A common class for general resource information - * - * @member {object} [localNetworkAddressSpace] Local network site address - * space. - * @member {array} [localNetworkAddressSpace.addressPrefixes] A list of address - * blocks reserved for this virtual network in CIDR notation. - * @member {string} [gatewayIpAddress] IP address of local network gateway. - * @member {object} [bgpSettings] Local network gateway's BGP speaker settings. - * @member {number} [bgpSettings.asn] The BGP speaker's ASN. - * @member {string} [bgpSettings.bgpPeeringAddress] The BGP peering address and - * BGP identifier of this BGP speaker. - * @member {number} [bgpSettings.peerWeight] The weight added to routes learned - * from this BGP speaker. - * @member {string} [resourceGuid] The resource GUID property of the - * LocalNetworkGateway resource. - * @member {string} [provisioningState] The provisioning state of the - * LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', - * and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface LocalNetworkGateway extends Resource { + /** + * Local network site address space. + */ localNetworkAddressSpace?: AddressSpace; + /** + * IP address of local network gateway. + */ gatewayIpAddress?: string; + /** + * Local network gateway's BGP speaker settings. + */ bgpSettings?: BgpSettings; + /** + * The resource GUID property of the LocalNetworkGateway resource. + */ resourceGuid?: string; + /** + * The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkGatewayConnection class. - * @constructor * A common class for general resource information - * - * @member {string} [authorizationKey] The authorizationKey. - * @member {object} virtualNetworkGateway1 The reference to virtual network - * gateway resource. - * @member {array} [virtualNetworkGateway1.ipConfigurations] IP configurations - * for virtual network gateway. - * @member {string} [virtualNetworkGateway1.gatewayType] The type of this - * virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - * Possible values include: 'Vpn', 'ExpressRoute' - * @member {string} [virtualNetworkGateway1.vpnType] The type of this virtual - * network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - * Possible values include: 'PolicyBased', 'RouteBased' - * @member {boolean} [virtualNetworkGateway1.enableBgp] Whether BGP is enabled - * for this virtual network gateway or not. - * @member {boolean} [virtualNetworkGateway1.activeActive] ActiveActive flag - * @member {object} [virtualNetworkGateway1.gatewayDefaultSite] The reference - * of the LocalNetworkGateway resource which represents local network site - * having default routes. Assign Null value in case of removing existing - * default site setting. - * @member {string} [virtualNetworkGateway1.gatewayDefaultSite.id] Resource ID. - * @member {object} [virtualNetworkGateway1.sku] The reference of the - * VirtualNetworkGatewaySku resource which represents the SKU selected for - * Virtual network gateway. - * @member {string} [virtualNetworkGateway1.sku.name] Gateway SKU name. - * Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' - * @member {string} [virtualNetworkGateway1.sku.tier] Gateway SKU tier. - * Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' - * @member {number} [virtualNetworkGateway1.sku.capacity] The capacity. - * @member {object} [virtualNetworkGateway1.vpnClientConfiguration] The - * reference of the VpnClientConfiguration resource which represents the P2S - * VpnClient configurations. - * @member {object} - * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientAddressPool] The - * reference of the address space resource which represents Address space for - * P2S VpnClient. - * @member {array} - * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] - * A list of address blocks reserved for this virtual network in CIDR notation. - * @member {array} - * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientRootCertificates] - * VpnClientRootCertificate for virtual network gateway. - * @member {array} - * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientRevokedCertificates] - * VpnClientRevokedCertificate for Virtual network gateway. - * @member {array} - * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientProtocols] - * VpnClientProtocols for Virtual network gateway. - * @member {array} - * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientIpsecPolicies] - * VpnClientIpsecPolicies for virtual network gateway P2S client. - * @member {string} - * [virtualNetworkGateway1.vpnClientConfiguration.radiusServerAddress] The - * radius server address property of the VirtualNetworkGateway resource for vpn - * client connection. - * @member {string} - * [virtualNetworkGateway1.vpnClientConfiguration.radiusServerSecret] The - * radius secret property of the VirtualNetworkGateway resource for vpn client - * connection. - * @member {object} [virtualNetworkGateway1.bgpSettings] Virtual network - * gateway's BGP speaker settings. - * @member {number} [virtualNetworkGateway1.bgpSettings.asn] The BGP speaker's - * ASN. - * @member {string} [virtualNetworkGateway1.bgpSettings.bgpPeeringAddress] The - * BGP peering address and BGP identifier of this BGP speaker. - * @member {number} [virtualNetworkGateway1.bgpSettings.peerWeight] The weight - * added to routes learned from this BGP speaker. - * @member {string} [virtualNetworkGateway1.resourceGuid] The resource GUID - * property of the VirtualNetworkGateway resource. - * @member {string} [virtualNetworkGateway1.provisioningState] The provisioning - * state of the VirtualNetworkGateway resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [virtualNetworkGateway1.etag] Gets a unique read-only - * string that changes whenever the resource is updated. - * @member {object} [virtualNetworkGateway2] The reference to virtual network - * gateway resource. - * @member {array} [virtualNetworkGateway2.ipConfigurations] IP configurations - * for virtual network gateway. - * @member {string} [virtualNetworkGateway2.gatewayType] The type of this - * virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - * Possible values include: 'Vpn', 'ExpressRoute' - * @member {string} [virtualNetworkGateway2.vpnType] The type of this virtual - * network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - * Possible values include: 'PolicyBased', 'RouteBased' - * @member {boolean} [virtualNetworkGateway2.enableBgp] Whether BGP is enabled - * for this virtual network gateway or not. - * @member {boolean} [virtualNetworkGateway2.activeActive] ActiveActive flag - * @member {object} [virtualNetworkGateway2.gatewayDefaultSite] The reference - * of the LocalNetworkGateway resource which represents local network site - * having default routes. Assign Null value in case of removing existing - * default site setting. - * @member {string} [virtualNetworkGateway2.gatewayDefaultSite.id] Resource ID. - * @member {object} [virtualNetworkGateway2.sku] The reference of the - * VirtualNetworkGatewaySku resource which represents the SKU selected for - * Virtual network gateway. - * @member {string} [virtualNetworkGateway2.sku.name] Gateway SKU name. - * Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' - * @member {string} [virtualNetworkGateway2.sku.tier] Gateway SKU tier. - * Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' - * @member {number} [virtualNetworkGateway2.sku.capacity] The capacity. - * @member {object} [virtualNetworkGateway2.vpnClientConfiguration] The - * reference of the VpnClientConfiguration resource which represents the P2S - * VpnClient configurations. - * @member {object} - * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool] The - * reference of the address space resource which represents Address space for - * P2S VpnClient. - * @member {array} - * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] - * A list of address blocks reserved for this virtual network in CIDR notation. - * @member {array} - * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientRootCertificates] - * VpnClientRootCertificate for virtual network gateway. - * @member {array} - * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientRevokedCertificates] - * VpnClientRevokedCertificate for Virtual network gateway. - * @member {array} - * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientProtocols] - * VpnClientProtocols for Virtual network gateway. - * @member {array} - * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientIpsecPolicies] - * VpnClientIpsecPolicies for virtual network gateway P2S client. - * @member {string} - * [virtualNetworkGateway2.vpnClientConfiguration.radiusServerAddress] The - * radius server address property of the VirtualNetworkGateway resource for vpn - * client connection. - * @member {string} - * [virtualNetworkGateway2.vpnClientConfiguration.radiusServerSecret] The - * radius secret property of the VirtualNetworkGateway resource for vpn client - * connection. - * @member {object} [virtualNetworkGateway2.bgpSettings] Virtual network - * gateway's BGP speaker settings. - * @member {number} [virtualNetworkGateway2.bgpSettings.asn] The BGP speaker's - * ASN. - * @member {string} [virtualNetworkGateway2.bgpSettings.bgpPeeringAddress] The - * BGP peering address and BGP identifier of this BGP speaker. - * @member {number} [virtualNetworkGateway2.bgpSettings.peerWeight] The weight - * added to routes learned from this BGP speaker. - * @member {string} [virtualNetworkGateway2.resourceGuid] The resource GUID - * property of the VirtualNetworkGateway resource. - * @member {string} [virtualNetworkGateway2.provisioningState] The provisioning - * state of the VirtualNetworkGateway resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [virtualNetworkGateway2.etag] Gets a unique read-only - * string that changes whenever the resource is updated. - * @member {object} [localNetworkGateway2] The reference to local network - * gateway resource. - * @member {object} [localNetworkGateway2.localNetworkAddressSpace] Local - * network site address space. - * @member {array} - * [localNetworkGateway2.localNetworkAddressSpace.addressPrefixes] A list of - * address blocks reserved for this virtual network in CIDR notation. - * @member {string} [localNetworkGateway2.gatewayIpAddress] IP address of local - * network gateway. - * @member {object} [localNetworkGateway2.bgpSettings] Local network gateway's - * BGP speaker settings. - * @member {number} [localNetworkGateway2.bgpSettings.asn] The BGP speaker's - * ASN. - * @member {string} [localNetworkGateway2.bgpSettings.bgpPeeringAddress] The - * BGP peering address and BGP identifier of this BGP speaker. - * @member {number} [localNetworkGateway2.bgpSettings.peerWeight] The weight - * added to routes learned from this BGP speaker. - * @member {string} [localNetworkGateway2.resourceGuid] The resource GUID - * property of the LocalNetworkGateway resource. - * @member {string} [localNetworkGateway2.provisioningState] The provisioning - * state of the LocalNetworkGateway resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [localNetworkGateway2.etag] A unique read-only string that - * changes whenever the resource is updated. - * @member {string} connectionType Gateway connection type. Possible values - * are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible values - * include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' - * @member {string} [connectionProtocol] Connection protocol used for this - * connection. Possible values include: 'IKEv2', 'IKEv1' - * @member {number} [routingWeight] The routing weight. - * @member {string} [sharedKey] The IPSec shared key. - * @member {string} [connectionStatus] Virtual network Gateway connection - * status. Possible values are 'Unknown', 'Connecting', 'Connected' and - * 'NotConnected'. Possible values include: 'Unknown', 'Connecting', - * 'Connected', 'NotConnected' - * @member {array} [tunnelConnectionStatus] Collection of all tunnels' - * connection health status. - * @member {number} [egressBytesTransferred] The egress bytes transferred in - * this connection. - * @member {number} [ingressBytesTransferred] The ingress bytes transferred in - * this connection. - * @member {object} [peer] The reference to peerings resource. - * @member {string} [peer.id] Resource ID. - * @member {boolean} [enableBgp] EnableBgp flag - * @member {boolean} [usePolicyBasedTrafficSelectors] Enable policy-based - * traffic selectors. - * @member {array} [ipsecPolicies] The IPSec Policies to be considered by this - * connection. - * @member {string} [resourceGuid] The resource GUID property of the - * VirtualNetworkGatewayConnection resource. - * @member {string} [provisioningState] The provisioning state of the - * VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {boolean} [expressRouteGatewayBypass] Bypass ExpressRoute Gateway - * for data forwarding - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface VirtualNetworkGatewayConnection extends Resource { + /** + * The authorizationKey. + */ authorizationKey?: string; + /** + * The reference to virtual network gateway resource. + */ virtualNetworkGateway1: VirtualNetworkGateway; + /** + * The reference to virtual network gateway resource. + */ virtualNetworkGateway2?: VirtualNetworkGateway; + /** + * The reference to local network gateway resource. + */ localNetworkGateway2?: LocalNetworkGateway; + /** + * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and + * 'VPNClient. Possible values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' + */ connectionType: string; + /** + * Connection protocol used for this connection. Possible values include: 'IKEv2', 'IKEv1' + */ connectionProtocol?: string; + /** + * The routing weight. + */ routingWeight?: number; + /** + * The IPSec shared key. + */ sharedKey?: string; + /** + * Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', + * 'Connected' and 'NotConnected'. Possible values include: 'Unknown', 'Connecting', 'Connected', + * 'NotConnected' + */ readonly connectionStatus?: string; + /** + * Collection of all tunnels' connection health status. + */ readonly tunnelConnectionStatus?: TunnelConnectionHealth[]; + /** + * The egress bytes transferred in this connection. + */ readonly egressBytesTransferred?: number; + /** + * The ingress bytes transferred in this connection. + */ readonly ingressBytesTransferred?: number; + /** + * The reference to peerings resource. + */ peer?: SubResource; + /** + * EnableBgp flag + */ enableBgp?: boolean; + /** + * Enable policy-based traffic selectors. + */ usePolicyBasedTrafficSelectors?: boolean; + /** + * The IPSec Policies to be considered by this connection. + */ ipsecPolicies?: IpsecPolicy[]; + /** + * The resource GUID property of the VirtualNetworkGatewayConnection resource. + */ resourceGuid?: string; + /** + * The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * Bypass ExpressRoute Gateway for data forwarding + */ expressRouteGatewayBypass?: boolean; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the ConnectionResetSharedKey class. - * @constructor * The virtual network connection reset shared key - * - * @member {number} keyLength The virtual network connection reset shared key - * length, should between 1 and 128. - */ +*/ export interface ConnectionResetSharedKey { + /** + * The virtual network connection reset shared key length, should between 1 and 128. + */ keyLength: number; } /** - * @class - * Initializes a new instance of the ConnectionSharedKey class. - * @constructor * Response for GetConnectionSharedKey API service call - * - * @member {string} value The virtual network connection shared key value. - */ +*/ export interface ConnectionSharedKey extends SubResource { + /** + * The virtual network connection shared key value. + */ value: string; } /** - * @class - * Initializes a new instance of the VpnClientIPsecParameters class. - * @constructor * An IPSec parameters for a virtual network gateway P2S connection. - * - * @member {number} saLifeTimeSeconds The IPSec Security Association (also - * called Quick Mode or Phase 2 SA) lifetime in seconds for P2S client. - * @member {number} saDataSizeKilobytes The IPSec Security Association (also - * called Quick Mode or Phase 2 SA) payload size in KB for P2S client.. - * @member {string} ipsecEncryption The IPSec encryption algorithm (IKE phase - * 1). Possible values include: 'None', 'DES', 'DES3', 'AES128', 'AES192', - * 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' - * @member {string} ipsecIntegrity The IPSec integrity algorithm (IKE phase 1). - * Possible values include: 'MD5', 'SHA1', 'SHA256', 'GCMAES128', 'GCMAES192', - * 'GCMAES256' - * @member {string} ikeEncryption The IKE encryption algorithm (IKE phase 2). - * Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256', - * 'GCMAES256', 'GCMAES128' - * @member {string} ikeIntegrity The IKE integrity algorithm (IKE phase 2). - * Possible values include: 'MD5', 'SHA1', 'SHA256', 'SHA384', 'GCMAES256', - * 'GCMAES128' - * @member {string} dhGroup The DH Groups used in IKE Phase 1 for initial SA. - * Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', - * 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24' - * @member {string} pfsGroup The Pfs Groups used in IKE Phase 2 for new child - * SA. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', 'ECP256', - * 'ECP384', 'PFS24', 'PFS14', 'PFSMM' - */ +*/ export interface VpnClientIPsecParameters { + /** + * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for + * P2S client. + */ saLifeTimeSeconds: number; + /** + * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for + * P2S client.. + */ saDataSizeKilobytes: number; + /** + * The IPSec encryption algorithm (IKE phase 1). Possible values include: 'None', 'DES', 'DES3', + * 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' + */ ipsecEncryption: string; + /** + * The IPSec integrity algorithm (IKE phase 1). Possible values include: 'MD5', 'SHA1', 'SHA256', + * 'GCMAES128', 'GCMAES192', 'GCMAES256' + */ ipsecIntegrity: string; + /** + * The IKE encryption algorithm (IKE phase 2). Possible values include: 'DES', 'DES3', 'AES128', + * 'AES192', 'AES256', 'GCMAES256', 'GCMAES128' + */ ikeEncryption: string; + /** + * The IKE integrity algorithm (IKE phase 2). Possible values include: 'MD5', 'SHA1', 'SHA256', + * 'SHA384', 'GCMAES256', 'GCMAES128' + */ ikeIntegrity: string; + /** + * The DH Groups used in IKE Phase 1 for initial SA. Possible values include: 'None', 'DHGroup1', + * 'DHGroup2', 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24' + */ dhGroup: string; + /** + * The Pfs Groups used in IKE Phase 2 for new child SA. Possible values include: 'None', 'PFS1', + * 'PFS2', 'PFS2048', 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM' + */ pfsGroup: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkConnectionGatewayReference class. - * @constructor * A reference to VirtualNetworkGateway or LocalNetworkGateway resource. - * - * @member {string} id The ID of VirtualNetworkGateway or LocalNetworkGateway - * resource. - */ +*/ export interface VirtualNetworkConnectionGatewayReference { + /** + * The ID of VirtualNetworkGateway or LocalNetworkGateway resource. + */ id: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkGatewayConnectionListEntity class. - * @constructor * A common class for general resource information - * - * @member {string} [authorizationKey] The authorizationKey. - * @member {object} virtualNetworkGateway1 The reference to virtual network - * gateway resource. - * @member {string} [virtualNetworkGateway1.id] The ID of VirtualNetworkGateway - * or LocalNetworkGateway resource. - * @member {object} [virtualNetworkGateway2] The reference to virtual network - * gateway resource. - * @member {string} [virtualNetworkGateway2.id] The ID of VirtualNetworkGateway - * or LocalNetworkGateway resource. - * @member {object} [localNetworkGateway2] The reference to local network - * gateway resource. - * @member {string} [localNetworkGateway2.id] The ID of VirtualNetworkGateway - * or LocalNetworkGateway resource. - * @member {string} connectionType Gateway connection type. Possible values - * are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible values - * include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' - * @member {string} [connectionProtocol] Connection protocol used for this - * connection. Possible values include: 'IKEv2', 'IKEv1' - * @member {number} [routingWeight] The routing weight. - * @member {string} [sharedKey] The IPSec shared key. - * @member {string} [connectionStatus] Virtual network Gateway connection - * status. Possible values are 'Unknown', 'Connecting', 'Connected' and - * 'NotConnected'. Possible values include: 'Unknown', 'Connecting', - * 'Connected', 'NotConnected' - * @member {array} [tunnelConnectionStatus] Collection of all tunnels' - * connection health status. - * @member {number} [egressBytesTransferred] The egress bytes transferred in - * this connection. - * @member {number} [ingressBytesTransferred] The ingress bytes transferred in - * this connection. - * @member {object} [peer] The reference to peerings resource. - * @member {string} [peer.id] Resource ID. - * @member {boolean} [enableBgp] EnableBgp flag - * @member {boolean} [usePolicyBasedTrafficSelectors] Enable policy-based - * traffic selectors. - * @member {array} [ipsecPolicies] The IPSec Policies to be considered by this - * connection. - * @member {string} [resourceGuid] The resource GUID property of the - * VirtualNetworkGatewayConnection resource. - * @member {string} [provisioningState] The provisioning state of the - * VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {boolean} [expressRouteGatewayBypass] Bypass ExpressRoute Gateway - * for data forwarding - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface VirtualNetworkGatewayConnectionListEntity extends Resource { + /** + * The authorizationKey. + */ authorizationKey?: string; + /** + * The reference to virtual network gateway resource. + */ virtualNetworkGateway1: VirtualNetworkConnectionGatewayReference; + /** + * The reference to virtual network gateway resource. + */ virtualNetworkGateway2?: VirtualNetworkConnectionGatewayReference; + /** + * The reference to local network gateway resource. + */ localNetworkGateway2?: VirtualNetworkConnectionGatewayReference; + /** + * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and + * 'VPNClient. Possible values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' + */ connectionType: string; + /** + * Connection protocol used for this connection. Possible values include: 'IKEv2', 'IKEv1' + */ connectionProtocol?: string; + /** + * The routing weight. + */ routingWeight?: number; + /** + * The IPSec shared key. + */ sharedKey?: string; + /** + * Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', + * 'Connected' and 'NotConnected'. Possible values include: 'Unknown', 'Connecting', 'Connected', + * 'NotConnected' + */ readonly connectionStatus?: string; + /** + * Collection of all tunnels' connection health status. + */ readonly tunnelConnectionStatus?: TunnelConnectionHealth[]; + /** + * The egress bytes transferred in this connection. + */ readonly egressBytesTransferred?: number; + /** + * The ingress bytes transferred in this connection. + */ readonly ingressBytesTransferred?: number; + /** + * The reference to peerings resource. + */ peer?: SubResource; + /** + * EnableBgp flag + */ enableBgp?: boolean; + /** + * Enable policy-based traffic selectors. + */ usePolicyBasedTrafficSelectors?: boolean; + /** + * The IPSec Policies to be considered by this connection. + */ ipsecPolicies?: IpsecPolicy[]; + /** + * The resource GUID property of the VirtualNetworkGatewayConnection resource. + */ resourceGuid?: string; + /** + * The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * Bypass ExpressRoute Gateway for data forwarding + */ expressRouteGatewayBypass?: boolean; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the VpnDeviceScriptParameters class. - * @constructor * Vpn device configuration script generation parameters - * - * @member {string} [vendor] The vendor for the vpn device. - * @member {string} [deviceFamily] The device family for the vpn device. - * @member {string} [firmwareVersion] The firmware version for the vpn device. - */ +*/ export interface VpnDeviceScriptParameters { + /** + * The vendor for the vpn device. + */ vendor?: string; + /** + * The device family for the vpn device. + */ deviceFamily?: string; + /** + * The firmware version for the vpn device. + */ firmwareVersion?: string; } /** - * @class - * Initializes a new instance of the P2SVpnServerConfigVpnClientRootCertificate class. - * @constructor * VPN client root certificate of P2SVpnServerConfiguration. - * - * @member {string} publicCertData The certificate public data. - * @member {string} [provisioningState] The provisioning state of the - * P2SVpnServerConfiguration VPN client root certificate resource. Possible - * values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface P2SVpnServerConfigVpnClientRootCertificate extends SubResource { + /** + * The certificate public data. + */ publicCertData: string; + /** + * The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. + * Possible values are: 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the P2SVpnServerConfigVpnClientRevokedCertificate class. - * @constructor * VPN client revoked certificate of P2SVpnServerConfiguration. - * - * @member {string} [thumbprint] The revoked VPN client certificate thumbprint. - * @member {string} [provisioningState] The provisioning state of the VPN - * client revoked certificate resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface P2SVpnServerConfigVpnClientRevokedCertificate extends SubResource { + /** + * The revoked VPN client certificate thumbprint. + */ thumbprint?: string; + /** + * The provisioning state of the VPN client revoked certificate resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the P2SVpnServerConfigRadiusServerRootCertificate class. - * @constructor * Radius Server root certificate of P2SVpnServerConfiguration. - * - * @member {string} publicCertData The certificate public data. - * @member {string} [provisioningState] The provisioning state of the - * P2SVpnServerConfiguration Radius Server root certificate resource. Possible - * values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface P2SVpnServerConfigRadiusServerRootCertificate extends SubResource { + /** + * The certificate public data. + */ publicCertData: string; + /** + * The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate + * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the P2SVpnServerConfigRadiusClientRootCertificate class. - * @constructor * Radius client root certificate of P2SVpnServerConfiguration. - * - * @member {string} [thumbprint] The Radius client root certificate thumbprint. - * @member {string} [provisioningState] The provisioning state of the Radius - * client root certificate resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever the - * resource is updated. - */ +*/ export interface P2SVpnServerConfigRadiusClientRootCertificate extends SubResource { + /** + * The Radius client root certificate thumbprint. + */ thumbprint?: string; + /** + * The provisioning state of the Radius client root certificate resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * A unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the P2SVpnServerConfiguration class. - * @constructor * P2SVpnServerConfiguration Resource. - * - * @member {string} [p2SVpnServerConfigurationPropertiesName] The name of the - * P2SVpnServerConfiguration that is unique within a VirtualWan in a resource - * group. This name can be used to access the resource along with Paren - * VirtualWan resource name. - * @member {array} [vpnProtocols] vpnProtocols for the - * P2SVpnServerConfiguration. - * @member {array} [p2SVpnServerConfigVpnClientRootCertificates] VPN client - * root certificate of P2SVpnServerConfiguration. - * @member {array} [p2SVpnServerConfigVpnClientRevokedCertificates] VPN client - * revoked certificate of P2SVpnServerConfiguration. - * @member {array} [p2SVpnServerConfigRadiusServerRootCertificates] Radius - * Server root certificate of P2SVpnServerConfiguration. - * @member {array} [p2SVpnServerConfigRadiusClientRootCertificates] Radius - * client root certificate of P2SVpnServerConfiguration. - * @member {array} [vpnClientIpsecPolicies] VpnClientIpsecPolicies for - * P2SVpnServerConfiguration. - * @member {string} [radiusServerAddress] The radius server address property of - * the P2SVpnServerConfiguration resource for point to site client connection. - * @member {string} [radiusServerSecret] The radius secret property of the - * P2SVpnServerConfiguration resource for for point to site client connection. - * @member {string} [provisioningState] The provisioning state of the - * P2SVpnServerConfiguration resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {array} [p2SVpnGateways] - * @member {string} [p2SVpnServerConfigurationPropertiesEtag] A unique - * read-only string that changes whenever the resource is updated. - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface P2SVpnServerConfiguration extends SubResource { + /** + * The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource + * group. This name can be used to access the resource along with Paren VirtualWan resource name. + */ p2SVpnServerConfigurationPropertiesName?: string; + /** + * vpnProtocols for the P2SVpnServerConfiguration. + */ vpnProtocols?: string[]; + /** + * VPN client root certificate of P2SVpnServerConfiguration. + */ p2SVpnServerConfigVpnClientRootCertificates?: P2SVpnServerConfigVpnClientRootCertificate[]; + /** + * VPN client revoked certificate of P2SVpnServerConfiguration. + */ p2SVpnServerConfigVpnClientRevokedCertificates?: P2SVpnServerConfigVpnClientRevokedCertificate[]; + /** + * Radius Server root certificate of P2SVpnServerConfiguration. + */ p2SVpnServerConfigRadiusServerRootCertificates?: P2SVpnServerConfigRadiusServerRootCertificate[]; + /** + * Radius client root certificate of P2SVpnServerConfiguration. + */ p2SVpnServerConfigRadiusClientRootCertificates?: P2SVpnServerConfigRadiusClientRootCertificate[]; + /** + * VpnClientIpsecPolicies for P2SVpnServerConfiguration. + */ vpnClientIpsecPolicies?: IpsecPolicy[]; + /** + * The radius server address property of the P2SVpnServerConfiguration resource for point to site + * client connection. + */ radiusServerAddress?: string; + /** + * The radius secret property of the P2SVpnServerConfiguration resource for for point to site + * client connection. + */ radiusServerSecret?: string; + /** + * The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + */ readonly provisioningState?: string; readonly p2SVpnGateways?: SubResource[]; + /** + * A unique read-only string that changes whenever the resource is updated. + */ p2SVpnServerConfigurationPropertiesEtag?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the VirtualWAN class. - * @constructor * VirtualWAN Resource. - * - * @member {boolean} [disableVpnEncryption] Vpn encryption to be disabled or - * not. - * @member {array} [virtualHubs] List of VirtualHubs in the VirtualWAN. - * @member {array} [vpnSites] - * @member {string} [securityProviderName] The Security Provider name. - * @member {boolean} [allowBranchToBranchTraffic] True if branch to branch - * traffic is allowed. - * @member {boolean} [allowVnetToVnetTraffic] True if Vnet to Vnet traffic is - * allowed. - * @member {string} [office365LocalBreakoutCategory] The office local breakout - * category. Possible values include: 'Optimize', 'OptimizeAndAllow', 'All', - * 'None' - * @member {array} [p2SVpnServerConfigurations] list of all - * P2SVpnServerConfigurations associated with the virtual wan. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface VirtualWAN extends Resource { + /** + * Vpn encryption to be disabled or not. + */ disableVpnEncryption?: boolean; + /** + * List of VirtualHubs in the VirtualWAN. + */ readonly virtualHubs?: SubResource[]; readonly vpnSites?: SubResource[]; + /** + * The Security Provider name. + */ securityProviderName?: string; + /** + * True if branch to branch traffic is allowed. + */ allowBranchToBranchTraffic?: boolean; + /** + * True if Vnet to Vnet traffic is allowed. + */ allowVnetToVnetTraffic?: boolean; + /** + * The office local breakout category. Possible values include: 'Optimize', 'OptimizeAndAllow', + * 'All', 'None' + */ office365LocalBreakoutCategory?: string; + /** + * list of all P2SVpnServerConfigurations associated with the virtual wan. + */ p2SVpnServerConfigurations?: P2SVpnServerConfiguration[]; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the DeviceProperties class. - * @constructor * List of properties of the device. - * - * @member {string} [deviceVendor] Name of the device Vendor. - * @member {string} [deviceModel] Model of the device. - * @member {number} [linkSpeedInMbps] Link speed. - */ +*/ export interface DeviceProperties { + /** + * Name of the device Vendor. + */ deviceVendor?: string; + /** + * Model of the device. + */ deviceModel?: string; + /** + * Link speed. + */ linkSpeedInMbps?: number; } /** - * @class - * Initializes a new instance of the VpnSite class. - * @constructor * VpnSite Resource. - * - * @member {object} [virtualWan] The VirtualWAN to which the vpnSite belongs - * @member {string} [virtualWan.id] Resource ID. - * @member {object} [deviceProperties] The device properties - * @member {string} [deviceProperties.deviceVendor] Name of the device Vendor. - * @member {string} [deviceProperties.deviceModel] Model of the device. - * @member {number} [deviceProperties.linkSpeedInMbps] Link speed. - * @member {string} [ipAddress] The ip-address for the vpn-site. - * @member {string} [siteKey] The key for vpn-site that can be used for - * connections. - * @member {object} [addressSpace] The AddressSpace that contains an array of - * IP address ranges. - * @member {array} [addressSpace.addressPrefixes] A list of address blocks - * reserved for this virtual network in CIDR notation. - * @member {object} [bgpProperties] The set of bgp properties. - * @member {number} [bgpProperties.asn] The BGP speaker's ASN. - * @member {string} [bgpProperties.bgpPeeringAddress] The BGP peering address - * and BGP identifier of this BGP speaker. - * @member {number} [bgpProperties.peerWeight] The weight added to routes - * learned from this BGP speaker. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {boolean} [isSecuritySite] IsSecuritySite flag - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface VpnSite extends Resource { + /** + * The VirtualWAN to which the vpnSite belongs + */ virtualWan?: SubResource; + /** + * The device properties + */ deviceProperties?: DeviceProperties; + /** + * The ip-address for the vpn-site. + */ ipAddress?: string; + /** + * The key for vpn-site that can be used for connections. + */ siteKey?: string; + /** + * The AddressSpace that contains an array of IP address ranges. + */ addressSpace?: AddressSpace; + /** + * The set of bgp properties. + */ bgpProperties?: BgpSettings; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * IsSecuritySite flag + */ isSecuritySite?: boolean; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the GetVpnSitesConfigurationRequest class. - * @constructor * List of Vpn-Sites - * - * @member {array} [vpnSites] List of resource-ids of the vpn-sites for which - * config is to be downloaded. - * @member {string} [outputBlobSasUrl] The sas-url to download the - * configurations for vpn-sites - */ +*/ export interface GetVpnSitesConfigurationRequest { + /** + * List of resource-ids of the vpn-sites for which config is to be downloaded. + */ vpnSites?: string[]; + /** + * The sas-url to download the configurations for vpn-sites + */ outputBlobSasUrl?: string; } /** - * @class - * Initializes a new instance of the HubVirtualNetworkConnection class. - * @constructor * HubVirtualNetworkConnection Resource. - * - * @member {object} [remoteVirtualNetwork] Reference to the remote virtual - * network. - * @member {string} [remoteVirtualNetwork.id] Resource ID. - * @member {boolean} [allowHubToRemoteVnetTransit] VirtualHub to RemoteVnet - * transit to enabled or not. - * @member {boolean} [allowRemoteVnetToUseHubVnetGateways] Allow RemoteVnet to - * use Virtual Hub's gateways. - * @member {boolean} [enableInternetSecurity] Enable internet security - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface HubVirtualNetworkConnection extends SubResource { + /** + * Reference to the remote virtual network. + */ remoteVirtualNetwork?: SubResource; + /** + * VirtualHub to RemoteVnet transit to enabled or not. + */ allowHubToRemoteVnetTransit?: boolean; + /** + * Allow RemoteVnet to use Virtual Hub's gateways. + */ allowRemoteVnetToUseHubVnetGateways?: boolean; + /** + * Enable internet security + */ enableInternetSecurity?: boolean; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the VirtualHubRoute class. - * @constructor * VirtualHub route - * - * @member {array} [addressPrefixes] list of all addressPrefixes. - * @member {string} [nextHopIpAddress] NextHop ip address. - */ +*/ export interface VirtualHubRoute { + /** + * list of all addressPrefixes. + */ addressPrefixes?: string[]; + /** + * NextHop ip address. + */ nextHopIpAddress?: string; } /** - * @class - * Initializes a new instance of the VirtualHubRouteTable class. - * @constructor * VirtualHub route table - * - * @member {array} [routes] list of all routes. - */ +*/ export interface VirtualHubRouteTable { + /** + * list of all routes. + */ routes?: VirtualHubRoute[]; } /** - * @class - * Initializes a new instance of the VirtualHub class. - * @constructor * VirtualHub Resource. - * - * @member {object} [virtualWan] The VirtualWAN to which the VirtualHub belongs - * @member {string} [virtualWan.id] Resource ID. - * @member {object} [vpnGateway] The VpnGateway associated with this VirtualHub - * @member {string} [vpnGateway.id] Resource ID. - * @member {object} [p2SVpnGateway] The P2SVpnGateway associated with this - * VirtualHub - * @member {string} [p2SVpnGateway.id] Resource ID. - * @member {object} [expressRouteGateway] The expressRouteGateway associated - * with this VirtualHub - * @member {string} [expressRouteGateway.id] Resource ID. - * @member {array} [virtualNetworkConnections] list of all vnet connections - * with this VirtualHub. - * @member {string} [addressPrefix] Address-prefix for this VirtualHub. - * @member {object} [routeTable] The routeTable associated with this virtual - * hub. - * @member {array} [routeTable.routes] list of all routes. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface VirtualHub extends Resource { + /** + * The VirtualWAN to which the VirtualHub belongs + */ virtualWan?: SubResource; + /** + * The VpnGateway associated with this VirtualHub + */ vpnGateway?: SubResource; + /** + * The P2SVpnGateway associated with this VirtualHub + */ p2SVpnGateway?: SubResource; + /** + * The expressRouteGateway associated with this VirtualHub + */ expressRouteGateway?: SubResource; + /** + * list of all vnet connections with this VirtualHub. + */ virtualNetworkConnections?: HubVirtualNetworkConnection[]; + /** + * Address-prefix for this VirtualHub. + */ addressPrefix?: string; + /** + * The routeTable associated with this virtual hub. + */ routeTable?: VirtualHubRouteTable; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the VpnConnection class. - * @constructor * VpnConnection Resource. - * - * @member {object} [remoteVpnSite] Id of the connected vpn site. - * @member {string} [remoteVpnSite.id] Resource ID. - * @member {number} [routingWeight] routing weight for vpn connection. - * @member {string} [connectionStatus] The connection status. Possible values - * include: 'Unknown', 'Connecting', 'Connected', 'NotConnected' - * @member {string} [vpnConnectionProtocolType] Connection protocol used for - * this connection. Possible values include: 'IKEv2', 'IKEv1' - * @member {number} [ingressBytesTransferred] Ingress bytes transferred. - * @member {number} [egressBytesTransferred] Egress bytes transferred. - * @member {number} [connectionBandwidth] Expected bandwidth in MBPS. - * @member {string} [sharedKey] SharedKey for the vpn connection. - * @member {boolean} [enableBgp] EnableBgp flag - * @member {array} [ipsecPolicies] The IPSec Policies to be considered by this - * connection. - * @member {boolean} [enableRateLimiting] EnableBgp flag - * @member {boolean} [enableInternetSecurity] Enable internet security - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {string} [name] The name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface VpnConnection extends SubResource { + /** + * Id of the connected vpn site. + */ remoteVpnSite?: SubResource; + /** + * routing weight for vpn connection. + */ routingWeight?: number; + /** + * The connection status. Possible values include: 'Unknown', 'Connecting', 'Connected', + * 'NotConnected' + */ connectionStatus?: string; + /** + * Connection protocol used for this connection. Possible values include: 'IKEv2', 'IKEv1' + */ vpnConnectionProtocolType?: string; + /** + * Ingress bytes transferred. + */ readonly ingressBytesTransferred?: number; + /** + * Egress bytes transferred. + */ readonly egressBytesTransferred?: number; + /** + * Expected bandwidth in MBPS. + */ connectionBandwidth?: number; + /** + * SharedKey for the vpn connection. + */ sharedKey?: string; + /** + * EnableBgp flag + */ enableBgp?: boolean; + /** + * The IPSec Policies to be considered by this connection. + */ ipsecPolicies?: IpsecPolicy[]; + /** + * EnableBgp flag + */ enableRateLimiting?: boolean; + /** + * Enable internet security + */ enableInternetSecurity?: boolean; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * The name of the resource that is unique within a resource group. This name can be used to + * access the resource. + */ name?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the VpnGateway class. - * @constructor * VpnGateway Resource. - * - * @member {object} [virtualHub] The VirtualHub to which the gateway belongs - * @member {string} [virtualHub.id] Resource ID. - * @member {array} [connections] list of all vpn connections to the gateway. - * @member {object} [bgpSettings] Local network gateway's BGP speaker settings. - * @member {number} [bgpSettings.asn] The BGP speaker's ASN. - * @member {string} [bgpSettings.bgpPeeringAddress] The BGP peering address and - * BGP identifier of this BGP speaker. - * @member {number} [bgpSettings.peerWeight] The weight added to routes learned - * from this BGP speaker. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {number} [vpnGatewayScaleUnit] The scale unit for this vpn gateway. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface VpnGateway extends Resource { + /** + * The VirtualHub to which the gateway belongs + */ virtualHub?: SubResource; + /** + * list of all vpn connections to the gateway. + */ connections?: VpnConnection[]; + /** + * Local network gateway's BGP speaker settings. + */ bgpSettings?: BgpSettings; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * The scale unit for this vpn gateway. + */ vpnGatewayScaleUnit?: number; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the VpnSiteId class. - * @constructor * VpnSite Resource. - * - * @member {string} [vpnSite] The resource-uri of the vpn-site for which config - * is to be fetched. - */ +*/ export interface VpnSiteId { + /** + * The resource-uri of the vpn-site for which config is to be fetched. + */ readonly vpnSite?: string; } /** - * @class - * Initializes a new instance of the VirtualWanSecurityProvider class. - * @constructor * Collection of SecurityProviders. - * - * @member {string} [name] Name of the security provider. - * @member {string} [url] Url of the security provider. - * @member {string} [type] Name of the security provider. Possible values - * include: 'External', 'Native' - */ +*/ export interface VirtualWanSecurityProvider { + /** + * Name of the security provider. + */ name?: string; + /** + * Url of the security provider. + */ url?: string; + /** + * Name of the security provider. Possible values include: 'External', 'Native' + */ type?: string; } /** - * @class - * Initializes a new instance of the VirtualWanSecurityProviders class. - * @constructor * Collection of SecurityProviders. - * - * @member {array} [supportedProviders] - */ +*/ export interface VirtualWanSecurityProviders { supportedProviders?: VirtualWanSecurityProvider[]; } /** - * @class - * Initializes a new instance of the VpnClientConnectionHealth class. - * @constructor * VpnClientConnectionHealth properties - * - * @member {number} [totalIngressBytesTransferred] Total of the Ingress Bytes - * Transferred in this P2S Vpn connection - * @member {number} [totalEgressBytesTransferred] Total of the Egress Bytes - * Transferred in this connection - * @member {number} [vpnClientConnectionsCount] The total of p2s vpn clients - * connected at this time to this P2SVpnGateway. - * @member {array} [allocatedIpAddresses] List of allocated ip addresses to the - * connected p2s vpn clients. - */ +*/ export interface VpnClientConnectionHealth { + /** + * Total of the Ingress Bytes Transferred in this P2S Vpn connection + */ readonly totalIngressBytesTransferred?: number; + /** + * Total of the Egress Bytes Transferred in this connection + */ readonly totalEgressBytesTransferred?: number; + /** + * The total of p2s vpn clients connected at this time to this P2SVpnGateway. + */ vpnClientConnectionsCount?: number; + /** + * List of allocated ip addresses to the connected p2s vpn clients. + */ allocatedIpAddresses?: string[]; } /** - * @class - * Initializes a new instance of the P2SVpnGateway class. - * @constructor * P2SVpnGateway Resource. - * - * @member {object} [virtualHub] The VirtualHub to which the gateway belongs - * @member {string} [virtualHub.id] Resource ID. - * @member {string} [provisioningState] The provisioning state of the resource. - * Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed' - * @member {number} [vpnGatewayScaleUnit] The scale unit for this p2s vpn - * gateway. - * @member {object} [p2SVpnServerConfiguration] The P2SVpnServerConfiguration - * to which the p2sVpnGateway is attached to. - * @member {string} [p2SVpnServerConfiguration.id] Resource ID. - * @member {object} [vpnClientAddressPool] The reference of the address space - * resource which represents Address space for P2S VpnClient. - * @member {array} [vpnClientAddressPool.addressPrefixes] A list of address - * blocks reserved for this virtual network in CIDR notation. - * @member {object} [vpnClientConnectionHealth] All P2S vpnclients' connection - * health status. - * @member {number} [vpnClientConnectionHealth.totalIngressBytesTransferred] - * Total of the Ingress Bytes Transferred in this P2S Vpn connection - * @member {number} [vpnClientConnectionHealth.totalEgressBytesTransferred] - * Total of the Egress Bytes Transferred in this connection - * @member {number} [vpnClientConnectionHealth.vpnClientConnectionsCount] The - * total of p2s vpn clients connected at this time to this P2SVpnGateway. - * @member {array} [vpnClientConnectionHealth.allocatedIpAddresses] List of - * allocated ip addresses to the connected p2s vpn clients. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface P2SVpnGateway extends Resource { + /** + * The VirtualHub to which the gateway belongs + */ virtualHub?: SubResource; + /** + * The provisioning state of the resource. Possible values include: 'Succeeded', 'Updating', + * 'Deleting', 'Failed' + */ provisioningState?: string; + /** + * The scale unit for this p2s vpn gateway. + */ vpnGatewayScaleUnit?: number; + /** + * The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to. + */ p2SVpnServerConfiguration?: SubResource; + /** + * The reference of the address space resource which represents Address space for P2S VpnClient. + */ vpnClientAddressPool?: AddressSpace; + /** + * All P2S vpnclients' connection health status. + */ readonly vpnClientConnectionHealth?: VpnClientConnectionHealth; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the P2SVpnProfileParameters class. - * @constructor * Vpn Client Parameters for package generation - * - * @member {string} [authenticationMethod] VPN client Authentication Method. - * Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values include: - * 'EAPTLS', 'EAPMSCHAPv2' - */ +*/ export interface P2SVpnProfileParameters { + /** + * VPN client Authentication Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible + * values include: 'EAPTLS', 'EAPMSCHAPv2' + */ authenticationMethod?: string; } /** - * @class - * Initializes a new instance of the VpnProfileResponse class. - * @constructor * Vpn Profile Response for package generation - * - * @member {string} [profileUrl] URL to the VPN profile - */ +*/ export interface VpnProfileResponse { + /** + * URL to the VPN profile + */ profileUrl?: string; } - /** - * @class - * Initializes a new instance of the ApplicationGatewayListResult class. - * @constructor * Response for ListApplicationGateways API service call. - * - * @member {string} [nextLink] URL to get the next set of results. - */ +*/ export interface ApplicationGatewayListResult extends Array { + /** + * URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ApplicationGatewayAvailableSslPredefinedPolicies class. - * @constructor * Response for ApplicationGatewayAvailableSslOptions API service call. - * - * @member {string} [nextLink] URL to get the next set of results. - */ -export interface ApplicationGatewayAvailableSslPredefinedPolicies extends Array { +*/ +export interface ApplicationGatewayAvailableSslPredefinedPolicies extends +Array { + /** + * URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ApplicationSecurityGroupListResult class. - * @constructor * A list of application security groups. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface ApplicationSecurityGroupListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the AvailableDelegationsResult class. - * @constructor * An array of available delegations. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface AvailableDelegationsResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the AzureFirewallListResult class. - * @constructor * Response for ListAzureFirewalls API service call. - * - * @member {string} [nextLink] URL to get the next set of results. - */ +*/ export interface AzureFirewallListResult extends Array { + /** + * URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the AzureFirewallFqdnTagListResult class. - * @constructor * Response for ListAzureFirewallFqdnTags API service call. - * - * @member {string} [nextLink] URL to get the next set of results. - */ +*/ export interface AzureFirewallFqdnTagListResult extends Array { + /** + * URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the DdosProtectionPlanListResult class. - * @constructor * A list of DDoS protection plans. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface DdosProtectionPlanListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the EndpointServicesListResult class. - * @constructor * Response for the ListAvailableEndpointServices API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface EndpointServicesListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the AuthorizationListResult class. - * @constructor - * Response for ListAuthorizations API service call retrieves all - * authorizations that belongs to an ExpressRouteCircuit. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ + * Response for ListAuthorizations API service call retrieves all authorizations that belongs to an + * ExpressRouteCircuit. +*/ export interface AuthorizationListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitPeeringListResult class. - * @constructor - * Response for ListPeering API service call retrieves all peerings that belong - * to an ExpressRouteCircuit. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ + * Response for ListPeering API service call retrieves all peerings that belong to an + * ExpressRouteCircuit. +*/ export interface ExpressRouteCircuitPeeringListResult extends Array { + /** + * The URL to get the next set of results. + */ + nextLink?: string; +} + +/** + * Response for ListConnections API service call retrieves all global reach connections that + * belongs to a Private Peering for an ExpressRouteCircuit. +*/ +export interface ExpressRouteCircuitConnectionListResult extends +Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCircuitListResult class. - * @constructor * Response for ListExpressRouteCircuit API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface ExpressRouteCircuitListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteServiceProviderListResult class. - * @constructor * Response for the ListExpressRouteServiceProvider API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface ExpressRouteServiceProviderListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCrossConnectionListResult class. - * @constructor * Response for ListExpressRouteCrossConnection API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface ExpressRouteCrossConnectionListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteCrossConnectionPeeringList class. - * @constructor - * Response for ListPeering API service call retrieves all peerings that belong - * to an ExpressRouteCrossConnection. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ -export interface ExpressRouteCrossConnectionPeeringList extends Array { + * Response for ListPeering API service call retrieves all peerings that belong to an + * ExpressRouteCrossConnection. +*/ +export interface ExpressRouteCrossConnectionPeeringList extends +Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRoutePortsLocationListResult class. - * @constructor * @summary ExpressRoutePorts Location List Result - * - * Response for ListExpressRoutePortsLocations API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ + * @description Response for ListExpressRoutePortsLocations API service call. +*/ export interface ExpressRoutePortsLocationListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRoutePortListResult class. - * @constructor * @summary ExpressRoute Port List Result - * - * Response for ListExpressRoutePorts API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ + * @description Response for ListExpressRoutePorts API service call. +*/ export interface ExpressRoutePortListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ExpressRouteLinkListResult class. - * @constructor * @summary ExpressRouteLink List Result - * - * Response for ListExpressRouteLinks API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ + * @description Response for ListExpressRouteLinks API service call. +*/ export interface ExpressRouteLinkListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the InterfaceEndpointListResult class. - * @constructor * Response for the ListInterfaceEndpoints API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface InterfaceEndpointListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the LoadBalancerListResult class. - * @constructor * Response for ListLoadBalancers API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface LoadBalancerListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the LoadBalancerBackendAddressPoolListResult class. - * @constructor * Response for ListBackendAddressPool API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface LoadBalancerBackendAddressPoolListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the LoadBalancerFrontendIPConfigurationListResult class. - * @constructor * Response for ListFrontendIPConfiguration API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ -export interface LoadBalancerFrontendIPConfigurationListResult extends Array { +*/ +export interface LoadBalancerFrontendIPConfigurationListResult extends +Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the InboundNatRuleListResult class. - * @constructor * Response for ListInboundNatRule API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface InboundNatRuleListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the LoadBalancerLoadBalancingRuleListResult class. - * @constructor * Response for ListLoadBalancingRule API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface LoadBalancerLoadBalancingRuleListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the LoadBalancerOutboundRuleListResult class. - * @constructor * Response for ListOutboundRule API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface LoadBalancerOutboundRuleListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the NetworkInterfaceListResult class. - * @constructor * Response for the ListNetworkInterface API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface NetworkInterfaceListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the LoadBalancerProbeListResult class. - * @constructor * Response for ListProbe API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface LoadBalancerProbeListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the NetworkInterfaceIPConfigurationListResult class. - * @constructor * Response for list ip configurations API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ -export interface NetworkInterfaceIPConfigurationListResult extends Array { +*/ +export interface NetworkInterfaceIPConfigurationListResult extends +Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the NetworkInterfaceLoadBalancerListResult class. - * @constructor * Response for list ip configurations API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface NetworkInterfaceLoadBalancerListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the NetworkInterfaceTapConfigurationListResult class. - * @constructor * Response for list tap configurations API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ -export interface NetworkInterfaceTapConfigurationListResult extends Array { +*/ +export interface NetworkInterfaceTapConfigurationListResult extends +Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the NetworkProfileListResult class. - * @constructor * Response for ListNetworkProfiles API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface NetworkProfileListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the NetworkSecurityGroupListResult class. - * @constructor * Response for ListNetworkSecurityGroups API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface NetworkSecurityGroupListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the SecurityRuleListResult class. - * @constructor - * Response for ListSecurityRule API service call. Retrieves all security rules - * that belongs to a network security group. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ + * Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a + * network security group. +*/ export interface SecurityRuleListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the NetworkWatcherListResult class. - * @constructor * List of network watcher resources. - * - */ +*/ export interface NetworkWatcherListResult extends Array { } /** - * @class - * Initializes a new instance of the PacketCaptureListResult class. - * @constructor * List of packet capture sessions. - * - */ +*/ export interface PacketCaptureListResult extends Array { } /** - * @class - * Initializes a new instance of the ConnectionMonitorListResult class. - * @constructor * List of connection monitors. - * - */ +*/ export interface ConnectionMonitorListResult extends Array { } /** - * @class - * Initializes a new instance of the OperationListResult class. - * @constructor - * Result of the request to list Network operations. It contains a list of - * operations and a URL link to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * Result of the request to list Network operations. It contains a list of operations and a URL + * link to get the next set of results. +*/ export interface OperationListResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the PublicIPAddressListResult class. - * @constructor * Response for ListPublicIpAddresses API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface PublicIPAddressListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the PublicIPPrefixListResult class. - * @constructor * Response for ListPublicIpPrefixes API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface PublicIPPrefixListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RouteFilterListResult class. - * @constructor * Response for the ListRouteFilters API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface RouteFilterListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RouteFilterRuleListResult class. - * @constructor * Response for the ListRouteFilterRules API service call - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface RouteFilterRuleListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RouteTableListResult class. - * @constructor * Response for the ListRouteTable API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface RouteTableListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RouteListResult class. - * @constructor * Response for the ListRoute API service call - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface RouteListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the BgpServiceCommunityListResult class. - * @constructor * Response for the ListServiceCommunity API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface BgpServiceCommunityListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ServiceEndpointPolicyListResult class. - * @constructor * Response for ListServiceEndpointPolicies API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface ServiceEndpointPolicyListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the ServiceEndpointPolicyDefinitionListResult class. - * @constructor - * Response for ListServiceEndpointPolicyDefinition API service call. Retrieves - * all service endpoint policy definition that belongs to a service endpoint - * policy. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ -export interface ServiceEndpointPolicyDefinitionListResult extends Array { + * Response for ListServiceEndpointPolicyDefinition API service call. Retrieves all service + * endpoint policy definition that belongs to a service endpoint policy. +*/ +export interface ServiceEndpointPolicyDefinitionListResult extends +Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the UsagesListResult class. - * @constructor * The list usages operation response. - * - * @member {string} [nextLink] URL to get the next set of results. - */ +*/ export interface UsagesListResult extends Array { + /** + * URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkListResult class. - * @constructor * Response for the ListVirtualNetworks API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface VirtualNetworkListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkListUsageResult class. - * @constructor * Response for the virtual networks GetUsage API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface VirtualNetworkListUsageResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the SubnetListResult class. - * @constructor - * Response for ListSubnets API service callRetrieves all subnet that belongs - * to a virtual network - * - * @member {string} [nextLink] The URL to get the next set of results. - */ + * Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network +*/ export interface SubnetListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkPeeringListResult class. - * @constructor - * Response for ListSubnets API service call. Retrieves all subnets that belong - * to a virtual network. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ + * Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual + * network. +*/ export interface VirtualNetworkPeeringListResult extends Array { + /** + * The URL to get the next set of results. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkTapListResult class. - * @constructor - * Response for ListVirtualNetworkTap API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ -export interface VirtualNetworkTapListResult extends Array { - nextLink?: string; -} - -/** - * @class - * Initializes a new instance of the VirtualNetworkGatewayListResult class. - * @constructor * Response for the ListVirtualNetworkGateways API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface VirtualNetworkGatewayListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkGatewayListConnectionsResult class. - * @constructor * Response for the VirtualNetworkGatewayListConnections API service call - * - * @member {string} [nextLink] The URL to get the next set of results. - */ -export interface VirtualNetworkGatewayListConnectionsResult extends Array { +*/ +export interface VirtualNetworkGatewayListConnectionsResult extends +Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the VirtualNetworkGatewayConnectionListResult class. - * @constructor * Response for the ListVirtualNetworkGatewayConnections API service call - * - * @member {string} [nextLink] The URL to get the next set of results. - */ -export interface VirtualNetworkGatewayConnectionListResult extends Array { +*/ +export interface VirtualNetworkGatewayConnectionListResult extends +Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the LocalNetworkGatewayListResult class. - * @constructor * Response for ListLocalNetworkGateways API service call. - * - * @member {string} [nextLink] The URL to get the next set of results. - */ +*/ export interface LocalNetworkGatewayListResult extends Array { + /** + * The URL to get the next set of results. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the ListVirtualWANsResult class. - * @constructor - * Result of the request to list VirtualWANs. It contains a list of VirtualWANs - * and a URL nextLink to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * Response for ListVirtualNetworkTap API service call. +*/ +export interface VirtualNetworkTapListResult extends Array { + /** + * The URL to get the next set of results. + */ + nextLink?: string; +} + +/** + * Result of the request to list VirtualWANs. It contains a list of VirtualWANs and a URL nextLink + * to get the next set of results. +*/ export interface ListVirtualWANsResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ListVpnSitesResult class. - * @constructor - * Result of the request to list VpnSites. It contains a list of VpnSites and a - * URL nextLink to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get + * the next set of results. +*/ export interface ListVpnSitesResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ListVirtualHubsResult class. - * @constructor - * Result of the request to list VirtualHubs. It contains a list of VirtualHubs - * and a URL nextLink to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * Result of the request to list VirtualHubs. It contains a list of VirtualHubs and a URL nextLink + * to get the next set of results. +*/ export interface ListVirtualHubsResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ListHubVirtualNetworkConnectionsResult class. - * @constructor - * List of HubVirtualNetworkConnections and a URL nextLink to get the next set - * of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ -export interface ListHubVirtualNetworkConnectionsResult extends Array { + * List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results. +*/ +export interface ListHubVirtualNetworkConnectionsResult extends Array +{ + /** + * URL to get the next set of operation list results if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ListVpnGatewaysResult class. - * @constructor - * Result of the request to list VpnGateways. It contains a list of VpnGateways - * and a URL nextLink to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * Result of the request to list VpnGateways. It contains a list of VpnGateways and a URL nextLink + * to get the next set of results. +*/ export interface ListVpnGatewaysResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ListVpnConnectionsResult class. - * @constructor - * Result of the request to list all vpn connections to a virtual wan vpn - * gateway. It contains a list of Vpn Connections and a URL nextLink to get the - * next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a + * list of Vpn Connections and a URL nextLink to get the next set of results. +*/ export interface ListVpnConnectionsResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ListP2SVpnServerConfigurationsResult class. - * @constructor - * Result of the request to list all P2SVpnServerConfigurations associated to a - * VirtualWan. It contains a list of P2SVpnServerConfigurations and a URL - * nextLink to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * Result of the request to list all P2SVpnServerConfigurations associated to a VirtualWan. It + * contains a list of P2SVpnServerConfigurations and a URL nextLink to get the next set of results. +*/ export interface ListP2SVpnServerConfigurationsResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the ListP2SVpnGatewaysResult class. - * @constructor - * Result of the request to list P2SVpnGateways. It contains a list of - * P2SVpnGateways and a URL nextLink to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL + * nextLink to get the next set of results. +*/ export interface ListP2SVpnGatewaysResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ nextLink?: string; } diff --git a/lib/services/networkManagement2/lib/models/index.js b/lib/services/networkManagement2/lib/models/index.js index d2a62a97e8..c3ef882830 100644 --- a/lib/services/networkManagement2/lib/models/index.js +++ b/lib/services/networkManagement2/lib/models/index.js @@ -70,12 +70,18 @@ exports.ApplicationGatewayPathRule = require('./applicationGatewayPathRule'); exports.ApplicationGatewayProbeHealthResponseMatch = require('./applicationGatewayProbeHealthResponseMatch'); exports.ApplicationGatewayProbe = require('./applicationGatewayProbe'); exports.ApplicationGatewayRequestRoutingRule = require('./applicationGatewayRequestRoutingRule'); +exports.ApplicationGatewayHeaderConfiguration = require('./applicationGatewayHeaderConfiguration'); +exports.ApplicationGatewayRewriteRuleActionSet = require('./applicationGatewayRewriteRuleActionSet'); +exports.ApplicationGatewayRewriteRule = require('./applicationGatewayRewriteRule'); +exports.ApplicationGatewayRewriteRuleSet = require('./applicationGatewayRewriteRuleSet'); exports.ApplicationGatewayRedirectConfiguration = require('./applicationGatewayRedirectConfiguration'); exports.ApplicationGatewayUrlPathMap = require('./applicationGatewayUrlPathMap'); exports.ApplicationGatewayFirewallDisabledRuleGroup = require('./applicationGatewayFirewallDisabledRuleGroup'); exports.ApplicationGatewayFirewallExclusion = require('./applicationGatewayFirewallExclusion'); exports.ApplicationGatewayWebApplicationFirewallConfiguration = require('./applicationGatewayWebApplicationFirewallConfiguration'); exports.ApplicationGatewayAutoscaleConfiguration = require('./applicationGatewayAutoscaleConfiguration'); +exports.ManagedServiceIdentityUserAssignedIdentitiesValue = require('./managedServiceIdentityUserAssignedIdentitiesValue'); +exports.ManagedServiceIdentity = require('./managedServiceIdentity'); exports.ApplicationGateway = require('./applicationGateway'); exports.ApplicationGatewayFirewallRule = require('./applicationGatewayFirewallRule'); exports.ApplicationGatewayFirewallRuleGroup = require('./applicationGatewayFirewallRuleGroup'); @@ -185,6 +191,7 @@ exports.TroubleshootingRecommendedActions = require('./troubleshootingRecommende exports.TroubleshootingDetails = require('./troubleshootingDetails'); exports.TroubleshootingResult = require('./troubleshootingResult'); exports.RetentionPolicyParameters = require('./retentionPolicyParameters'); +exports.FlowLogFormatParameters = require('./flowLogFormatParameters'); exports.FlowLogStatusParameters = require('./flowLogStatusParameters'); exports.TrafficAnalyticsConfigurationProperties = require('./trafficAnalyticsConfigurationProperties'); exports.TrafficAnalyticsProperties = require('./trafficAnalyticsProperties'); @@ -300,6 +307,7 @@ exports.DdosProtectionPlanListResult = require('./ddosProtectionPlanListResult') exports.EndpointServicesListResult = require('./endpointServicesListResult'); exports.AuthorizationListResult = require('./authorizationListResult'); exports.ExpressRouteCircuitPeeringListResult = require('./expressRouteCircuitPeeringListResult'); +exports.ExpressRouteCircuitConnectionListResult = require('./expressRouteCircuitConnectionListResult'); exports.ExpressRouteCircuitListResult = require('./expressRouteCircuitListResult'); exports.ExpressRouteServiceProviderListResult = require('./expressRouteServiceProviderListResult'); exports.ExpressRouteCrossConnectionListResult = require('./expressRouteCrossConnectionListResult'); @@ -340,11 +348,11 @@ exports.VirtualNetworkListResult = require('./virtualNetworkListResult'); exports.VirtualNetworkListUsageResult = require('./virtualNetworkListUsageResult'); exports.SubnetListResult = require('./subnetListResult'); exports.VirtualNetworkPeeringListResult = require('./virtualNetworkPeeringListResult'); -exports.VirtualNetworkTapListResult = require('./virtualNetworkTapListResult'); exports.VirtualNetworkGatewayListResult = require('./virtualNetworkGatewayListResult'); exports.VirtualNetworkGatewayListConnectionsResult = require('./virtualNetworkGatewayListConnectionsResult'); exports.VirtualNetworkGatewayConnectionListResult = require('./virtualNetworkGatewayConnectionListResult'); exports.LocalNetworkGatewayListResult = require('./localNetworkGatewayListResult'); +exports.VirtualNetworkTapListResult = require('./virtualNetworkTapListResult'); exports.ListVirtualWANsResult = require('./listVirtualWANsResult'); exports.ListVpnSitesResult = require('./listVpnSitesResult'); exports.ListVirtualHubsResult = require('./listVirtualHubsResult'); diff --git a/lib/services/networkManagement2/lib/models/interfaceEndpoint.js b/lib/services/networkManagement2/lib/models/interfaceEndpoint.js index 2ba172e159..38a18dfd37 100644 --- a/lib/services/networkManagement2/lib/models/interfaceEndpoint.js +++ b/lib/services/networkManagement2/lib/models/interfaceEndpoint.js @@ -20,80 +20,81 @@ const models = require('./index'); class InterfaceEndpoint extends models['Resource'] { /** * Create a InterfaceEndpoint. - * @member {string} [fqdn] A first-party service's FQDN that is mapped to the - * private IP allocated via this interface endpoint. - * @member {object} [endpointService] A reference to the service being + * @property {string} [fqdn] A first-party service's FQDN that is mapped to + * the private IP allocated via this interface endpoint. + * @property {object} [endpointService] A reference to the service being * brought into the virtual network. - * @member {string} [endpointService.id] A unique identifier of the service + * @property {string} [endpointService.id] A unique identifier of the service * being referenced by the interface endpoint. - * @member {object} [subnet] The ID of the subnet from which the private IP + * @property {object} [subnet] The ID of the subnet from which the private IP * will be allocated. - * @member {string} [subnet.addressPrefix] The address prefix for the subnet. - * @member {array} [subnet.addressPrefixes] List of address prefixes for the + * @property {string} [subnet.addressPrefix] The address prefix for the * subnet. - * @member {object} [subnet.networkSecurityGroup] The reference of the + * @property {array} [subnet.addressPrefixes] List of address prefixes for + * the subnet. + * @property {object} [subnet.networkSecurityGroup] The reference of the * NetworkSecurityGroup resource. - * @member {array} [subnet.networkSecurityGroup.securityRules] A collection + * @property {array} [subnet.networkSecurityGroup.securityRules] A collection * of security rules of the network security group. - * @member {array} [subnet.networkSecurityGroup.defaultSecurityRules] The + * @property {array} [subnet.networkSecurityGroup.defaultSecurityRules] The * default security rules of network security group. - * @member {array} [subnet.networkSecurityGroup.networkInterfaces] A + * @property {array} [subnet.networkSecurityGroup.networkInterfaces] A * collection of references to network interfaces. - * @member {array} [subnet.networkSecurityGroup.subnets] A collection of + * @property {array} [subnet.networkSecurityGroup.subnets] A collection of * references to subnets. - * @member {string} [subnet.networkSecurityGroup.resourceGuid] The resource + * @property {string} [subnet.networkSecurityGroup.resourceGuid] The resource * GUID property of the network security group resource. - * @member {string} [subnet.networkSecurityGroup.provisioningState] The + * @property {string} [subnet.networkSecurityGroup.provisioningState] The * provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [subnet.networkSecurityGroup.etag] A unique read-only + * @property {string} [subnet.networkSecurityGroup.etag] A unique read-only * string that changes whenever the resource is updated. - * @member {object} [subnet.routeTable] The reference of the RouteTable + * @property {object} [subnet.routeTable] The reference of the RouteTable * resource. - * @member {array} [subnet.routeTable.routes] Collection of routes contained - * within a route table. - * @member {array} [subnet.routeTable.subnets] A collection of references to - * subnets. - * @member {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or + * @property {array} [subnet.routeTable.routes] Collection of routes + * contained within a route table. + * @property {array} [subnet.routeTable.subnets] A collection of references + * to subnets. + * @property {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or * sets whether to disable the routes learned by BGP on that route table. * True means disable. - * @member {string} [subnet.routeTable.provisioningState] The provisioning + * @property {string} [subnet.routeTable.provisioningState] The provisioning * state of the resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [subnet.routeTable.etag] Gets a unique read-only string + * @property {string} [subnet.routeTable.etag] Gets a unique read-only string * that changes whenever the resource is updated. - * @member {array} [subnet.serviceEndpoints] An array of service endpoints. - * @member {array} [subnet.serviceEndpointPolicies] An array of service + * @property {array} [subnet.serviceEndpoints] An array of service endpoints. + * @property {array} [subnet.serviceEndpointPolicies] An array of service * endpoint policies. - * @member {array} [subnet.interfaceEndpoints] An array of references to + * @property {array} [subnet.interfaceEndpoints] An array of references to * interface endpoints - * @member {array} [subnet.ipConfigurations] Gets an array of references to + * @property {array} [subnet.ipConfigurations] Gets an array of references to * the network interface IP configurations using subnet. - * @member {array} [subnet.ipConfigurationProfiles] Array of IP configuration - * profiles which reference this subnet. - * @member {array} [subnet.resourceNavigationLinks] Gets an array of + * @property {array} [subnet.ipConfigurationProfiles] Array of IP + * configuration profiles which reference this subnet. + * @property {array} [subnet.resourceNavigationLinks] Gets an array of * references to the external resources using subnet. - * @member {array} [subnet.serviceAssociationLinks] Gets an array of + * @property {array} [subnet.serviceAssociationLinks] Gets an array of * references to services injecting into this subnet. - * @member {array} [subnet.delegations] Gets an array of references to the + * @property {array} [subnet.delegations] Gets an array of references to the * delegations on the subnet. - * @member {string} [subnet.purpose] A read-only string identifying the + * @property {string} [subnet.purpose] A read-only string identifying the * intention of use for this subnet based on delegations and other * user-defined properties. - * @member {string} [subnet.provisioningState] The provisioning state of the - * resource. - * @member {string} [subnet.name] The name of the resource that is unique + * @property {string} [subnet.provisioningState] The provisioning state of + * the resource. + * @property {string} [subnet.name] The name of the resource that is unique * within a resource group. This name can be used to access the resource. - * @member {string} [subnet.etag] A unique read-only string that changes + * @property {string} [subnet.etag] A unique read-only string that changes * whenever the resource is updated. - * @member {array} [networkInterfaces] Gets an array of references to the + * @property {array} [networkInterfaces] Gets an array of references to the * network interfaces created for this interface endpoint. - * @member {string} [owner] A read-only property that identifies who created - * this interface endpoint. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [owner] A read-only property that identifies who + * created this interface endpoint. + * @property {string} [provisioningState] The provisioning state of the * interface endpoint. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/interfaceEndpointListResult.js b/lib/services/networkManagement2/lib/models/interfaceEndpointListResult.js index 8de4d9e62e..b1c7334cab 100644 --- a/lib/services/networkManagement2/lib/models/interfaceEndpointListResult.js +++ b/lib/services/networkManagement2/lib/models/interfaceEndpointListResult.js @@ -16,7 +16,7 @@ class InterfaceEndpointListResult extends Array { /** * Create a InterfaceEndpointListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/ipTag.js b/lib/services/networkManagement2/lib/models/ipTag.js index 799730a776..47fab3d90f 100644 --- a/lib/services/networkManagement2/lib/models/ipTag.js +++ b/lib/services/networkManagement2/lib/models/ipTag.js @@ -17,10 +17,10 @@ class IpTag { /** * Create a IpTag. - * @member {string} [ipTagType] Gets or sets the ipTag type: Example + * @property {string} [ipTagType] Gets or sets the ipTag type: Example * FirstPartyUsage. - * @member {string} [tag] Gets or sets value of the IpTag associated with the - * public IP. Example SQL, Storage etc + * @property {string} [tag] Gets or sets value of the IpTag associated with + * the public IP. Example SQL, Storage etc */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/ipsecPolicy.js b/lib/services/networkManagement2/lib/models/ipsecPolicy.js index ee16d6a604..3ec08267ad 100644 --- a/lib/services/networkManagement2/lib/models/ipsecPolicy.js +++ b/lib/services/networkManagement2/lib/models/ipsecPolicy.js @@ -17,30 +17,30 @@ class IpsecPolicy { /** * Create a IpsecPolicy. - * @member {number} saLifeTimeSeconds The IPSec Security Association (also + * @property {number} saLifeTimeSeconds The IPSec Security Association (also * called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site * VPN tunnel. - * @member {number} saDataSizeKilobytes The IPSec Security Association (also - * called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN - * tunnel. - * @member {string} ipsecEncryption The IPSec encryption algorithm (IKE phase - * 1). Possible values include: 'None', 'DES', 'DES3', 'AES128', 'AES192', - * 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' - * @member {string} ipsecIntegrity The IPSec integrity algorithm (IKE phase + * @property {number} saDataSizeKilobytes The IPSec Security Association + * (also called Quick Mode or Phase 2 SA) payload size in KB for a site to + * site VPN tunnel. + * @property {string} ipsecEncryption The IPSec encryption algorithm (IKE + * phase 1). Possible values include: 'None', 'DES', 'DES3', 'AES128', + * 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' + * @property {string} ipsecIntegrity The IPSec integrity algorithm (IKE phase * 1). Possible values include: 'MD5', 'SHA1', 'SHA256', 'GCMAES128', * 'GCMAES192', 'GCMAES256' - * @member {string} ikeEncryption The IKE encryption algorithm (IKE phase 2). - * Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256', + * @property {string} ikeEncryption The IKE encryption algorithm (IKE phase + * 2). Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256', * 'GCMAES256', 'GCMAES128' - * @member {string} ikeIntegrity The IKE integrity algorithm (IKE phase 2). + * @property {string} ikeIntegrity The IKE integrity algorithm (IKE phase 2). * Possible values include: 'MD5', 'SHA1', 'SHA256', 'SHA384', 'GCMAES256', * 'GCMAES128' - * @member {string} dhGroup The DH Groups used in IKE Phase 1 for initial SA. - * Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', + * @property {string} dhGroup The DH Groups used in IKE Phase 1 for initial + * SA. Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', * 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24' - * @member {string} pfsGroup The Pfs Groups used in IKE Phase 2 for new child - * SA. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', 'ECP256', - * 'ECP384', 'PFS24', 'PFS14', 'PFSMM' + * @property {string} pfsGroup The Pfs Groups used in IKE Phase 2 for new + * child SA. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', + * 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM' */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/ipv6ExpressRouteCircuitPeeringConfig.js b/lib/services/networkManagement2/lib/models/ipv6ExpressRouteCircuitPeeringConfig.js index 58ebfff294..8963d27f2e 100644 --- a/lib/services/networkManagement2/lib/models/ipv6ExpressRouteCircuitPeeringConfig.js +++ b/lib/services/networkManagement2/lib/models/ipv6ExpressRouteCircuitPeeringConfig.js @@ -17,37 +17,38 @@ class Ipv6ExpressRouteCircuitPeeringConfig { /** * Create a Ipv6ExpressRouteCircuitPeeringConfig. - * @member {string} [primaryPeerAddressPrefix] The primary address prefix. - * @member {string} [secondaryPeerAddressPrefix] The secondary address + * @property {string} [primaryPeerAddressPrefix] The primary address prefix. + * @property {string} [secondaryPeerAddressPrefix] The secondary address * prefix. - * @member {object} [microsoftPeeringConfig] The Microsoft peering + * @property {object} [microsoftPeeringConfig] The Microsoft peering * configuration. - * @member {array} [microsoftPeeringConfig.advertisedPublicPrefixes] The + * @property {array} [microsoftPeeringConfig.advertisedPublicPrefixes] The * reference of AdvertisedPublicPrefixes. - * @member {array} [microsoftPeeringConfig.advertisedCommunities] The + * @property {array} [microsoftPeeringConfig.advertisedCommunities] The * communities of bgp peering. Spepcified for microsoft peering - * @member {string} [microsoftPeeringConfig.advertisedPublicPrefixesState] + * @property {string} [microsoftPeeringConfig.advertisedPublicPrefixesState] * AdvertisedPublicPrefixState of the Peering resource. Possible values are * 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. * Possible values include: 'NotConfigured', 'Configuring', 'Configured', * 'ValidationNeeded' - * @member {number} [microsoftPeeringConfig.legacyMode] The legacy mode of + * @property {number} [microsoftPeeringConfig.legacyMode] The legacy mode of * the peering. - * @member {number} [microsoftPeeringConfig.customerASN] The CustomerASN of + * @property {number} [microsoftPeeringConfig.customerASN] The CustomerASN of * the peering. - * @member {string} [microsoftPeeringConfig.routingRegistryName] The + * @property {string} [microsoftPeeringConfig.routingRegistryName] The * RoutingRegistryName of the configuration. - * @member {object} [routeFilter] The reference of the RouteFilter resource. - * @member {array} [routeFilter.rules] Collection of RouteFilterRules + * @property {object} [routeFilter] The reference of the RouteFilter + * resource. + * @property {array} [routeFilter.rules] Collection of RouteFilterRules * contained within a route filter. - * @member {array} [routeFilter.peerings] A collection of references to + * @property {array} [routeFilter.peerings] A collection of references to * express route circuit peerings. - * @member {string} [routeFilter.provisioningState] The provisioning state of - * the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and - * 'Failed'. - * @member {string} [routeFilter.etag] Gets a unique read-only string that + * @property {string} [routeFilter.provisioningState] The provisioning state + * of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' + * and 'Failed'. + * @property {string} [routeFilter.etag] Gets a unique read-only string that * changes whenever the resource is updated. - * @member {string} [state] The state of peering. Possible values are: + * @property {string} [state] The state of peering. Possible values are: * 'Disabled' and 'Enabled'. Possible values include: 'Disabled', 'Enabled' */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/listHubVirtualNetworkConnectionsResult.js b/lib/services/networkManagement2/lib/models/listHubVirtualNetworkConnectionsResult.js index 8c7741dbc1..9596bebb86 100644 --- a/lib/services/networkManagement2/lib/models/listHubVirtualNetworkConnectionsResult.js +++ b/lib/services/networkManagement2/lib/models/listHubVirtualNetworkConnectionsResult.js @@ -17,7 +17,7 @@ class ListHubVirtualNetworkConnectionsResult extends Array { /** * Create a ListHubVirtualNetworkConnectionsResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/listP2SVpnGatewaysResult.js b/lib/services/networkManagement2/lib/models/listP2SVpnGatewaysResult.js index ce6911aa72..988b232df9 100644 --- a/lib/services/networkManagement2/lib/models/listP2SVpnGatewaysResult.js +++ b/lib/services/networkManagement2/lib/models/listP2SVpnGatewaysResult.js @@ -17,7 +17,7 @@ class ListP2SVpnGatewaysResult extends Array { /** * Create a ListP2SVpnGatewaysResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/listP2SVpnServerConfigurationsResult.js b/lib/services/networkManagement2/lib/models/listP2SVpnServerConfigurationsResult.js index 0c4df250da..24dc8bccc3 100644 --- a/lib/services/networkManagement2/lib/models/listP2SVpnServerConfigurationsResult.js +++ b/lib/services/networkManagement2/lib/models/listP2SVpnServerConfigurationsResult.js @@ -18,7 +18,7 @@ class ListP2SVpnServerConfigurationsResult extends Array { /** * Create a ListP2SVpnServerConfigurationsResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/listVirtualHubsResult.js b/lib/services/networkManagement2/lib/models/listVirtualHubsResult.js index 60052e6e7d..f5c2f8321e 100644 --- a/lib/services/networkManagement2/lib/models/listVirtualHubsResult.js +++ b/lib/services/networkManagement2/lib/models/listVirtualHubsResult.js @@ -17,7 +17,7 @@ class ListVirtualHubsResult extends Array { /** * Create a ListVirtualHubsResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/listVirtualWANsResult.js b/lib/services/networkManagement2/lib/models/listVirtualWANsResult.js index 2f58389096..0d494c5bf8 100644 --- a/lib/services/networkManagement2/lib/models/listVirtualWANsResult.js +++ b/lib/services/networkManagement2/lib/models/listVirtualWANsResult.js @@ -17,7 +17,7 @@ class ListVirtualWANsResult extends Array { /** * Create a ListVirtualWANsResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/listVpnConnectionsResult.js b/lib/services/networkManagement2/lib/models/listVpnConnectionsResult.js index 91652c5497..d991a75842 100644 --- a/lib/services/networkManagement2/lib/models/listVpnConnectionsResult.js +++ b/lib/services/networkManagement2/lib/models/listVpnConnectionsResult.js @@ -18,7 +18,7 @@ class ListVpnConnectionsResult extends Array { /** * Create a ListVpnConnectionsResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/listVpnGatewaysResult.js b/lib/services/networkManagement2/lib/models/listVpnGatewaysResult.js index b840abe313..6f02669101 100644 --- a/lib/services/networkManagement2/lib/models/listVpnGatewaysResult.js +++ b/lib/services/networkManagement2/lib/models/listVpnGatewaysResult.js @@ -17,7 +17,7 @@ class ListVpnGatewaysResult extends Array { /** * Create a ListVpnGatewaysResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/listVpnSitesResult.js b/lib/services/networkManagement2/lib/models/listVpnSitesResult.js index b704f0b2e5..76f08e9658 100644 --- a/lib/services/networkManagement2/lib/models/listVpnSitesResult.js +++ b/lib/services/networkManagement2/lib/models/listVpnSitesResult.js @@ -17,7 +17,7 @@ class ListVpnSitesResult extends Array { /** * Create a ListVpnSitesResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/loadBalancer.js b/lib/services/networkManagement2/lib/models/loadBalancer.js index 506f205995..ae646db2c0 100644 --- a/lib/services/networkManagement2/lib/models/loadBalancer.js +++ b/lib/services/networkManagement2/lib/models/loadBalancer.js @@ -20,24 +20,24 @@ const models = require('./index'); class LoadBalancer extends models['Resource'] { /** * Create a LoadBalancer. - * @member {object} [sku] The load balancer SKU. - * @member {string} [sku.name] Name of a load balancer SKU. Possible values + * @property {object} [sku] The load balancer SKU. + * @property {string} [sku.name] Name of a load balancer SKU. Possible values * include: 'Basic', 'Standard' - * @member {array} [frontendIPConfigurations] Object representing the + * @property {array} [frontendIPConfigurations] Object representing the * frontend IPs to be used for the load balancer - * @member {array} [backendAddressPools] Collection of backend address pools - * used by a load balancer - * @member {array} [loadBalancingRules] Object collection representing the + * @property {array} [backendAddressPools] Collection of backend address + * pools used by a load balancer + * @property {array} [loadBalancingRules] Object collection representing the * load balancing rules Gets the provisioning - * @member {array} [probes] Collection of probe objects used in the load + * @property {array} [probes] Collection of probe objects used in the load * balancer - * @member {array} [inboundNatRules] Collection of inbound NAT Rules used by - * a load balancer. Defining inbound NAT rules on your load balancer is + * @property {array} [inboundNatRules] Collection of inbound NAT Rules used + * by a load balancer. Defining inbound NAT rules on your load balancer is * mutually exclusive with defining an inbound NAT pool. Inbound NAT pools * are referenced from virtual machine scale sets. NICs that are associated * with individual virtual machines cannot reference an Inbound NAT pool. * They have to reference individual inbound NAT rules. - * @member {array} [inboundNatPools] Defines an external port range for + * @property {array} [inboundNatPools] Defines an external port range for * inbound NAT to a single backend port on NICs associated with a load * balancer. Inbound NAT rules are created automatically for each NIC * associated with the Load Balancer using an external port from this range. @@ -46,13 +46,13 @@ class LoadBalancer extends models['Resource'] { * virtual machine scale sets. NICs that are associated with individual * virtual machines cannot reference an inbound NAT pool. They have to * reference individual inbound NAT rules. - * @member {array} [outboundRules] The outbound rules. - * @member {string} [resourceGuid] The resource GUID property of the load + * @property {array} [outboundRules] The outbound rules. + * @property {string} [resourceGuid] The resource GUID property of the load * balancer resource. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {string} [provisioningState] Gets the provisioning state of the * PublicIP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/loadBalancerBackendAddressPoolListResult.js b/lib/services/networkManagement2/lib/models/loadBalancerBackendAddressPoolListResult.js index 0950d568de..85fd12fb5a 100644 --- a/lib/services/networkManagement2/lib/models/loadBalancerBackendAddressPoolListResult.js +++ b/lib/services/networkManagement2/lib/models/loadBalancerBackendAddressPoolListResult.js @@ -16,7 +16,7 @@ class LoadBalancerBackendAddressPoolListResult extends Array { /** * Create a LoadBalancerBackendAddressPoolListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/loadBalancerFrontendIPConfigurationListResult.js b/lib/services/networkManagement2/lib/models/loadBalancerFrontendIPConfigurationListResult.js index f7833aa361..c54d053383 100644 --- a/lib/services/networkManagement2/lib/models/loadBalancerFrontendIPConfigurationListResult.js +++ b/lib/services/networkManagement2/lib/models/loadBalancerFrontendIPConfigurationListResult.js @@ -16,7 +16,7 @@ class LoadBalancerFrontendIPConfigurationListResult extends Array { /** * Create a LoadBalancerFrontendIPConfigurationListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/loadBalancerListResult.js b/lib/services/networkManagement2/lib/models/loadBalancerListResult.js index 23583728e8..74571c16cc 100644 --- a/lib/services/networkManagement2/lib/models/loadBalancerListResult.js +++ b/lib/services/networkManagement2/lib/models/loadBalancerListResult.js @@ -16,7 +16,7 @@ class LoadBalancerListResult extends Array { /** * Create a LoadBalancerListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/loadBalancerLoadBalancingRuleListResult.js b/lib/services/networkManagement2/lib/models/loadBalancerLoadBalancingRuleListResult.js index d2d4db85ca..72de287b53 100644 --- a/lib/services/networkManagement2/lib/models/loadBalancerLoadBalancingRuleListResult.js +++ b/lib/services/networkManagement2/lib/models/loadBalancerLoadBalancingRuleListResult.js @@ -16,7 +16,7 @@ class LoadBalancerLoadBalancingRuleListResult extends Array { /** * Create a LoadBalancerLoadBalancingRuleListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/loadBalancerOutboundRuleListResult.js b/lib/services/networkManagement2/lib/models/loadBalancerOutboundRuleListResult.js index 7037ecebf8..a609dd45c7 100644 --- a/lib/services/networkManagement2/lib/models/loadBalancerOutboundRuleListResult.js +++ b/lib/services/networkManagement2/lib/models/loadBalancerOutboundRuleListResult.js @@ -16,7 +16,7 @@ class LoadBalancerOutboundRuleListResult extends Array { /** * Create a LoadBalancerOutboundRuleListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/loadBalancerProbeListResult.js b/lib/services/networkManagement2/lib/models/loadBalancerProbeListResult.js index c56bf7bd1b..a699792ba3 100644 --- a/lib/services/networkManagement2/lib/models/loadBalancerProbeListResult.js +++ b/lib/services/networkManagement2/lib/models/loadBalancerProbeListResult.js @@ -16,7 +16,7 @@ class LoadBalancerProbeListResult extends Array { /** * Create a LoadBalancerProbeListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/loadBalancerSku.js b/lib/services/networkManagement2/lib/models/loadBalancerSku.js index b0779d1650..6f8157992f 100644 --- a/lib/services/networkManagement2/lib/models/loadBalancerSku.js +++ b/lib/services/networkManagement2/lib/models/loadBalancerSku.js @@ -17,7 +17,7 @@ class LoadBalancerSku { /** * Create a LoadBalancerSku. - * @member {string} [name] Name of a load balancer SKU. Possible values + * @property {string} [name] Name of a load balancer SKU. Possible values * include: 'Basic', 'Standard' */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/loadBalancingRule.js b/lib/services/networkManagement2/lib/models/loadBalancingRule.js index 978d0deb75..5b6f1b769b 100644 --- a/lib/services/networkManagement2/lib/models/loadBalancingRule.js +++ b/lib/services/networkManagement2/lib/models/loadBalancingRule.js @@ -20,46 +20,47 @@ const models = require('./index'); class LoadBalancingRule extends models['SubResource'] { /** * Create a LoadBalancingRule. - * @member {object} [frontendIPConfiguration] A reference to frontend IP + * @property {object} [frontendIPConfiguration] A reference to frontend IP * addresses. - * @member {string} [frontendIPConfiguration.id] Resource ID. - * @member {object} [backendAddressPool] A reference to a pool of DIPs. + * @property {string} [frontendIPConfiguration.id] Resource ID. + * @property {object} [backendAddressPool] A reference to a pool of DIPs. * Inbound traffic is randomly load balanced across IPs in the backend IPs. - * @member {string} [backendAddressPool.id] Resource ID. - * @member {object} [probe] The reference of the load balancer probe used by - * the load balancing rule. - * @member {string} [probe.id] Resource ID. - * @member {string} protocol Possible values include: 'Udp', 'Tcp', 'All' - * @member {string} [loadDistribution] The load distribution policy for this - * rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. - * Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol' - * @member {number} frontendPort The port for the external endpoint. Port + * @property {string} [backendAddressPool.id] Resource ID. + * @property {object} [probe] The reference of the load balancer probe used + * by the load balancing rule. + * @property {string} [probe.id] Resource ID. + * @property {string} protocol Possible values include: 'Udp', 'Tcp', 'All' + * @property {string} [loadDistribution] The load distribution policy for + * this rule. Possible values are 'Default', 'SourceIP', and + * 'SourceIPProtocol'. Possible values include: 'Default', 'SourceIP', + * 'SourceIPProtocol' + * @property {number} frontendPort The port for the external endpoint. Port * numbers for each rule must be unique within the Load Balancer. Acceptable * values are between 0 and 65534. Note that value 0 enables "Any Port" - * @member {number} [backendPort] The port used for internal connections on + * @property {number} [backendPort] The port used for internal connections on * the endpoint. Acceptable values are between 0 and 65535. Note that value 0 * enables "Any Port" - * @member {number} [idleTimeoutInMinutes] The timeout for the TCP idle + * @property {number} [idleTimeoutInMinutes] The timeout for the TCP idle * connection. The value can be set between 4 and 30 minutes. The default * value is 4 minutes. This element is only used when the protocol is set to * TCP. - * @member {boolean} [enableFloatingIP] Configures a virtual machine's + * @property {boolean} [enableFloatingIP] Configures a virtual machine's * endpoint for the floating IP capability required to configure a SQL * AlwaysOn Availability Group. This setting is required when using the SQL * AlwaysOn Availability Groups in SQL server. This setting can't be changed * after you create the endpoint. - * @member {boolean} [enableTcpReset] Receive bidirectional TCP Reset on TCP - * flow idle timeout or unexpected connection termination. This element is - * only used when the protocol is set to TCP. - * @member {boolean} [disableOutboundSnat] Configures SNAT for the VMs in the - * backend pool to use the publicIP address specified in the frontend of the - * load balancing rule. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {boolean} [enableTcpReset] Receive bidirectional TCP Reset on + * TCP flow idle timeout or unexpected connection termination. This element + * is only used when the protocol is set to TCP. + * @property {boolean} [disableOutboundSnat] Configures SNAT for the VMs in + * the backend pool to use the publicIP address specified in the frontend of + * the load balancing rule. + * @property {string} [provisioningState] Gets the provisioning state of the * PublicIP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/localNetworkGateway.js b/lib/services/networkManagement2/lib/models/localNetworkGateway.js index 2ec08f4459..17746a1855 100644 --- a/lib/services/networkManagement2/lib/models/localNetworkGateway.js +++ b/lib/services/networkManagement2/lib/models/localNetworkGateway.js @@ -20,24 +20,24 @@ const models = require('./index'); class LocalNetworkGateway extends models['Resource'] { /** * Create a LocalNetworkGateway. - * @member {object} [localNetworkAddressSpace] Local network site address + * @property {object} [localNetworkAddressSpace] Local network site address * space. - * @member {array} [localNetworkAddressSpace.addressPrefixes] A list of + * @property {array} [localNetworkAddressSpace.addressPrefixes] A list of * address blocks reserved for this virtual network in CIDR notation. - * @member {string} [gatewayIpAddress] IP address of local network gateway. - * @member {object} [bgpSettings] Local network gateway's BGP speaker + * @property {string} [gatewayIpAddress] IP address of local network gateway. + * @property {object} [bgpSettings] Local network gateway's BGP speaker * settings. - * @member {number} [bgpSettings.asn] The BGP speaker's ASN. - * @member {string} [bgpSettings.bgpPeeringAddress] The BGP peering address + * @property {number} [bgpSettings.asn] The BGP speaker's ASN. + * @property {string} [bgpSettings.bgpPeeringAddress] The BGP peering address * and BGP identifier of this BGP speaker. - * @member {number} [bgpSettings.peerWeight] The weight added to routes + * @property {number} [bgpSettings.peerWeight] The weight added to routes * learned from this BGP speaker. - * @member {string} [resourceGuid] The resource GUID property of the + * @property {string} [resourceGuid] The resource GUID property of the * LocalNetworkGateway resource. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', * and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/localNetworkGatewayListResult.js b/lib/services/networkManagement2/lib/models/localNetworkGatewayListResult.js index 83f2432d5d..d7aa91afdf 100644 --- a/lib/services/networkManagement2/lib/models/localNetworkGatewayListResult.js +++ b/lib/services/networkManagement2/lib/models/localNetworkGatewayListResult.js @@ -16,7 +16,7 @@ class LocalNetworkGatewayListResult extends Array { /** * Create a LocalNetworkGatewayListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/logSpecification.js b/lib/services/networkManagement2/lib/models/logSpecification.js index bd032c17ec..56344441e1 100644 --- a/lib/services/networkManagement2/lib/models/logSpecification.js +++ b/lib/services/networkManagement2/lib/models/logSpecification.js @@ -17,9 +17,9 @@ class LogSpecification { /** * Create a LogSpecification. - * @member {string} [name] The name of the specification. - * @member {string} [displayName] The display name of the specification. - * @member {string} [blobDuration] Duration of the blob. + * @property {string} [name] The name of the specification. + * @property {string} [displayName] The display name of the specification. + * @property {string} [blobDuration] Duration of the blob. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/managedServiceIdentity.js b/lib/services/networkManagement2/lib/models/managedServiceIdentity.js new file mode 100644 index 0000000000..fa402858b7 --- /dev/null +++ b/lib/services/networkManagement2/lib/models/managedServiceIdentity.js @@ -0,0 +1,98 @@ +/* + * 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'; + +/** + * Identity for the resource. + * + */ +class ManagedServiceIdentity { + /** + * Create a ManagedServiceIdentity. + * @property {string} [principalId] The principal id of the system assigned + * identity. This property will only be provided for a system assigned + * identity. + * @property {string} [tenantId] The tenant id of the system assigned + * identity. This property will only be provided for a system assigned + * identity. + * @property {string} [type] The type of identity used for the resource. The + * type 'SystemAssigned, UserAssigned' includes both an implicitly created + * identity and a set of user assigned identities. The type 'None' will + * remove any identities from the virtual machine. Possible values include: + * 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' + * @property {object} [userAssignedIdentities] The list of user identities + * associated with resource. The user identity dictionary key references will + * be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + */ + constructor() { + } + + /** + * Defines the metadata of ManagedServiceIdentity + * + * @returns {object} metadata of ManagedServiceIdentity + * + */ + mapper() { + return { + required: false, + serializedName: 'ManagedServiceIdentity', + type: { + name: 'Composite', + className: 'ManagedServiceIdentity', + modelProperties: { + principalId: { + required: false, + readOnly: true, + serializedName: 'principalId', + type: { + name: 'String' + } + }, + tenantId: { + required: false, + readOnly: true, + serializedName: 'tenantId', + type: { + name: 'String' + } + }, + type: { + required: false, + serializedName: 'type', + type: { + name: 'Enum', + allowedValues: [ 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None' ] + } + }, + userAssignedIdentities: { + required: false, + serializedName: 'userAssignedIdentities', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'ManagedServiceIdentityUserAssignedIdentitiesValueElementType', + type: { + name: 'Composite', + className: 'ManagedServiceIdentityUserAssignedIdentitiesValue' + } + } + } + } + } + } + }; + } +} + +module.exports = ManagedServiceIdentity; diff --git a/lib/services/networkManagement2/lib/models/managedServiceIdentityUserAssignedIdentitiesValue.js b/lib/services/networkManagement2/lib/models/managedServiceIdentityUserAssignedIdentitiesValue.js new file mode 100644 index 0000000000..8f6531620b --- /dev/null +++ b/lib/services/networkManagement2/lib/models/managedServiceIdentityUserAssignedIdentitiesValue.js @@ -0,0 +1,62 @@ +/* + * 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'; + +/** + * Class representing a ManagedServiceIdentityUserAssignedIdentitiesValue. + */ +class ManagedServiceIdentityUserAssignedIdentitiesValue { + /** + * Create a ManagedServiceIdentityUserAssignedIdentitiesValue. + * @property {string} [principalId] The principal id of user assigned + * identity. + * @property {string} [clientId] The client id of user assigned identity. + */ + constructor() { + } + + /** + * Defines the metadata of ManagedServiceIdentityUserAssignedIdentitiesValue + * + * @returns {object} metadata of ManagedServiceIdentityUserAssignedIdentitiesValue + * + */ + mapper() { + return { + required: false, + serializedName: 'ManagedServiceIdentity_userAssignedIdentitiesValue', + type: { + name: 'Composite', + className: 'ManagedServiceIdentityUserAssignedIdentitiesValue', + modelProperties: { + principalId: { + required: false, + readOnly: true, + serializedName: 'principalId', + type: { + name: 'String' + } + }, + clientId: { + required: false, + readOnly: true, + serializedName: 'clientId', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = ManagedServiceIdentityUserAssignedIdentitiesValue; diff --git a/lib/services/networkManagement2/lib/models/matchedRule.js b/lib/services/networkManagement2/lib/models/matchedRule.js index ec9d7d44cd..a137af717c 100644 --- a/lib/services/networkManagement2/lib/models/matchedRule.js +++ b/lib/services/networkManagement2/lib/models/matchedRule.js @@ -17,8 +17,8 @@ class MatchedRule { /** * Create a MatchedRule. - * @member {string} [ruleName] Name of the matched network security rule. - * @member {string} [action] The network traffic is allowed or denied. + * @property {string} [ruleName] Name of the matched network security rule. + * @property {string} [action] The network traffic is allowed or denied. * Possible values are 'Allow' and 'Deny'. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/metricSpecification.js b/lib/services/networkManagement2/lib/models/metricSpecification.js index 851b3d3fbb..1b41458efd 100644 --- a/lib/services/networkManagement2/lib/models/metricSpecification.js +++ b/lib/services/networkManagement2/lib/models/metricSpecification.js @@ -17,23 +17,23 @@ class MetricSpecification { /** * Create a MetricSpecification. - * @member {string} [name] The name of the metric. - * @member {string} [displayName] The display name of the metric. - * @member {string} [displayDescription] The description of the metric. - * @member {string} [unit] Units the metric to be displayed in. - * @member {string} [aggregationType] The aggregation type. - * @member {array} [availabilities] List of availability. - * @member {boolean} [enableRegionalMdmAccount] Whether regional MDM account - * enabled. - * @member {boolean} [fillGapWithZero] Whether gaps would be filled with + * @property {string} [name] The name of the metric. + * @property {string} [displayName] The display name of the metric. + * @property {string} [displayDescription] The description of the metric. + * @property {string} [unit] Units the metric to be displayed in. + * @property {string} [aggregationType] The aggregation type. + * @property {array} [availabilities] List of availability. + * @property {boolean} [enableRegionalMdmAccount] Whether regional MDM + * account enabled. + * @property {boolean} [fillGapWithZero] Whether gaps would be filled with * zeros. - * @member {string} [metricFilterPattern] Pattern for the filter of the + * @property {string} [metricFilterPattern] Pattern for the filter of the * metric. - * @member {array} [dimensions] List of dimensions. - * @member {boolean} [isInternal] Whether the metric is internal. - * @member {string} [sourceMdmAccount] The source MDM account. - * @member {string} [sourceMdmNamespace] The source MDM namespace. - * @member {string} [resourceIdDimensionNameOverride] The resource Id + * @property {array} [dimensions] List of dimensions. + * @property {boolean} [isInternal] Whether the metric is internal. + * @property {string} [sourceMdmAccount] The source MDM account. + * @property {string} [sourceMdmNamespace] The source MDM namespace. + * @property {string} [resourceIdDimensionNameOverride] The resource Id * dimension name override. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticParameters.js b/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticParameters.js index f1ec723e18..fc90a15cd1 100644 --- a/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticParameters.js +++ b/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticParameters.js @@ -17,13 +17,13 @@ class NetworkConfigurationDiagnosticParameters { /** * Create a NetworkConfigurationDiagnosticParameters. - * @member {string} targetResourceId The ID of the target resource to perform - * network configuration diagnostic. Valid options are VM, NetworkInterface, - * VMSS/NetworkInterface and Application Gateway. - * @member {string} [verbosityLevel] Verbosity level. Accepted values are + * @property {string} targetResourceId The ID of the target resource to + * perform network configuration diagnostic. Valid options are VM, + * NetworkInterface, VMSS/NetworkInterface and Application Gateway. + * @property {string} [verbosityLevel] Verbosity level. Accepted values are * 'Normal', 'Minimum', 'Full'. Possible values include: 'Normal', 'Minimum', * 'Full' - * @member {array} profiles List of network configuration diagnostic + * @property {array} profiles List of network configuration diagnostic * profiles. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticProfile.js b/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticProfile.js index 8933b6defa..18b0e42a73 100644 --- a/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticProfile.js +++ b/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticProfile.js @@ -17,16 +17,16 @@ class NetworkConfigurationDiagnosticProfile { /** * Create a NetworkConfigurationDiagnosticProfile. - * @member {string} direction The direction of the traffic. Accepted values + * @property {string} direction The direction of the traffic. Accepted values * are 'Inbound' and 'Outbound'. Possible values include: 'Inbound', * 'Outbound' - * @member {string} protocol Protocol to be verified on. Accepted values are - * '*', TCP, UDP. - * @member {string} source Traffic source. Accepted values are '*', IP + * @property {string} protocol Protocol to be verified on. Accepted values + * are '*', TCP, UDP. + * @property {string} source Traffic source. Accepted values are '*', IP * Address/CIDR, Service Tag. - * @member {string} destination Traffic destination. Accepted values are: + * @property {string} destination Traffic destination. Accepted values are: * '*', IP Address/CIDR, Service Tag. - * @member {string} destinationPort Traffice destination port. Accepted + * @property {string} destinationPort Traffice destination port. Accepted * values are '*', port (for example, 3389) and port range (for example, * 80-100). */ diff --git a/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticResponse.js b/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticResponse.js index 684d65b67e..ef54a102f1 100644 --- a/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticResponse.js +++ b/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticResponse.js @@ -17,7 +17,7 @@ class NetworkConfigurationDiagnosticResponse { /** * Create a NetworkConfigurationDiagnosticResponse. - * @member {array} [results] List of network configuration diagnostic + * @property {array} [results] List of network configuration diagnostic * results. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticResult.js b/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticResult.js index 7eab355840..0f92eccfff 100644 --- a/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticResult.js +++ b/lib/services/networkManagement2/lib/models/networkConfigurationDiagnosticResult.js @@ -18,24 +18,24 @@ class NetworkConfigurationDiagnosticResult { /** * Create a NetworkConfigurationDiagnosticResult. - * @member {object} [profile] - * @member {string} [profile.direction] The direction of the traffic. + * @property {object} [profile] + * @property {string} [profile.direction] The direction of the traffic. * Accepted values are 'Inbound' and 'Outbound'. Possible values include: * 'Inbound', 'Outbound' - * @member {string} [profile.protocol] Protocol to be verified on. Accepted + * @property {string} [profile.protocol] Protocol to be verified on. Accepted * values are '*', TCP, UDP. - * @member {string} [profile.source] Traffic source. Accepted values are '*', - * IP Address/CIDR, Service Tag. - * @member {string} [profile.destination] Traffic destination. Accepted + * @property {string} [profile.source] Traffic source. Accepted values are + * '*', IP Address/CIDR, Service Tag. + * @property {string} [profile.destination] Traffic destination. Accepted * values are: '*', IP Address/CIDR, Service Tag. - * @member {string} [profile.destinationPort] Traffice destination port. + * @property {string} [profile.destinationPort] Traffice destination port. * Accepted values are '*', port (for example, 3389) and port range (for * example, 80-100). - * @member {object} [networkSecurityGroupResult] - * @member {string} [networkSecurityGroupResult.securityRuleAccessResult] The - * network traffic is allowed or denied. Possible values are 'Allow' and + * @property {object} [networkSecurityGroupResult] + * @property {string} [networkSecurityGroupResult.securityRuleAccessResult] + * The network traffic is allowed or denied. Possible values are 'Allow' and * 'Deny'. Possible values include: 'Allow', 'Deny' - * @member {array} + * @property {array} * [networkSecurityGroupResult.evaluatedNetworkSecurityGroups] List of * results network security groups diagnostic. */ diff --git a/lib/services/networkManagement2/lib/models/networkInterface.js b/lib/services/networkManagement2/lib/models/networkInterface.js index f73349171d..69b084a3f8 100644 --- a/lib/services/networkManagement2/lib/models/networkInterface.js +++ b/lib/services/networkManagement2/lib/models/networkInterface.js @@ -20,148 +20,150 @@ const models = require('./index'); class NetworkInterface extends models['Resource'] { /** * Create a NetworkInterface. - * @member {object} [virtualMachine] The reference of a virtual machine. - * @member {string} [virtualMachine.id] Resource ID. - * @member {object} [networkSecurityGroup] The reference of the + * @property {object} [virtualMachine] The reference of a virtual machine. + * @property {string} [virtualMachine.id] Resource ID. + * @property {object} [networkSecurityGroup] The reference of the * NetworkSecurityGroup resource. - * @member {array} [networkSecurityGroup.securityRules] A collection of + * @property {array} [networkSecurityGroup.securityRules] A collection of * security rules of the network security group. - * @member {array} [networkSecurityGroup.defaultSecurityRules] The default + * @property {array} [networkSecurityGroup.defaultSecurityRules] The default * security rules of network security group. - * @member {array} [networkSecurityGroup.networkInterfaces] A collection of + * @property {array} [networkSecurityGroup.networkInterfaces] A collection of * references to network interfaces. - * @member {array} [networkSecurityGroup.subnets] A collection of references - * to subnets. - * @member {string} [networkSecurityGroup.resourceGuid] The resource GUID + * @property {array} [networkSecurityGroup.subnets] A collection of + * references to subnets. + * @property {string} [networkSecurityGroup.resourceGuid] The resource GUID * property of the network security group resource. - * @member {string} [networkSecurityGroup.provisioningState] The provisioning - * state of the public IP resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [networkSecurityGroup.etag] A unique read-only string + * @property {string} [networkSecurityGroup.provisioningState] The + * provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + * @property {string} [networkSecurityGroup.etag] A unique read-only string * that changes whenever the resource is updated. - * @member {object} [interfaceEndpoint] A reference to the interface endpoint - * to which the network interface is linked. - * @member {string} [interfaceEndpoint.fqdn] A first-party service's FQDN + * @property {object} [interfaceEndpoint] A reference to the interface + * endpoint to which the network interface is linked. + * @property {string} [interfaceEndpoint.fqdn] A first-party service's FQDN * that is mapped to the private IP allocated via this interface endpoint. - * @member {object} [interfaceEndpoint.endpointService] A reference to the + * @property {object} [interfaceEndpoint.endpointService] A reference to the * service being brought into the virtual network. - * @member {string} [interfaceEndpoint.endpointService.id] A unique + * @property {string} [interfaceEndpoint.endpointService.id] A unique * identifier of the service being referenced by the interface endpoint. - * @member {object} [interfaceEndpoint.subnet] The ID of the subnet from + * @property {object} [interfaceEndpoint.subnet] The ID of the subnet from * which the private IP will be allocated. - * @member {string} [interfaceEndpoint.subnet.addressPrefix] The address + * @property {string} [interfaceEndpoint.subnet.addressPrefix] The address * prefix for the subnet. - * @member {array} [interfaceEndpoint.subnet.addressPrefixes] List of + * @property {array} [interfaceEndpoint.subnet.addressPrefixes] List of * address prefixes for the subnet. - * @member {object} [interfaceEndpoint.subnet.networkSecurityGroup] The + * @property {object} [interfaceEndpoint.subnet.networkSecurityGroup] The * reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [interfaceEndpoint.subnet.networkSecurityGroup.securityRules] A collection * of security rules of the network security group. - * @member {array} + * @property {array} * [interfaceEndpoint.subnet.networkSecurityGroup.defaultSecurityRules] The * default security rules of network security group. - * @member {array} + * @property {array} * [interfaceEndpoint.subnet.networkSecurityGroup.networkInterfaces] A * collection of references to network interfaces. - * @member {array} [interfaceEndpoint.subnet.networkSecurityGroup.subnets] A - * collection of references to subnets. - * @member {string} + * @property {array} [interfaceEndpoint.subnet.networkSecurityGroup.subnets] + * A collection of references to subnets. + * @property {string} * [interfaceEndpoint.subnet.networkSecurityGroup.resourceGuid] The resource * GUID property of the network security group resource. - * @member {string} + * @property {string} * [interfaceEndpoint.subnet.networkSecurityGroup.provisioningState] The * provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [interfaceEndpoint.subnet.networkSecurityGroup.etag] A + * @property {string} [interfaceEndpoint.subnet.networkSecurityGroup.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {object} [interfaceEndpoint.subnet.routeTable] The reference of + * @property {object} [interfaceEndpoint.subnet.routeTable] The reference of * the RouteTable resource. - * @member {array} [interfaceEndpoint.subnet.routeTable.routes] Collection of - * routes contained within a route table. - * @member {array} [interfaceEndpoint.subnet.routeTable.subnets] A collection - * of references to subnets. - * @member {boolean} + * @property {array} [interfaceEndpoint.subnet.routeTable.routes] Collection + * of routes contained within a route table. + * @property {array} [interfaceEndpoint.subnet.routeTable.subnets] A + * collection of references to subnets. + * @property {boolean} * [interfaceEndpoint.subnet.routeTable.disableBgpRoutePropagation] Gets or * sets whether to disable the routes learned by BGP on that route table. * True means disable. - * @member {string} [interfaceEndpoint.subnet.routeTable.provisioningState] + * @property {string} [interfaceEndpoint.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [interfaceEndpoint.subnet.routeTable.etag] Gets a unique - * read-only string that changes whenever the resource is updated. - * @member {array} [interfaceEndpoint.subnet.serviceEndpoints] An array of + * @property {string} [interfaceEndpoint.subnet.routeTable.etag] Gets a + * unique read-only string that changes whenever the resource is updated. + * @property {array} [interfaceEndpoint.subnet.serviceEndpoints] An array of * service endpoints. - * @member {array} [interfaceEndpoint.subnet.serviceEndpointPolicies] An + * @property {array} [interfaceEndpoint.subnet.serviceEndpointPolicies] An * array of service endpoint policies. - * @member {array} [interfaceEndpoint.subnet.interfaceEndpoints] An array of - * references to interface endpoints - * @member {array} [interfaceEndpoint.subnet.ipConfigurations] Gets an array - * of references to the network interface IP configurations using subnet. - * @member {array} [interfaceEndpoint.subnet.ipConfigurationProfiles] Array + * @property {array} [interfaceEndpoint.subnet.interfaceEndpoints] An array + * of references to interface endpoints + * @property {array} [interfaceEndpoint.subnet.ipConfigurations] Gets an + * array of references to the network interface IP configurations using + * subnet. + * @property {array} [interfaceEndpoint.subnet.ipConfigurationProfiles] Array * of IP configuration profiles which reference this subnet. - * @member {array} [interfaceEndpoint.subnet.resourceNavigationLinks] Gets an - * array of references to the external resources using subnet. - * @member {array} [interfaceEndpoint.subnet.serviceAssociationLinks] Gets an - * array of references to services injecting into this subnet. - * @member {array} [interfaceEndpoint.subnet.delegations] Gets an array of + * @property {array} [interfaceEndpoint.subnet.resourceNavigationLinks] Gets + * an array of references to the external resources using subnet. + * @property {array} [interfaceEndpoint.subnet.serviceAssociationLinks] Gets + * an array of references to services injecting into this subnet. + * @property {array} [interfaceEndpoint.subnet.delegations] Gets an array of * references to the delegations on the subnet. - * @member {string} [interfaceEndpoint.subnet.purpose] A read-only string + * @property {string} [interfaceEndpoint.subnet.purpose] A read-only string * identifying the intention of use for this subnet based on delegations and * other user-defined properties. - * @member {string} [interfaceEndpoint.subnet.provisioningState] The + * @property {string} [interfaceEndpoint.subnet.provisioningState] The * provisioning state of the resource. - * @member {string} [interfaceEndpoint.subnet.name] The name of the resource - * that is unique within a resource group. This name can be used to access - * the resource. - * @member {string} [interfaceEndpoint.subnet.etag] A unique read-only string - * that changes whenever the resource is updated. - * @member {array} [interfaceEndpoint.networkInterfaces] Gets an array of + * @property {string} [interfaceEndpoint.subnet.name] The name of the + * resource that is unique within a resource group. This name can be used to + * access the resource. + * @property {string} [interfaceEndpoint.subnet.etag] A unique read-only + * string that changes whenever the resource is updated. + * @property {array} [interfaceEndpoint.networkInterfaces] Gets an array of * references to the network interfaces created for this interface endpoint. - * @member {string} [interfaceEndpoint.owner] A read-only property that + * @property {string} [interfaceEndpoint.owner] A read-only property that * identifies who created this interface endpoint. - * @member {string} [interfaceEndpoint.provisioningState] The provisioning + * @property {string} [interfaceEndpoint.provisioningState] The provisioning * state of the interface endpoint. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [interfaceEndpoint.etag] Gets a unique read-only string + * @property {string} [interfaceEndpoint.etag] Gets a unique read-only string * that changes whenever the resource is updated. - * @member {array} [ipConfigurations] A list of IPConfigurations of the + * @property {array} [ipConfigurations] A list of IPConfigurations of the * network interface. - * @member {array} [tapConfigurations] A list of TapConfigurations of the + * @property {array} [tapConfigurations] A list of TapConfigurations of the * network interface. - * @member {object} [dnsSettings] The DNS settings in network interface. - * @member {array} [dnsSettings.dnsServers] List of DNS servers IP addresses. - * Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. - * 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the - * only value in dnsServers collection. - * @member {array} [dnsSettings.appliedDnsServers] If the VM that uses this + * @property {object} [dnsSettings] The DNS settings in network interface. + * @property {array} [dnsSettings.dnsServers] List of DNS servers IP + * addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS + * resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it + * must be the only value in dnsServers collection. + * @property {array} [dnsSettings.appliedDnsServers] If the VM that uses this * NIC is part of an Availability Set, then this list will have the union of * all DNS servers from all NICs that are part of the Availability Set. This * property is what is configured on each of those VMs. - * @member {string} [dnsSettings.internalDnsNameLabel] Relative DNS name for - * this NIC used for internal communications between VMs in the same virtual - * network. - * @member {string} [dnsSettings.internalFqdn] Fully qualified DNS name + * @property {string} [dnsSettings.internalDnsNameLabel] Relative DNS name + * for this NIC used for internal communications between VMs in the same + * virtual network. + * @property {string} [dnsSettings.internalFqdn] Fully qualified DNS name * supporting internal communications between VMs in the same virtual * network. - * @member {string} [dnsSettings.internalDomainNameSuffix] Even if + * @property {string} [dnsSettings.internalDomainNameSuffix] Even if * internalDnsNameLabel is not specified, a DNS entry is created for the * primary NIC of the VM. This DNS name can be constructed by concatenating * the VM name with the value of internalDomainNameSuffix. - * @member {string} [macAddress] The MAC address of the network interface. - * @member {boolean} [primary] Gets whether this is a primary network + * @property {string} [macAddress] The MAC address of the network interface. + * @property {boolean} [primary] Gets whether this is a primary network * interface on a virtual machine. - * @member {boolean} [enableAcceleratedNetworking] If the network interface + * @property {boolean} [enableAcceleratedNetworking] If the network interface * is accelerated networking enabled. - * @member {boolean} [enableIPForwarding] Indicates whether IP forwarding is - * enabled on this network interface. - * @member {array} [hostedWorkloads] A list of references to linked BareMetal - * resources - * @member {string} [resourceGuid] The resource GUID property of the network - * interface resource. - * @member {string} [provisioningState] The provisioning state of the public - * IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {boolean} [enableIPForwarding] Indicates whether IP forwarding + * is enabled on this network interface. + * @property {array} [hostedWorkloads] A list of references to linked + * BareMetal resources + * @property {string} [resourceGuid] The resource GUID property of the + * network interface resource. + * @property {string} [provisioningState] The provisioning state of the + * public IP resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/networkInterfaceAssociation.js b/lib/services/networkManagement2/lib/models/networkInterfaceAssociation.js index 4bc413a521..34a8f127b9 100644 --- a/lib/services/networkManagement2/lib/models/networkInterfaceAssociation.js +++ b/lib/services/networkManagement2/lib/models/networkInterfaceAssociation.js @@ -17,8 +17,8 @@ class NetworkInterfaceAssociation { /** * Create a NetworkInterfaceAssociation. - * @member {string} [id] Network interface ID. - * @member {array} [securityRules] Collection of custom security rules. + * @property {string} [id] Network interface ID. + * @property {array} [securityRules] Collection of custom security rules. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/networkInterfaceDnsSettings.js b/lib/services/networkManagement2/lib/models/networkInterfaceDnsSettings.js index eb3373a032..adf9050c5a 100644 --- a/lib/services/networkManagement2/lib/models/networkInterfaceDnsSettings.js +++ b/lib/services/networkManagement2/lib/models/networkInterfaceDnsSettings.js @@ -17,19 +17,19 @@ class NetworkInterfaceDnsSettings { /** * Create a NetworkInterfaceDnsSettings. - * @member {array} [dnsServers] List of DNS servers IP addresses. Use + * @property {array} [dnsServers] List of DNS servers IP addresses. Use * 'AzureProvidedDNS' to switch to azure provided DNS resolution. * 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the * only value in dnsServers collection. - * @member {array} [appliedDnsServers] If the VM that uses this NIC is part + * @property {array} [appliedDnsServers] If the VM that uses this NIC is part * of an Availability Set, then this list will have the union of all DNS * servers from all NICs that are part of the Availability Set. This property * is what is configured on each of those VMs. - * @member {string} [internalDnsNameLabel] Relative DNS name for this NIC + * @property {string} [internalDnsNameLabel] Relative DNS name for this NIC * used for internal communications between VMs in the same virtual network. - * @member {string} [internalFqdn] Fully qualified DNS name supporting + * @property {string} [internalFqdn] Fully qualified DNS name supporting * internal communications between VMs in the same virtual network. - * @member {string} [internalDomainNameSuffix] Even if internalDnsNameLabel + * @property {string} [internalDomainNameSuffix] Even if internalDnsNameLabel * is not specified, a DNS entry is created for the primary NIC of the VM. * This DNS name can be constructed by concatenating the VM name with the * value of internalDomainNameSuffix. diff --git a/lib/services/networkManagement2/lib/models/networkInterfaceIPConfiguration.js b/lib/services/networkManagement2/lib/models/networkInterfaceIPConfiguration.js index b63537f8d3..bc754a7e9f 100644 --- a/lib/services/networkManagement2/lib/models/networkInterfaceIPConfiguration.js +++ b/lib/services/networkManagement2/lib/models/networkInterfaceIPConfiguration.js @@ -20,238 +20,241 @@ const models = require('./index'); class NetworkInterfaceIPConfiguration extends models['SubResource'] { /** * Create a NetworkInterfaceIPConfiguration. - * @member {array} [virtualNetworkTaps] The reference to Virtual Network + * @property {array} [virtualNetworkTaps] The reference to Virtual Network * Taps. - * @member {array} [applicationGatewayBackendAddressPools] The reference of + * @property {array} [applicationGatewayBackendAddressPools] The reference of * ApplicationGatewayBackendAddressPool resource. - * @member {array} [loadBalancerBackendAddressPools] The reference of + * @property {array} [loadBalancerBackendAddressPools] The reference of * LoadBalancerBackendAddressPool resource. - * @member {array} [loadBalancerInboundNatRules] A list of references of + * @property {array} [loadBalancerInboundNatRules] A list of references of * LoadBalancerInboundNatRules. - * @member {string} [privateIPAddress] Private IP address of the IP + * @property {string} [privateIPAddress] Private IP address of the IP * configuration. - * @member {string} [privateIPAllocationMethod] Defines how a private IP + * @property {string} [privateIPAllocationMethod] Defines how a private IP * address is assigned. Possible values are: 'Static' and 'Dynamic'. Possible * values include: 'Static', 'Dynamic' - * @member {string} [privateIPAddressVersion] Available from Api-Version + * @property {string} [privateIPAddressVersion] Available from Api-Version * 2016-03-30 onwards, it represents whether the specific ipconfiguration is * IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and * 'IPv6'. Possible values include: 'IPv4', 'IPv6' - * @member {object} [subnet] Subnet bound to the IP configuration. - * @member {string} [subnet.addressPrefix] The address prefix for the subnet. - * @member {array} [subnet.addressPrefixes] List of address prefixes for the + * @property {object} [subnet] Subnet bound to the IP configuration. + * @property {string} [subnet.addressPrefix] The address prefix for the * subnet. - * @member {object} [subnet.networkSecurityGroup] The reference of the + * @property {array} [subnet.addressPrefixes] List of address prefixes for + * the subnet. + * @property {object} [subnet.networkSecurityGroup] The reference of the * NetworkSecurityGroup resource. - * @member {array} [subnet.networkSecurityGroup.securityRules] A collection + * @property {array} [subnet.networkSecurityGroup.securityRules] A collection * of security rules of the network security group. - * @member {array} [subnet.networkSecurityGroup.defaultSecurityRules] The + * @property {array} [subnet.networkSecurityGroup.defaultSecurityRules] The * default security rules of network security group. - * @member {array} [subnet.networkSecurityGroup.networkInterfaces] A + * @property {array} [subnet.networkSecurityGroup.networkInterfaces] A * collection of references to network interfaces. - * @member {array} [subnet.networkSecurityGroup.subnets] A collection of + * @property {array} [subnet.networkSecurityGroup.subnets] A collection of * references to subnets. - * @member {string} [subnet.networkSecurityGroup.resourceGuid] The resource + * @property {string} [subnet.networkSecurityGroup.resourceGuid] The resource * GUID property of the network security group resource. - * @member {string} [subnet.networkSecurityGroup.provisioningState] The + * @property {string} [subnet.networkSecurityGroup.provisioningState] The * provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [subnet.networkSecurityGroup.etag] A unique read-only + * @property {string} [subnet.networkSecurityGroup.etag] A unique read-only * string that changes whenever the resource is updated. - * @member {object} [subnet.routeTable] The reference of the RouteTable + * @property {object} [subnet.routeTable] The reference of the RouteTable * resource. - * @member {array} [subnet.routeTable.routes] Collection of routes contained - * within a route table. - * @member {array} [subnet.routeTable.subnets] A collection of references to - * subnets. - * @member {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or + * @property {array} [subnet.routeTable.routes] Collection of routes + * contained within a route table. + * @property {array} [subnet.routeTable.subnets] A collection of references + * to subnets. + * @property {boolean} [subnet.routeTable.disableBgpRoutePropagation] Gets or * sets whether to disable the routes learned by BGP on that route table. * True means disable. - * @member {string} [subnet.routeTable.provisioningState] The provisioning + * @property {string} [subnet.routeTable.provisioningState] The provisioning * state of the resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [subnet.routeTable.etag] Gets a unique read-only string + * @property {string} [subnet.routeTable.etag] Gets a unique read-only string * that changes whenever the resource is updated. - * @member {array} [subnet.serviceEndpoints] An array of service endpoints. - * @member {array} [subnet.serviceEndpointPolicies] An array of service + * @property {array} [subnet.serviceEndpoints] An array of service endpoints. + * @property {array} [subnet.serviceEndpointPolicies] An array of service * endpoint policies. - * @member {array} [subnet.interfaceEndpoints] An array of references to + * @property {array} [subnet.interfaceEndpoints] An array of references to * interface endpoints - * @member {array} [subnet.ipConfigurations] Gets an array of references to + * @property {array} [subnet.ipConfigurations] Gets an array of references to * the network interface IP configurations using subnet. - * @member {array} [subnet.ipConfigurationProfiles] Array of IP configuration - * profiles which reference this subnet. - * @member {array} [subnet.resourceNavigationLinks] Gets an array of + * @property {array} [subnet.ipConfigurationProfiles] Array of IP + * configuration profiles which reference this subnet. + * @property {array} [subnet.resourceNavigationLinks] Gets an array of * references to the external resources using subnet. - * @member {array} [subnet.serviceAssociationLinks] Gets an array of + * @property {array} [subnet.serviceAssociationLinks] Gets an array of * references to services injecting into this subnet. - * @member {array} [subnet.delegations] Gets an array of references to the + * @property {array} [subnet.delegations] Gets an array of references to the * delegations on the subnet. - * @member {string} [subnet.purpose] A read-only string identifying the + * @property {string} [subnet.purpose] A read-only string identifying the * intention of use for this subnet based on delegations and other * user-defined properties. - * @member {string} [subnet.provisioningState] The provisioning state of the - * resource. - * @member {string} [subnet.name] The name of the resource that is unique + * @property {string} [subnet.provisioningState] The provisioning state of + * the resource. + * @property {string} [subnet.name] The name of the resource that is unique * within a resource group. This name can be used to access the resource. - * @member {string} [subnet.etag] A unique read-only string that changes + * @property {string} [subnet.etag] A unique read-only string that changes * whenever the resource is updated. - * @member {boolean} [primary] Gets whether this is a primary customer + * @property {boolean} [primary] Gets whether this is a primary customer * address on the network interface. - * @member {object} [publicIPAddress] Public IP address bound to the IP + * @property {object} [publicIPAddress] Public IP address bound to the IP * configuration. - * @member {object} [publicIPAddress.sku] The public IP address SKU. - * @member {string} [publicIPAddress.sku.name] Name of a public IP address + * @property {object} [publicIPAddress.sku] The public IP address SKU. + * @property {string} [publicIPAddress.sku.name] Name of a public IP address * SKU. Possible values include: 'Basic', 'Standard' - * @member {string} [publicIPAddress.publicIPAllocationMethod] The public IP - * allocation method. Possible values are: 'Static' and 'Dynamic'. Possible - * values include: 'Static', 'Dynamic' - * @member {string} [publicIPAddress.publicIPAddressVersion] The public IP + * @property {string} [publicIPAddress.publicIPAllocationMethod] The public + * IP allocation method. Possible values are: 'Static' and 'Dynamic'. + * Possible values include: 'Static', 'Dynamic' + * @property {string} [publicIPAddress.publicIPAddressVersion] The public IP * address version. Possible values are: 'IPv4' and 'IPv6'. Possible values * include: 'IPv4', 'IPv6' - * @member {object} [publicIPAddress.ipConfiguration] The IP configuration + * @property {object} [publicIPAddress.ipConfiguration] The IP configuration * associated with the public IP address. - * @member {string} [publicIPAddress.ipConfiguration.privateIPAddress] The + * @property {string} [publicIPAddress.ipConfiguration.privateIPAddress] The * private IP address of the IP configuration. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.privateIPAllocationMethod] The private IP * allocation method. Possible values are 'Static' and 'Dynamic'. Possible * values include: 'Static', 'Dynamic' - * @member {object} [publicIPAddress.ipConfiguration.subnet] The reference of - * the subnet resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.addressPrefix] + * @property {object} [publicIPAddress.ipConfiguration.subnet] The reference + * of the subnet resource. + * @property {string} [publicIPAddress.ipConfiguration.subnet.addressPrefix] * The address prefix for the subnet. - * @member {array} [publicIPAddress.ipConfiguration.subnet.addressPrefixes] + * @property {array} [publicIPAddress.ipConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] The * reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] A * collection of references to subnets. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.ipConfiguration.subnet.routeTable] The + * @property {object} [publicIPAddress.ipConfiguration.subnet.routeTable] The * reference of the RouteTable resource. - * @member {array} [publicIPAddress.ipConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * @member {array} + * @property {array} + * [publicIPAddress.ipConfiguration.subnet.routeTable.routes] Collection of + * routes contained within a route table. + * @property {array} * [publicIPAddress.ipConfiguration.subnet.routeTable.subnets] A collection * of references to subnets. - * @member {boolean} + * @property {boolean} * [publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] The * provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.ipConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * @member {array} [publicIPAddress.ipConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * @member {array} + * @property {string} + * [publicIPAddress.ipConfiguration.subnet.routeTable.etag] Gets a unique + * read-only string that changes whenever the resource is updated. + * @property {array} + * [publicIPAddress.ipConfiguration.subnet.serviceEndpoints] An array of + * service endpoints. + * @property {array} * [publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] An array * of service endpoint policies. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] An array of * references to interface endpoints - * @member {array} [publicIPAddress.ipConfiguration.subnet.ipConfigurations] - * Gets an array of references to the network interface IP configurations - * using subnet. - * @member {array} + * @property {array} + * [publicIPAddress.ipConfiguration.subnet.ipConfigurations] Gets an array of + * references to the network interface IP configurations using subnet. + * @property {array} * [publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] Array of * IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] Gets an * array of references to the external resources using subnet. - * @member {array} + * @property {array} * [publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] Gets an * array of references to services injecting into this subnet. - * @member {array} [publicIPAddress.ipConfiguration.subnet.delegations] Gets - * an array of references to the delegations on the subnet. - * @member {string} [publicIPAddress.ipConfiguration.subnet.purpose] A + * @property {array} [publicIPAddress.ipConfiguration.subnet.delegations] + * Gets an array of references to the delegations on the subnet. + * @property {string} [publicIPAddress.ipConfiguration.subnet.purpose] A * read-only string identifying the intention of use for this subnet based on * delegations and other user-defined properties. - * @member {string} + * @property {string} * [publicIPAddress.ipConfiguration.subnet.provisioningState] The * provisioning state of the resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.name] The name of - * the resource that is unique within a resource group. This name can be used - * to access the resource. - * @member {string} [publicIPAddress.ipConfiguration.subnet.etag] A unique + * @property {string} [publicIPAddress.ipConfiguration.subnet.name] The name + * of the resource that is unique within a resource group. This name can be + * used to access the resource. + * @property {string} [publicIPAddress.ipConfiguration.subnet.etag] A unique * read-only string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.ipConfiguration.publicIPAddress] The + * @property {object} [publicIPAddress.ipConfiguration.publicIPAddress] The * reference of the public IP resource. - * @member {string} [publicIPAddress.ipConfiguration.provisioningState] Gets - * the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.ipConfiguration.name] The name of the + * @property {string} [publicIPAddress.ipConfiguration.provisioningState] + * Gets the provisioning state of the public IP resource. Possible values + * are: 'Updating', 'Deleting', and 'Failed'. + * @property {string} [publicIPAddress.ipConfiguration.name] The name of the * resource that is unique within a resource group. This name can be used to * access the resource. - * @member {string} [publicIPAddress.ipConfiguration.etag] A unique read-only - * string that changes whenever the resource is updated. - * @member {object} [publicIPAddress.dnsSettings] The FQDN of the DNS record - * associated with the public IP address. - * @member {string} [publicIPAddress.dnsSettings.domainNameLabel] Gets or + * @property {string} [publicIPAddress.ipConfiguration.etag] A unique + * read-only string that changes whenever the resource is updated. + * @property {object} [publicIPAddress.dnsSettings] The FQDN of the DNS + * record associated with the public IP address. + * @property {string} [publicIPAddress.dnsSettings.domainNameLabel] Gets or * sets the Domain name label.The concatenation of the domain name label and * the regionalized DNS zone make up the fully qualified domain name * associated with the public IP address. If a domain name label is * specified, an A DNS record is created for the public IP in the Microsoft * Azure DNS system. - * @member {string} [publicIPAddress.dnsSettings.fqdn] Gets the FQDN, Fully + * @property {string} [publicIPAddress.dnsSettings.fqdn] Gets the FQDN, Fully * qualified domain name of the A DNS record associated with the public IP. * This is the concatenation of the domainNameLabel and the regionalized DNS * zone. - * @member {string} [publicIPAddress.dnsSettings.reverseFqdn] Gets or Sets + * @property {string} [publicIPAddress.dnsSettings.reverseFqdn] Gets or Sets * the Reverse FQDN. A user-visible, fully qualified domain name that * resolves to this public IP address. If the reverseFqdn is specified, then * a PTR DNS record is created pointing from the IP address in the * in-addr.arpa domain to the reverse FQDN. - * @member {array} [publicIPAddress.ipTags] The list of tags associated with - * the public IP address. - * @member {string} [publicIPAddress.ipAddress] The IP address associated + * @property {array} [publicIPAddress.ipTags] The list of tags associated + * with the public IP address. + * @property {string} [publicIPAddress.ipAddress] The IP address associated * with the public IP address resource. - * @member {object} [publicIPAddress.publicIPPrefix] The Public IP Prefix + * @property {object} [publicIPAddress.publicIPPrefix] The Public IP Prefix * this Public IP Address should be allocated from. - * @member {string} [publicIPAddress.publicIPPrefix.id] Resource ID. - * @member {number} [publicIPAddress.idleTimeoutInMinutes] The idle timeout + * @property {string} [publicIPAddress.publicIPPrefix.id] Resource ID. + * @property {number} [publicIPAddress.idleTimeoutInMinutes] The idle timeout * of the public IP address. - * @member {string} [publicIPAddress.resourceGuid] The resource GUID property - * of the public IP resource. - * @member {string} [publicIPAddress.provisioningState] The provisioning + * @property {string} [publicIPAddress.resourceGuid] The resource GUID + * property of the public IP resource. + * @property {string} [publicIPAddress.provisioningState] The provisioning * state of the PublicIP resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [publicIPAddress.etag] A unique read-only string that + * @property {string} [publicIPAddress.etag] A unique read-only string that * changes whenever the resource is updated. - * @member {array} [publicIPAddress.zones] A list of availability zones + * @property {array} [publicIPAddress.zones] A list of availability zones * denoting the IP allocated for the resource needs to come from. - * @member {array} [applicationSecurityGroups] Application security groups in - * which the IP configuration is included. - * @member {string} [provisioningState] The provisioning state of the network - * interface IP configuration. Possible values are: 'Updating', 'Deleting', - * and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {array} [applicationSecurityGroups] Application security groups + * in which the IP configuration is included. + * @property {string} [provisioningState] The provisioning state of the + * network interface IP configuration. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/networkInterfaceIPConfigurationListResult.js b/lib/services/networkManagement2/lib/models/networkInterfaceIPConfigurationListResult.js index af962fd6bc..6af1631121 100644 --- a/lib/services/networkManagement2/lib/models/networkInterfaceIPConfigurationListResult.js +++ b/lib/services/networkManagement2/lib/models/networkInterfaceIPConfigurationListResult.js @@ -16,7 +16,7 @@ class NetworkInterfaceIPConfigurationListResult extends Array { /** * Create a NetworkInterfaceIPConfigurationListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/networkInterfaceListResult.js b/lib/services/networkManagement2/lib/models/networkInterfaceListResult.js index 125b569ac8..c2a4895e9a 100644 --- a/lib/services/networkManagement2/lib/models/networkInterfaceListResult.js +++ b/lib/services/networkManagement2/lib/models/networkInterfaceListResult.js @@ -16,7 +16,7 @@ class NetworkInterfaceListResult extends Array { /** * Create a NetworkInterfaceListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/networkInterfaceLoadBalancerListResult.js b/lib/services/networkManagement2/lib/models/networkInterfaceLoadBalancerListResult.js index c4ff846d5c..6df02f387d 100644 --- a/lib/services/networkManagement2/lib/models/networkInterfaceLoadBalancerListResult.js +++ b/lib/services/networkManagement2/lib/models/networkInterfaceLoadBalancerListResult.js @@ -16,7 +16,7 @@ class NetworkInterfaceLoadBalancerListResult extends Array { /** * Create a NetworkInterfaceLoadBalancerListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/networkInterfaceTapConfiguration.js b/lib/services/networkManagement2/lib/models/networkInterfaceTapConfiguration.js index 8194c5da80..d79d64dcf9 100644 --- a/lib/services/networkManagement2/lib/models/networkInterfaceTapConfiguration.js +++ b/lib/services/networkManagement2/lib/models/networkInterfaceTapConfiguration.js @@ -20,678 +20,678 @@ const models = require('./index'); class NetworkInterfaceTapConfiguration extends models['SubResource'] { /** * Create a NetworkInterfaceTapConfiguration. - * @member {object} [virtualNetworkTap] The reference of the Virtual Network - * Tap resource. - * @member {array} [virtualNetworkTap.networkInterfaceTapConfigurations] + * @property {object} [virtualNetworkTap] The reference of the Virtual + * Network Tap resource. + * @property {array} [virtualNetworkTap.networkInterfaceTapConfigurations] * Specifies the list of resource IDs for the network interface IP * configuration that needs to be tapped. - * @member {string} [virtualNetworkTap.resourceGuid] The resourceGuid + * @property {string} [virtualNetworkTap.resourceGuid] The resourceGuid * property of the virtual network tap. - * @member {string} [virtualNetworkTap.provisioningState] The provisioning + * @property {string} [virtualNetworkTap.provisioningState] The provisioning * state of the virtual network tap. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration] The * reference to the private IP Address of the collector nic that will receive * the tap - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] * The reference to Virtual Network Taps. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] * The reference of ApplicationGatewayBackendAddressPool resource. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] * The reference of LoadBalancerBackendAddressPool resource. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] * A list of references of LoadBalancerInboundNatRules. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.privateIPAddress] * Private IP address of the IP configuration. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] * Defines how a private IP address is assigned. Possible values are: * 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] * Available from Api-Version 2016-03-30 onwards, it represents whether the * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', * 'IPv6' - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet] * Subnet bound to the IP configuration. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.addressPrefix] * The address prefix for the subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup] * The reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.subnets] * A collection of references to subnets. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable] * The reference of the RouteTable resource. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable.subnets] * A collection of references to subnets. - * @member {boolean} + * @property {boolean} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.routeTable.etag] * Gets a unique read-only string that changes whenever the resource is * updated. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.serviceEndpoints] * An array of service endpoints. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.serviceEndpointPolicies] * An array of service endpoint policies. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.interfaceEndpoints] * An array of references to interface endpoints - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.ipConfigurations] * Gets an array of references to the network interface IP configurations * using subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.delegations] * Gets an array of references to the delegations on the subnet. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.purpose] * A read-only string identifying the intention of use for this subnet based * on delegations and other user-defined properties. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.provisioningState] * The provisioning state of the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.subnet.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {boolean} + * @property {boolean} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.primary] * Gets whether this is a primary customer address on the network interface. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress] * Public IP address bound to the IP configuration. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.sku] * The public IP address SKU. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.sku.name] * Name of a public IP address SKU. Possible values include: 'Basic', * 'Standard' - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPAllocationMethod] * The public IP allocation method. Possible values are: 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPAddressVersion] * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. * Possible values include: 'IPv4', 'IPv6' - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration] * The IP configuration associated with the public IP address. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] * The private IP address of the IP configuration. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] * The private IP allocation method. Possible values are 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet] * The reference of the subnet resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] * The address prefix for the subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] * The reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] * A collection of references to subnets. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] * The reference of the RouteTable resource. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] * A collection of references to subnets. - * @member {boolean} + * @property {boolean} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] * Gets a unique read-only string that changes whenever the resource is * updated. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] * An array of service endpoints. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] * An array of service endpoint policies. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] * An array of references to interface endpoints - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] * Gets an array of references to the network interface IP configurations * using subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] * Gets an array of references to the delegations on the subnet. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] * A read-only string identifying the intention of use for this subnet based * on delegations and other user-defined properties. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] * The provisioning state of the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] * The reference of the public IP resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.provisioningState] * Gets the provisioning state of the public IP resource. Possible values * are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings] * The FQDN of the DNS record associated with the public IP address. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] * Gets or sets the Domain name label.The concatenation of the domain name * label and the regionalized DNS zone make up the fully qualified domain * name associated with the public IP address. If a domain name label is * specified, an A DNS record is created for the public IP in the Microsoft * Azure DNS system. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.fqdn] * Gets the FQDN, Fully qualified domain name of the A DNS record associated * with the public IP. This is the concatenation of the domainNameLabel and * the regionalized DNS zone. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name * that resolves to this public IP address. If the reverseFqdn is specified, * then a PTR DNS record is created pointing from the IP address in the * in-addr.arpa domain to the reverse FQDN. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipTags] * The list of tags associated with the public IP address. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipAddress] * The IP address associated with the public IP address resource. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPPrefix] * The Public IP Prefix this Public IP Address should be allocated from. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPPrefix.id] * Resource ID. - * @member {number} + * @property {number} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.idleTimeoutInMinutes] * The idle timeout of the public IP address. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.resourceGuid] * The resource GUID property of the public IP resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.provisioningState] * The provisioning state of the PublicIP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.publicIPAddress.zones] * A list of availability zones denoting the IP allocated for the resource * needs to come from. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] * Application security groups in which the IP configuration is included. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.provisioningState] * The provisioning state of the network interface IP configuration. Possible * values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.name] The * name of the resource that is unique within a resource group. This name can * be used to access the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationNetworkInterfaceIPConfiguration.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration] The * reference to the private IP address on the internal Load Balancer that * will receive the tap - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.inboundNatRules] * Read only. Inbound rules URIs that use this frontend IP. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.inboundNatPools] * Read only. Inbound pools URIs that use this frontend IP. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.outboundRules] * Read only. Outbound rules URIs that use this frontend IP. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.loadBalancingRules] * Gets load balancing rules URIs that use this frontend IP. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] * The private IP address of the IP configuration. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] * The Private IP allocation method. Possible values are: 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet] * The reference of the subnet resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] * The address prefix for the subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] * The reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.subnets] * A collection of references to subnets. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] * The reference of the RouteTable resource. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.subnets] * A collection of references to subnets. - * @member {boolean} + * @property {boolean} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] * Gets a unique read-only string that changes whenever the resource is * updated. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] * An array of service endpoints. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] * An array of service endpoint policies. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.interfaceEndpoints] * An array of references to interface endpoints - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.ipConfigurations] * Gets an array of references to the network interface IP configurations * using subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] * Gets an array of references to the delegations on the subnet. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.purpose] * A read-only string identifying the intention of use for this subnet based * on delegations and other user-defined properties. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] * The provisioning state of the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] * The reference of the Public IP resource. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] * The public IP address SKU. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] * Name of a public IP address SKU. Possible values include: 'Basic', * 'Standard' - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] * The public IP allocation method. Possible values are: 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. * Possible values include: 'IPv4', 'IPv6' - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration] * The IP configuration associated with the public IP address. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] * The private IP address of the IP configuration. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] * The private IP allocation method. Possible values are 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet] * The reference of the subnet resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] * The address prefix for the subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] * The reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] * A collection of references to subnets. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] * The reference of the RouteTable resource. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] * A collection of references to subnets. - * @member {boolean} + * @property {boolean} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] * Gets a unique read-only string that changes whenever the resource is * updated. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] * An array of service endpoints. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] * An array of service endpoint policies. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] * An array of references to interface endpoints - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] * Gets an array of references to the network interface IP configurations * using subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] * Gets an array of references to the delegations on the subnet. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] * A read-only string identifying the intention of use for this subnet based * on delegations and other user-defined properties. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] * The provisioning state of the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] * The reference of the public IP resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.provisioningState] * Gets the provisioning state of the public IP resource. Possible values * are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] * The FQDN of the DNS record associated with the public IP address. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] * Gets or sets the Domain name label.The concatenation of the domain name * label and the regionalized DNS zone make up the fully qualified domain * name associated with the public IP address. If a domain name label is * specified, an A DNS record is created for the public IP in the Microsoft * Azure DNS system. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] * Gets the FQDN, Fully qualified domain name of the A DNS record associated * with the public IP. This is the concatenation of the domainNameLabel and * the regionalized DNS zone. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name * that resolves to this public IP address. If the reverseFqdn is specified, * then a PTR DNS record is created pointing from the IP address in the * in-addr.arpa domain to the reverse FQDN. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] * The list of tags associated with the public IP address. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] * The IP address associated with the public IP address resource. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] * The Public IP Prefix this Public IP Address should be allocated from. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix.id] * Resource ID. - * @member {number} + * @property {number} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] * The idle timeout of the public IP address. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] * The resource GUID property of the public IP resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] * The provisioning state of the PublicIP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] * A list of availability zones denoting the IP allocated for the resource * needs to come from. - * @member {object} + * @property {object} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] * The reference of the Public IP Prefix resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] * Resource ID. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.provisioningState] * Gets the provisioning state of the public IP resource. Possible values * are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {array} + * @property {array} * [virtualNetworkTap.destinationLoadBalancerFrontEndIPConfiguration.zones] A * list of availability zones denoting the IP allocated for the resource * needs to come from. - * @member {number} [virtualNetworkTap.destinationPort] The VXLAN destination - * port that will receive the tapped traffic. - * @member {string} [virtualNetworkTap.etag] Gets a unique read-only string + * @property {number} [virtualNetworkTap.destinationPort] The VXLAN + * destination port that will receive the tapped traffic. + * @property {string} [virtualNetworkTap.etag] Gets a unique read-only string * that changes whenever the resource is updated. - * @member {string} [provisioningState] The provisioning state of the network - * interface tap configuration. Possible values are: 'Updating', 'Deleting', - * and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [provisioningState] The provisioning state of the + * network interface tap configuration. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Sub Resource type. + * @property {string} [type] Sub Resource type. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/networkInterfaceTapConfigurationListResult.js b/lib/services/networkManagement2/lib/models/networkInterfaceTapConfigurationListResult.js index 14de141b82..65b62ed335 100644 --- a/lib/services/networkManagement2/lib/models/networkInterfaceTapConfigurationListResult.js +++ b/lib/services/networkManagement2/lib/models/networkInterfaceTapConfigurationListResult.js @@ -16,7 +16,7 @@ class NetworkInterfaceTapConfigurationListResult extends Array { /** * Create a NetworkInterfaceTapConfigurationListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/networkProfile.js b/lib/services/networkManagement2/lib/models/networkProfile.js index 63caf03671..7d5ed3108e 100644 --- a/lib/services/networkManagement2/lib/models/networkProfile.js +++ b/lib/services/networkManagement2/lib/models/networkProfile.js @@ -20,15 +20,15 @@ const models = require('./index'); class NetworkProfile extends models['Resource'] { /** * Create a NetworkProfile. - * @member {array} [containerNetworkInterfaces] List of child container + * @property {array} [containerNetworkInterfaces] List of child container * network interfaces. - * @member {array} [containerNetworkInterfaceConfigurations] List of chid + * @property {array} [containerNetworkInterfaceConfigurations] List of chid * container network interface configurations. - * @member {string} [resourceGuid] The resource GUID property of the network - * interface resource. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [resourceGuid] The resource GUID property of the + * network interface resource. + * @property {string} [provisioningState] The provisioning state of the * resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/networkProfileListResult.js b/lib/services/networkManagement2/lib/models/networkProfileListResult.js index fc034b4d09..0ce54d6eeb 100644 --- a/lib/services/networkManagement2/lib/models/networkProfileListResult.js +++ b/lib/services/networkManagement2/lib/models/networkProfileListResult.js @@ -16,7 +16,7 @@ class NetworkProfileListResult extends Array { /** * Create a NetworkProfileListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/networkSecurityGroup.js b/lib/services/networkManagement2/lib/models/networkSecurityGroup.js index 9a486a39ab..f0ffa4844a 100644 --- a/lib/services/networkManagement2/lib/models/networkSecurityGroup.js +++ b/lib/services/networkManagement2/lib/models/networkSecurityGroup.js @@ -20,18 +20,19 @@ const models = require('./index'); class NetworkSecurityGroup extends models['Resource'] { /** * Create a NetworkSecurityGroup. - * @member {array} [securityRules] A collection of security rules of the + * @property {array} [securityRules] A collection of security rules of the * network security group. - * @member {array} [defaultSecurityRules] The default security rules of + * @property {array} [defaultSecurityRules] The default security rules of * network security group. - * @member {array} [networkInterfaces] A collection of references to network - * interfaces. - * @member {array} [subnets] A collection of references to subnets. - * @member {string} [resourceGuid] The resource GUID property of the network - * security group resource. - * @member {string} [provisioningState] The provisioning state of the public - * IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {array} [networkInterfaces] A collection of references to + * network interfaces. + * @property {array} [subnets] A collection of references to subnets. + * @property {string} [resourceGuid] The resource GUID property of the + * network security group resource. + * @property {string} [provisioningState] The provisioning state of the + * public IP resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/networkSecurityGroupListResult.js b/lib/services/networkManagement2/lib/models/networkSecurityGroupListResult.js index abf75b6d9d..884344e23b 100644 --- a/lib/services/networkManagement2/lib/models/networkSecurityGroupListResult.js +++ b/lib/services/networkManagement2/lib/models/networkSecurityGroupListResult.js @@ -16,7 +16,7 @@ class NetworkSecurityGroupListResult extends Array { /** * Create a NetworkSecurityGroupListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/networkSecurityGroupResult.js b/lib/services/networkManagement2/lib/models/networkSecurityGroupResult.js index 146cf3e741..e5cdf90189 100644 --- a/lib/services/networkManagement2/lib/models/networkSecurityGroupResult.js +++ b/lib/services/networkManagement2/lib/models/networkSecurityGroupResult.js @@ -17,10 +17,10 @@ class NetworkSecurityGroupResult { /** * Create a NetworkSecurityGroupResult. - * @member {string} [securityRuleAccessResult] The network traffic is allowed - * or denied. Possible values are 'Allow' and 'Deny'. Possible values + * @property {string} [securityRuleAccessResult] The network traffic is + * allowed or denied. Possible values are 'Allow' and 'Deny'. Possible values * include: 'Allow', 'Deny' - * @member {array} [evaluatedNetworkSecurityGroups] List of results network + * @property {array} [evaluatedNetworkSecurityGroups] List of results network * security groups diagnostic. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/networkSecurityRulesEvaluationResult.js b/lib/services/networkManagement2/lib/models/networkSecurityRulesEvaluationResult.js index 86f808efb3..9dd0326cb8 100644 --- a/lib/services/networkManagement2/lib/models/networkSecurityRulesEvaluationResult.js +++ b/lib/services/networkManagement2/lib/models/networkSecurityRulesEvaluationResult.js @@ -17,16 +17,16 @@ class NetworkSecurityRulesEvaluationResult { /** * Create a NetworkSecurityRulesEvaluationResult. - * @member {string} [name] Name of the network security rule. - * @member {boolean} [protocolMatched] Value indicating whether protocol is + * @property {string} [name] Name of the network security rule. + * @property {boolean} [protocolMatched] Value indicating whether protocol is * matched. - * @member {boolean} [sourceMatched] Value indicating whether source is + * @property {boolean} [sourceMatched] Value indicating whether source is * matched. - * @member {boolean} [sourcePortMatched] Value indicating whether source port - * is matched. - * @member {boolean} [destinationMatched] Value indicating whether + * @property {boolean} [sourcePortMatched] Value indicating whether source + * port is matched. + * @property {boolean} [destinationMatched] Value indicating whether * destination is matched. - * @member {boolean} [destinationPortMatched] Value indicating whether + * @property {boolean} [destinationPortMatched] Value indicating whether * destination port is matched. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/networkWatcher.js b/lib/services/networkManagement2/lib/models/networkWatcher.js index 2d392cef39..b8b5c4d301 100644 --- a/lib/services/networkManagement2/lib/models/networkWatcher.js +++ b/lib/services/networkManagement2/lib/models/networkWatcher.js @@ -20,9 +20,9 @@ const models = require('./index'); class NetworkWatcher extends models['Resource'] { /** * Create a NetworkWatcher. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' */ diff --git a/lib/services/networkManagement2/lib/models/nextHopParameters.js b/lib/services/networkManagement2/lib/models/nextHopParameters.js index 490154bbbb..eb3f975679 100644 --- a/lib/services/networkManagement2/lib/models/nextHopParameters.js +++ b/lib/services/networkManagement2/lib/models/nextHopParameters.js @@ -17,11 +17,11 @@ class NextHopParameters { /** * Create a NextHopParameters. - * @member {string} targetResourceId The resource identifier of the target + * @property {string} targetResourceId The resource identifier of the target * resource against which the action is to be performed. - * @member {string} sourceIPAddress The source IP address. - * @member {string} destinationIPAddress The destination IP address. - * @member {string} [targetNicResourceId] The NIC ID. (If VM has multiple + * @property {string} sourceIPAddress The source IP address. + * @property {string} destinationIPAddress The destination IP address. + * @property {string} [targetNicResourceId] The NIC ID. (If VM has multiple * NICs and IP forwarding is enabled on any of the nics, then this parameter * must be specified. Otherwise optional). */ diff --git a/lib/services/networkManagement2/lib/models/nextHopResult.js b/lib/services/networkManagement2/lib/models/nextHopResult.js index e6717174e8..d034c5adf1 100644 --- a/lib/services/networkManagement2/lib/models/nextHopResult.js +++ b/lib/services/networkManagement2/lib/models/nextHopResult.js @@ -17,11 +17,11 @@ class NextHopResult { /** * Create a NextHopResult. - * @member {string} [nextHopType] Next hop type. Possible values include: + * @property {string} [nextHopType] Next hop type. Possible values include: * 'Internet', 'VirtualAppliance', 'VirtualNetworkGateway', 'VnetLocal', * 'HyperNetGateway', 'None' - * @member {string} [nextHopIpAddress] Next hop IP Address - * @member {string} [routeTableId] The resource identifier for the route + * @property {string} [nextHopIpAddress] Next hop IP Address + * @property {string} [routeTableId] The resource identifier for the route * table associated with the route being returned. If the route being * returned does not correspond to any user created routes then this field * will be the string 'System Route'. diff --git a/lib/services/networkManagement2/lib/models/operation.js b/lib/services/networkManagement2/lib/models/operation.js index c840f63964..6e51a230b9 100644 --- a/lib/services/networkManagement2/lib/models/operation.js +++ b/lib/services/networkManagement2/lib/models/operation.js @@ -17,19 +17,21 @@ class Operation { /** * Create a Operation. - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] Display metadata associated with the operation. - * @member {string} [display.provider] Service provider: Microsoft Network. - * @member {string} [display.resource] Resource on which the operation is + * @property {string} [name] Operation name: + * {provider}/{resource}/{operation} + * @property {object} [display] Display metadata associated with the + * operation. + * @property {string} [display.provider] Service provider: Microsoft Network. + * @property {string} [display.resource] Resource on which the operation is * performed. - * @member {string} [display.operation] Type of the operation: get, read, + * @property {string} [display.operation] Type of the operation: get, read, * delete, etc. - * @member {string} [display.description] Description of the operation. - * @member {string} [origin] Origin of the operation. - * @member {object} [serviceSpecification] Specification of the service. - * @member {array} [serviceSpecification.metricSpecifications] Operation + * @property {string} [display.description] Description of the operation. + * @property {string} [origin] Origin of the operation. + * @property {object} [serviceSpecification] Specification of the service. + * @property {array} [serviceSpecification.metricSpecifications] Operation * service specification. - * @member {array} [serviceSpecification.logSpecifications] Operation log + * @property {array} [serviceSpecification.logSpecifications] Operation log * specification. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/operationDisplay.js b/lib/services/networkManagement2/lib/models/operationDisplay.js index da0bff9211..a2debe7e34 100644 --- a/lib/services/networkManagement2/lib/models/operationDisplay.js +++ b/lib/services/networkManagement2/lib/models/operationDisplay.js @@ -17,11 +17,12 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [provider] Service provider: Microsoft Network. - * @member {string} [resource] Resource on which the operation is performed. - * @member {string} [operation] Type of the operation: get, read, delete, + * @property {string} [provider] Service provider: Microsoft Network. + * @property {string} [resource] Resource on which the operation is + * performed. + * @property {string} [operation] Type of the operation: get, read, delete, * etc. - * @member {string} [description] Description of the operation. + * @property {string} [description] Description of the operation. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/operationListResult.js b/lib/services/networkManagement2/lib/models/operationListResult.js index cdcc6ce3c6..3fb3ae54b7 100644 --- a/lib/services/networkManagement2/lib/models/operationListResult.js +++ b/lib/services/networkManagement2/lib/models/operationListResult.js @@ -17,7 +17,7 @@ class OperationListResult extends Array { /** * Create a OperationListResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/operationPropertiesFormatServiceSpecification.js b/lib/services/networkManagement2/lib/models/operationPropertiesFormatServiceSpecification.js index 29bbe64be2..82efd248c7 100644 --- a/lib/services/networkManagement2/lib/models/operationPropertiesFormatServiceSpecification.js +++ b/lib/services/networkManagement2/lib/models/operationPropertiesFormatServiceSpecification.js @@ -17,8 +17,8 @@ class OperationPropertiesFormatServiceSpecification { /** * Create a OperationPropertiesFormatServiceSpecification. - * @member {array} [metricSpecifications] Operation service specification. - * @member {array} [logSpecifications] Operation log specification. + * @property {array} [metricSpecifications] Operation service specification. + * @property {array} [logSpecifications] Operation log specification. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/outboundRule.js b/lib/services/networkManagement2/lib/models/outboundRule.js index 8ba27b1b00..de9a6eceb0 100644 --- a/lib/services/networkManagement2/lib/models/outboundRule.js +++ b/lib/services/networkManagement2/lib/models/outboundRule.js @@ -20,26 +20,26 @@ const models = require('./index'); class OutboundRule extends models['SubResource'] { /** * Create a OutboundRule. - * @member {number} [allocatedOutboundPorts] The number of outbound ports to - * be used for NAT. - * @member {array} frontendIPConfigurations The Frontend IP addresses of the - * load balancer. - * @member {object} backendAddressPool A reference to a pool of DIPs. + * @property {number} [allocatedOutboundPorts] The number of outbound ports + * to be used for NAT. + * @property {array} frontendIPConfigurations The Frontend IP addresses of + * the load balancer. + * @property {object} backendAddressPool A reference to a pool of DIPs. * Outbound traffic is randomly load balanced across IPs in the backend IPs. - * @member {string} [backendAddressPool.id] Resource ID. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {string} [backendAddressPool.id] Resource ID. + * @property {string} [provisioningState] Gets the provisioning state of the * PublicIP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} protocol Protocol - TCP, UDP or All. Possible values + * @property {string} protocol Protocol - TCP, UDP or All. Possible values * include: 'Tcp', 'Udp', 'All' - * @member {boolean} [enableTcpReset] Receive bidirectional TCP Reset on TCP - * flow idle timeout or unexpected connection termination. This element is - * only used when the protocol is set to TCP. - * @member {number} [idleTimeoutInMinutes] The timeout for the TCP idle + * @property {boolean} [enableTcpReset] Receive bidirectional TCP Reset on + * TCP flow idle timeout or unexpected connection termination. This element + * is only used when the protocol is set to TCP. + * @property {number} [idleTimeoutInMinutes] The timeout for the TCP idle * connection - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/p2SVpnGateway.js b/lib/services/networkManagement2/lib/models/p2SVpnGateway.js index 0952f19a2c..52c0a8e4aa 100644 --- a/lib/services/networkManagement2/lib/models/p2SVpnGateway.js +++ b/lib/services/networkManagement2/lib/models/p2SVpnGateway.js @@ -20,31 +20,33 @@ const models = require('./index'); class P2SVpnGateway extends models['Resource'] { /** * Create a P2SVpnGateway. - * @member {object} [virtualHub] The VirtualHub to which the gateway belongs - * @member {string} [virtualHub.id] Resource ID. - * @member {string} [provisioningState] The provisioning state of the + * @property {object} [virtualHub] The VirtualHub to which the gateway + * belongs + * @property {string} [virtualHub.id] Resource ID. + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {number} [vpnGatewayScaleUnit] The scale unit for this p2s vpn + * @property {number} [vpnGatewayScaleUnit] The scale unit for this p2s vpn * gateway. - * @member {object} [p2SVpnServerConfiguration] The P2SVpnServerConfiguration - * to which the p2sVpnGateway is attached to. - * @member {string} [p2SVpnServerConfiguration.id] Resource ID. - * @member {object} [vpnClientAddressPool] The reference of the address space - * resource which represents Address space for P2S VpnClient. - * @member {array} [vpnClientAddressPool.addressPrefixes] A list of address + * @property {object} [p2SVpnServerConfiguration] The + * P2SVpnServerConfiguration to which the p2sVpnGateway is attached to. + * @property {string} [p2SVpnServerConfiguration.id] Resource ID. + * @property {object} [vpnClientAddressPool] The reference of the address + * space resource which represents Address space for P2S VpnClient. + * @property {array} [vpnClientAddressPool.addressPrefixes] A list of address * blocks reserved for this virtual network in CIDR notation. - * @member {object} [vpnClientConnectionHealth] All P2S vpnclients' + * @property {object} [vpnClientConnectionHealth] All P2S vpnclients' * connection health status. - * @member {number} [vpnClientConnectionHealth.totalIngressBytesTransferred] - * Total of the Ingress Bytes Transferred in this P2S Vpn connection - * @member {number} [vpnClientConnectionHealth.totalEgressBytesTransferred] + * @property {number} + * [vpnClientConnectionHealth.totalIngressBytesTransferred] Total of the + * Ingress Bytes Transferred in this P2S Vpn connection + * @property {number} [vpnClientConnectionHealth.totalEgressBytesTransferred] * Total of the Egress Bytes Transferred in this connection - * @member {number} [vpnClientConnectionHealth.vpnClientConnectionsCount] The - * total of p2s vpn clients connected at this time to this P2SVpnGateway. - * @member {array} [vpnClientConnectionHealth.allocatedIpAddresses] List of + * @property {number} [vpnClientConnectionHealth.vpnClientConnectionsCount] + * The total of p2s vpn clients connected at this time to this P2SVpnGateway. + * @property {array} [vpnClientConnectionHealth.allocatedIpAddresses] List of * allocated ip addresses to the connected p2s vpn clients. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/p2SVpnProfileParameters.js b/lib/services/networkManagement2/lib/models/p2SVpnProfileParameters.js index 050b8ec698..d404ecb56d 100644 --- a/lib/services/networkManagement2/lib/models/p2SVpnProfileParameters.js +++ b/lib/services/networkManagement2/lib/models/p2SVpnProfileParameters.js @@ -17,9 +17,9 @@ class P2SVpnProfileParameters { /** * Create a P2SVpnProfileParameters. - * @member {string} [authenticationMethod] VPN client Authentication Method. - * Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values include: - * 'EAPTLS', 'EAPMSCHAPv2' + * @property {string} [authenticationMethod] VPN client Authentication + * Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values + * include: 'EAPTLS', 'EAPMSCHAPv2' */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/p2SVpnServerConfigRadiusClientRootCertificate.js b/lib/services/networkManagement2/lib/models/p2SVpnServerConfigRadiusClientRootCertificate.js index b965aaede9..871dc18e26 100644 --- a/lib/services/networkManagement2/lib/models/p2SVpnServerConfigRadiusClientRootCertificate.js +++ b/lib/services/networkManagement2/lib/models/p2SVpnServerConfigRadiusClientRootCertificate.js @@ -20,14 +20,14 @@ const models = require('./index'); class P2SVpnServerConfigRadiusClientRootCertificate extends models['SubResource'] { /** * Create a P2SVpnServerConfigRadiusClientRootCertificate. - * @member {string} [thumbprint] The Radius client root certificate + * @property {string} [thumbprint] The Radius client root certificate * thumbprint. - * @member {string} [provisioningState] The provisioning state of the Radius - * client root certificate resource. Possible values are: 'Updating', + * @property {string} [provisioningState] The provisioning state of the + * Radius client root certificate resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/p2SVpnServerConfigRadiusServerRootCertificate.js b/lib/services/networkManagement2/lib/models/p2SVpnServerConfigRadiusServerRootCertificate.js index 94ccac982a..597eb16551 100644 --- a/lib/services/networkManagement2/lib/models/p2SVpnServerConfigRadiusServerRootCertificate.js +++ b/lib/services/networkManagement2/lib/models/p2SVpnServerConfigRadiusServerRootCertificate.js @@ -20,13 +20,13 @@ const models = require('./index'); class P2SVpnServerConfigRadiusServerRootCertificate extends models['SubResource'] { /** * Create a P2SVpnServerConfigRadiusServerRootCertificate. - * @member {string} publicCertData The certificate public data. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} publicCertData The certificate public data. + * @property {string} [provisioningState] The provisioning state of the * P2SVpnServerConfiguration Radius Server root certificate resource. * Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/p2SVpnServerConfigVpnClientRevokedCertificate.js b/lib/services/networkManagement2/lib/models/p2SVpnServerConfigVpnClientRevokedCertificate.js index 051c2b7a1d..7aec179203 100644 --- a/lib/services/networkManagement2/lib/models/p2SVpnServerConfigVpnClientRevokedCertificate.js +++ b/lib/services/networkManagement2/lib/models/p2SVpnServerConfigVpnClientRevokedCertificate.js @@ -20,14 +20,14 @@ const models = require('./index'); class P2SVpnServerConfigVpnClientRevokedCertificate extends models['SubResource'] { /** * Create a P2SVpnServerConfigVpnClientRevokedCertificate. - * @member {string} [thumbprint] The revoked VPN client certificate + * @property {string} [thumbprint] The revoked VPN client certificate * thumbprint. - * @member {string} [provisioningState] The provisioning state of the VPN + * @property {string} [provisioningState] The provisioning state of the VPN * client revoked certificate resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/p2SVpnServerConfigVpnClientRootCertificate.js b/lib/services/networkManagement2/lib/models/p2SVpnServerConfigVpnClientRootCertificate.js index 2d8316a087..e7e7fb0ca1 100644 --- a/lib/services/networkManagement2/lib/models/p2SVpnServerConfigVpnClientRootCertificate.js +++ b/lib/services/networkManagement2/lib/models/p2SVpnServerConfigVpnClientRootCertificate.js @@ -20,13 +20,13 @@ const models = require('./index'); class P2SVpnServerConfigVpnClientRootCertificate extends models['SubResource'] { /** * Create a P2SVpnServerConfigVpnClientRootCertificate. - * @member {string} publicCertData The certificate public data. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} publicCertData The certificate public data. + * @property {string} [provisioningState] The provisioning state of the * P2SVpnServerConfiguration VPN client root certificate resource. Possible * values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/p2SVpnServerConfiguration.js b/lib/services/networkManagement2/lib/models/p2SVpnServerConfiguration.js index ffb2ff5835..0ae7cb2040 100644 --- a/lib/services/networkManagement2/lib/models/p2SVpnServerConfiguration.js +++ b/lib/services/networkManagement2/lib/models/p2SVpnServerConfiguration.js @@ -20,37 +20,37 @@ const models = require('./index'); class P2SVpnServerConfiguration extends models['SubResource'] { /** * Create a P2SVpnServerConfiguration. - * @member {string} [p2SVpnServerConfigurationPropertiesName] The name of the - * P2SVpnServerConfiguration that is unique within a VirtualWan in a resource - * group. This name can be used to access the resource along with Paren - * VirtualWan resource name. - * @member {array} [vpnProtocols] vpnProtocols for the + * @property {string} [p2SVpnServerConfigurationPropertiesName] The name of + * the P2SVpnServerConfiguration that is unique within a VirtualWan in a + * resource group. This name can be used to access the resource along with + * Paren VirtualWan resource name. + * @property {array} [vpnProtocols] vpnProtocols for the * P2SVpnServerConfiguration. - * @member {array} [p2SVpnServerConfigVpnClientRootCertificates] VPN client + * @property {array} [p2SVpnServerConfigVpnClientRootCertificates] VPN client * root certificate of P2SVpnServerConfiguration. - * @member {array} [p2SVpnServerConfigVpnClientRevokedCertificates] VPN + * @property {array} [p2SVpnServerConfigVpnClientRevokedCertificates] VPN * client revoked certificate of P2SVpnServerConfiguration. - * @member {array} [p2SVpnServerConfigRadiusServerRootCertificates] Radius + * @property {array} [p2SVpnServerConfigRadiusServerRootCertificates] Radius * Server root certificate of P2SVpnServerConfiguration. - * @member {array} [p2SVpnServerConfigRadiusClientRootCertificates] Radius + * @property {array} [p2SVpnServerConfigRadiusClientRootCertificates] Radius * client root certificate of P2SVpnServerConfiguration. - * @member {array} [vpnClientIpsecPolicies] VpnClientIpsecPolicies for + * @property {array} [vpnClientIpsecPolicies] VpnClientIpsecPolicies for * P2SVpnServerConfiguration. - * @member {string} [radiusServerAddress] The radius server address property - * of the P2SVpnServerConfiguration resource for point to site client - * connection. - * @member {string} [radiusServerSecret] The radius secret property of the + * @property {string} [radiusServerAddress] The radius server address + * property of the P2SVpnServerConfiguration resource for point to site + * client connection. + * @property {string} [radiusServerSecret] The radius secret property of the * P2SVpnServerConfiguration resource for for point to site client * connection. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * P2SVpnServerConfiguration resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {array} [p2SVpnGateways] - * @member {string} [p2SVpnServerConfigurationPropertiesEtag] A unique + * @property {array} [p2SVpnGateways] + * @property {string} [p2SVpnServerConfigurationPropertiesEtag] A unique * read-only string that changes whenever the resource is updated. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/packetCapture.js b/lib/services/networkManagement2/lib/models/packetCapture.js index b3c0317c83..0005ff0d88 100644 --- a/lib/services/networkManagement2/lib/models/packetCapture.js +++ b/lib/services/networkManagement2/lib/models/packetCapture.js @@ -17,26 +17,26 @@ class PacketCapture { /** * Create a PacketCapture. - * @member {string} target The ID of the targeted resource, only VM is + * @property {string} target The ID of the targeted resource, only VM is * currently supported. - * @member {number} [bytesToCapturePerPacket] Number of bytes captured per + * @property {number} [bytesToCapturePerPacket] Number of bytes captured per * packet, the remaining bytes are truncated. Default value: 0 . - * @member {number} [totalBytesPerSession] Maximum size of the capture + * @property {number} [totalBytesPerSession] Maximum size of the capture * output. Default value: 1073741824 . - * @member {number} [timeLimitInSeconds] Maximum duration of the capture + * @property {number} [timeLimitInSeconds] Maximum duration of the capture * session in seconds. Default value: 18000 . - * @member {object} storageLocation - * @member {string} [storageLocation.storageId] The ID of the storage account - * to save the packet capture session. Required if no local file path is - * provided. - * @member {string} [storageLocation.storagePath] The URI of the storage path - * to save the packet capture. Must be a well-formed URI describing the + * @property {object} storageLocation + * @property {string} [storageLocation.storageId] The ID of the storage + * account to save the packet capture session. Required if no local file path + * is provided. + * @property {string} [storageLocation.storagePath] The URI of the storage + * path to save the packet capture. Must be a well-formed URI describing the * location to save the packet capture. - * @member {string} [storageLocation.filePath] A valid local path on the + * @property {string} [storageLocation.filePath] A valid local path on the * targeting VM. Must include the name of the capture file (*.cap). For linux * virtual machine it must start with /var/captures. Required if no storage * ID is provided, otherwise optional. - * @member {array} [filters] + * @property {array} [filters] */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/packetCaptureFilter.js b/lib/services/networkManagement2/lib/models/packetCaptureFilter.js index fd13922bb6..637b7f9900 100644 --- a/lib/services/networkManagement2/lib/models/packetCaptureFilter.js +++ b/lib/services/networkManagement2/lib/models/packetCaptureFilter.js @@ -18,23 +18,23 @@ class PacketCaptureFilter { /** * Create a PacketCaptureFilter. - * @member {string} [protocol] Protocol to be filtered on. Possible values + * @property {string} [protocol] Protocol to be filtered on. Possible values * include: 'TCP', 'UDP', 'Any'. Default value: 'Any' . - * @member {string} [localIPAddress] Local IP Address to be filtered on. + * @property {string} [localIPAddress] Local IP Address to be filtered on. * Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" * for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges * not currently supported. Mixing ranges with multiple entries not currently * supported. Default = null. - * @member {string} [remoteIPAddress] Local IP Address to be filtered on. + * @property {string} [remoteIPAddress] Local IP Address to be filtered on. * Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" * for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges * not currently supported. Mixing ranges with multiple entries not currently * supported. Default = null. - * @member {string} [localPort] Local port to be filtered on. Notation: "80" - * for single port entry."80-85" for range. "80;443;" for multiple entries. - * Multiple ranges not currently supported. Mixing ranges with multiple - * entries not currently supported. Default = null. - * @member {string} [remotePort] Remote port to be filtered on. Notation: + * @property {string} [localPort] Local port to be filtered on. Notation: + * "80" for single port entry."80-85" for range. "80;443;" for multiple + * entries. Multiple ranges not currently supported. Mixing ranges with + * multiple entries not currently supported. Default = null. + * @property {string} [remotePort] Remote port to be filtered on. Notation: * "80" for single port entry."80-85" for range. "80;443;" for multiple * entries. Multiple ranges not currently supported. Mixing ranges with * multiple entries not currently supported. Default = null. diff --git a/lib/services/networkManagement2/lib/models/packetCaptureParameters.js b/lib/services/networkManagement2/lib/models/packetCaptureParameters.js index b21eae5f02..59b17b4d8d 100644 --- a/lib/services/networkManagement2/lib/models/packetCaptureParameters.js +++ b/lib/services/networkManagement2/lib/models/packetCaptureParameters.js @@ -17,26 +17,26 @@ class PacketCaptureParameters { /** * Create a PacketCaptureParameters. - * @member {string} target The ID of the targeted resource, only VM is + * @property {string} target The ID of the targeted resource, only VM is * currently supported. - * @member {number} [bytesToCapturePerPacket] Number of bytes captured per + * @property {number} [bytesToCapturePerPacket] Number of bytes captured per * packet, the remaining bytes are truncated. Default value: 0 . - * @member {number} [totalBytesPerSession] Maximum size of the capture + * @property {number} [totalBytesPerSession] Maximum size of the capture * output. Default value: 1073741824 . - * @member {number} [timeLimitInSeconds] Maximum duration of the capture + * @property {number} [timeLimitInSeconds] Maximum duration of the capture * session in seconds. Default value: 18000 . - * @member {object} storageLocation - * @member {string} [storageLocation.storageId] The ID of the storage account - * to save the packet capture session. Required if no local file path is - * provided. - * @member {string} [storageLocation.storagePath] The URI of the storage path - * to save the packet capture. Must be a well-formed URI describing the + * @property {object} storageLocation + * @property {string} [storageLocation.storageId] The ID of the storage + * account to save the packet capture session. Required if no local file path + * is provided. + * @property {string} [storageLocation.storagePath] The URI of the storage + * path to save the packet capture. Must be a well-formed URI describing the * location to save the packet capture. - * @member {string} [storageLocation.filePath] A valid local path on the + * @property {string} [storageLocation.filePath] A valid local path on the * targeting VM. Must include the name of the capture file (*.cap). For linux * virtual machine it must start with /var/captures. Required if no storage * ID is provided, otherwise optional. - * @member {array} [filters] + * @property {array} [filters] */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/packetCaptureQueryStatusResult.js b/lib/services/networkManagement2/lib/models/packetCaptureQueryStatusResult.js index 21b2693d17..4d02500d59 100644 --- a/lib/services/networkManagement2/lib/models/packetCaptureQueryStatusResult.js +++ b/lib/services/networkManagement2/lib/models/packetCaptureQueryStatusResult.js @@ -17,16 +17,16 @@ class PacketCaptureQueryStatusResult { /** * Create a PacketCaptureQueryStatusResult. - * @member {string} [name] The name of the packet capture resource. - * @member {string} [id] The ID of the packet capture resource. - * @member {date} [captureStartTime] The start time of the packet capture + * @property {string} [name] The name of the packet capture resource. + * @property {string} [id] The ID of the packet capture resource. + * @property {date} [captureStartTime] The start time of the packet capture * session. - * @member {string} [packetCaptureStatus] The status of the packet capture + * @property {string} [packetCaptureStatus] The status of the packet capture * session. Possible values include: 'NotStarted', 'Running', 'Stopped', * 'Error', 'Unknown' - * @member {string} [stopReason] The reason the current packet capture + * @property {string} [stopReason] The reason the current packet capture * session was stopped. - * @member {array} [packetCaptureError] List of errors of packet capture + * @property {array} [packetCaptureError] List of errors of packet capture * session. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/packetCaptureResult.js b/lib/services/networkManagement2/lib/models/packetCaptureResult.js index f3dd64236f..5492bebedf 100644 --- a/lib/services/networkManagement2/lib/models/packetCaptureResult.js +++ b/lib/services/networkManagement2/lib/models/packetCaptureResult.js @@ -17,32 +17,32 @@ class PacketCaptureResult { /** * Create a PacketCaptureResult. - * @member {string} [name] Name of the packet capture session. - * @member {string} [id] ID of the packet capture operation. - * @member {string} [etag] Default value: 'A unique read-only string that + * @property {string} [name] Name of the packet capture session. + * @property {string} [id] ID of the packet capture operation. + * @property {string} [etag] Default value: 'A unique read-only string that * changes whenever the resource is updated.' . - * @member {string} target The ID of the targeted resource, only VM is + * @property {string} target The ID of the targeted resource, only VM is * currently supported. - * @member {number} [bytesToCapturePerPacket] Number of bytes captured per + * @property {number} [bytesToCapturePerPacket] Number of bytes captured per * packet, the remaining bytes are truncated. Default value: 0 . - * @member {number} [totalBytesPerSession] Maximum size of the capture + * @property {number} [totalBytesPerSession] Maximum size of the capture * output. Default value: 1073741824 . - * @member {number} [timeLimitInSeconds] Maximum duration of the capture + * @property {number} [timeLimitInSeconds] Maximum duration of the capture * session in seconds. Default value: 18000 . - * @member {object} storageLocation - * @member {string} [storageLocation.storageId] The ID of the storage account - * to save the packet capture session. Required if no local file path is - * provided. - * @member {string} [storageLocation.storagePath] The URI of the storage path - * to save the packet capture. Must be a well-formed URI describing the + * @property {object} storageLocation + * @property {string} [storageLocation.storageId] The ID of the storage + * account to save the packet capture session. Required if no local file path + * is provided. + * @property {string} [storageLocation.storagePath] The URI of the storage + * path to save the packet capture. Must be a well-formed URI describing the * location to save the packet capture. - * @member {string} [storageLocation.filePath] A valid local path on the + * @property {string} [storageLocation.filePath] A valid local path on the * targeting VM. Must include the name of the capture file (*.cap). For linux * virtual machine it must start with /var/captures. Required if no storage * ID is provided, otherwise optional. - * @member {array} [filters] - * @member {string} [provisioningState] The provisioning state of the packet - * capture session. Possible values include: 'Succeeded', 'Updating', + * @property {array} [filters] + * @property {string} [provisioningState] The provisioning state of the + * packet capture session. Possible values include: 'Succeeded', 'Updating', * 'Deleting', 'Failed' */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/packetCaptureStorageLocation.js b/lib/services/networkManagement2/lib/models/packetCaptureStorageLocation.js index 1661120018..84402c1329 100644 --- a/lib/services/networkManagement2/lib/models/packetCaptureStorageLocation.js +++ b/lib/services/networkManagement2/lib/models/packetCaptureStorageLocation.js @@ -17,12 +17,12 @@ class PacketCaptureStorageLocation { /** * Create a PacketCaptureStorageLocation. - * @member {string} [storageId] The ID of the storage account to save the + * @property {string} [storageId] The ID of the storage account to save the * packet capture session. Required if no local file path is provided. - * @member {string} [storagePath] The URI of the storage path to save the + * @property {string} [storagePath] The URI of the storage path to save the * packet capture. Must be a well-formed URI describing the location to save * the packet capture. - * @member {string} [filePath] A valid local path on the targeting VM. Must + * @property {string} [filePath] A valid local path on the targeting VM. Must * include the name of the capture file (*.cap). For linux virtual machine it * must start with /var/captures. Required if no storage ID is provided, * otherwise optional. diff --git a/lib/services/networkManagement2/lib/models/patchRouteFilter.js b/lib/services/networkManagement2/lib/models/patchRouteFilter.js index 4765da6f2b..657016c299 100644 --- a/lib/services/networkManagement2/lib/models/patchRouteFilter.js +++ b/lib/services/networkManagement2/lib/models/patchRouteFilter.js @@ -20,19 +20,19 @@ const models = require('./index'); class PatchRouteFilter extends models['SubResource'] { /** * Create a PatchRouteFilter. - * @member {array} [rules] Collection of RouteFilterRules contained within a - * route filter. - * @member {array} [peerings] A collection of references to express route + * @property {array} [rules] Collection of RouteFilterRules contained within + * a route filter. + * @property {array} [peerings] A collection of references to express route * circuit peerings. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {string} [type] Resource type. - * @member {object} [tags] Resource tags. + * @property {string} [type] Resource type. + * @property {object} [tags] Resource tags. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/patchRouteFilterRule.js b/lib/services/networkManagement2/lib/models/patchRouteFilterRule.js index 2a576e68a4..9eede0b053 100644 --- a/lib/services/networkManagement2/lib/models/patchRouteFilterRule.js +++ b/lib/services/networkManagement2/lib/models/patchRouteFilterRule.js @@ -20,16 +20,16 @@ const models = require('./index'); class PatchRouteFilterRule extends models['SubResource'] { /** * Create a PatchRouteFilterRule. - * @member {string} access The access type of the rule. Valid values are: + * @property {string} access The access type of the rule. Valid values are: * 'Allow', 'Deny'. Possible values include: 'Allow', 'Deny' - * @member {array} communities The collection for bgp community values to + * @property {array} communities The collection for bgp community values to * filter on. e.g. ['12076:5010','12076:5020'] - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/probe.js b/lib/services/networkManagement2/lib/models/probe.js index 48081c251c..c65bdf8a09 100644 --- a/lib/services/networkManagement2/lib/models/probe.js +++ b/lib/services/networkManagement2/lib/models/probe.js @@ -20,33 +20,33 @@ const models = require('./index'); class Probe extends models['SubResource'] { /** * Create a Probe. - * @member {array} [loadBalancingRules] The load balancer rules that use this - * probe. - * @member {string} protocol The protocol of the end point. Possible values + * @property {array} [loadBalancingRules] The load balancer rules that use + * this probe. + * @property {string} protocol The protocol of the end point. Possible values * are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is * required for the probe to be successful. If 'Http' or 'Https' is * specified, a 200 OK response from the specifies URI is required for the * probe to be successful. Possible values include: 'Http', 'Tcp', 'Https' - * @member {number} port The port for communicating the probe. Possible + * @property {number} port The port for communicating the probe. Possible * values range from 1 to 65535, inclusive. - * @member {number} [intervalInSeconds] The interval, in seconds, for how + * @property {number} [intervalInSeconds] The interval, in seconds, for how * frequently to probe the endpoint for health status. Typically, the * interval is slightly less than half the allocated timeout period (in * seconds) which allows two full probes before taking the instance out of * rotation. The default value is 15, the minimum value is 5. - * @member {number} [numberOfProbes] The number of probes where if no + * @property {number} [numberOfProbes] The number of probes where if no * response, will result in stopping further traffic from being delivered to * the endpoint. This values allows endpoints to be taken out of rotation * faster or slower than the typical times used in Azure. - * @member {string} [requestPath] The URI used for requesting health status + * @property {string} [requestPath] The URI used for requesting health status * from the VM. Path is required if a protocol is set to http. Otherwise, it * is not allowed. There is no default value. - * @member {string} [provisioningState] Gets the provisioning state of the + * @property {string} [provisioningState] Gets the provisioning state of the * public IP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [name] Gets name of the resource that is unique within a - * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [name] Gets name of the resource that is unique within + * a resource group. This name can be used to access the resource. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/protocolConfiguration.js b/lib/services/networkManagement2/lib/models/protocolConfiguration.js index 0441741b15..5df596eb1d 100644 --- a/lib/services/networkManagement2/lib/models/protocolConfiguration.js +++ b/lib/services/networkManagement2/lib/models/protocolConfiguration.js @@ -17,11 +17,11 @@ class ProtocolConfiguration { /** * Create a ProtocolConfiguration. - * @member {object} [hTTPConfiguration] - * @member {string} [hTTPConfiguration.method] HTTP method. Possible values + * @property {object} [hTTPConfiguration] + * @property {string} [hTTPConfiguration.method] HTTP method. Possible values * include: 'Get' - * @member {array} [hTTPConfiguration.headers] List of HTTP headers. - * @member {array} [hTTPConfiguration.validStatusCodes] Valid status codes. + * @property {array} [hTTPConfiguration.headers] List of HTTP headers. + * @property {array} [hTTPConfiguration.validStatusCodes] Valid status codes. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/publicIPAddress.js b/lib/services/networkManagement2/lib/models/publicIPAddress.js index 113c900ad2..761e9f4765 100644 --- a/lib/services/networkManagement2/lib/models/publicIPAddress.js +++ b/lib/services/networkManagement2/lib/models/publicIPAddress.js @@ -20,133 +20,133 @@ const models = require('./index'); class PublicIPAddress extends models['Resource'] { /** * Create a PublicIPAddress. - * @member {object} [sku] The public IP address SKU. - * @member {string} [sku.name] Name of a public IP address SKU. Possible + * @property {object} [sku] The public IP address SKU. + * @property {string} [sku.name] Name of a public IP address SKU. Possible * values include: 'Basic', 'Standard' - * @member {string} [publicIPAllocationMethod] The public IP allocation + * @property {string} [publicIPAllocationMethod] The public IP allocation * method. Possible values are: 'Static' and 'Dynamic'. Possible values * include: 'Static', 'Dynamic' - * @member {string} [publicIPAddressVersion] The public IP address version. + * @property {string} [publicIPAddressVersion] The public IP address version. * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', * 'IPv6' - * @member {object} [ipConfiguration] The IP configuration associated with + * @property {object} [ipConfiguration] The IP configuration associated with * the public IP address. - * @member {string} [ipConfiguration.privateIPAddress] The private IP address - * of the IP configuration. - * @member {string} [ipConfiguration.privateIPAllocationMethod] The private + * @property {string} [ipConfiguration.privateIPAddress] The private IP + * address of the IP configuration. + * @property {string} [ipConfiguration.privateIPAllocationMethod] The private * IP allocation method. Possible values are 'Static' and 'Dynamic'. Possible * values include: 'Static', 'Dynamic' - * @member {object} [ipConfiguration.subnet] The reference of the subnet + * @property {object} [ipConfiguration.subnet] The reference of the subnet * resource. - * @member {string} [ipConfiguration.subnet.addressPrefix] The address prefix - * for the subnet. - * @member {array} [ipConfiguration.subnet.addressPrefixes] List of address - * prefixes for the subnet. - * @member {object} [ipConfiguration.subnet.networkSecurityGroup] The + * @property {string} [ipConfiguration.subnet.addressPrefix] The address + * prefix for the subnet. + * @property {array} [ipConfiguration.subnet.addressPrefixes] List of + * address prefixes for the subnet. + * @property {object} [ipConfiguration.subnet.networkSecurityGroup] The * reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [ipConfiguration.subnet.networkSecurityGroup.securityRules] A collection * of security rules of the network security group. - * @member {array} + * @property {array} * [ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] The * default security rules of network security group. - * @member {array} + * @property {array} * [ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] A * collection of references to network interfaces. - * @member {array} [ipConfiguration.subnet.networkSecurityGroup.subnets] A + * @property {array} [ipConfiguration.subnet.networkSecurityGroup.subnets] A * collection of references to subnets. - * @member {string} + * @property {string} * [ipConfiguration.subnet.networkSecurityGroup.resourceGuid] The resource * GUID property of the network security group resource. - * @member {string} + * @property {string} * [ipConfiguration.subnet.networkSecurityGroup.provisioningState] The * provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.subnet.networkSecurityGroup.etag] A + * @property {string} [ipConfiguration.subnet.networkSecurityGroup.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {object} [ipConfiguration.subnet.routeTable] The reference of the - * RouteTable resource. - * @member {array} [ipConfiguration.subnet.routeTable.routes] Collection of + * @property {object} [ipConfiguration.subnet.routeTable] The reference of + * the RouteTable resource. + * @property {array} [ipConfiguration.subnet.routeTable.routes] Collection of * routes contained within a route table. - * @member {array} [ipConfiguration.subnet.routeTable.subnets] A collection + * @property {array} [ipConfiguration.subnet.routeTable.subnets] A collection * of references to subnets. - * @member {boolean} + * @property {boolean} * [ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] Gets or * sets whether to disable the routes learned by BGP on that route table. * True means disable. - * @member {string} [ipConfiguration.subnet.routeTable.provisioningState] The - * provisioning state of the resource. Possible values are: 'Updating', + * @property {string} [ipConfiguration.subnet.routeTable.provisioningState] + * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.subnet.routeTable.etag] Gets a unique + * @property {string} [ipConfiguration.subnet.routeTable.etag] Gets a unique * read-only string that changes whenever the resource is updated. - * @member {array} [ipConfiguration.subnet.serviceEndpoints] An array of + * @property {array} [ipConfiguration.subnet.serviceEndpoints] An array of * service endpoints. - * @member {array} [ipConfiguration.subnet.serviceEndpointPolicies] An array - * of service endpoint policies. - * @member {array} [ipConfiguration.subnet.interfaceEndpoints] An array of + * @property {array} [ipConfiguration.subnet.serviceEndpointPolicies] An + * array of service endpoint policies. + * @property {array} [ipConfiguration.subnet.interfaceEndpoints] An array of * references to interface endpoints - * @member {array} [ipConfiguration.subnet.ipConfigurations] Gets an array of - * references to the network interface IP configurations using subnet. - * @member {array} [ipConfiguration.subnet.ipConfigurationProfiles] Array of - * IP configuration profiles which reference this subnet. - * @member {array} [ipConfiguration.subnet.resourceNavigationLinks] Gets an + * @property {array} [ipConfiguration.subnet.ipConfigurations] Gets an array + * of references to the network interface IP configurations using subnet. + * @property {array} [ipConfiguration.subnet.ipConfigurationProfiles] Array + * of IP configuration profiles which reference this subnet. + * @property {array} [ipConfiguration.subnet.resourceNavigationLinks] Gets an * array of references to the external resources using subnet. - * @member {array} [ipConfiguration.subnet.serviceAssociationLinks] Gets an + * @property {array} [ipConfiguration.subnet.serviceAssociationLinks] Gets an * array of references to services injecting into this subnet. - * @member {array} [ipConfiguration.subnet.delegations] Gets an array of + * @property {array} [ipConfiguration.subnet.delegations] Gets an array of * references to the delegations on the subnet. - * @member {string} [ipConfiguration.subnet.purpose] A read-only string + * @property {string} [ipConfiguration.subnet.purpose] A read-only string * identifying the intention of use for this subnet based on delegations and * other user-defined properties. - * @member {string} [ipConfiguration.subnet.provisioningState] The + * @property {string} [ipConfiguration.subnet.provisioningState] The * provisioning state of the resource. - * @member {string} [ipConfiguration.subnet.name] The name of the resource + * @property {string} [ipConfiguration.subnet.name] The name of the resource * that is unique within a resource group. This name can be used to access * the resource. - * @member {string} [ipConfiguration.subnet.etag] A unique read-only string + * @property {string} [ipConfiguration.subnet.etag] A unique read-only string * that changes whenever the resource is updated. - * @member {object} [ipConfiguration.publicIPAddress] The reference of the + * @property {object} [ipConfiguration.publicIPAddress] The reference of the * public IP resource. - * @member {string} [ipConfiguration.provisioningState] Gets the provisioning - * state of the public IP resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [ipConfiguration.name] The name of the resource that is + * @property {string} [ipConfiguration.provisioningState] Gets the + * provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + * @property {string} [ipConfiguration.name] The name of the resource that is * unique within a resource group. This name can be used to access the * resource. - * @member {string} [ipConfiguration.etag] A unique read-only string that + * @property {string} [ipConfiguration.etag] A unique read-only string that * changes whenever the resource is updated. - * @member {object} [dnsSettings] The FQDN of the DNS record associated with - * the public IP address. - * @member {string} [dnsSettings.domainNameLabel] Gets or sets the Domain + * @property {object} [dnsSettings] The FQDN of the DNS record associated + * with the public IP address. + * @property {string} [dnsSettings.domainNameLabel] Gets or sets the Domain * name label.The concatenation of the domain name label and the regionalized * DNS zone make up the fully qualified domain name associated with the * public IP address. If a domain name label is specified, an A DNS record is * created for the public IP in the Microsoft Azure DNS system. - * @member {string} [dnsSettings.fqdn] Gets the FQDN, Fully qualified domain - * name of the A DNS record associated with the public IP. This is the + * @property {string} [dnsSettings.fqdn] Gets the FQDN, Fully qualified + * domain name of the A DNS record associated with the public IP. This is the * concatenation of the domainNameLabel and the regionalized DNS zone. - * @member {string} [dnsSettings.reverseFqdn] Gets or Sets the Reverse FQDN. - * A user-visible, fully qualified domain name that resolves to this public - * IP address. If the reverseFqdn is specified, then a PTR DNS record is - * created pointing from the IP address in the in-addr.arpa domain to the + * @property {string} [dnsSettings.reverseFqdn] Gets or Sets the Reverse + * FQDN. A user-visible, fully qualified domain name that resolves to this + * public IP address. If the reverseFqdn is specified, then a PTR DNS record + * is created pointing from the IP address in the in-addr.arpa domain to the * reverse FQDN. - * @member {array} [ipTags] The list of tags associated with the public IP + * @property {array} [ipTags] The list of tags associated with the public IP * address. - * @member {string} [ipAddress] The IP address associated with the public IP - * address resource. - * @member {object} [publicIPPrefix] The Public IP Prefix this Public IP + * @property {string} [ipAddress] The IP address associated with the public + * IP address resource. + * @property {object} [publicIPPrefix] The Public IP Prefix this Public IP * Address should be allocated from. - * @member {string} [publicIPPrefix.id] Resource ID. - * @member {number} [idleTimeoutInMinutes] The idle timeout of the public IP - * address. - * @member {string} [resourceGuid] The resource GUID property of the public + * @property {string} [publicIPPrefix.id] Resource ID. + * @property {number} [idleTimeoutInMinutes] The idle timeout of the public + * IP address. + * @property {string} [resourceGuid] The resource GUID property of the public * IP resource. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * PublicIP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {array} [zones] A list of availability zones denoting the IP + * @property {array} [zones] A list of availability zones denoting the IP * allocated for the resource needs to come from. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/publicIPAddressDnsSettings.js b/lib/services/networkManagement2/lib/models/publicIPAddressDnsSettings.js index 1381dca87a..2b78e949c9 100644 --- a/lib/services/networkManagement2/lib/models/publicIPAddressDnsSettings.js +++ b/lib/services/networkManagement2/lib/models/publicIPAddressDnsSettings.js @@ -17,15 +17,15 @@ class PublicIPAddressDnsSettings { /** * Create a PublicIPAddressDnsSettings. - * @member {string} [domainNameLabel] Gets or sets the Domain name label.The - * concatenation of the domain name label and the regionalized DNS zone make - * up the fully qualified domain name associated with the public IP address. - * If a domain name label is specified, an A DNS record is created for the - * public IP in the Microsoft Azure DNS system. - * @member {string} [fqdn] Gets the FQDN, Fully qualified domain name of the - * A DNS record associated with the public IP. This is the concatenation of - * the domainNameLabel and the regionalized DNS zone. - * @member {string} [reverseFqdn] Gets or Sets the Reverse FQDN. A + * @property {string} [domainNameLabel] Gets or sets the Domain name + * label.The concatenation of the domain name label and the regionalized DNS + * zone make up the fully qualified domain name associated with the public IP + * address. If a domain name label is specified, an A DNS record is created + * for the public IP in the Microsoft Azure DNS system. + * @property {string} [fqdn] Gets the FQDN, Fully qualified domain name of + * the A DNS record associated with the public IP. This is the concatenation + * of the domainNameLabel and the regionalized DNS zone. + * @property {string} [reverseFqdn] Gets or Sets the Reverse FQDN. A * user-visible, fully qualified domain name that resolves to this public IP * address. If the reverseFqdn is specified, then a PTR DNS record is created * pointing from the IP address in the in-addr.arpa domain to the reverse diff --git a/lib/services/networkManagement2/lib/models/publicIPAddressListResult.js b/lib/services/networkManagement2/lib/models/publicIPAddressListResult.js index 5545b55f0b..9baed5f64b 100644 --- a/lib/services/networkManagement2/lib/models/publicIPAddressListResult.js +++ b/lib/services/networkManagement2/lib/models/publicIPAddressListResult.js @@ -16,7 +16,7 @@ class PublicIPAddressListResult extends Array { /** * Create a PublicIPAddressListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/publicIPAddressSku.js b/lib/services/networkManagement2/lib/models/publicIPAddressSku.js index c3198b0439..4b51a49f7b 100644 --- a/lib/services/networkManagement2/lib/models/publicIPAddressSku.js +++ b/lib/services/networkManagement2/lib/models/publicIPAddressSku.js @@ -17,7 +17,7 @@ class PublicIPAddressSku { /** * Create a PublicIPAddressSku. - * @member {string} [name] Name of a public IP address SKU. Possible values + * @property {string} [name] Name of a public IP address SKU. Possible values * include: 'Basic', 'Standard' */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/publicIPPrefix.js b/lib/services/networkManagement2/lib/models/publicIPPrefix.js index 15fa2711a9..86392b0edd 100644 --- a/lib/services/networkManagement2/lib/models/publicIPPrefix.js +++ b/lib/services/networkManagement2/lib/models/publicIPPrefix.js @@ -20,26 +20,26 @@ const models = require('./index'); class PublicIPPrefix extends models['Resource'] { /** * Create a PublicIPPrefix. - * @member {object} [sku] The public IP prefix SKU. - * @member {string} [sku.name] Name of a public IP prefix SKU. Possible + * @property {object} [sku] The public IP prefix SKU. + * @property {string} [sku.name] Name of a public IP prefix SKU. Possible * values include: 'Standard' - * @member {string} [publicIPAddressVersion] The public IP address version. + * @property {string} [publicIPAddressVersion] The public IP address version. * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', * 'IPv6' - * @member {array} [ipTags] The list of tags associated with the public IP + * @property {array} [ipTags] The list of tags associated with the public IP * prefix. - * @member {number} [prefixLength] The Length of the Public IP Prefix. - * @member {string} [ipPrefix] The allocated Prefix - * @member {array} [publicIPAddresses] The list of all referenced + * @property {number} [prefixLength] The Length of the Public IP Prefix. + * @property {string} [ipPrefix] The allocated Prefix + * @property {array} [publicIPAddresses] The list of all referenced * PublicIPAddresses - * @member {string} [resourceGuid] The resource GUID property of the public + * @property {string} [resourceGuid] The resource GUID property of the public * IP prefix resource. - * @member {string} [provisioningState] The provisioning state of the Public - * IP prefix resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [provisioningState] The provisioning state of the + * Public IP prefix resource. Possible values are: 'Updating', 'Deleting', + * and 'Failed'. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. - * @member {array} [zones] A list of availability zones denoting the IP + * @property {array} [zones] A list of availability zones denoting the IP * allocated for the resource needs to come from. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/publicIPPrefixListResult.js b/lib/services/networkManagement2/lib/models/publicIPPrefixListResult.js index 42972e61b0..f74416a96a 100644 --- a/lib/services/networkManagement2/lib/models/publicIPPrefixListResult.js +++ b/lib/services/networkManagement2/lib/models/publicIPPrefixListResult.js @@ -16,7 +16,7 @@ class PublicIPPrefixListResult extends Array { /** * Create a PublicIPPrefixListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/publicIPPrefixSku.js b/lib/services/networkManagement2/lib/models/publicIPPrefixSku.js index d9cc8fc416..f9ce9a7be2 100644 --- a/lib/services/networkManagement2/lib/models/publicIPPrefixSku.js +++ b/lib/services/networkManagement2/lib/models/publicIPPrefixSku.js @@ -17,7 +17,7 @@ class PublicIPPrefixSku { /** * Create a PublicIPPrefixSku. - * @member {string} [name] Name of a public IP prefix SKU. Possible values + * @property {string} [name] Name of a public IP prefix SKU. Possible values * include: 'Standard' */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/queryTroubleshootingParameters.js b/lib/services/networkManagement2/lib/models/queryTroubleshootingParameters.js index ffca4c1894..26952c93dc 100644 --- a/lib/services/networkManagement2/lib/models/queryTroubleshootingParameters.js +++ b/lib/services/networkManagement2/lib/models/queryTroubleshootingParameters.js @@ -17,7 +17,7 @@ class QueryTroubleshootingParameters { /** * Create a QueryTroubleshootingParameters. - * @member {string} targetResourceId The target resource ID to query the + * @property {string} targetResourceId The target resource ID to query the * troubleshooting result. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/referencedPublicIpAddress.js b/lib/services/networkManagement2/lib/models/referencedPublicIpAddress.js index b68714178b..9e7149557e 100644 --- a/lib/services/networkManagement2/lib/models/referencedPublicIpAddress.js +++ b/lib/services/networkManagement2/lib/models/referencedPublicIpAddress.js @@ -16,7 +16,7 @@ class ReferencedPublicIpAddress { /** * Create a ReferencedPublicIpAddress. - * @member {string} [id] The PublicIPAddress Reference + * @property {string} [id] The PublicIPAddress Reference */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/resource.js b/lib/services/networkManagement2/lib/models/resource.js index cbf0836276..c220802ef9 100644 --- a/lib/services/networkManagement2/lib/models/resource.js +++ b/lib/services/networkManagement2/lib/models/resource.js @@ -20,11 +20,11 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. - * @member {string} [location] Resource location. - * @member {object} [tags] Resource tags. + * @property {string} [id] Resource ID. + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. + * @property {string} [location] Resource location. + * @property {object} [tags] Resource tags. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/resourceNavigationLink.js b/lib/services/networkManagement2/lib/models/resourceNavigationLink.js index 998fc4a73e..84e4e08898 100644 --- a/lib/services/networkManagement2/lib/models/resourceNavigationLink.js +++ b/lib/services/networkManagement2/lib/models/resourceNavigationLink.js @@ -20,14 +20,14 @@ const models = require('./index'); class ResourceNavigationLink extends models['SubResource'] { /** * Create a ResourceNavigationLink. - * @member {string} [linkedResourceType] Resource type of the linked + * @property {string} [linkedResourceType] Resource type of the linked * resource. - * @member {string} [link] Link to the external resource - * @member {string} [provisioningState] Provisioning state of the + * @property {string} [link] Link to the external resource + * @property {string} [provisioningState] Provisioning state of the * ResourceNavigationLink resource. - * @member {string} [name] Name of the resource that is unique within a + * @property {string} [name] Name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/retentionPolicyParameters.js b/lib/services/networkManagement2/lib/models/retentionPolicyParameters.js index 85a9101d3b..fe32bc2fe1 100644 --- a/lib/services/networkManagement2/lib/models/retentionPolicyParameters.js +++ b/lib/services/networkManagement2/lib/models/retentionPolicyParameters.js @@ -17,9 +17,9 @@ class RetentionPolicyParameters { /** * Create a RetentionPolicyParameters. - * @member {number} [days] Number of days to retain flow log records. Default - * value: 0 . - * @member {boolean} [enabled] Flag to enable/disable retention. Default + * @property {number} [days] Number of days to retain flow log records. + * Default value: 0 . + * @property {boolean} [enabled] Flag to enable/disable retention. Default * value: false . */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/route.js b/lib/services/networkManagement2/lib/models/route.js index 8fb7c8b2b8..e5d5060e76 100644 --- a/lib/services/networkManagement2/lib/models/route.js +++ b/lib/services/networkManagement2/lib/models/route.js @@ -20,21 +20,21 @@ const models = require('./index'); class Route extends models['SubResource'] { /** * Create a Route. - * @member {string} [addressPrefix] The destination CIDR to which the route + * @property {string} [addressPrefix] The destination CIDR to which the route * applies. - * @member {string} nextHopType The type of Azure hop the packet should be + * @property {string} nextHopType The type of Azure hop the packet should be * sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', * 'Internet', 'VirtualAppliance', and 'None'. Possible values include: * 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', * 'None' - * @member {string} [nextHopIpAddress] The IP address packets should be + * @property {string} [nextHopIpAddress] The IP address packets should be * forwarded to. Next hop values are only allowed in routes where the next * hop type is VirtualAppliance. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/routeFilter.js b/lib/services/networkManagement2/lib/models/routeFilter.js index 3c965667ac..9ea6b7ebf3 100644 --- a/lib/services/networkManagement2/lib/models/routeFilter.js +++ b/lib/services/networkManagement2/lib/models/routeFilter.js @@ -20,14 +20,14 @@ const models = require('./index'); class RouteFilter extends models['Resource'] { /** * Create a RouteFilter. - * @member {array} [rules] Collection of RouteFilterRules contained within a - * route filter. - * @member {array} [peerings] A collection of references to express route + * @property {array} [rules] Collection of RouteFilterRules contained within + * a route filter. + * @property {array} [peerings] A collection of references to express route * circuit peerings. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and * 'Failed'. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/routeFilterListResult.js b/lib/services/networkManagement2/lib/models/routeFilterListResult.js index 07f60cfe43..4de8a1b912 100644 --- a/lib/services/networkManagement2/lib/models/routeFilterListResult.js +++ b/lib/services/networkManagement2/lib/models/routeFilterListResult.js @@ -16,7 +16,7 @@ class RouteFilterListResult extends Array { /** * Create a RouteFilterListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/routeFilterRule.js b/lib/services/networkManagement2/lib/models/routeFilterRule.js index 026d2ba3cb..b02d449f68 100644 --- a/lib/services/networkManagement2/lib/models/routeFilterRule.js +++ b/lib/services/networkManagement2/lib/models/routeFilterRule.js @@ -20,17 +20,17 @@ const models = require('./index'); class RouteFilterRule extends models['SubResource'] { /** * Create a RouteFilterRule. - * @member {string} access The access type of the rule. Valid values are: + * @property {string} access The access type of the rule. Valid values are: * 'Allow', 'Deny'. Possible values include: 'Allow', 'Deny' - * @member {array} communities The collection for bgp community values to + * @property {array} communities The collection for bgp community values to * filter on. e.g. ['12076:5010','12076:5020'] - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and * 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [location] Resource location. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [location] Resource location. + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/routeFilterRuleListResult.js b/lib/services/networkManagement2/lib/models/routeFilterRuleListResult.js index d5fc3d232a..21c158f52f 100644 --- a/lib/services/networkManagement2/lib/models/routeFilterRuleListResult.js +++ b/lib/services/networkManagement2/lib/models/routeFilterRuleListResult.js @@ -16,7 +16,7 @@ class RouteFilterRuleListResult extends Array { /** * Create a RouteFilterRuleListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/routeListResult.js b/lib/services/networkManagement2/lib/models/routeListResult.js index d5e97bccfd..e90ab9dd67 100644 --- a/lib/services/networkManagement2/lib/models/routeListResult.js +++ b/lib/services/networkManagement2/lib/models/routeListResult.js @@ -16,7 +16,7 @@ class RouteListResult extends Array { /** * Create a RouteListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/routeTable.js b/lib/services/networkManagement2/lib/models/routeTable.js index e6355aad77..bedf8cc4e9 100644 --- a/lib/services/networkManagement2/lib/models/routeTable.js +++ b/lib/services/networkManagement2/lib/models/routeTable.js @@ -20,14 +20,14 @@ const models = require('./index'); class RouteTable extends models['Resource'] { /** * Create a RouteTable. - * @member {array} [routes] Collection of routes contained within a route + * @property {array} [routes] Collection of routes contained within a route * table. - * @member {array} [subnets] A collection of references to subnets. - * @member {boolean} [disableBgpRoutePropagation] Gets or sets whether to + * @property {array} [subnets] A collection of references to subnets. + * @property {boolean} [disableBgpRoutePropagation] Gets or sets whether to * disable the routes learned by BGP on that route table. True means disable. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/routeTableListResult.js b/lib/services/networkManagement2/lib/models/routeTableListResult.js index e7fcdff6bc..5498bc590a 100644 --- a/lib/services/networkManagement2/lib/models/routeTableListResult.js +++ b/lib/services/networkManagement2/lib/models/routeTableListResult.js @@ -16,7 +16,7 @@ class RouteTableListResult extends Array { /** * Create a RouteTableListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/securityGroupNetworkInterface.js b/lib/services/networkManagement2/lib/models/securityGroupNetworkInterface.js index 6899a7d05e..e45ddcfb53 100644 --- a/lib/services/networkManagement2/lib/models/securityGroupNetworkInterface.js +++ b/lib/services/networkManagement2/lib/models/securityGroupNetworkInterface.js @@ -17,22 +17,24 @@ class SecurityGroupNetworkInterface { /** * Create a SecurityGroupNetworkInterface. - * @member {string} [id] ID of the network interface. - * @member {object} [securityRuleAssociations] - * @member {object} [securityRuleAssociations.networkInterfaceAssociation] - * @member {string} [securityRuleAssociations.networkInterfaceAssociation.id] - * Network interface ID. - * @member {array} + * @property {string} [id] ID of the network interface. + * @property {object} [securityRuleAssociations] + * @property {object} [securityRuleAssociations.networkInterfaceAssociation] + * @property {string} + * [securityRuleAssociations.networkInterfaceAssociation.id] Network + * interface ID. + * @property {array} * [securityRuleAssociations.networkInterfaceAssociation.securityRules] * Collection of custom security rules. - * @member {object} [securityRuleAssociations.subnetAssociation] - * @member {string} [securityRuleAssociations.subnetAssociation.id] Subnet + * @property {object} [securityRuleAssociations.subnetAssociation] + * @property {string} [securityRuleAssociations.subnetAssociation.id] Subnet * ID. - * @member {array} [securityRuleAssociations.subnetAssociation.securityRules] - * Collection of custom security rules. - * @member {array} [securityRuleAssociations.defaultSecurityRules] Collection - * of default security rules of the network security group. - * @member {array} [securityRuleAssociations.effectiveSecurityRules] + * @property {array} + * [securityRuleAssociations.subnetAssociation.securityRules] Collection of + * custom security rules. + * @property {array} [securityRuleAssociations.defaultSecurityRules] + * Collection of default security rules of the network security group. + * @property {array} [securityRuleAssociations.effectiveSecurityRules] * Collection of effective security rules. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/securityGroupViewParameters.js b/lib/services/networkManagement2/lib/models/securityGroupViewParameters.js index f44e5ddca7..b93b5445f4 100644 --- a/lib/services/networkManagement2/lib/models/securityGroupViewParameters.js +++ b/lib/services/networkManagement2/lib/models/securityGroupViewParameters.js @@ -17,7 +17,7 @@ class SecurityGroupViewParameters { /** * Create a SecurityGroupViewParameters. - * @member {string} targetResourceId ID of the target VM. + * @property {string} targetResourceId ID of the target VM. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/securityGroupViewResult.js b/lib/services/networkManagement2/lib/models/securityGroupViewResult.js index 9a8409cc8f..06cb6c4905 100644 --- a/lib/services/networkManagement2/lib/models/securityGroupViewResult.js +++ b/lib/services/networkManagement2/lib/models/securityGroupViewResult.js @@ -17,7 +17,7 @@ class SecurityGroupViewResult { /** * Create a SecurityGroupViewResult. - * @member {array} [networkInterfaces] List of network interfaces on the + * @property {array} [networkInterfaces] List of network interfaces on the * specified VM. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/securityRule.js b/lib/services/networkManagement2/lib/models/securityRule.js index 2cd405eb52..a40f02a127 100644 --- a/lib/services/networkManagement2/lib/models/securityRule.js +++ b/lib/services/networkManagement2/lib/models/securityRule.js @@ -20,49 +20,51 @@ const models = require('./index'); class SecurityRule extends models['SubResource'] { /** * Create a SecurityRule. - * @member {string} [description] A description for this rule. Restricted to - * 140 chars. - * @member {string} protocol Network protocol this rule applies to. Possible - * values are 'Tcp', 'Udp', and '*'. Possible values include: 'Tcp', 'Udp', - * '*' - * @member {string} [sourcePortRange] The source port or range. Integer or + * @property {string} [description] A description for this rule. Restricted + * to 140 chars. + * @property {string} protocol Network protocol this rule applies to. + * Possible values are 'Tcp', 'Udp', and '*'. Possible values include: 'Tcp', + * 'Udp', '*' + * @property {string} [sourcePortRange] The source port or range. Integer or * range between 0 and 65535. Asterix '*' can also be used to match all * ports. - * @member {string} [destinationPortRange] The destination port or range. + * @property {string} [destinationPortRange] The destination port or range. * Integer or range between 0 and 65535. Asterix '*' can also be used to * match all ports. - * @member {string} [sourceAddressPrefix] The CIDR or source IP range. + * @property {string} [sourceAddressPrefix] The CIDR or source IP range. * Asterix '*' can also be used to match all source IPs. Default tags such as * 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If * this is an ingress rule, specifies where network traffic originates from. - * @member {array} [sourceAddressPrefixes] The CIDR or source IP ranges. - * @member {array} [sourceApplicationSecurityGroups] The application security - * group specified as source. - * @member {string} [destinationAddressPrefix] The destination address + * @property {array} [sourceAddressPrefixes] The CIDR or source IP ranges. + * @property {array} [sourceApplicationSecurityGroups] The application + * security group specified as source. + * @property {string} [destinationAddressPrefix] The destination address * prefix. CIDR or destination IP range. Asterix '*' can also be used to * match all source IPs. Default tags such as 'VirtualNetwork', * 'AzureLoadBalancer' and 'Internet' can also be used. - * @member {array} [destinationAddressPrefixes] The destination address + * @property {array} [destinationAddressPrefixes] The destination address * prefixes. CIDR or destination IP ranges. - * @member {array} [destinationApplicationSecurityGroups] The application + * @property {array} [destinationApplicationSecurityGroups] The application * security group specified as destination. - * @member {array} [sourcePortRanges] The source port ranges. - * @member {array} [destinationPortRanges] The destination port ranges. - * @member {string} access The network traffic is allowed or denied. Possible - * values are: 'Allow' and 'Deny'. Possible values include: 'Allow', 'Deny' - * @member {number} [priority] The priority of the rule. The value can be + * @property {array} [sourcePortRanges] The source port ranges. + * @property {array} [destinationPortRanges] The destination port ranges. + * @property {string} access The network traffic is allowed or denied. + * Possible values are: 'Allow' and 'Deny'. Possible values include: 'Allow', + * 'Deny' + * @property {number} [priority] The priority of the rule. The value can be * between 100 and 4096. The priority number must be unique for each rule in * the collection. The lower the priority number, the higher the priority of * the rule. - * @member {string} direction The direction of the rule. The direction + * @property {string} direction The direction of the rule. The direction * specifies if rule will be evaluated on incoming or outcoming traffic. * Possible values are: 'Inbound' and 'Outbound'. Possible values include: * 'Inbound', 'Outbound' - * @member {string} [provisioningState] The provisioning state of the public - * IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [provisioningState] The provisioning state of the + * public IP resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/securityRuleAssociations.js b/lib/services/networkManagement2/lib/models/securityRuleAssociations.js index e4eceb2156..1a322cc925 100644 --- a/lib/services/networkManagement2/lib/models/securityRuleAssociations.js +++ b/lib/services/networkManagement2/lib/models/securityRuleAssociations.js @@ -17,18 +17,18 @@ class SecurityRuleAssociations { /** * Create a SecurityRuleAssociations. - * @member {object} [networkInterfaceAssociation] - * @member {string} [networkInterfaceAssociation.id] Network interface ID. - * @member {array} [networkInterfaceAssociation.securityRules] Collection of - * custom security rules. - * @member {object} [subnetAssociation] - * @member {string} [subnetAssociation.id] Subnet ID. - * @member {array} [subnetAssociation.securityRules] Collection of custom + * @property {object} [networkInterfaceAssociation] + * @property {string} [networkInterfaceAssociation.id] Network interface ID. + * @property {array} [networkInterfaceAssociation.securityRules] Collection + * of custom security rules. + * @property {object} [subnetAssociation] + * @property {string} [subnetAssociation.id] Subnet ID. + * @property {array} [subnetAssociation.securityRules] Collection of custom * security rules. - * @member {array} [defaultSecurityRules] Collection of default security + * @property {array} [defaultSecurityRules] Collection of default security * rules of the network security group. - * @member {array} [effectiveSecurityRules] Collection of effective security - * rules. + * @property {array} [effectiveSecurityRules] Collection of effective + * security rules. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/securityRuleListResult.js b/lib/services/networkManagement2/lib/models/securityRuleListResult.js index f8e55a66b4..4a6eae986a 100644 --- a/lib/services/networkManagement2/lib/models/securityRuleListResult.js +++ b/lib/services/networkManagement2/lib/models/securityRuleListResult.js @@ -17,7 +17,7 @@ class SecurityRuleListResult extends Array { /** * Create a SecurityRuleListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/serviceAssociationLink.js b/lib/services/networkManagement2/lib/models/serviceAssociationLink.js index b89cea2271..0e5e800677 100644 --- a/lib/services/networkManagement2/lib/models/serviceAssociationLink.js +++ b/lib/services/networkManagement2/lib/models/serviceAssociationLink.js @@ -20,14 +20,14 @@ const models = require('./index'); class ServiceAssociationLink extends models['SubResource'] { /** * Create a ServiceAssociationLink. - * @member {string} [linkedResourceType] Resource type of the linked + * @property {string} [linkedResourceType] Resource type of the linked * resource. - * @member {string} [link] Link to the external resource. - * @member {string} [provisioningState] Provisioning state of the + * @property {string} [link] Link to the external resource. + * @property {string} [provisioningState] Provisioning state of the * ServiceAssociationLink resource. - * @member {string} [name] Name of the resource that is unique within a + * @property {string} [name] Name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/serviceEndpointPolicy.js b/lib/services/networkManagement2/lib/models/serviceEndpointPolicy.js index 8728b9005a..8b47652fb8 100644 --- a/lib/services/networkManagement2/lib/models/serviceEndpointPolicy.js +++ b/lib/services/networkManagement2/lib/models/serviceEndpointPolicy.js @@ -20,15 +20,15 @@ const models = require('./index'); class ServiceEndpointPolicy extends models['Resource'] { /** * Create a ServiceEndpointPolicy. - * @member {array} [serviceEndpointPolicyDefinitions] A collection of service - * endpoint policy definitions of the service endpoint policy. - * @member {array} [subnets] A collection of references to subnets. - * @member {string} [resourceGuid] The resource GUID property of the service - * endpoint policy resource. - * @member {string} [provisioningState] The provisioning state of the service - * endpoint policy. Possible values are: 'Updating', 'Deleting', and + * @property {array} [serviceEndpointPolicyDefinitions] A collection of + * service endpoint policy definitions of the service endpoint policy. + * @property {array} [subnets] A collection of references to subnets. + * @property {string} [resourceGuid] The resource GUID property of the + * service endpoint policy resource. + * @property {string} [provisioningState] The provisioning state of the + * service endpoint policy. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/serviceEndpointPolicyDefinition.js b/lib/services/networkManagement2/lib/models/serviceEndpointPolicyDefinition.js index d05a956862..623b59ac0e 100644 --- a/lib/services/networkManagement2/lib/models/serviceEndpointPolicyDefinition.js +++ b/lib/services/networkManagement2/lib/models/serviceEndpointPolicyDefinition.js @@ -20,16 +20,16 @@ const models = require('./index'); class ServiceEndpointPolicyDefinition extends models['SubResource'] { /** * Create a ServiceEndpointPolicyDefinition. - * @member {string} [description] A description for this rule. Restricted to - * 140 chars. - * @member {string} [service] service endpoint name. - * @member {array} [serviceResources] A list of service resources. - * @member {string} [provisioningState] The provisioning state of the service - * end point policy definition. Possible values are: 'Updating', 'Deleting', - * and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [description] A description for this rule. Restricted + * to 140 chars. + * @property {string} [service] service endpoint name. + * @property {array} [serviceResources] A list of service resources. + * @property {string} [provisioningState] The provisioning state of the + * service end point policy definition. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/serviceEndpointPolicyDefinitionListResult.js b/lib/services/networkManagement2/lib/models/serviceEndpointPolicyDefinitionListResult.js index f79b5fd535..68e9f172de 100644 --- a/lib/services/networkManagement2/lib/models/serviceEndpointPolicyDefinitionListResult.js +++ b/lib/services/networkManagement2/lib/models/serviceEndpointPolicyDefinitionListResult.js @@ -18,7 +18,7 @@ class ServiceEndpointPolicyDefinitionListResult extends Array { /** * Create a ServiceEndpointPolicyDefinitionListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/serviceEndpointPolicyListResult.js b/lib/services/networkManagement2/lib/models/serviceEndpointPolicyListResult.js index ce785e4771..aae5392b5a 100644 --- a/lib/services/networkManagement2/lib/models/serviceEndpointPolicyListResult.js +++ b/lib/services/networkManagement2/lib/models/serviceEndpointPolicyListResult.js @@ -16,7 +16,7 @@ class ServiceEndpointPolicyListResult extends Array { /** * Create a ServiceEndpointPolicyListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/serviceEndpointPropertiesFormat.js b/lib/services/networkManagement2/lib/models/serviceEndpointPropertiesFormat.js index 710f651b4e..b3f5746af1 100644 --- a/lib/services/networkManagement2/lib/models/serviceEndpointPropertiesFormat.js +++ b/lib/services/networkManagement2/lib/models/serviceEndpointPropertiesFormat.js @@ -17,9 +17,9 @@ class ServiceEndpointPropertiesFormat { /** * Create a ServiceEndpointPropertiesFormat. - * @member {string} [service] The type of the endpoint service. - * @member {array} [locations] A list of locations. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [service] The type of the endpoint service. + * @property {array} [locations] A list of locations. + * @property {string} [provisioningState] The provisioning state of the * resource. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/subResource.js b/lib/services/networkManagement2/lib/models/subResource.js index 51215f1707..f59dea3bbf 100644 --- a/lib/services/networkManagement2/lib/models/subResource.js +++ b/lib/services/networkManagement2/lib/models/subResource.js @@ -20,7 +20,7 @@ const models = require('./index'); class SubResource extends models['BaseResource'] { /** * Create a SubResource. - * @member {string} [id] Resource ID. + * @property {string} [id] Resource ID. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/subnet.js b/lib/services/networkManagement2/lib/models/subnet.js index 53a36af7c1..e0d3e37db7 100644 --- a/lib/services/networkManagement2/lib/models/subnet.js +++ b/lib/services/networkManagement2/lib/models/subnet.js @@ -20,61 +20,62 @@ const models = require('./index'); class Subnet extends models['SubResource'] { /** * Create a Subnet. - * @member {string} [addressPrefix] The address prefix for the subnet. - * @member {array} [addressPrefixes] List of address prefixes for the + * @property {string} [addressPrefix] The address prefix for the subnet. + * @property {array} [addressPrefixes] List of address prefixes for the * subnet. - * @member {object} [networkSecurityGroup] The reference of the + * @property {object} [networkSecurityGroup] The reference of the * NetworkSecurityGroup resource. - * @member {array} [networkSecurityGroup.securityRules] A collection of + * @property {array} [networkSecurityGroup.securityRules] A collection of * security rules of the network security group. - * @member {array} [networkSecurityGroup.defaultSecurityRules] The default + * @property {array} [networkSecurityGroup.defaultSecurityRules] The default * security rules of network security group. - * @member {array} [networkSecurityGroup.networkInterfaces] A collection of + * @property {array} [networkSecurityGroup.networkInterfaces] A collection of * references to network interfaces. - * @member {array} [networkSecurityGroup.subnets] A collection of references - * to subnets. - * @member {string} [networkSecurityGroup.resourceGuid] The resource GUID + * @property {array} [networkSecurityGroup.subnets] A collection of + * references to subnets. + * @property {string} [networkSecurityGroup.resourceGuid] The resource GUID * property of the network security group resource. - * @member {string} [networkSecurityGroup.provisioningState] The provisioning - * state of the public IP resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * @member {string} [networkSecurityGroup.etag] A unique read-only string + * @property {string} [networkSecurityGroup.provisioningState] The + * provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + * @property {string} [networkSecurityGroup.etag] A unique read-only string * that changes whenever the resource is updated. - * @member {object} [routeTable] The reference of the RouteTable resource. - * @member {array} [routeTable.routes] Collection of routes contained within - * a route table. - * @member {array} [routeTable.subnets] A collection of references to + * @property {object} [routeTable] The reference of the RouteTable resource. + * @property {array} [routeTable.routes] Collection of routes contained + * within a route table. + * @property {array} [routeTable.subnets] A collection of references to * subnets. - * @member {boolean} [routeTable.disableBgpRoutePropagation] Gets or sets + * @property {boolean} [routeTable.disableBgpRoutePropagation] Gets or sets * whether to disable the routes learned by BGP on that route table. True * means disable. - * @member {string} [routeTable.provisioningState] The provisioning state of - * the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [routeTable.etag] Gets a unique read-only string that + * @property {string} [routeTable.provisioningState] The provisioning state + * of the resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + * @property {string} [routeTable.etag] Gets a unique read-only string that * changes whenever the resource is updated. - * @member {array} [serviceEndpoints] An array of service endpoints. - * @member {array} [serviceEndpointPolicies] An array of service endpoint + * @property {array} [serviceEndpoints] An array of service endpoints. + * @property {array} [serviceEndpointPolicies] An array of service endpoint * policies. - * @member {array} [interfaceEndpoints] An array of references to interface + * @property {array} [interfaceEndpoints] An array of references to interface * endpoints - * @member {array} [ipConfigurations] Gets an array of references to the + * @property {array} [ipConfigurations] Gets an array of references to the * network interface IP configurations using subnet. - * @member {array} [ipConfigurationProfiles] Array of IP configuration + * @property {array} [ipConfigurationProfiles] Array of IP configuration * profiles which reference this subnet. - * @member {array} [resourceNavigationLinks] Gets an array of references to + * @property {array} [resourceNavigationLinks] Gets an array of references to * the external resources using subnet. - * @member {array} [serviceAssociationLinks] Gets an array of references to + * @property {array} [serviceAssociationLinks] Gets an array of references to * services injecting into this subnet. - * @member {array} [delegations] Gets an array of references to the + * @property {array} [delegations] Gets an array of references to the * delegations on the subnet. - * @member {string} [purpose] A read-only string identifying the intention of - * use for this subnet based on delegations and other user-defined + * @property {string} [purpose] A read-only string identifying the intention + * of use for this subnet based on delegations and other user-defined * properties. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/subnetAssociation.js b/lib/services/networkManagement2/lib/models/subnetAssociation.js index f5a79b5f5d..6c91bc204e 100644 --- a/lib/services/networkManagement2/lib/models/subnetAssociation.js +++ b/lib/services/networkManagement2/lib/models/subnetAssociation.js @@ -17,8 +17,8 @@ class SubnetAssociation { /** * Create a SubnetAssociation. - * @member {string} [id] Subnet ID. - * @member {array} [securityRules] Collection of custom security rules. + * @property {string} [id] Subnet ID. + * @property {array} [securityRules] Collection of custom security rules. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/subnetListResult.js b/lib/services/networkManagement2/lib/models/subnetListResult.js index fd7e58bb19..c9006e6b0f 100644 --- a/lib/services/networkManagement2/lib/models/subnetListResult.js +++ b/lib/services/networkManagement2/lib/models/subnetListResult.js @@ -17,7 +17,7 @@ class SubnetListResult extends Array { /** * Create a SubnetListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/tagsObject.js b/lib/services/networkManagement2/lib/models/tagsObject.js index 755b116391..a22fc07dfd 100644 --- a/lib/services/networkManagement2/lib/models/tagsObject.js +++ b/lib/services/networkManagement2/lib/models/tagsObject.js @@ -17,7 +17,7 @@ class TagsObject { /** * Create a TagsObject. - * @member {object} [tags] Resource tags. + * @property {object} [tags] Resource tags. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/topology.js b/lib/services/networkManagement2/lib/models/topology.js index 273704b3e4..31fb32e3b2 100644 --- a/lib/services/networkManagement2/lib/models/topology.js +++ b/lib/services/networkManagement2/lib/models/topology.js @@ -17,12 +17,12 @@ class Topology { /** * Create a Topology. - * @member {string} [id] GUID representing the operation id. - * @member {date} [createdDateTime] The datetime when the topology was + * @property {string} [id] GUID representing the operation id. + * @property {date} [createdDateTime] The datetime when the topology was * initially created for the resource group. - * @member {date} [lastModified] The datetime when the topology was last + * @property {date} [lastModified] The datetime when the topology was last * modified. - * @member {array} [resources] + * @property {array} [resources] */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/topologyAssociation.js b/lib/services/networkManagement2/lib/models/topologyAssociation.js index af3667e2ec..5967b0f7aa 100644 --- a/lib/services/networkManagement2/lib/models/topologyAssociation.js +++ b/lib/services/networkManagement2/lib/models/topologyAssociation.js @@ -17,11 +17,11 @@ class TopologyAssociation { /** * Create a TopologyAssociation. - * @member {string} [name] The name of the resource that is associated with + * @property {string} [name] The name of the resource that is associated with * the parent resource. - * @member {string} [resourceId] The ID of the resource that is associated + * @property {string} [resourceId] The ID of the resource that is associated * with the parent resource. - * @member {string} [associationType] The association type of the child + * @property {string} [associationType] The association type of the child * resource to the parent resource. Possible values include: 'Associated', * 'Contains' */ diff --git a/lib/services/networkManagement2/lib/models/topologyParameters.js b/lib/services/networkManagement2/lib/models/topologyParameters.js index f11000b981..f503a9dc15 100644 --- a/lib/services/networkManagement2/lib/models/topologyParameters.js +++ b/lib/services/networkManagement2/lib/models/topologyParameters.js @@ -17,13 +17,13 @@ class TopologyParameters { /** * Create a TopologyParameters. - * @member {string} [targetResourceGroupName] The name of the target resource - * group to perform topology on. - * @member {object} [targetVirtualNetwork] The reference of the Virtual + * @property {string} [targetResourceGroupName] The name of the target + * resource group to perform topology on. + * @property {object} [targetVirtualNetwork] The reference of the Virtual * Network resource. - * @member {string} [targetVirtualNetwork.id] Resource ID. - * @member {object} [targetSubnet] The reference of the Subnet resource. - * @member {string} [targetSubnet.id] Resource ID. + * @property {string} [targetVirtualNetwork.id] Resource ID. + * @property {object} [targetSubnet] The reference of the Subnet resource. + * @property {string} [targetSubnet.id] Resource ID. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/topologyResource.js b/lib/services/networkManagement2/lib/models/topologyResource.js index be522c60f4..18c8aa4404 100644 --- a/lib/services/networkManagement2/lib/models/topologyResource.js +++ b/lib/services/networkManagement2/lib/models/topologyResource.js @@ -17,10 +17,10 @@ class TopologyResource { /** * Create a TopologyResource. - * @member {string} [name] Name of the resource. - * @member {string} [id] ID of the resource. - * @member {string} [location] Resource location. - * @member {array} [associations] Holds the associations the resource has + * @property {string} [name] Name of the resource. + * @property {string} [id] ID of the resource. + * @property {string} [location] Resource location. + * @property {array} [associations] Holds the associations the resource has * with other resources in the resource group. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/trafficAnalyticsConfigurationProperties.js b/lib/services/networkManagement2/lib/models/trafficAnalyticsConfigurationProperties.js index 58b762cb24..6277575e4f 100644 --- a/lib/services/networkManagement2/lib/models/trafficAnalyticsConfigurationProperties.js +++ b/lib/services/networkManagement2/lib/models/trafficAnalyticsConfigurationProperties.js @@ -17,10 +17,13 @@ class TrafficAnalyticsConfigurationProperties { /** * Create a TrafficAnalyticsConfigurationProperties. - * @member {boolean} enabled Flag to enable/disable traffic analytics. - * @member {string} workspaceId The resource guid of the attached workspace - * @member {string} workspaceRegion The location of the attached workspace - * @member {string} workspaceResourceId Resource Id of the attached workspace + * @property {boolean} enabled Flag to enable/disable traffic analytics. + * @property {string} workspaceId The resource guid of the attached workspace + * @property {string} workspaceRegion The location of the attached workspace + * @property {string} workspaceResourceId Resource Id of the attached + * workspace + * @property {number} [trafficAnalyticsInterval] The interval in minutes + * which would decide how frequently TA service should do flow analytics */ constructor() { } @@ -66,6 +69,13 @@ class TrafficAnalyticsConfigurationProperties { type: { name: 'String' } + }, + trafficAnalyticsInterval: { + required: false, + serializedName: 'trafficAnalyticsInterval', + type: { + name: 'Number' + } } } } diff --git a/lib/services/networkManagement2/lib/models/trafficAnalyticsProperties.js b/lib/services/networkManagement2/lib/models/trafficAnalyticsProperties.js index e36bd54490..40b3c2c59b 100644 --- a/lib/services/networkManagement2/lib/models/trafficAnalyticsProperties.js +++ b/lib/services/networkManagement2/lib/models/trafficAnalyticsProperties.js @@ -17,17 +17,21 @@ class TrafficAnalyticsProperties { /** * Create a TrafficAnalyticsProperties. - * @member {object} networkWatcherFlowAnalyticsConfiguration - * @member {boolean} [networkWatcherFlowAnalyticsConfiguration.enabled] Flag - * to enable/disable traffic analytics. - * @member {string} [networkWatcherFlowAnalyticsConfiguration.workspaceId] + * @property {object} networkWatcherFlowAnalyticsConfiguration + * @property {boolean} [networkWatcherFlowAnalyticsConfiguration.enabled] + * Flag to enable/disable traffic analytics. + * @property {string} [networkWatcherFlowAnalyticsConfiguration.workspaceId] * The resource guid of the attached workspace - * @member {string} + * @property {string} * [networkWatcherFlowAnalyticsConfiguration.workspaceRegion] The location of * the attached workspace - * @member {string} + * @property {string} * [networkWatcherFlowAnalyticsConfiguration.workspaceResourceId] Resource Id * of the attached workspace + * @property {number} + * [networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] The + * interval in minutes which would decide how frequently TA service should do + * flow analytics */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/trafficQuery.js b/lib/services/networkManagement2/lib/models/trafficQuery.js deleted file mode 100644 index 29bbed73ae..0000000000 --- a/lib/services/networkManagement2/lib/models/trafficQuery.js +++ /dev/null @@ -1,91 +0,0 @@ -/* - * 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'; - -/** - * Parameters to compare with network configuration. - * - */ -class TrafficQuery { - /** - * Create a TrafficQuery. - * @member {string} direction The direction of the traffic. Accepted values - * are 'Inbound' and 'Outbound'. Possible values include: 'Inbound', - * 'Outbound' - * @member {string} protocol Protocol to be verified on. Accepted values are - * '*', TCP, UDP. - * @member {string} source Traffic source. Accepted values are '*', IP - * Address/CIDR, Service Tag. - * @member {string} destination Traffic destination. Accepted values are: - * '*', IP Address/CIDR, Service Tag. - * @member {string} destinationPort Traffice destination port. Accepted - * values are '*', port (for example, 3389) and port range (for example, - * 80-100). - */ - constructor() { - } - - /** - * Defines the metadata of TrafficQuery - * - * @returns {object} metadata of TrafficQuery - * - */ - mapper() { - return { - required: false, - serializedName: 'TrafficQuery', - type: { - name: 'Composite', - className: 'TrafficQuery', - modelProperties: { - direction: { - required: true, - serializedName: 'direction', - type: { - name: 'String' - } - }, - protocol: { - required: true, - serializedName: 'protocol', - type: { - name: 'String' - } - }, - source: { - required: true, - serializedName: 'source', - type: { - name: 'String' - } - }, - destination: { - required: true, - serializedName: 'destination', - type: { - name: 'String' - } - }, - destinationPort: { - required: true, - serializedName: 'destinationPort', - type: { - name: 'String' - } - } - } - } - }; - } -} - -module.exports = TrafficQuery; diff --git a/lib/services/networkManagement2/lib/models/troubleshootingDetails.js b/lib/services/networkManagement2/lib/models/troubleshootingDetails.js index b1dc38c77b..fe3d042bcd 100644 --- a/lib/services/networkManagement2/lib/models/troubleshootingDetails.js +++ b/lib/services/networkManagement2/lib/models/troubleshootingDetails.js @@ -17,11 +17,11 @@ class TroubleshootingDetails { /** * Create a TroubleshootingDetails. - * @member {string} [id] The id of the get troubleshoot operation. - * @member {string} [reasonType] Reason type of failure. - * @member {string} [summary] A summary of troubleshooting. - * @member {string} [detail] Details on troubleshooting results. - * @member {array} [recommendedActions] List of recommended actions. + * @property {string} [id] The id of the get troubleshoot operation. + * @property {string} [reasonType] Reason type of failure. + * @property {string} [summary] A summary of troubleshooting. + * @property {string} [detail] Details on troubleshooting results. + * @property {array} [recommendedActions] List of recommended actions. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/troubleshootingParameters.js b/lib/services/networkManagement2/lib/models/troubleshootingParameters.js index d57f7fcc88..bffe8084ad 100644 --- a/lib/services/networkManagement2/lib/models/troubleshootingParameters.js +++ b/lib/services/networkManagement2/lib/models/troubleshootingParameters.js @@ -17,11 +17,11 @@ class TroubleshootingParameters { /** * Create a TroubleshootingParameters. - * @member {string} targetResourceId The target resource to troubleshoot. - * @member {string} storageId The ID for the storage account to save the + * @property {string} targetResourceId The target resource to troubleshoot. + * @property {string} storageId The ID for the storage account to save the * troubleshoot result. - * @member {string} storagePath The path to the blob to save the troubleshoot - * result in. + * @property {string} storagePath The path to the blob to save the + * troubleshoot result in. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/troubleshootingRecommendedActions.js b/lib/services/networkManagement2/lib/models/troubleshootingRecommendedActions.js index 60b1587277..a72fedff29 100644 --- a/lib/services/networkManagement2/lib/models/troubleshootingRecommendedActions.js +++ b/lib/services/networkManagement2/lib/models/troubleshootingRecommendedActions.js @@ -17,11 +17,11 @@ class TroubleshootingRecommendedActions { /** * Create a TroubleshootingRecommendedActions. - * @member {string} [actionId] ID of the recommended action. - * @member {string} [actionText] Description of recommended actions. - * @member {string} [actionUri] The uri linking to a documentation for the + * @property {string} [actionId] ID of the recommended action. + * @property {string} [actionText] Description of recommended actions. + * @property {string} [actionUri] The uri linking to a documentation for the * recommended troubleshooting actions. - * @member {string} [actionUriText] The information from the URI for the + * @property {string} [actionUriText] The information from the URI for the * recommended troubleshooting actions. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/troubleshootingResult.js b/lib/services/networkManagement2/lib/models/troubleshootingResult.js index eeec7a0ab4..6ca8153128 100644 --- a/lib/services/networkManagement2/lib/models/troubleshootingResult.js +++ b/lib/services/networkManagement2/lib/models/troubleshootingResult.js @@ -17,10 +17,10 @@ class TroubleshootingResult { /** * Create a TroubleshootingResult. - * @member {date} [startTime] The start time of the troubleshooting. - * @member {date} [endTime] The end time of the troubleshooting. - * @member {string} [code] The result code of the troubleshooting. - * @member {array} [results] Information from troubleshooting. + * @property {date} [startTime] The start time of the troubleshooting. + * @property {date} [endTime] The end time of the troubleshooting. + * @property {string} [code] The result code of the troubleshooting. + * @property {array} [results] Information from troubleshooting. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/tunnelConnectionHealth.js b/lib/services/networkManagement2/lib/models/tunnelConnectionHealth.js index 4f0858957a..6a3c0d011f 100644 --- a/lib/services/networkManagement2/lib/models/tunnelConnectionHealth.js +++ b/lib/services/networkManagement2/lib/models/tunnelConnectionHealth.js @@ -17,15 +17,15 @@ class TunnelConnectionHealth { /** * Create a TunnelConnectionHealth. - * @member {string} [tunnel] Tunnel name. - * @member {string} [connectionStatus] Virtual network Gateway connection + * @property {string} [tunnel] Tunnel name. + * @property {string} [connectionStatus] Virtual network Gateway connection * status. Possible values include: 'Unknown', 'Connecting', 'Connected', * 'NotConnected' - * @member {number} [ingressBytesTransferred] The Ingress Bytes Transferred + * @property {number} [ingressBytesTransferred] The Ingress Bytes Transferred * in this connection - * @member {number} [egressBytesTransferred] The Egress Bytes Transferred in - * this connection - * @member {string} [lastConnectionEstablishedUtcTime] The time at which + * @property {number} [egressBytesTransferred] The Egress Bytes Transferred + * in this connection + * @property {string} [lastConnectionEstablishedUtcTime] The time at which * connection was established in Utc format. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/usage.js b/lib/services/networkManagement2/lib/models/usage.js index dc57449b64..2fdcbfe81f 100644 --- a/lib/services/networkManagement2/lib/models/usage.js +++ b/lib/services/networkManagement2/lib/models/usage.js @@ -17,12 +17,12 @@ class Usage { /** * Create a Usage. - * @member {string} [id] Resource identifier. - * @member {number} currentValue The current value of the usage. - * @member {number} limit The limit of usage. - * @member {object} name The name of the type of usage. - * @member {string} [name.value] A string describing the resource name. - * @member {string} [name.localizedValue] A localized string describing the + * @property {string} [id] Resource identifier. + * @property {number} currentValue The current value of the usage. + * @property {number} limit The limit of usage. + * @property {object} name The name of the type of usage. + * @property {string} [name.value] A string describing the resource name. + * @property {string} [name.localizedValue] A localized string describing the * resource name. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/usageName.js b/lib/services/networkManagement2/lib/models/usageName.js index 391cb23fe0..d6e59b9fd3 100644 --- a/lib/services/networkManagement2/lib/models/usageName.js +++ b/lib/services/networkManagement2/lib/models/usageName.js @@ -17,8 +17,8 @@ class UsageName { /** * Create a UsageName. - * @member {string} [value] A string describing the resource name. - * @member {string} [localizedValue] A localized string describing the + * @property {string} [value] A string describing the resource name. + * @property {string} [localizedValue] A localized string describing the * resource name. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/usagesListResult.js b/lib/services/networkManagement2/lib/models/usagesListResult.js index 7c5697ddb4..448f03cc39 100644 --- a/lib/services/networkManagement2/lib/models/usagesListResult.js +++ b/lib/services/networkManagement2/lib/models/usagesListResult.js @@ -16,7 +16,7 @@ class UsagesListResult extends Array { /** * Create a UsagesListResult. - * @member {string} [nextLink] URL to get the next set of results. + * @property {string} [nextLink] URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/verificationIPFlowParameters.js b/lib/services/networkManagement2/lib/models/verificationIPFlowParameters.js index 6270bd0162..897d5eed28 100644 --- a/lib/services/networkManagement2/lib/models/verificationIPFlowParameters.js +++ b/lib/services/networkManagement2/lib/models/verificationIPFlowParameters.js @@ -17,23 +17,23 @@ class VerificationIPFlowParameters { /** * Create a VerificationIPFlowParameters. - * @member {string} targetResourceId The ID of the target resource to perform - * next-hop on. - * @member {string} direction The direction of the packet represented as a + * @property {string} targetResourceId The ID of the target resource to + * perform next-hop on. + * @property {string} direction The direction of the packet represented as a * 5-tuple. Possible values include: 'Inbound', 'Outbound' - * @member {string} protocol Protocol to be verified on. Possible values + * @property {string} protocol Protocol to be verified on. Possible values * include: 'TCP', 'UDP' - * @member {string} localPort The local port. Acceptable values are a single - * integer in the range (0-65535). Support for * for the source port, which - * depends on the direction. - * @member {string} remotePort The remote port. Acceptable values are a + * @property {string} localPort The local port. Acceptable values are a * single integer in the range (0-65535). Support for * for the source port, * which depends on the direction. - * @member {string} localIPAddress The local IP address. Acceptable values - * are valid IPv4 addresses. - * @member {string} remoteIPAddress The remote IP address. Acceptable values + * @property {string} remotePort The remote port. Acceptable values are a + * single integer in the range (0-65535). Support for * for the source port, + * which depends on the direction. + * @property {string} localIPAddress The local IP address. Acceptable values * are valid IPv4 addresses. - * @member {string} [targetNicResourceId] The NIC ID. (If VM has multiple + * @property {string} remoteIPAddress The remote IP address. Acceptable + * values are valid IPv4 addresses. + * @property {string} [targetNicResourceId] The NIC ID. (If VM has multiple * NICs and IP forwarding is enabled on any of them, then this parameter must * be specified. Otherwise optional). */ diff --git a/lib/services/networkManagement2/lib/models/verificationIPFlowResult.js b/lib/services/networkManagement2/lib/models/verificationIPFlowResult.js index 47b6fa77d7..97754cfb71 100644 --- a/lib/services/networkManagement2/lib/models/verificationIPFlowResult.js +++ b/lib/services/networkManagement2/lib/models/verificationIPFlowResult.js @@ -17,9 +17,9 @@ class VerificationIPFlowResult { /** * Create a VerificationIPFlowResult. - * @member {string} [access] Indicates whether the traffic is allowed or + * @property {string} [access] Indicates whether the traffic is allowed or * denied. Possible values include: 'Allow', 'Deny' - * @member {string} [ruleName] Name of the rule. If input is not matched + * @property {string} [ruleName] Name of the rule. If input is not matched * against any security rule, it is not displayed. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualHub.js b/lib/services/networkManagement2/lib/models/virtualHub.js index 3155c699ca..3ad3307784 100644 --- a/lib/services/networkManagement2/lib/models/virtualHub.js +++ b/lib/services/networkManagement2/lib/models/virtualHub.js @@ -20,28 +20,28 @@ const models = require('./index'); class VirtualHub extends models['Resource'] { /** * Create a VirtualHub. - * @member {object} [virtualWan] The VirtualWAN to which the VirtualHub + * @property {object} [virtualWan] The VirtualWAN to which the VirtualHub * belongs - * @member {string} [virtualWan.id] Resource ID. - * @member {object} [vpnGateway] The VpnGateway associated with this + * @property {string} [virtualWan.id] Resource ID. + * @property {object} [vpnGateway] The VpnGateway associated with this * VirtualHub - * @member {string} [vpnGateway.id] Resource ID. - * @member {object} [p2SVpnGateway] The P2SVpnGateway associated with this + * @property {string} [vpnGateway.id] Resource ID. + * @property {object} [p2SVpnGateway] The P2SVpnGateway associated with this * VirtualHub - * @member {string} [p2SVpnGateway.id] Resource ID. - * @member {object} [expressRouteGateway] The expressRouteGateway associated - * with this VirtualHub - * @member {string} [expressRouteGateway.id] Resource ID. - * @member {array} [virtualNetworkConnections] list of all vnet connections + * @property {string} [p2SVpnGateway.id] Resource ID. + * @property {object} [expressRouteGateway] The expressRouteGateway + * associated with this VirtualHub + * @property {string} [expressRouteGateway.id] Resource ID. + * @property {array} [virtualNetworkConnections] list of all vnet connections * with this VirtualHub. - * @member {string} [addressPrefix] Address-prefix for this VirtualHub. - * @member {object} [routeTable] The routeTable associated with this virtual - * hub. - * @member {array} [routeTable.routes] list of all routes. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [addressPrefix] Address-prefix for this VirtualHub. + * @property {object} [routeTable] The routeTable associated with this + * virtual hub. + * @property {array} [routeTable.routes] list of all routes. + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualHubId.js b/lib/services/networkManagement2/lib/models/virtualHubId.js index 53d973ed1e..3c9244d28c 100644 --- a/lib/services/networkManagement2/lib/models/virtualHubId.js +++ b/lib/services/networkManagement2/lib/models/virtualHubId.js @@ -17,7 +17,7 @@ class VirtualHubId { /** * Create a VirtualHubId. - * @member {string} [id] The resource URI for the Virtual Hub where the + * @property {string} [id] The resource URI for the Virtual Hub where the * ExpressRoute gateway is or will be deployed. The Virtual Hub resource and * the ExpressRoute gateway resource reside in the same subscription. */ diff --git a/lib/services/networkManagement2/lib/models/virtualHubRoute.js b/lib/services/networkManagement2/lib/models/virtualHubRoute.js index bb59c5d479..0958a270e0 100644 --- a/lib/services/networkManagement2/lib/models/virtualHubRoute.js +++ b/lib/services/networkManagement2/lib/models/virtualHubRoute.js @@ -17,8 +17,8 @@ class VirtualHubRoute { /** * Create a VirtualHubRoute. - * @member {array} [addressPrefixes] list of all addressPrefixes. - * @member {string} [nextHopIpAddress] NextHop ip address. + * @property {array} [addressPrefixes] list of all addressPrefixes. + * @property {string} [nextHopIpAddress] NextHop ip address. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/virtualHubRouteTable.js b/lib/services/networkManagement2/lib/models/virtualHubRouteTable.js index 0738fbf5a3..535228bcc0 100644 --- a/lib/services/networkManagement2/lib/models/virtualHubRouteTable.js +++ b/lib/services/networkManagement2/lib/models/virtualHubRouteTable.js @@ -17,7 +17,7 @@ class VirtualHubRouteTable { /** * Create a VirtualHubRouteTable. - * @member {array} [routes] list of all routes. + * @property {array} [routes] list of all routes. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/virtualNetwork.js b/lib/services/networkManagement2/lib/models/virtualNetwork.js index 824d27e2a4..ff3fe44ba3 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetwork.js +++ b/lib/services/networkManagement2/lib/models/virtualNetwork.js @@ -20,32 +20,32 @@ const models = require('./index'); class VirtualNetwork extends models['Resource'] { /** * Create a VirtualNetwork. - * @member {object} [addressSpace] The AddressSpace that contains an array of - * IP address ranges that can be used by subnets. - * @member {array} [addressSpace.addressPrefixes] A list of address blocks + * @property {object} [addressSpace] The AddressSpace that contains an array + * of IP address ranges that can be used by subnets. + * @property {array} [addressSpace.addressPrefixes] A list of address blocks * reserved for this virtual network in CIDR notation. - * @member {object} [dhcpOptions] The dhcpOptions that contains an array of + * @property {object} [dhcpOptions] The dhcpOptions that contains an array of * DNS servers available to VMs deployed in the virtual network. - * @member {array} [dhcpOptions.dnsServers] The list of DNS servers IP + * @property {array} [dhcpOptions.dnsServers] The list of DNS servers IP * addresses. - * @member {array} [subnets] A list of subnets in a Virtual Network. - * @member {array} [virtualNetworkPeerings] A list of peerings in a Virtual + * @property {array} [subnets] A list of subnets in a Virtual Network. + * @property {array} [virtualNetworkPeerings] A list of peerings in a Virtual * Network. - * @member {string} [resourceGuid] The resourceGuid property of the Virtual + * @property {string} [resourceGuid] The resourceGuid property of the Virtual * Network resource. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * PublicIP resource. Possible values are: 'Updating', 'Deleting', and * 'Failed'. - * @member {boolean} [enableDdosProtection] Indicates if DDoS protection is + * @property {boolean} [enableDdosProtection] Indicates if DDoS protection is * enabled for all the protected resources in the virtual network. It * requires a DDoS protection plan associated with the resource. Default * value: false . - * @member {boolean} [enableVmProtection] Indicates if VM protection is + * @property {boolean} [enableVmProtection] Indicates if VM protection is * enabled for all the subnets in the virtual network. Default value: false . - * @member {object} [ddosProtectionPlan] The DDoS protection plan associated - * with the virtual network. - * @member {string} [ddosProtectionPlan.id] Resource ID. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {object} [ddosProtectionPlan] The DDoS protection plan + * associated with the virtual network. + * @property {string} [ddosProtectionPlan.id] Resource ID. + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkConnectionGatewayReference.js b/lib/services/networkManagement2/lib/models/virtualNetworkConnectionGatewayReference.js index 8484f69350..f65c434a56 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkConnectionGatewayReference.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkConnectionGatewayReference.js @@ -17,8 +17,8 @@ class VirtualNetworkConnectionGatewayReference { /** * Create a VirtualNetworkConnectionGatewayReference. - * @member {string} id The ID of VirtualNetworkGateway or LocalNetworkGateway - * resource. + * @property {string} id The ID of VirtualNetworkGateway or + * LocalNetworkGateway resource. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkGateway.js b/lib/services/networkManagement2/lib/models/virtualNetworkGateway.js index 1447f48628..59e2fd1e8c 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkGateway.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkGateway.js @@ -20,69 +20,69 @@ const models = require('./index'); class VirtualNetworkGateway extends models['Resource'] { /** * Create a VirtualNetworkGateway. - * @member {array} [ipConfigurations] IP configurations for virtual network + * @property {array} [ipConfigurations] IP configurations for virtual network * gateway. - * @member {string} [gatewayType] The type of this virtual network gateway. + * @property {string} [gatewayType] The type of this virtual network gateway. * Possible values are: 'Vpn' and 'ExpressRoute'. Possible values include: * 'Vpn', 'ExpressRoute' - * @member {string} [vpnType] The type of this virtual network gateway. + * @property {string} [vpnType] The type of this virtual network gateway. * Possible values are: 'PolicyBased' and 'RouteBased'. Possible values * include: 'PolicyBased', 'RouteBased' - * @member {boolean} [enableBgp] Whether BGP is enabled for this virtual + * @property {boolean} [enableBgp] Whether BGP is enabled for this virtual * network gateway or not. - * @member {boolean} [activeActive] ActiveActive flag - * @member {object} [gatewayDefaultSite] The reference of the + * @property {boolean} [activeActive] ActiveActive flag + * @property {object} [gatewayDefaultSite] The reference of the * LocalNetworkGateway resource which represents local network site having * default routes. Assign Null value in case of removing existing default * site setting. - * @member {string} [gatewayDefaultSite.id] Resource ID. - * @member {object} [sku] The reference of the VirtualNetworkGatewaySku + * @property {string} [gatewayDefaultSite.id] Resource ID. + * @property {object} [sku] The reference of the VirtualNetworkGatewaySku * resource which represents the SKU selected for Virtual network gateway. - * @member {string} [sku.name] Gateway SKU name. Possible values include: + * @property {string} [sku.name] Gateway SKU name. Possible values include: * 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', * 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', * 'ErGw2AZ', 'ErGw3AZ' - * @member {string} [sku.tier] Gateway SKU tier. Possible values include: + * @property {string} [sku.tier] Gateway SKU tier. Possible values include: * 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', * 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', * 'ErGw2AZ', 'ErGw3AZ' - * @member {number} [sku.capacity] The capacity. - * @member {object} [vpnClientConfiguration] The reference of the + * @property {number} [sku.capacity] The capacity. + * @property {object} [vpnClientConfiguration] The reference of the * VpnClientConfiguration resource which represents the P2S VpnClient * configurations. - * @member {object} [vpnClientConfiguration.vpnClientAddressPool] The + * @property {object} [vpnClientConfiguration.vpnClientAddressPool] The * reference of the address space resource which represents Address space for * P2S VpnClient. - * @member {array} + * @property {array} * [vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] A list of * address blocks reserved for this virtual network in CIDR notation. - * @member {array} [vpnClientConfiguration.vpnClientRootCertificates] + * @property {array} [vpnClientConfiguration.vpnClientRootCertificates] * VpnClientRootCertificate for virtual network gateway. - * @member {array} [vpnClientConfiguration.vpnClientRevokedCertificates] + * @property {array} [vpnClientConfiguration.vpnClientRevokedCertificates] * VpnClientRevokedCertificate for Virtual network gateway. - * @member {array} [vpnClientConfiguration.vpnClientProtocols] + * @property {array} [vpnClientConfiguration.vpnClientProtocols] * VpnClientProtocols for Virtual network gateway. - * @member {array} [vpnClientConfiguration.vpnClientIpsecPolicies] + * @property {array} [vpnClientConfiguration.vpnClientIpsecPolicies] * VpnClientIpsecPolicies for virtual network gateway P2S client. - * @member {string} [vpnClientConfiguration.radiusServerAddress] The radius + * @property {string} [vpnClientConfiguration.radiusServerAddress] The radius * server address property of the VirtualNetworkGateway resource for vpn * client connection. - * @member {string} [vpnClientConfiguration.radiusServerSecret] The radius + * @property {string} [vpnClientConfiguration.radiusServerSecret] The radius * secret property of the VirtualNetworkGateway resource for vpn client * connection. - * @member {object} [bgpSettings] Virtual network gateway's BGP speaker + * @property {object} [bgpSettings] Virtual network gateway's BGP speaker * settings. - * @member {number} [bgpSettings.asn] The BGP speaker's ASN. - * @member {string} [bgpSettings.bgpPeeringAddress] The BGP peering address + * @property {number} [bgpSettings.asn] The BGP speaker's ASN. + * @property {string} [bgpSettings.bgpPeeringAddress] The BGP peering address * and BGP identifier of this BGP speaker. - * @member {number} [bgpSettings.peerWeight] The weight added to routes + * @property {number} [bgpSettings.peerWeight] The weight added to routes * learned from this BGP speaker. - * @member {string} [resourceGuid] The resource GUID property of the + * @property {string} [resourceGuid] The resource GUID property of the * VirtualNetworkGateway resource. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * VirtualNetworkGateway resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnection.js b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnection.js index 5d07002e5c..4f8a433ad1 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnection.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnection.js @@ -20,217 +20,219 @@ const models = require('./index'); class VirtualNetworkGatewayConnection extends models['Resource'] { /** * Create a VirtualNetworkGatewayConnection. - * @member {string} [authorizationKey] The authorizationKey. - * @member {object} virtualNetworkGateway1 The reference to virtual network + * @property {string} [authorizationKey] The authorizationKey. + * @property {object} virtualNetworkGateway1 The reference to virtual network * gateway resource. - * @member {array} [virtualNetworkGateway1.ipConfigurations] IP + * @property {array} [virtualNetworkGateway1.ipConfigurations] IP * configurations for virtual network gateway. - * @member {string} [virtualNetworkGateway1.gatewayType] The type of this + * @property {string} [virtualNetworkGateway1.gatewayType] The type of this * virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. * Possible values include: 'Vpn', 'ExpressRoute' - * @member {string} [virtualNetworkGateway1.vpnType] The type of this virtual - * network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - * Possible values include: 'PolicyBased', 'RouteBased' - * @member {boolean} [virtualNetworkGateway1.enableBgp] Whether BGP is + * @property {string} [virtualNetworkGateway1.vpnType] The type of this + * virtual network gateway. Possible values are: 'PolicyBased' and + * 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased' + * @property {boolean} [virtualNetworkGateway1.enableBgp] Whether BGP is * enabled for this virtual network gateway or not. - * @member {boolean} [virtualNetworkGateway1.activeActive] ActiveActive flag - * @member {object} [virtualNetworkGateway1.gatewayDefaultSite] The reference - * of the LocalNetworkGateway resource which represents local network site - * having default routes. Assign Null value in case of removing existing - * default site setting. - * @member {string} [virtualNetworkGateway1.gatewayDefaultSite.id] Resource + * @property {boolean} [virtualNetworkGateway1.activeActive] ActiveActive + * flag + * @property {object} [virtualNetworkGateway1.gatewayDefaultSite] The + * reference of the LocalNetworkGateway resource which represents local + * network site having default routes. Assign Null value in case of removing + * existing default site setting. + * @property {string} [virtualNetworkGateway1.gatewayDefaultSite.id] Resource * ID. - * @member {object} [virtualNetworkGateway1.sku] The reference of the + * @property {object} [virtualNetworkGateway1.sku] The reference of the * VirtualNetworkGatewaySku resource which represents the SKU selected for * Virtual network gateway. - * @member {string} [virtualNetworkGateway1.sku.name] Gateway SKU name. + * @property {string} [virtualNetworkGateway1.sku.name] Gateway SKU name. * Possible values include: 'Basic', 'HighPerformance', 'Standard', * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' - * @member {string} [virtualNetworkGateway1.sku.tier] Gateway SKU tier. + * @property {string} [virtualNetworkGateway1.sku.tier] Gateway SKU tier. * Possible values include: 'Basic', 'HighPerformance', 'Standard', * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' - * @member {number} [virtualNetworkGateway1.sku.capacity] The capacity. - * @member {object} [virtualNetworkGateway1.vpnClientConfiguration] The + * @property {number} [virtualNetworkGateway1.sku.capacity] The capacity. + * @property {object} [virtualNetworkGateway1.vpnClientConfiguration] The * reference of the VpnClientConfiguration resource which represents the P2S * VpnClient configurations. - * @member {object} + * @property {object} * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientAddressPool] The * reference of the address space resource which represents Address space for * P2S VpnClient. - * @member {array} + * @property {array} * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] * A list of address blocks reserved for this virtual network in CIDR * notation. - * @member {array} + * @property {array} * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientRootCertificates] * VpnClientRootCertificate for virtual network gateway. - * @member {array} + * @property {array} * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientRevokedCertificates] * VpnClientRevokedCertificate for Virtual network gateway. - * @member {array} + * @property {array} * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientProtocols] * VpnClientProtocols for Virtual network gateway. - * @member {array} + * @property {array} * [virtualNetworkGateway1.vpnClientConfiguration.vpnClientIpsecPolicies] * VpnClientIpsecPolicies for virtual network gateway P2S client. - * @member {string} + * @property {string} * [virtualNetworkGateway1.vpnClientConfiguration.radiusServerAddress] The * radius server address property of the VirtualNetworkGateway resource for * vpn client connection. - * @member {string} + * @property {string} * [virtualNetworkGateway1.vpnClientConfiguration.radiusServerSecret] The * radius secret property of the VirtualNetworkGateway resource for vpn * client connection. - * @member {object} [virtualNetworkGateway1.bgpSettings] Virtual network + * @property {object} [virtualNetworkGateway1.bgpSettings] Virtual network * gateway's BGP speaker settings. - * @member {number} [virtualNetworkGateway1.bgpSettings.asn] The BGP + * @property {number} [virtualNetworkGateway1.bgpSettings.asn] The BGP * speaker's ASN. - * @member {string} [virtualNetworkGateway1.bgpSettings.bgpPeeringAddress] + * @property {string} [virtualNetworkGateway1.bgpSettings.bgpPeeringAddress] * The BGP peering address and BGP identifier of this BGP speaker. - * @member {number} [virtualNetworkGateway1.bgpSettings.peerWeight] The + * @property {number} [virtualNetworkGateway1.bgpSettings.peerWeight] The * weight added to routes learned from this BGP speaker. - * @member {string} [virtualNetworkGateway1.resourceGuid] The resource GUID + * @property {string} [virtualNetworkGateway1.resourceGuid] The resource GUID * property of the VirtualNetworkGateway resource. - * @member {string} [virtualNetworkGateway1.provisioningState] The + * @property {string} [virtualNetworkGateway1.provisioningState] The * provisioning state of the VirtualNetworkGateway resource. Possible values * are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [virtualNetworkGateway1.etag] Gets a unique read-only + * @property {string} [virtualNetworkGateway1.etag] Gets a unique read-only * string that changes whenever the resource is updated. - * @member {object} [virtualNetworkGateway2] The reference to virtual network - * gateway resource. - * @member {array} [virtualNetworkGateway2.ipConfigurations] IP + * @property {object} [virtualNetworkGateway2] The reference to virtual + * network gateway resource. + * @property {array} [virtualNetworkGateway2.ipConfigurations] IP * configurations for virtual network gateway. - * @member {string} [virtualNetworkGateway2.gatewayType] The type of this + * @property {string} [virtualNetworkGateway2.gatewayType] The type of this * virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. * Possible values include: 'Vpn', 'ExpressRoute' - * @member {string} [virtualNetworkGateway2.vpnType] The type of this virtual - * network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - * Possible values include: 'PolicyBased', 'RouteBased' - * @member {boolean} [virtualNetworkGateway2.enableBgp] Whether BGP is + * @property {string} [virtualNetworkGateway2.vpnType] The type of this + * virtual network gateway. Possible values are: 'PolicyBased' and + * 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased' + * @property {boolean} [virtualNetworkGateway2.enableBgp] Whether BGP is * enabled for this virtual network gateway or not. - * @member {boolean} [virtualNetworkGateway2.activeActive] ActiveActive flag - * @member {object} [virtualNetworkGateway2.gatewayDefaultSite] The reference - * of the LocalNetworkGateway resource which represents local network site - * having default routes. Assign Null value in case of removing existing - * default site setting. - * @member {string} [virtualNetworkGateway2.gatewayDefaultSite.id] Resource + * @property {boolean} [virtualNetworkGateway2.activeActive] ActiveActive + * flag + * @property {object} [virtualNetworkGateway2.gatewayDefaultSite] The + * reference of the LocalNetworkGateway resource which represents local + * network site having default routes. Assign Null value in case of removing + * existing default site setting. + * @property {string} [virtualNetworkGateway2.gatewayDefaultSite.id] Resource * ID. - * @member {object} [virtualNetworkGateway2.sku] The reference of the + * @property {object} [virtualNetworkGateway2.sku] The reference of the * VirtualNetworkGatewaySku resource which represents the SKU selected for * Virtual network gateway. - * @member {string} [virtualNetworkGateway2.sku.name] Gateway SKU name. + * @property {string} [virtualNetworkGateway2.sku.name] Gateway SKU name. * Possible values include: 'Basic', 'HighPerformance', 'Standard', * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' - * @member {string} [virtualNetworkGateway2.sku.tier] Gateway SKU tier. + * @property {string} [virtualNetworkGateway2.sku.tier] Gateway SKU tier. * Possible values include: 'Basic', 'HighPerformance', 'Standard', * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' - * @member {number} [virtualNetworkGateway2.sku.capacity] The capacity. - * @member {object} [virtualNetworkGateway2.vpnClientConfiguration] The + * @property {number} [virtualNetworkGateway2.sku.capacity] The capacity. + * @property {object} [virtualNetworkGateway2.vpnClientConfiguration] The * reference of the VpnClientConfiguration resource which represents the P2S * VpnClient configurations. - * @member {object} + * @property {object} * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool] The * reference of the address space resource which represents Address space for * P2S VpnClient. - * @member {array} + * @property {array} * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] * A list of address blocks reserved for this virtual network in CIDR * notation. - * @member {array} + * @property {array} * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientRootCertificates] * VpnClientRootCertificate for virtual network gateway. - * @member {array} + * @property {array} * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientRevokedCertificates] * VpnClientRevokedCertificate for Virtual network gateway. - * @member {array} + * @property {array} * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientProtocols] * VpnClientProtocols for Virtual network gateway. - * @member {array} + * @property {array} * [virtualNetworkGateway2.vpnClientConfiguration.vpnClientIpsecPolicies] * VpnClientIpsecPolicies for virtual network gateway P2S client. - * @member {string} + * @property {string} * [virtualNetworkGateway2.vpnClientConfiguration.radiusServerAddress] The * radius server address property of the VirtualNetworkGateway resource for * vpn client connection. - * @member {string} + * @property {string} * [virtualNetworkGateway2.vpnClientConfiguration.radiusServerSecret] The * radius secret property of the VirtualNetworkGateway resource for vpn * client connection. - * @member {object} [virtualNetworkGateway2.bgpSettings] Virtual network + * @property {object} [virtualNetworkGateway2.bgpSettings] Virtual network * gateway's BGP speaker settings. - * @member {number} [virtualNetworkGateway2.bgpSettings.asn] The BGP + * @property {number} [virtualNetworkGateway2.bgpSettings.asn] The BGP * speaker's ASN. - * @member {string} [virtualNetworkGateway2.bgpSettings.bgpPeeringAddress] + * @property {string} [virtualNetworkGateway2.bgpSettings.bgpPeeringAddress] * The BGP peering address and BGP identifier of this BGP speaker. - * @member {number} [virtualNetworkGateway2.bgpSettings.peerWeight] The + * @property {number} [virtualNetworkGateway2.bgpSettings.peerWeight] The * weight added to routes learned from this BGP speaker. - * @member {string} [virtualNetworkGateway2.resourceGuid] The resource GUID + * @property {string} [virtualNetworkGateway2.resourceGuid] The resource GUID * property of the VirtualNetworkGateway resource. - * @member {string} [virtualNetworkGateway2.provisioningState] The + * @property {string} [virtualNetworkGateway2.provisioningState] The * provisioning state of the VirtualNetworkGateway resource. Possible values * are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [virtualNetworkGateway2.etag] Gets a unique read-only + * @property {string} [virtualNetworkGateway2.etag] Gets a unique read-only * string that changes whenever the resource is updated. - * @member {object} [localNetworkGateway2] The reference to local network + * @property {object} [localNetworkGateway2] The reference to local network * gateway resource. - * @member {object} [localNetworkGateway2.localNetworkAddressSpace] Local + * @property {object} [localNetworkGateway2.localNetworkAddressSpace] Local * network site address space. - * @member {array} + * @property {array} * [localNetworkGateway2.localNetworkAddressSpace.addressPrefixes] A list of * address blocks reserved for this virtual network in CIDR notation. - * @member {string} [localNetworkGateway2.gatewayIpAddress] IP address of + * @property {string} [localNetworkGateway2.gatewayIpAddress] IP address of * local network gateway. - * @member {object} [localNetworkGateway2.bgpSettings] Local network + * @property {object} [localNetworkGateway2.bgpSettings] Local network * gateway's BGP speaker settings. - * @member {number} [localNetworkGateway2.bgpSettings.asn] The BGP speaker's - * ASN. - * @member {string} [localNetworkGateway2.bgpSettings.bgpPeeringAddress] The - * BGP peering address and BGP identifier of this BGP speaker. - * @member {number} [localNetworkGateway2.bgpSettings.peerWeight] The weight - * added to routes learned from this BGP speaker. - * @member {string} [localNetworkGateway2.resourceGuid] The resource GUID + * @property {number} [localNetworkGateway2.bgpSettings.asn] The BGP + * speaker's ASN. + * @property {string} [localNetworkGateway2.bgpSettings.bgpPeeringAddress] + * The BGP peering address and BGP identifier of this BGP speaker. + * @property {number} [localNetworkGateway2.bgpSettings.peerWeight] The + * weight added to routes learned from this BGP speaker. + * @property {string} [localNetworkGateway2.resourceGuid] The resource GUID * property of the LocalNetworkGateway resource. - * @member {string} [localNetworkGateway2.provisioningState] The provisioning - * state of the LocalNetworkGateway resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [localNetworkGateway2.etag] A unique read-only string + * @property {string} [localNetworkGateway2.provisioningState] The + * provisioning state of the LocalNetworkGateway resource. Possible values + * are: 'Updating', 'Deleting', and 'Failed'. + * @property {string} [localNetworkGateway2.etag] A unique read-only string * that changes whenever the resource is updated. - * @member {string} connectionType Gateway connection type. Possible values + * @property {string} connectionType Gateway connection type. Possible values * are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible values * include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' - * @member {string} [connectionProtocol] Connection protocol used for this + * @property {string} [connectionProtocol] Connection protocol used for this * connection. Possible values include: 'IKEv2', 'IKEv1' - * @member {number} [routingWeight] The routing weight. - * @member {string} [sharedKey] The IPSec shared key. - * @member {string} [connectionStatus] Virtual network Gateway connection + * @property {number} [routingWeight] The routing weight. + * @property {string} [sharedKey] The IPSec shared key. + * @property {string} [connectionStatus] Virtual network Gateway connection * status. Possible values are 'Unknown', 'Connecting', 'Connected' and * 'NotConnected'. Possible values include: 'Unknown', 'Connecting', * 'Connected', 'NotConnected' - * @member {array} [tunnelConnectionStatus] Collection of all tunnels' + * @property {array} [tunnelConnectionStatus] Collection of all tunnels' * connection health status. - * @member {number} [egressBytesTransferred] The egress bytes transferred in - * this connection. - * @member {number} [ingressBytesTransferred] The ingress bytes transferred + * @property {number} [egressBytesTransferred] The egress bytes transferred + * in this connection. + * @property {number} [ingressBytesTransferred] The ingress bytes transferred * in this connection. - * @member {object} [peer] The reference to peerings resource. - * @member {string} [peer.id] Resource ID. - * @member {boolean} [enableBgp] EnableBgp flag - * @member {boolean} [usePolicyBasedTrafficSelectors] Enable policy-based + * @property {object} [peer] The reference to peerings resource. + * @property {string} [peer.id] Resource ID. + * @property {boolean} [enableBgp] EnableBgp flag + * @property {boolean} [usePolicyBasedTrafficSelectors] Enable policy-based * traffic selectors. - * @member {array} [ipsecPolicies] The IPSec Policies to be considered by + * @property {array} [ipsecPolicies] The IPSec Policies to be considered by * this connection. - * @member {string} [resourceGuid] The resource GUID property of the + * @property {string} [resourceGuid] The resource GUID property of the * VirtualNetworkGatewayConnection resource. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {boolean} [expressRouteGatewayBypass] Bypass ExpressRoute Gateway - * for data forwarding - * @member {string} [etag] Gets a unique read-only string that changes + * @property {boolean} [expressRouteGatewayBypass] Bypass ExpressRoute + * Gateway for data forwarding + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnectionListEntity.js b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnectionListEntity.js index a23dc5c010..21ffba1246 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnectionListEntity.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnectionListEntity.js @@ -20,51 +20,51 @@ const models = require('./index'); class VirtualNetworkGatewayConnectionListEntity extends models['Resource'] { /** * Create a VirtualNetworkGatewayConnectionListEntity. - * @member {string} [authorizationKey] The authorizationKey. - * @member {object} virtualNetworkGateway1 The reference to virtual network + * @property {string} [authorizationKey] The authorizationKey. + * @property {object} virtualNetworkGateway1 The reference to virtual network * gateway resource. - * @member {string} [virtualNetworkGateway1.id] The ID of + * @property {string} [virtualNetworkGateway1.id] The ID of * VirtualNetworkGateway or LocalNetworkGateway resource. - * @member {object} [virtualNetworkGateway2] The reference to virtual network - * gateway resource. - * @member {string} [virtualNetworkGateway2.id] The ID of + * @property {object} [virtualNetworkGateway2] The reference to virtual + * network gateway resource. + * @property {string} [virtualNetworkGateway2.id] The ID of * VirtualNetworkGateway or LocalNetworkGateway resource. - * @member {object} [localNetworkGateway2] The reference to local network + * @property {object} [localNetworkGateway2] The reference to local network * gateway resource. - * @member {string} [localNetworkGateway2.id] The ID of VirtualNetworkGateway - * or LocalNetworkGateway resource. - * @member {string} connectionType Gateway connection type. Possible values + * @property {string} [localNetworkGateway2.id] The ID of + * VirtualNetworkGateway or LocalNetworkGateway resource. + * @property {string} connectionType Gateway connection type. Possible values * are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible values * include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' - * @member {string} [connectionProtocol] Connection protocol used for this + * @property {string} [connectionProtocol] Connection protocol used for this * connection. Possible values include: 'IKEv2', 'IKEv1' - * @member {number} [routingWeight] The routing weight. - * @member {string} [sharedKey] The IPSec shared key. - * @member {string} [connectionStatus] Virtual network Gateway connection + * @property {number} [routingWeight] The routing weight. + * @property {string} [sharedKey] The IPSec shared key. + * @property {string} [connectionStatus] Virtual network Gateway connection * status. Possible values are 'Unknown', 'Connecting', 'Connected' and * 'NotConnected'. Possible values include: 'Unknown', 'Connecting', * 'Connected', 'NotConnected' - * @member {array} [tunnelConnectionStatus] Collection of all tunnels' + * @property {array} [tunnelConnectionStatus] Collection of all tunnels' * connection health status. - * @member {number} [egressBytesTransferred] The egress bytes transferred in - * this connection. - * @member {number} [ingressBytesTransferred] The ingress bytes transferred + * @property {number} [egressBytesTransferred] The egress bytes transferred + * in this connection. + * @property {number} [ingressBytesTransferred] The ingress bytes transferred * in this connection. - * @member {object} [peer] The reference to peerings resource. - * @member {string} [peer.id] Resource ID. - * @member {boolean} [enableBgp] EnableBgp flag - * @member {boolean} [usePolicyBasedTrafficSelectors] Enable policy-based + * @property {object} [peer] The reference to peerings resource. + * @property {string} [peer.id] Resource ID. + * @property {boolean} [enableBgp] EnableBgp flag + * @property {boolean} [usePolicyBasedTrafficSelectors] Enable policy-based * traffic selectors. - * @member {array} [ipsecPolicies] The IPSec Policies to be considered by + * @property {array} [ipsecPolicies] The IPSec Policies to be considered by * this connection. - * @member {string} [resourceGuid] The resource GUID property of the + * @property {string} [resourceGuid] The resource GUID property of the * VirtualNetworkGatewayConnection resource. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {boolean} [expressRouteGatewayBypass] Bypass ExpressRoute Gateway - * for data forwarding - * @member {string} [etag] Gets a unique read-only string that changes + * @property {boolean} [expressRouteGatewayBypass] Bypass ExpressRoute + * Gateway for data forwarding + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnectionListResult.js b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnectionListResult.js index 6572635654..8bee812e81 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnectionListResult.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayConnectionListResult.js @@ -16,7 +16,7 @@ class VirtualNetworkGatewayConnectionListResult extends Array { /** * Create a VirtualNetworkGatewayConnectionListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayIPConfiguration.js b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayIPConfiguration.js index 704ba94ddd..d7eb833605 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayIPConfiguration.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayIPConfiguration.js @@ -20,19 +20,20 @@ const models = require('./index'); class VirtualNetworkGatewayIPConfiguration extends models['SubResource'] { /** * Create a VirtualNetworkGatewayIPConfiguration. - * @member {string} [privateIPAllocationMethod] The private IP allocation + * @property {string} [privateIPAllocationMethod] The private IP allocation * method. Possible values are: 'Static' and 'Dynamic'. Possible values * include: 'Static', 'Dynamic' - * @member {object} [subnet] The reference of the subnet resource. - * @member {string} [subnet.id] Resource ID. - * @member {object} [publicIPAddress] The reference of the public IP + * @property {object} [subnet] The reference of the subnet resource. + * @property {string} [subnet.id] Resource ID. + * @property {object} [publicIPAddress] The reference of the public IP * resource. - * @member {string} [publicIPAddress.id] Resource ID. - * @member {string} [provisioningState] The provisioning state of the public - * IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [publicIPAddress.id] Resource ID. + * @property {string} [provisioningState] The provisioning state of the + * public IP resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayListConnectionsResult.js b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayListConnectionsResult.js index b2ad2405b1..4546296ad0 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayListConnectionsResult.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayListConnectionsResult.js @@ -16,7 +16,7 @@ class VirtualNetworkGatewayListConnectionsResult extends Array { /** * Create a VirtualNetworkGatewayListConnectionsResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayListResult.js b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayListResult.js index 7daeceaa76..dbec4bd6d6 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkGatewayListResult.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkGatewayListResult.js @@ -16,7 +16,7 @@ class VirtualNetworkGatewayListResult extends Array { /** * Create a VirtualNetworkGatewayListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkGatewaySku.js b/lib/services/networkManagement2/lib/models/virtualNetworkGatewaySku.js index 27313b7a45..b0f94f82f5 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkGatewaySku.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkGatewaySku.js @@ -17,15 +17,15 @@ class VirtualNetworkGatewaySku { /** * Create a VirtualNetworkGatewaySku. - * @member {string} [name] Gateway SKU name. Possible values include: + * @property {string} [name] Gateway SKU name. Possible values include: * 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', * 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', * 'ErGw2AZ', 'ErGw3AZ' - * @member {string} [tier] Gateway SKU tier. Possible values include: + * @property {string} [tier] Gateway SKU tier. Possible values include: * 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', 'VpnGw1', * 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', * 'ErGw2AZ', 'ErGw3AZ' - * @member {number} [capacity] The capacity. + * @property {number} [capacity] The capacity. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkListResult.js b/lib/services/networkManagement2/lib/models/virtualNetworkListResult.js index d578f54820..8d2d1783ef 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkListResult.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkListResult.js @@ -16,7 +16,7 @@ class VirtualNetworkListResult extends Array { /** * Create a VirtualNetworkListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkListUsageResult.js b/lib/services/networkManagement2/lib/models/virtualNetworkListUsageResult.js index 633640ecb3..f09e53c76a 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkListUsageResult.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkListUsageResult.js @@ -16,7 +16,7 @@ class VirtualNetworkListUsageResult extends Array { /** * Create a VirtualNetworkListUsageResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkPeering.js b/lib/services/networkManagement2/lib/models/virtualNetworkPeering.js index 813b33c2b0..cef9023dd8 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkPeering.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkPeering.js @@ -20,37 +20,37 @@ const models = require('./index'); class VirtualNetworkPeering extends models['SubResource'] { /** * Create a VirtualNetworkPeering. - * @member {boolean} [allowVirtualNetworkAccess] Whether the VMs in the + * @property {boolean} [allowVirtualNetworkAccess] Whether the VMs in the * linked virtual network space would be able to access all the VMs in local * Virtual network space. - * @member {boolean} [allowForwardedTraffic] Whether the forwarded traffic + * @property {boolean} [allowForwardedTraffic] Whether the forwarded traffic * from the VMs in the remote virtual network will be allowed/disallowed. - * @member {boolean} [allowGatewayTransit] If gateway links can be used in + * @property {boolean} [allowGatewayTransit] If gateway links can be used in * remote virtual networking to link to this virtual network. - * @member {boolean} [useRemoteGateways] If remote gateways can be used on + * @property {boolean} [useRemoteGateways] If remote gateways can be used on * this virtual network. If the flag is set to true, and allowGatewayTransit * on remote peering is also true, virtual network will use gateways of * remote virtual network for transit. Only one peering can have this flag * set to true. This flag cannot be set if virtual network already has a * gateway. - * @member {object} [remoteVirtualNetwork] The reference of the remote + * @property {object} [remoteVirtualNetwork] The reference of the remote * virtual network. The remote virtual network can be in the same or * different region (preview). See here to register for the preview and learn * more * (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). - * @member {string} [remoteVirtualNetwork.id] Resource ID. - * @member {object} [remoteAddressSpace] The reference of the remote virtual - * network address space. - * @member {array} [remoteAddressSpace.addressPrefixes] A list of address + * @property {string} [remoteVirtualNetwork.id] Resource ID. + * @property {object} [remoteAddressSpace] The reference of the remote + * virtual network address space. + * @property {array} [remoteAddressSpace.addressPrefixes] A list of address * blocks reserved for this virtual network in CIDR notation. - * @member {string} [peeringState] The status of the virtual network peering. - * Possible values are 'Initiated', 'Connected', and 'Disconnected'. Possible - * values include: 'Initiated', 'Connected', 'Disconnected' - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [peeringState] The status of the virtual network + * peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. + * Possible values include: 'Initiated', 'Connected', 'Disconnected' + * @property {string} [provisioningState] The provisioning state of the * resource. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkPeeringListResult.js b/lib/services/networkManagement2/lib/models/virtualNetworkPeeringListResult.js index f3ee98739a..298ee2478b 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkPeeringListResult.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkPeeringListResult.js @@ -17,7 +17,7 @@ class VirtualNetworkPeeringListResult extends Array { /** * Create a VirtualNetworkPeeringListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkTap.js b/lib/services/networkManagement2/lib/models/virtualNetworkTap.js index 952fe13b70..7a465cf8bc 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkTap.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkTap.js @@ -20,652 +20,655 @@ const models = require('./index'); class VirtualNetworkTap extends models['Resource'] { /** * Create a VirtualNetworkTap. - * @member {array} [networkInterfaceTapConfigurations] Specifies the list of - * resource IDs for the network interface IP configuration that needs to be - * tapped. - * @member {string} [resourceGuid] The resourceGuid property of the virtual + * @property {array} [networkInterfaceTapConfigurations] Specifies the list + * of resource IDs for the network interface IP configuration that needs to + * be tapped. + * @property {string} [resourceGuid] The resourceGuid property of the virtual * network tap. - * @member {string} [provisioningState] The provisioning state of the virtual - * network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. - * @member {object} [destinationNetworkInterfaceIPConfiguration] The + * @property {string} [provisioningState] The provisioning state of the + * virtual network tap. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + * @property {object} [destinationNetworkInterfaceIPConfiguration] The * reference to the private IP Address of the collector nic that will receive * the tap - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] The * reference to Virtual Network Taps. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] * The reference of ApplicationGatewayBackendAddressPool resource. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] * The reference of LoadBalancerBackendAddressPool resource. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] A * list of references of LoadBalancerInboundNatRules. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.privateIPAddress] Private IP * address of the IP configuration. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] * Defines how a private IP address is assigned. Possible values are: * 'Static' and 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] * Available from Api-Version 2016-03-30 onwards, it represents whether the * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', * 'IPv6' - * @member {object} [destinationNetworkInterfaceIPConfiguration.subnet] + * @property {object} [destinationNetworkInterfaceIPConfiguration.subnet] * Subnet bound to the IP configuration. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.subnet.addressPrefix] The * address prefix for the subnet. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.addressPrefixes] List * of address prefixes for the subnet. - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup] * The reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.subnets] * A collection of references to subnets. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.subnet.networkSecurityGroup.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable] The * reference of the RouteTable resource. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable.subnets] A * collection of references to subnets. - * @member {boolean} + * @property {boolean} * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.subnet.routeTable.etag] Gets a * unique read-only string that changes whenever the resource is updated. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.serviceEndpoints] An * array of service endpoints. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.serviceEndpointPolicies] * An array of service endpoint policies. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.interfaceEndpoints] An * array of references to interface endpoints - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.ipConfigurations] Gets * an array of references to the network interface IP configurations using * subnet. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.subnet.delegations] Gets an * array of references to the delegations on the subnet. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.subnet.purpose] A read-only * string identifying the intention of use for this subnet based on * delegations and other user-defined properties. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.subnet.provisioningState] The * provisioning state of the resource. - * @member {string} [destinationNetworkInterfaceIPConfiguration.subnet.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * @member {string} [destinationNetworkInterfaceIPConfiguration.subnet.etag] - * A unique read-only string that changes whenever the resource is updated. - * @member {boolean} [destinationNetworkInterfaceIPConfiguration.primary] + * @property {string} + * [destinationNetworkInterfaceIPConfiguration.subnet.name] The name of the + * resource that is unique within a resource group. This name can be used to + * access the resource. + * @property {string} + * [destinationNetworkInterfaceIPConfiguration.subnet.etag] A unique + * read-only string that changes whenever the resource is updated. + * @property {boolean} [destinationNetworkInterfaceIPConfiguration.primary] * Gets whether this is a primary customer address on the network interface. - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress] Public IP * address bound to the IP configuration. - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.sku] The * public IP address SKU. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.sku.name] Name * of a public IP address SKU. Possible values include: 'Basic', 'Standard' - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPAllocationMethod] * The public IP allocation method. Possible values are: 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPAddressVersion] * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. * Possible values include: 'IPv4', 'IPv6' - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration] * The IP configuration associated with the public IP address. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] * The private IP address of the IP configuration. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] * The private IP allocation method. Possible values are 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet] * The reference of the subnet resource. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] * The address prefix for the subnet. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] * The reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] * A collection of references to subnets. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] * The reference of the RouteTable resource. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] * A collection of references to subnets. - * @member {boolean} + * @property {boolean} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] * Gets a unique read-only string that changes whenever the resource is * updated. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] * An array of service endpoints. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] * An array of service endpoint policies. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] * An array of references to interface endpoints - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] * Gets an array of references to the network interface IP configurations * using subnet. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] * Gets an array of references to the delegations on the subnet. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] * A read-only string identifying the intention of use for this subnet based * on delegations and other user-defined properties. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] * The provisioning state of the resource. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.subnet.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] * The reference of the public IP resource. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.provisioningState] * Gets the provisioning state of the public IP resource. Possible values * are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipConfiguration.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings] * The FQDN of the DNS record associated with the public IP address. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] * Gets or sets the Domain name label.The concatenation of the domain name * label and the regionalized DNS zone make up the fully qualified domain * name associated with the public IP address. If a domain name label is * specified, an A DNS record is created for the public IP in the Microsoft * Azure DNS system. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.fqdn] * Gets the FQDN, Fully qualified domain name of the A DNS record associated * with the public IP. This is the concatenation of the domainNameLabel and * the regionalized DNS zone. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name * that resolves to this public IP address. If the reverseFqdn is specified, * then a PTR DNS record is created pointing from the IP address in the * in-addr.arpa domain to the reverse FQDN. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipTags] The * list of tags associated with the public IP address. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.ipAddress] The * IP address associated with the public IP address resource. - * @member {object} + * @property {object} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPPrefix] * The Public IP Prefix this Public IP Address should be allocated from. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.publicIPPrefix.id] * Resource ID. - * @member {number} + * @property {number} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.idleTimeoutInMinutes] * The idle timeout of the public IP address. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.resourceGuid] * The resource GUID property of the public IP resource. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.provisioningState] * The provisioning state of the PublicIP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.etag] A unique * read-only string that changes whenever the resource is updated. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.publicIPAddress.zones] A list * of availability zones denoting the IP allocated for the resource needs to * come from. - * @member {array} + * @property {array} * [destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] * Application security groups in which the IP configuration is included. - * @member {string} + * @property {string} * [destinationNetworkInterfaceIPConfiguration.provisioningState] The * provisioning state of the network interface IP configuration. Possible * values are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} [destinationNetworkInterfaceIPConfiguration.name] The + * @property {string} [destinationNetworkInterfaceIPConfiguration.name] The * name of the resource that is unique within a resource group. This name can * be used to access the resource. - * @member {string} [destinationNetworkInterfaceIPConfiguration.etag] A + * @property {string} [destinationNetworkInterfaceIPConfiguration.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {object} [destinationLoadBalancerFrontEndIPConfiguration] The + * @property {object} [destinationLoadBalancerFrontEndIPConfiguration] The * reference to the private IP address on the internal Load Balancer that * will receive the tap - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.inboundNatRules] Read * only. Inbound rules URIs that use this frontend IP. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.inboundNatPools] Read * only. Inbound pools URIs that use this frontend IP. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.outboundRules] Read only. * Outbound rules URIs that use this frontend IP. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.loadBalancingRules] Gets * load balancing rules URIs that use this frontend IP. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] The * private IP address of the IP configuration. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] * The Private IP allocation method. Possible values are: 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} [destinationLoadBalancerFrontEndIPConfiguration.subnet] + * @property {object} [destinationLoadBalancerFrontEndIPConfiguration.subnet] * The reference of the subnet resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] The * address prefix for the subnet. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] * The reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.subnets] * A collection of references to subnets. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] The * reference of the RouteTable resource. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.subnets] * A collection of references to subnets. - * @member {boolean} + * @property {boolean} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] * Gets a unique read-only string that changes whenever the resource is * updated. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] * An array of service endpoints. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] * An array of service endpoint policies. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.interfaceEndpoints] * An array of references to interface endpoints - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.ipConfigurations] * Gets an array of references to the network interface IP configurations * using subnet. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] Gets * an array of references to the delegations on the subnet. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.purpose] A * read-only string identifying the intention of use for this subnet based on * delegations and other user-defined properties. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] * The provisioning state of the resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.name] The name of * the resource that is unique within a resource group. This name can be used * to access the resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] A unique * read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] The * reference of the Public IP resource. - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] The * public IP address SKU. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] * Name of a public IP address SKU. Possible values include: 'Basic', * 'Standard' - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] * The public IP allocation method. Possible values are: 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. * Possible values include: 'IPv4', 'IPv6' - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration] * The IP configuration associated with the public IP address. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.privateIPAddress] * The private IP address of the IP configuration. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.privateIPAllocationMethod] * The private IP allocation method. Possible values are 'Static' and * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet] * The reference of the subnet resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefix] * The address prefix for the subnet. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.addressPrefixes] * List of address prefixes for the subnet. - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup] * The reference of the NetworkSecurityGroup resource. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.securityRules] * A collection of security rules of the network security group. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] * The default security rules of network security group. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.networkInterfaces] * A collection of references to network interfaces. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.subnets] * A collection of references to subnets. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.resourceGuid] * The resource GUID property of the network security group resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.provisioningState] * The provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.networkSecurityGroup.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable] * The reference of the RouteTable resource. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.routes] * Collection of routes contained within a route table. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.subnets] * A collection of references to subnets. - * @member {boolean} + * @property {boolean} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.disableBgpRoutePropagation] * Gets or sets whether to disable the routes learned by BGP on that route * table. True means disable. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.provisioningState] * The provisioning state of the resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.routeTable.etag] * Gets a unique read-only string that changes whenever the resource is * updated. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpoints] * An array of service endpoints. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceEndpointPolicies] * An array of service endpoint policies. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.interfaceEndpoints] * An array of references to interface endpoints - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurations] * Gets an array of references to the network interface IP configurations * using subnet. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.ipConfigurationProfiles] * Array of IP configuration profiles which reference this subnet. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.resourceNavigationLinks] * Gets an array of references to the external resources using subnet. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.serviceAssociationLinks] * Gets an array of references to services injecting into this subnet. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.delegations] * Gets an array of references to the delegations on the subnet. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.purpose] * A read-only string identifying the intention of use for this subnet based * on delegations and other user-defined properties. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.provisioningState] * The provisioning state of the resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.subnet.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.publicIPAddress] * The reference of the public IP resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.provisioningState] * Gets the provisioning state of the public IP resource. Possible values * are: 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.name] * The name of the resource that is unique within a resource group. This name * can be used to access the resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipConfiguration.etag] * A unique read-only string that changes whenever the resource is updated. - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] * The FQDN of the DNS record associated with the public IP address. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] * Gets or sets the Domain name label.The concatenation of the domain name * label and the regionalized DNS zone make up the fully qualified domain * name associated with the public IP address. If a domain name label is * specified, an A DNS record is created for the public IP in the Microsoft * Azure DNS system. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] * Gets the FQDN, Fully qualified domain name of the A DNS record associated * with the public IP. This is the concatenation of the domainNameLabel and * the regionalized DNS zone. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name * that resolves to this public IP address. If the reverseFqdn is specified, * then a PTR DNS record is created pointing from the IP address in the * in-addr.arpa domain to the reverse FQDN. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] * The list of tags associated with the public IP address. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] * The IP address associated with the public IP address resource. - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] * The Public IP Prefix this Public IP Address should be allocated from. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix.id] * Resource ID. - * @member {number} + * @property {number} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] * The idle timeout of the public IP address. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] * The resource GUID property of the public IP resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] * The provisioning state of the PublicIP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {array} + * @property {array} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] A * list of availability zones denoting the IP allocated for the resource * needs to come from. - * @member {object} + * @property {object} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] The * reference of the Public IP Prefix resource. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] * Resource ID. - * @member {string} + * @property {string} * [destinationLoadBalancerFrontEndIPConfiguration.provisioningState] Gets * the provisioning state of the public IP resource. Possible values are: * 'Updating', 'Deleting', and 'Failed'. - * @member {string} [destinationLoadBalancerFrontEndIPConfiguration.name] The - * name of the resource that is unique within a resource group. This name can - * be used to access the resource. - * @member {string} [destinationLoadBalancerFrontEndIPConfiguration.etag] A + * @property {string} [destinationLoadBalancerFrontEndIPConfiguration.name] + * The name of the resource that is unique within a resource group. This name + * can be used to access the resource. + * @property {string} [destinationLoadBalancerFrontEndIPConfiguration.etag] A * unique read-only string that changes whenever the resource is updated. - * @member {array} [destinationLoadBalancerFrontEndIPConfiguration.zones] A + * @property {array} [destinationLoadBalancerFrontEndIPConfiguration.zones] A * list of availability zones denoting the IP allocated for the resource * needs to come from. - * @member {number} [destinationPort] The VXLAN destination port that will + * @property {number} [destinationPort] The VXLAN destination port that will * receive the tapped traffic. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkTapListResult.js b/lib/services/networkManagement2/lib/models/virtualNetworkTapListResult.js index 408dcbe071..ac90696356 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkTapListResult.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkTapListResult.js @@ -16,7 +16,7 @@ class VirtualNetworkTapListResult extends Array { /** * Create a VirtualNetworkTapListResult. - * @member {string} [nextLink] The URL to get the next set of results. + * @property {string} [nextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkUsage.js b/lib/services/networkManagement2/lib/models/virtualNetworkUsage.js index 543c706d5b..a5b32e2171 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkUsage.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkUsage.js @@ -17,16 +17,16 @@ class VirtualNetworkUsage { /** * Create a VirtualNetworkUsage. - * @member {number} [currentValue] Indicates number of IPs used from the + * @property {number} [currentValue] Indicates number of IPs used from the * Subnet. - * @member {string} [id] Subnet identifier. - * @member {number} [limit] Indicates the size of the subnet. - * @member {object} [name] The name containing common and localized value for - * usage. - * @member {string} [name.localizedValue] Localized subnet size and usage + * @property {string} [id] Subnet identifier. + * @property {number} [limit] Indicates the size of the subnet. + * @property {object} [name] The name containing common and localized value + * for usage. + * @property {string} [name.localizedValue] Localized subnet size and usage * string. - * @member {string} [name.value] Subnet size and usage string. - * @member {string} [unit] Usage units. Returns 'Count' + * @property {string} [name.value] Subnet size and usage string. + * @property {string} [unit] Usage units. Returns 'Count' */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/virtualNetworkUsageName.js b/lib/services/networkManagement2/lib/models/virtualNetworkUsageName.js index 093951db51..c78bed08a0 100644 --- a/lib/services/networkManagement2/lib/models/virtualNetworkUsageName.js +++ b/lib/services/networkManagement2/lib/models/virtualNetworkUsageName.js @@ -17,8 +17,9 @@ class VirtualNetworkUsageName { /** * Create a VirtualNetworkUsageName. - * @member {string} [localizedValue] Localized subnet size and usage string. - * @member {string} [value] Subnet size and usage string. + * @property {string} [localizedValue] Localized subnet size and usage + * string. + * @property {string} [value] Subnet size and usage string. */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/virtualWAN.js b/lib/services/networkManagement2/lib/models/virtualWAN.js index 06f774bada..96ce283250 100644 --- a/lib/services/networkManagement2/lib/models/virtualWAN.js +++ b/lib/services/networkManagement2/lib/models/virtualWAN.js @@ -20,24 +20,24 @@ const models = require('./index'); class VirtualWAN extends models['Resource'] { /** * Create a VirtualWAN. - * @member {boolean} [disableVpnEncryption] Vpn encryption to be disabled or - * not. - * @member {array} [virtualHubs] List of VirtualHubs in the VirtualWAN. - * @member {array} [vpnSites] - * @member {string} [securityProviderName] The Security Provider name. - * @member {boolean} [allowBranchToBranchTraffic] True if branch to branch + * @property {boolean} [disableVpnEncryption] Vpn encryption to be disabled + * or not. + * @property {array} [virtualHubs] List of VirtualHubs in the VirtualWAN. + * @property {array} [vpnSites] + * @property {string} [securityProviderName] The Security Provider name. + * @property {boolean} [allowBranchToBranchTraffic] True if branch to branch * traffic is allowed. - * @member {boolean} [allowVnetToVnetTraffic] True if Vnet to Vnet traffic is - * allowed. - * @member {string} [office365LocalBreakoutCategory] The office local + * @property {boolean} [allowVnetToVnetTraffic] True if Vnet to Vnet traffic + * is allowed. + * @property {string} [office365LocalBreakoutCategory] The office local * breakout category. Possible values include: 'Optimize', * 'OptimizeAndAllow', 'All', 'None' - * @member {array} [p2SVpnServerConfigurations] list of all + * @property {array} [p2SVpnServerConfigurations] list of all * P2SVpnServerConfigurations associated with the virtual wan. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualWanSecurityProvider.js b/lib/services/networkManagement2/lib/models/virtualWanSecurityProvider.js index 617122fc78..d7185cbc43 100644 --- a/lib/services/networkManagement2/lib/models/virtualWanSecurityProvider.js +++ b/lib/services/networkManagement2/lib/models/virtualWanSecurityProvider.js @@ -17,9 +17,9 @@ class VirtualWanSecurityProvider { /** * Create a VirtualWanSecurityProvider. - * @member {string} [name] Name of the security provider. - * @member {string} [url] Url of the security provider. - * @member {string} [type] Name of the security provider. Possible values + * @property {string} [name] Name of the security provider. + * @property {string} [url] Url of the security provider. + * @property {string} [type] Name of the security provider. Possible values * include: 'External', 'Native' */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/virtualWanSecurityProviders.js b/lib/services/networkManagement2/lib/models/virtualWanSecurityProviders.js index b47282affc..c440949c25 100644 --- a/lib/services/networkManagement2/lib/models/virtualWanSecurityProviders.js +++ b/lib/services/networkManagement2/lib/models/virtualWanSecurityProviders.js @@ -17,7 +17,7 @@ class VirtualWanSecurityProviders { /** * Create a VirtualWanSecurityProviders. - * @member {array} [supportedProviders] + * @property {array} [supportedProviders] */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/vpnClientConfiguration.js b/lib/services/networkManagement2/lib/models/vpnClientConfiguration.js index 4341215763..a90e518099 100644 --- a/lib/services/networkManagement2/lib/models/vpnClientConfiguration.js +++ b/lib/services/networkManagement2/lib/models/vpnClientConfiguration.js @@ -17,21 +17,21 @@ class VpnClientConfiguration { /** * Create a VpnClientConfiguration. - * @member {object} [vpnClientAddressPool] The reference of the address space - * resource which represents Address space for P2S VpnClient. - * @member {array} [vpnClientAddressPool.addressPrefixes] A list of address + * @property {object} [vpnClientAddressPool] The reference of the address + * space resource which represents Address space for P2S VpnClient. + * @property {array} [vpnClientAddressPool.addressPrefixes] A list of address * blocks reserved for this virtual network in CIDR notation. - * @member {array} [vpnClientRootCertificates] VpnClientRootCertificate for + * @property {array} [vpnClientRootCertificates] VpnClientRootCertificate for * virtual network gateway. - * @member {array} [vpnClientRevokedCertificates] VpnClientRevokedCertificate - * for Virtual network gateway. - * @member {array} [vpnClientProtocols] VpnClientProtocols for Virtual + * @property {array} [vpnClientRevokedCertificates] + * VpnClientRevokedCertificate for Virtual network gateway. + * @property {array} [vpnClientProtocols] VpnClientProtocols for Virtual * network gateway. - * @member {array} [vpnClientIpsecPolicies] VpnClientIpsecPolicies for + * @property {array} [vpnClientIpsecPolicies] VpnClientIpsecPolicies for * virtual network gateway P2S client. - * @member {string} [radiusServerAddress] The radius server address property - * of the VirtualNetworkGateway resource for vpn client connection. - * @member {string} [radiusServerSecret] The radius secret property of the + * @property {string} [radiusServerAddress] The radius server address + * property of the VirtualNetworkGateway resource for vpn client connection. + * @property {string} [radiusServerSecret] The radius secret property of the * VirtualNetworkGateway resource for vpn client connection. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/vpnClientConnectionHealth.js b/lib/services/networkManagement2/lib/models/vpnClientConnectionHealth.js index 10a781f657..b8407c21df 100644 --- a/lib/services/networkManagement2/lib/models/vpnClientConnectionHealth.js +++ b/lib/services/networkManagement2/lib/models/vpnClientConnectionHealth.js @@ -17,13 +17,13 @@ class VpnClientConnectionHealth { /** * Create a VpnClientConnectionHealth. - * @member {number} [totalIngressBytesTransferred] Total of the Ingress Bytes - * Transferred in this P2S Vpn connection - * @member {number} [totalEgressBytesTransferred] Total of the Egress Bytes + * @property {number} [totalIngressBytesTransferred] Total of the Ingress + * Bytes Transferred in this P2S Vpn connection + * @property {number} [totalEgressBytesTransferred] Total of the Egress Bytes * Transferred in this connection - * @member {number} [vpnClientConnectionsCount] The total of p2s vpn clients - * connected at this time to this P2SVpnGateway. - * @member {array} [allocatedIpAddresses] List of allocated ip addresses to + * @property {number} [vpnClientConnectionsCount] The total of p2s vpn + * clients connected at this time to this P2SVpnGateway. + * @property {array} [allocatedIpAddresses] List of allocated ip addresses to * the connected p2s vpn clients. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/vpnClientIPsecParameters.js b/lib/services/networkManagement2/lib/models/vpnClientIPsecParameters.js index b166295913..aa396bea39 100644 --- a/lib/services/networkManagement2/lib/models/vpnClientIPsecParameters.js +++ b/lib/services/networkManagement2/lib/models/vpnClientIPsecParameters.js @@ -17,28 +17,28 @@ class VpnClientIPsecParameters { /** * Create a VpnClientIPsecParameters. - * @member {number} saLifeTimeSeconds The IPSec Security Association (also + * @property {number} saLifeTimeSeconds The IPSec Security Association (also * called Quick Mode or Phase 2 SA) lifetime in seconds for P2S client. - * @member {number} saDataSizeKilobytes The IPSec Security Association (also - * called Quick Mode or Phase 2 SA) payload size in KB for P2S client.. - * @member {string} ipsecEncryption The IPSec encryption algorithm (IKE phase - * 1). Possible values include: 'None', 'DES', 'DES3', 'AES128', 'AES192', - * 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' - * @member {string} ipsecIntegrity The IPSec integrity algorithm (IKE phase + * @property {number} saDataSizeKilobytes The IPSec Security Association + * (also called Quick Mode or Phase 2 SA) payload size in KB for P2S client.. + * @property {string} ipsecEncryption The IPSec encryption algorithm (IKE + * phase 1). Possible values include: 'None', 'DES', 'DES3', 'AES128', + * 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' + * @property {string} ipsecIntegrity The IPSec integrity algorithm (IKE phase * 1). Possible values include: 'MD5', 'SHA1', 'SHA256', 'GCMAES128', * 'GCMAES192', 'GCMAES256' - * @member {string} ikeEncryption The IKE encryption algorithm (IKE phase 2). - * Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256', + * @property {string} ikeEncryption The IKE encryption algorithm (IKE phase + * 2). Possible values include: 'DES', 'DES3', 'AES128', 'AES192', 'AES256', * 'GCMAES256', 'GCMAES128' - * @member {string} ikeIntegrity The IKE integrity algorithm (IKE phase 2). + * @property {string} ikeIntegrity The IKE integrity algorithm (IKE phase 2). * Possible values include: 'MD5', 'SHA1', 'SHA256', 'SHA384', 'GCMAES256', * 'GCMAES128' - * @member {string} dhGroup The DH Groups used in IKE Phase 1 for initial SA. - * Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', + * @property {string} dhGroup The DH Groups used in IKE Phase 1 for initial + * SA. Possible values include: 'None', 'DHGroup1', 'DHGroup2', 'DHGroup14', * 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24' - * @member {string} pfsGroup The Pfs Groups used in IKE Phase 2 for new child - * SA. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', 'ECP256', - * 'ECP384', 'PFS24', 'PFS14', 'PFSMM' + * @property {string} pfsGroup The Pfs Groups used in IKE Phase 2 for new + * child SA. Possible values include: 'None', 'PFS1', 'PFS2', 'PFS2048', + * 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM' */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/vpnClientParameters.js b/lib/services/networkManagement2/lib/models/vpnClientParameters.js index f83ecb68a3..5511de202a 100644 --- a/lib/services/networkManagement2/lib/models/vpnClientParameters.js +++ b/lib/services/networkManagement2/lib/models/vpnClientParameters.js @@ -17,17 +17,17 @@ class VpnClientParameters { /** * Create a VpnClientParameters. - * @member {string} [processorArchitecture] VPN client Processor + * @property {string} [processorArchitecture] VPN client Processor * Architecture. Possible values are: 'AMD64' and 'X86'. Possible values * include: 'Amd64', 'X86' - * @member {string} [authenticationMethod] VPN client Authentication Method. - * Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values include: - * 'EAPTLS', 'EAPMSCHAPv2' - * @member {string} [radiusServerAuthCertificate] The public certificate data - * for the radius server authentication certificate as a Base-64 encoded + * @property {string} [authenticationMethod] VPN client Authentication + * Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values + * include: 'EAPTLS', 'EAPMSCHAPv2' + * @property {string} [radiusServerAuthCertificate] The public certificate + * data for the radius server authentication certificate as a Base-64 encoded * string. Required only if external radius authentication has been * configured with EAPTLS authentication. - * @member {array} [clientRootCertificates] A list of client root + * @property {array} [clientRootCertificates] A list of client root * certificates public certificate data encoded as Base-64 strings. Optional * parameter for external radius based authentication with EAPTLS. */ diff --git a/lib/services/networkManagement2/lib/models/vpnClientRevokedCertificate.js b/lib/services/networkManagement2/lib/models/vpnClientRevokedCertificate.js index 6765ec0de6..25974939aa 100644 --- a/lib/services/networkManagement2/lib/models/vpnClientRevokedCertificate.js +++ b/lib/services/networkManagement2/lib/models/vpnClientRevokedCertificate.js @@ -20,14 +20,14 @@ const models = require('./index'); class VpnClientRevokedCertificate extends models['SubResource'] { /** * Create a VpnClientRevokedCertificate. - * @member {string} [thumbprint] The revoked VPN client certificate + * @property {string} [thumbprint] The revoked VPN client certificate * thumbprint. - * @member {string} [provisioningState] The provisioning state of the VPN + * @property {string} [provisioningState] The provisioning state of the VPN * client revoked certificate resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/vpnClientRootCertificate.js b/lib/services/networkManagement2/lib/models/vpnClientRootCertificate.js index c37cf3e0db..5e5e2c5155 100644 --- a/lib/services/networkManagement2/lib/models/vpnClientRootCertificate.js +++ b/lib/services/networkManagement2/lib/models/vpnClientRootCertificate.js @@ -20,13 +20,13 @@ const models = require('./index'); class VpnClientRootCertificate extends models['SubResource'] { /** * Create a VpnClientRootCertificate. - * @member {string} publicCertData The certificate public data. - * @member {string} [provisioningState] The provisioning state of the VPN + * @property {string} publicCertData The certificate public data. + * @property {string} [provisioningState] The provisioning state of the VPN * client root certificate resource. Possible values are: 'Updating', * 'Deleting', and 'Failed'. - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] A unique read-only string that changes whenever + * @property {string} [etag] A unique read-only string that changes whenever * the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/vpnConnection.js b/lib/services/networkManagement2/lib/models/vpnConnection.js index 350af67fe6..28a80804d5 100644 --- a/lib/services/networkManagement2/lib/models/vpnConnection.js +++ b/lib/services/networkManagement2/lib/models/vpnConnection.js @@ -20,28 +20,28 @@ const models = require('./index'); class VpnConnection extends models['SubResource'] { /** * Create a VpnConnection. - * @member {object} [remoteVpnSite] Id of the connected vpn site. - * @member {string} [remoteVpnSite.id] Resource ID. - * @member {number} [routingWeight] routing weight for vpn connection. - * @member {string} [connectionStatus] The connection status. Possible values - * include: 'Unknown', 'Connecting', 'Connected', 'NotConnected' - * @member {string} [vpnConnectionProtocolType] Connection protocol used for - * this connection. Possible values include: 'IKEv2', 'IKEv1' - * @member {number} [ingressBytesTransferred] Ingress bytes transferred. - * @member {number} [egressBytesTransferred] Egress bytes transferred. - * @member {number} [connectionBandwidth] Expected bandwidth in MBPS. - * @member {string} [sharedKey] SharedKey for the vpn connection. - * @member {boolean} [enableBgp] EnableBgp flag - * @member {array} [ipsecPolicies] The IPSec Policies to be considered by + * @property {object} [remoteVpnSite] Id of the connected vpn site. + * @property {string} [remoteVpnSite.id] Resource ID. + * @property {number} [routingWeight] routing weight for vpn connection. + * @property {string} [connectionStatus] The connection status. Possible + * values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected' + * @property {string} [vpnConnectionProtocolType] Connection protocol used + * for this connection. Possible values include: 'IKEv2', 'IKEv1' + * @property {number} [ingressBytesTransferred] Ingress bytes transferred. + * @property {number} [egressBytesTransferred] Egress bytes transferred. + * @property {number} [connectionBandwidth] Expected bandwidth in MBPS. + * @property {string} [sharedKey] SharedKey for the vpn connection. + * @property {boolean} [enableBgp] EnableBgp flag + * @property {array} [ipsecPolicies] The IPSec Policies to be considered by * this connection. - * @member {boolean} [enableRateLimiting] EnableBgp flag - * @member {boolean} [enableInternetSecurity] Enable internet security - * @member {string} [provisioningState] The provisioning state of the + * @property {boolean} [enableRateLimiting] EnableBgp flag + * @property {boolean} [enableInternetSecurity] Enable internet security + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {string} [name] The name of the resource that is unique within a + * @property {string} [name] The name of the resource that is unique within a * resource group. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/vpnDeviceScriptParameters.js b/lib/services/networkManagement2/lib/models/vpnDeviceScriptParameters.js index ff0a58c30b..984bdaeb1d 100644 --- a/lib/services/networkManagement2/lib/models/vpnDeviceScriptParameters.js +++ b/lib/services/networkManagement2/lib/models/vpnDeviceScriptParameters.js @@ -17,9 +17,9 @@ class VpnDeviceScriptParameters { /** * Create a VpnDeviceScriptParameters. - * @member {string} [vendor] The vendor for the vpn device. - * @member {string} [deviceFamily] The device family for the vpn device. - * @member {string} [firmwareVersion] The firmware version for the vpn + * @property {string} [vendor] The vendor for the vpn device. + * @property {string} [deviceFamily] The device family for the vpn device. + * @property {string} [firmwareVersion] The firmware version for the vpn * device. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/vpnGateway.js b/lib/services/networkManagement2/lib/models/vpnGateway.js index abc5ae46dd..c19b48ab52 100644 --- a/lib/services/networkManagement2/lib/models/vpnGateway.js +++ b/lib/services/networkManagement2/lib/models/vpnGateway.js @@ -20,22 +20,24 @@ const models = require('./index'); class VpnGateway extends models['Resource'] { /** * Create a VpnGateway. - * @member {object} [virtualHub] The VirtualHub to which the gateway belongs - * @member {string} [virtualHub.id] Resource ID. - * @member {array} [connections] list of all vpn connections to the gateway. - * @member {object} [bgpSettings] Local network gateway's BGP speaker + * @property {object} [virtualHub] The VirtualHub to which the gateway + * belongs + * @property {string} [virtualHub.id] Resource ID. + * @property {array} [connections] list of all vpn connections to the + * gateway. + * @property {object} [bgpSettings] Local network gateway's BGP speaker * settings. - * @member {number} [bgpSettings.asn] The BGP speaker's ASN. - * @member {string} [bgpSettings.bgpPeeringAddress] The BGP peering address + * @property {number} [bgpSettings.asn] The BGP speaker's ASN. + * @property {string} [bgpSettings.bgpPeeringAddress] The BGP peering address * and BGP identifier of this BGP speaker. - * @member {number} [bgpSettings.peerWeight] The weight added to routes + * @property {number} [bgpSettings.peerWeight] The weight added to routes * learned from this BGP speaker. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {number} [vpnGatewayScaleUnit] The scale unit for this vpn + * @property {number} [vpnGatewayScaleUnit] The scale unit for this vpn * gateway. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/vpnProfileResponse.js b/lib/services/networkManagement2/lib/models/vpnProfileResponse.js index 4fcab7e02c..e7d40d0cee 100644 --- a/lib/services/networkManagement2/lib/models/vpnProfileResponse.js +++ b/lib/services/networkManagement2/lib/models/vpnProfileResponse.js @@ -17,7 +17,7 @@ class VpnProfileResponse { /** * Create a VpnProfileResponse. - * @member {string} [profileUrl] URL to the VPN profile + * @property {string} [profileUrl] URL to the VPN profile */ constructor() { } diff --git a/lib/services/networkManagement2/lib/models/vpnSite.js b/lib/services/networkManagement2/lib/models/vpnSite.js index 702e68e349..69ab0f59a8 100644 --- a/lib/services/networkManagement2/lib/models/vpnSite.js +++ b/lib/services/networkManagement2/lib/models/vpnSite.js @@ -20,31 +20,32 @@ const models = require('./index'); class VpnSite extends models['Resource'] { /** * Create a VpnSite. - * @member {object} [virtualWan] The VirtualWAN to which the vpnSite belongs - * @member {string} [virtualWan.id] Resource ID. - * @member {object} [deviceProperties] The device properties - * @member {string} [deviceProperties.deviceVendor] Name of the device + * @property {object} [virtualWan] The VirtualWAN to which the vpnSite + * belongs + * @property {string} [virtualWan.id] Resource ID. + * @property {object} [deviceProperties] The device properties + * @property {string} [deviceProperties.deviceVendor] Name of the device * Vendor. - * @member {string} [deviceProperties.deviceModel] Model of the device. - * @member {number} [deviceProperties.linkSpeedInMbps] Link speed. - * @member {string} [ipAddress] The ip-address for the vpn-site. - * @member {string} [siteKey] The key for vpn-site that can be used for + * @property {string} [deviceProperties.deviceModel] Model of the device. + * @property {number} [deviceProperties.linkSpeedInMbps] Link speed. + * @property {string} [ipAddress] The ip-address for the vpn-site. + * @property {string} [siteKey] The key for vpn-site that can be used for * connections. - * @member {object} [addressSpace] The AddressSpace that contains an array of - * IP address ranges. - * @member {array} [addressSpace.addressPrefixes] A list of address blocks + * @property {object} [addressSpace] The AddressSpace that contains an array + * of IP address ranges. + * @property {array} [addressSpace.addressPrefixes] A list of address blocks * reserved for this virtual network in CIDR notation. - * @member {object} [bgpProperties] The set of bgp properties. - * @member {number} [bgpProperties.asn] The BGP speaker's ASN. - * @member {string} [bgpProperties.bgpPeeringAddress] The BGP peering address - * and BGP identifier of this BGP speaker. - * @member {number} [bgpProperties.peerWeight] The weight added to routes + * @property {object} [bgpProperties] The set of bgp properties. + * @property {number} [bgpProperties.asn] The BGP speaker's ASN. + * @property {string} [bgpProperties.bgpPeeringAddress] The BGP peering + * address and BGP identifier of this BGP speaker. + * @property {number} [bgpProperties.peerWeight] The weight added to routes * learned from this BGP speaker. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', * 'Failed' - * @member {boolean} [isSecuritySite] IsSecuritySite flag - * @member {string} [etag] Gets a unique read-only string that changes + * @property {boolean} [isSecuritySite] IsSecuritySite flag + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/networkManagement2/lib/models/vpnSiteId.js b/lib/services/networkManagement2/lib/models/vpnSiteId.js index f00971195c..0367c3232b 100644 --- a/lib/services/networkManagement2/lib/models/vpnSiteId.js +++ b/lib/services/networkManagement2/lib/models/vpnSiteId.js @@ -17,7 +17,7 @@ class VpnSiteId { /** * Create a VpnSiteId. - * @member {string} [vpnSite] The resource-uri of the vpn-site for which + * @property {string} [vpnSite] The resource-uri of the vpn-site for which * config is to be fetched. */ constructor() { diff --git a/lib/services/networkManagement2/lib/networkManagementClient.d.ts b/lib/services/networkManagement2/lib/networkManagementClient.d.ts index 463c4db920..9753f42d8a 100644 --- a/lib/services/networkManagement2/lib/networkManagementClient.d.ts +++ b/lib/services/networkManagement2/lib/networkManagementClient.d.ts @@ -108,10 +108,10 @@ export default class NetworkManagementClient extends AzureServiceClient { virtualNetworks: operations.VirtualNetworks; subnets: operations.Subnets; virtualNetworkPeerings: operations.VirtualNetworkPeerings; - virtualNetworkTaps: operations.VirtualNetworkTaps; virtualNetworkGateways: operations.VirtualNetworkGateways; virtualNetworkGatewayConnections: operations.VirtualNetworkGatewayConnections; localNetworkGateways: operations.LocalNetworkGateways; + virtualNetworkTaps: operations.VirtualNetworkTaps; virtualWans: operations.VirtualWans; vpnSites: operations.VpnSites; vpnSitesConfiguration: operations.VpnSitesConfiguration; diff --git a/lib/services/networkManagement2/lib/networkManagementClient.js b/lib/services/networkManagement2/lib/networkManagementClient.js index 5dd51810ee..baa2b3cbc4 100644 --- a/lib/services/networkManagement2/lib/networkManagementClient.js +++ b/lib/services/networkManagement2/lib/networkManagementClient.js @@ -61,7 +61,7 @@ function _checkDnsNameAvailability(location, domainNameLabel, options, callback) if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (location === null || location === undefined || typeof location.valueOf() !== 'string') { @@ -206,7 +206,7 @@ function _supportedSecurityProviders(resourceGroupName, virtualWANName, options, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.subscriptionId === null || this.subscriptionId === undefined || typeof this.subscriptionId.valueOf() !== 'string') { @@ -418,10 +418,10 @@ class NetworkManagementClient extends ServiceClient { this.virtualNetworks = new operations.VirtualNetworks(this); this.subnets = new operations.Subnets(this); this.virtualNetworkPeerings = new operations.VirtualNetworkPeerings(this); - this.virtualNetworkTaps = new operations.VirtualNetworkTaps(this); this.virtualNetworkGateways = new operations.VirtualNetworkGateways(this); this.virtualNetworkGatewayConnections = new operations.VirtualNetworkGatewayConnections(this); this.localNetworkGateways = new operations.LocalNetworkGateways(this); + this.virtualNetworkTaps = new operations.VirtualNetworkTaps(this); this.virtualWans = new operations.VirtualWans(this); this.vpnSites = new operations.VpnSites(this); this.vpnSitesConfiguration = new operations.VpnSitesConfiguration(this); diff --git a/lib/services/networkManagement2/lib/operations/applicationGateways.js b/lib/services/networkManagement2/lib/operations/applicationGateways.js index a6b9b9c2c3..fbfc67b905 100644 --- a/lib/services/networkManagement2/lib/operations/applicationGateways.js +++ b/lib/services/networkManagement2/lib/operations/applicationGateways.js @@ -112,7 +112,7 @@ function _get(resourceGroupName, applicationGatewayName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -299,6 +299,9 @@ function _get(resourceGroupName, applicationGatewayName, options, callback) { * @param {array} [parameters.requestRoutingRules] Request routing rules of the * application gateway resource. * + * @param {array} [parameters.rewriteRuleSets] Rewrite rules for the + * application gateway resource. + * * @param {array} [parameters.redirectConfigurations] Redirect configurations * of the application gateway resource. * @@ -370,6 +373,21 @@ function _get(resourceGroupName, applicationGatewayName, options, callback) { * @param {array} [parameters.zones] A list of availability zones denoting * where the resource needs to come from. * + * @param {object} [parameters.identity] The identity of the application + * gateway, if configured. + * + * @param {string} [parameters.identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values + * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + * + * @param {object} [parameters.identity.userAssignedIdentities] The list of + * user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + * * @param {string} [parameters.id] Resource ID. * * @param {string} [parameters.location] Resource location. @@ -563,7 +581,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -699,7 +717,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1041,7 +1059,7 @@ function _listAvailableWafRuleSets(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1173,7 +1191,7 @@ function _listAvailableSslOptions(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1306,7 +1324,7 @@ function _listAvailableSslPredefinedPolicies(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1440,7 +1458,7 @@ function _getSslPredefinedPolicy(predefinedPolicyName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1578,7 +1596,7 @@ function _beginDeleteMethod(resourceGroupName, applicationGatewayName, options, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1747,6 +1765,9 @@ function _beginDeleteMethod(resourceGroupName, applicationGatewayName, options, * @param {array} [parameters.requestRoutingRules] Request routing rules of the * application gateway resource. * + * @param {array} [parameters.rewriteRuleSets] Rewrite rules for the + * application gateway resource. + * * @param {array} [parameters.redirectConfigurations] Redirect configurations * of the application gateway resource. * @@ -1818,6 +1839,21 @@ function _beginDeleteMethod(resourceGroupName, applicationGatewayName, options, * @param {array} [parameters.zones] A list of availability zones denoting * where the resource needs to come from. * + * @param {object} [parameters.identity] The identity of the application + * gateway, if configured. + * + * @param {string} [parameters.identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values + * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + * + * @param {object} [parameters.identity.userAssignedIdentities] The list of + * user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + * * @param {string} [parameters.id] Resource ID. * * @param {string} [parameters.location] Resource location. @@ -1852,7 +1888,7 @@ function _beginCreateOrUpdate(resourceGroupName, applicationGatewayName, paramet if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2034,7 +2070,7 @@ function _beginUpdateTags(resourceGroupName, applicationGatewayName, parameters, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2193,7 +2229,7 @@ function _beginStart(resourceGroupName, applicationGatewayName, options, callbac if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2318,7 +2354,7 @@ function _beginStop(resourceGroupName, applicationGatewayName, options, callback if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2450,7 +2486,7 @@ function _beginBackendHealth(resourceGroupName, applicationGatewayName, options, throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3230,6 +3266,9 @@ class ApplicationGateways { * @param {array} [parameters.requestRoutingRules] Request routing rules of the * application gateway resource. * + * @param {array} [parameters.rewriteRuleSets] Rewrite rules for the + * application gateway resource. + * * @param {array} [parameters.redirectConfigurations] Redirect configurations * of the application gateway resource. * @@ -3301,6 +3340,21 @@ class ApplicationGateways { * @param {array} [parameters.zones] A list of availability zones denoting * where the resource needs to come from. * + * @param {object} [parameters.identity] The identity of the application + * gateway, if configured. + * + * @param {string} [parameters.identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values + * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + * + * @param {object} [parameters.identity.userAssignedIdentities] The list of + * user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + * * @param {string} [parameters.id] Resource ID. * * @param {string} [parameters.location] Resource location. @@ -3410,6 +3464,9 @@ class ApplicationGateways { * @param {array} [parameters.requestRoutingRules] Request routing rules of the * application gateway resource. * + * @param {array} [parameters.rewriteRuleSets] Rewrite rules for the + * application gateway resource. + * * @param {array} [parameters.redirectConfigurations] Redirect configurations * of the application gateway resource. * @@ -3481,6 +3538,21 @@ class ApplicationGateways { * @param {array} [parameters.zones] A list of availability zones denoting * where the resource needs to come from. * + * @param {object} [parameters.identity] The identity of the application + * gateway, if configured. + * + * @param {string} [parameters.identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values + * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + * + * @param {object} [parameters.identity.userAssignedIdentities] The list of + * user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + * * @param {string} [parameters.id] Resource ID. * * @param {string} [parameters.location] Resource location. @@ -4542,6 +4614,9 @@ class ApplicationGateways { * @param {array} [parameters.requestRoutingRules] Request routing rules of the * application gateway resource. * + * @param {array} [parameters.rewriteRuleSets] Rewrite rules for the + * application gateway resource. + * * @param {array} [parameters.redirectConfigurations] Redirect configurations * of the application gateway resource. * @@ -4613,6 +4688,21 @@ class ApplicationGateways { * @param {array} [parameters.zones] A list of availability zones denoting * where the resource needs to come from. * + * @param {object} [parameters.identity] The identity of the application + * gateway, if configured. + * + * @param {string} [parameters.identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values + * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + * + * @param {object} [parameters.identity.userAssignedIdentities] The list of + * user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + * * @param {string} [parameters.id] Resource ID. * * @param {string} [parameters.location] Resource location. @@ -4722,6 +4812,9 @@ class ApplicationGateways { * @param {array} [parameters.requestRoutingRules] Request routing rules of the * application gateway resource. * + * @param {array} [parameters.rewriteRuleSets] Rewrite rules for the + * application gateway resource. + * * @param {array} [parameters.redirectConfigurations] Redirect configurations * of the application gateway resource. * @@ -4793,6 +4886,21 @@ class ApplicationGateways { * @param {array} [parameters.zones] A list of availability zones denoting * where the resource needs to come from. * + * @param {object} [parameters.identity] The identity of the application + * gateway, if configured. + * + * @param {string} [parameters.identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values + * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + * + * @param {object} [parameters.identity.userAssignedIdentities] The list of + * user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + * * @param {string} [parameters.id] Resource ID. * * @param {string} [parameters.location] Resource location. diff --git a/lib/services/networkManagement2/lib/operations/applicationSecurityGroups.js b/lib/services/networkManagement2/lib/operations/applicationSecurityGroups.js index 8f4d7be13a..cbd49b44de 100644 --- a/lib/services/networkManagement2/lib/operations/applicationSecurityGroups.js +++ b/lib/services/networkManagement2/lib/operations/applicationSecurityGroups.js @@ -115,7 +115,7 @@ function _get(resourceGroupName, applicationSecurityGroupName, options, callback if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -344,7 +344,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -478,7 +478,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -617,7 +617,7 @@ function _beginDeleteMethod(resourceGroupName, applicationSecurityGroupName, opt if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -754,7 +754,7 @@ function _beginCreateOrUpdate(resourceGroupName, applicationSecurityGroupName, p if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/availableDelegations.js b/lib/services/networkManagement2/lib/operations/availableDelegations.js index bb49a72dc4..c9135d952e 100644 --- a/lib/services/networkManagement2/lib/operations/availableDelegations.js +++ b/lib/services/networkManagement2/lib/operations/availableDelegations.js @@ -49,7 +49,7 @@ function _list(location, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (location === null || location === undefined || typeof location.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/availableEndpointServices.js b/lib/services/networkManagement2/lib/operations/availableEndpointServices.js index 959cdbd191..ceb1cd2fa8 100644 --- a/lib/services/networkManagement2/lib/operations/availableEndpointServices.js +++ b/lib/services/networkManagement2/lib/operations/availableEndpointServices.js @@ -48,7 +48,7 @@ function _list(location, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (location === null || location === undefined || typeof location.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/availableResourceGroupDelegations.js b/lib/services/networkManagement2/lib/operations/availableResourceGroupDelegations.js index 5ab86b62fd..3c242eaf47 100644 --- a/lib/services/networkManagement2/lib/operations/availableResourceGroupDelegations.js +++ b/lib/services/networkManagement2/lib/operations/availableResourceGroupDelegations.js @@ -51,7 +51,7 @@ function _list(location, resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (location === null || location === undefined || typeof location.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/azureFirewallFqdnTags.js b/lib/services/networkManagement2/lib/operations/azureFirewallFqdnTags.js index f45c916178..1239e0ba2f 100644 --- a/lib/services/networkManagement2/lib/operations/azureFirewallFqdnTags.js +++ b/lib/services/networkManagement2/lib/operations/azureFirewallFqdnTags.js @@ -46,7 +46,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/azureFirewalls.js b/lib/services/networkManagement2/lib/operations/azureFirewalls.js index 7c3ea7fe6c..ef1dc648b0 100644 --- a/lib/services/networkManagement2/lib/operations/azureFirewalls.js +++ b/lib/services/networkManagement2/lib/operations/azureFirewalls.js @@ -112,7 +112,7 @@ function _get(resourceGroupName, azureFirewallName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -357,7 +357,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -493,7 +493,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -627,7 +627,7 @@ function _beginDeleteMethod(resourceGroupName, azureFirewallName, options, callb if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -778,7 +778,7 @@ function _beginCreateOrUpdate(resourceGroupName, azureFirewallName, parameters, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/bgpServiceCommunities.js b/lib/services/networkManagement2/lib/operations/bgpServiceCommunities.js index 93e1fb43f5..9e942bbc59 100644 --- a/lib/services/networkManagement2/lib/operations/bgpServiceCommunities.js +++ b/lib/services/networkManagement2/lib/operations/bgpServiceCommunities.js @@ -46,7 +46,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/connectionMonitors.js b/lib/services/networkManagement2/lib/operations/connectionMonitors.js index 66d6b97470..ed2c2ebe34 100644 --- a/lib/services/networkManagement2/lib/operations/connectionMonitors.js +++ b/lib/services/networkManagement2/lib/operations/connectionMonitors.js @@ -167,7 +167,7 @@ function _get(resourceGroupName, networkWatcherName, connectionMonitorName, opti if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -598,7 +598,7 @@ function _list(resourceGroupName, networkWatcherName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -778,7 +778,7 @@ function _beginCreateOrUpdate(resourceGroupName, networkWatcherName, connectionM if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -962,7 +962,7 @@ function _beginDeleteMethod(resourceGroupName, networkWatcherName, connectionMon if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1095,7 +1095,7 @@ function _beginStop(resourceGroupName, networkWatcherName, connectionMonitorName if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1228,7 +1228,7 @@ function _beginStart(resourceGroupName, networkWatcherName, connectionMonitorNam if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1364,7 +1364,7 @@ function _beginQuery(resourceGroupName, networkWatcherName, connectionMonitorNam if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/ddosProtectionPlans.js b/lib/services/networkManagement2/lib/operations/ddosProtectionPlans.js index 498e565f40..b042b7dd1c 100644 --- a/lib/services/networkManagement2/lib/operations/ddosProtectionPlans.js +++ b/lib/services/networkManagement2/lib/operations/ddosProtectionPlans.js @@ -112,7 +112,7 @@ function _get(resourceGroupName, ddosProtectionPlanName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -337,7 +337,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -471,7 +471,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -609,7 +609,7 @@ function _beginDeleteMethod(resourceGroupName, ddosProtectionPlanName, options, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -742,7 +742,7 @@ function _beginCreateOrUpdate(resourceGroupName, ddosProtectionPlanName, paramet if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/defaultSecurityRules.js b/lib/services/networkManagement2/lib/operations/defaultSecurityRules.js index 5c2255fe9b..bdde507af6 100644 --- a/lib/services/networkManagement2/lib/operations/defaultSecurityRules.js +++ b/lib/services/networkManagement2/lib/operations/defaultSecurityRules.js @@ -51,7 +51,7 @@ function _list(resourceGroupName, networkSecurityGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -198,7 +198,7 @@ function _get(resourceGroupName, networkSecurityGroupName, defaultSecurityRuleNa if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRouteCircuitAuthorizations.js b/lib/services/networkManagement2/lib/operations/expressRouteCircuitAuthorizations.js index 80525f78a6..183d5b8462 100644 --- a/lib/services/networkManagement2/lib/operations/expressRouteCircuitAuthorizations.js +++ b/lib/services/networkManagement2/lib/operations/expressRouteCircuitAuthorizations.js @@ -118,7 +118,7 @@ function _get(resourceGroupName, circuitName, authorizationName, options, callba if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -367,7 +367,7 @@ function _list(resourceGroupName, circuitName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -512,7 +512,7 @@ function _beginDeleteMethod(resourceGroupName, circuitName, authorizationName, o if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -665,7 +665,7 @@ function _beginCreateOrUpdate(resourceGroupName, circuitName, authorizationName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRouteCircuitConnections.js b/lib/services/networkManagement2/lib/operations/expressRouteCircuitConnections.js index c4fc55ba4c..b11d32d6de 100644 --- a/lib/services/networkManagement2/lib/operations/expressRouteCircuitConnections.js +++ b/lib/services/networkManagement2/lib/operations/expressRouteCircuitConnections.js @@ -125,7 +125,7 @@ function _get(resourceGroupName, circuitName, peeringName, connectionName, optio if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -355,6 +355,157 @@ function _createOrUpdate(resourceGroupName, circuitName, peeringName, connection }); } +/** + * Gets all global reach connections associated with a private peering in an + * express route circuit. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} circuitName The name of the circuit. + * + * @param {string} peeringName The name of the peering. + * + * @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 ExpressRouteCircuitConnectionListResult} 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 _list(resourceGroupName, circuitName, peeringName, 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.'); + } + let apiVersion = '2018-10-01'; + // Validate + try { + 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 (circuitName === null || circuitName === undefined || typeof circuitName.valueOf() !== 'string') { + throw new Error('circuitName cannot be null or undefined and it must be of type string.'); + } + if (peeringName === null || peeringName === undefined || typeof peeringName.valueOf() !== 'string') { + throw new Error('peeringName cannot be null or undefined and it must be of type string.'); + } + 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 (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.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{circuitName}', encodeURIComponent(circuitName)); + requestUrl = requestUrl.replace('{peeringName}', encodeURIComponent(peeringName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + let queryParameters = []; + queryParameters.push('api-version=' + encodeURIComponent(apiVersion)); + if (queryParameters.length > 0) { + requestUrl += '?' + queryParameters.join('&'); + } + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['ExpressRouteCircuitConnectionListResult']().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); + }); +} + /** * Deletes the specified Express Route Circuit Connection from the specified * express route circuit. @@ -395,7 +546,7 @@ function _beginDeleteMethod(resourceGroupName, circuitName, peeringName, connect if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -565,7 +716,7 @@ function _beginCreateOrUpdate(resourceGroupName, circuitName, peeringName, conne if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -715,6 +866,135 @@ function _beginCreateOrUpdate(resourceGroupName, circuitName, peeringName, conne }); } +/** + * Gets all global reach connections associated with a private peering in an + * express route circuit. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 ExpressRouteCircuitConnectionListResult} 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 _listNext(nextPageLink, 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 (nextPageLink === null || nextPageLink === undefined || typeof nextPageLink.valueOf() !== 'string') { + throw new Error('nextPageLink cannot be null or undefined and it must be of type string.'); + } + 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 requestUrl = '{nextLink}'; + requestUrl = requestUrl.replace('{nextLink}', nextPageLink); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['ExpressRouteCircuitConnectionListResult']().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); + }); +} + /** Class representing a ExpressRouteCircuitConnections. */ class ExpressRouteCircuitConnections { /** @@ -726,8 +1006,10 @@ class ExpressRouteCircuitConnections { this._deleteMethod = _deleteMethod; this._get = _get; this._createOrUpdate = _createOrUpdate; + this._list = _list; this._beginDeleteMethod = _beginDeleteMethod; this._beginCreateOrUpdate = _beginCreateOrUpdate; + this._listNext = _listNext; } /** @@ -1083,6 +1365,99 @@ class ExpressRouteCircuitConnections { } } + /** + * Gets all global reach connections associated with a private peering in an + * express route circuit. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} circuitName The name of the circuit. + * + * @param {string} peeringName The name of the peering. + * + * @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. + */ + listWithHttpOperationResponse(resourceGroupName, circuitName, peeringName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(resourceGroupName, circuitName, peeringName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets all global reach connections associated with a private peering in an + * express route circuit. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} circuitName The name of the circuit. + * + * @param {string} peeringName The name of the peering. + * + * @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 {ExpressRouteCircuitConnectionListResult} - 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 ExpressRouteCircuitConnectionListResult} 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. + */ + list(resourceGroupName, circuitName, peeringName, 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._list(resourceGroupName, circuitName, peeringName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(resourceGroupName, circuitName, peeringName, options, optionalCallback); + } + } + /** * Deletes the specified Express Route Circuit Connection from the specified * express route circuit. @@ -1337,6 +1712,93 @@ class ExpressRouteCircuitConnections { } } + /** + * Gets all global reach connections associated with a private peering in an + * express route circuit. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listNext(nextPageLink, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets all global reach connections associated with a private peering in an + * express route circuit. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {ExpressRouteCircuitConnectionListResult} - 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 ExpressRouteCircuitConnectionListResult} 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. + */ + listNext(nextPageLink, 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._listNext(nextPageLink, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listNext(nextPageLink, options, optionalCallback); + } + } + } module.exports = ExpressRouteCircuitConnections; diff --git a/lib/services/networkManagement2/lib/operations/expressRouteCircuitPeerings.js b/lib/services/networkManagement2/lib/operations/expressRouteCircuitPeerings.js index d45c5ddcf2..1dd8a495d4 100644 --- a/lib/services/networkManagement2/lib/operations/expressRouteCircuitPeerings.js +++ b/lib/services/networkManagement2/lib/operations/expressRouteCircuitPeerings.js @@ -117,7 +117,7 @@ function _get(resourceGroupName, circuitName, peeringName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -479,7 +479,7 @@ function _list(resourceGroupName, circuitName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -623,7 +623,7 @@ function _beginDeleteMethod(resourceGroupName, circuitName, peeringName, options if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -889,7 +889,7 @@ function _beginCreateOrUpdate(resourceGroupName, circuitName, peeringName, peeri if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRouteCircuits.js b/lib/services/networkManagement2/lib/operations/expressRouteCircuits.js index dd4725baf6..c33b5478e4 100644 --- a/lib/services/networkManagement2/lib/operations/expressRouteCircuits.js +++ b/lib/services/networkManagement2/lib/operations/expressRouteCircuits.js @@ -112,7 +112,7 @@ function _get(resourceGroupName, circuitName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -741,7 +741,7 @@ function _getStats(resourceGroupName, circuitName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -887,7 +887,7 @@ function _getPeeringStats(resourceGroupName, circuitName, peeringName, options, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1033,7 +1033,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1169,7 +1169,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1303,7 +1303,7 @@ function _beginDeleteMethod(resourceGroupName, circuitName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1500,7 +1500,7 @@ function _beginCreateOrUpdate(resourceGroupName, circuitName, parameters, option if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1682,7 +1682,7 @@ function _beginUpdateTags(resourceGroupName, circuitName, parameters, options, c if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1848,7 +1848,7 @@ function _beginListArpTable(resourceGroupName, circuitName, peeringName, deviceP if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2005,7 +2005,7 @@ function _beginListRoutesTable(resourceGroupName, circuitName, peeringName, devi if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2163,7 +2163,7 @@ function _beginListRoutesTableSummary(resourceGroupName, circuitName, peeringNam if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRouteConnections.js b/lib/services/networkManagement2/lib/operations/expressRouteConnections.js index d1c1042c3e..46537277c1 100644 --- a/lib/services/networkManagement2/lib/operations/expressRouteConnections.js +++ b/lib/services/networkManagement2/lib/operations/expressRouteConnections.js @@ -158,7 +158,7 @@ function _get(resourceGroupName, expressRouteGatewayName, connectionName, option if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -373,7 +373,7 @@ function _list(resourceGroupName, expressRouteGatewayName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -543,7 +543,7 @@ function _beginCreateOrUpdate(resourceGroupName, expressRouteGatewayName, connec if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -726,7 +726,7 @@ function _beginDeleteMethod(resourceGroupName, expressRouteGatewayName, connecti if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRouteCrossConnectionPeerings.js b/lib/services/networkManagement2/lib/operations/expressRouteCrossConnectionPeerings.js index fbc867ff48..6b95dfb5c9 100644 --- a/lib/services/networkManagement2/lib/operations/expressRouteCrossConnectionPeerings.js +++ b/lib/services/networkManagement2/lib/operations/expressRouteCrossConnectionPeerings.js @@ -51,7 +51,7 @@ function _list(resourceGroupName, crossConnectionName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -264,7 +264,7 @@ function _get(resourceGroupName, crossConnectionName, peeringName, options, call if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -595,7 +595,7 @@ function _beginDeleteMethod(resourceGroupName, crossConnectionName, peeringName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -829,7 +829,7 @@ function _beginCreateOrUpdate(resourceGroupName, crossConnectionName, peeringNam if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRouteCrossConnections.js b/lib/services/networkManagement2/lib/operations/expressRouteCrossConnections.js index 84edc12ba7..6091982c69 100644 --- a/lib/services/networkManagement2/lib/operations/expressRouteCrossConnections.js +++ b/lib/services/networkManagement2/lib/operations/expressRouteCrossConnections.js @@ -46,7 +46,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -180,7 +180,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -322,7 +322,7 @@ function _get(resourceGroupName, crossConnectionName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -947,7 +947,7 @@ function _beginCreateOrUpdate(resourceGroupName, crossConnectionName, parameters if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1113,7 +1113,7 @@ function _beginUpdateTags(resourceGroupName, crossConnectionName, crossConnectio if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1280,7 +1280,7 @@ function _beginListArpTable(resourceGroupName, crossConnectionName, peeringName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1439,7 +1439,7 @@ function _beginListRoutesTableSummary(resourceGroupName, crossConnectionName, pe if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1597,7 +1597,7 @@ function _beginListRoutesTable(resourceGroupName, crossConnectionName, peeringNa if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRouteGateways.js b/lib/services/networkManagement2/lib/operations/expressRouteGateways.js index 60ccff7a15..21a00d5b36 100644 --- a/lib/services/networkManagement2/lib/operations/expressRouteGateways.js +++ b/lib/services/networkManagement2/lib/operations/expressRouteGateways.js @@ -46,7 +46,7 @@ function _listBySubscription(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -180,7 +180,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -432,7 +432,7 @@ function _get(resourceGroupName, expressRouteGatewayName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -675,7 +675,7 @@ function _beginCreateOrUpdate(resourceGroupName, expressRouteGatewayName, putExp if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -854,7 +854,7 @@ function _beginDeleteMethod(resourceGroupName, expressRouteGatewayName, options, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRouteLinks.js b/lib/services/networkManagement2/lib/operations/expressRouteLinks.js index 49202bd2ce..a3e698b8e1 100644 --- a/lib/services/networkManagement2/lib/operations/expressRouteLinks.js +++ b/lib/services/networkManagement2/lib/operations/expressRouteLinks.js @@ -52,7 +52,7 @@ function _get(resourceGroupName, expressRoutePortName, linkName, options, callba if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -202,7 +202,7 @@ function _list(resourceGroupName, expressRoutePortName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRoutePorts.js b/lib/services/networkManagement2/lib/operations/expressRoutePorts.js index f8d545888c..2b78ede842 100644 --- a/lib/services/networkManagement2/lib/operations/expressRoutePorts.js +++ b/lib/services/networkManagement2/lib/operations/expressRoutePorts.js @@ -113,7 +113,7 @@ function _get(resourceGroupName, expressRoutePortName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -442,7 +442,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -578,7 +578,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -713,7 +713,7 @@ function _beginDeleteMethod(resourceGroupName, expressRoutePortName, options, ca if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -864,7 +864,7 @@ function _beginCreateOrUpdate(resourceGroupName, expressRoutePortName, parameter if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1047,7 +1047,7 @@ function _beginUpdateTags(resourceGroupName, expressRoutePortName, parameters, o if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRoutePortsLocations.js b/lib/services/networkManagement2/lib/operations/expressRoutePortsLocations.js index f84b4bde25..d947f57ec5 100644 --- a/lib/services/networkManagement2/lib/operations/expressRoutePortsLocations.js +++ b/lib/services/networkManagement2/lib/operations/expressRoutePortsLocations.js @@ -48,7 +48,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -184,7 +184,7 @@ function _get(locationName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/expressRouteServiceProviders.js b/lib/services/networkManagement2/lib/operations/expressRouteServiceProviders.js index 695f5b31cb..8a848a5f78 100644 --- a/lib/services/networkManagement2/lib/operations/expressRouteServiceProviders.js +++ b/lib/services/networkManagement2/lib/operations/expressRouteServiceProviders.js @@ -46,7 +46,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/hubVirtualNetworkConnections.js b/lib/services/networkManagement2/lib/operations/hubVirtualNetworkConnections.js index 0de69c288d..5940773bc1 100644 --- a/lib/services/networkManagement2/lib/operations/hubVirtualNetworkConnections.js +++ b/lib/services/networkManagement2/lib/operations/hubVirtualNetworkConnections.js @@ -52,7 +52,7 @@ function _get(resourceGroupName, virtualHubName, connectionName, options, callba if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -201,7 +201,7 @@ function _list(resourceGroupName, virtualHubName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/inboundNatRules.js b/lib/services/networkManagement2/lib/operations/inboundNatRules.js index a3ad71fefd..e06bd3730f 100644 --- a/lib/services/networkManagement2/lib/operations/inboundNatRules.js +++ b/lib/services/networkManagement2/lib/operations/inboundNatRules.js @@ -50,7 +50,7 @@ function _list(resourceGroupName, loadBalancerName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -263,7 +263,7 @@ function _get(resourceGroupName, loadBalancerName, inboundNatRuleName, options, throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -544,7 +544,7 @@ function _beginDeleteMethod(resourceGroupName, loadBalancerName, inboundNatRuleN if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -723,7 +723,7 @@ function _beginCreateOrUpdate(resourceGroupName, loadBalancerName, inboundNatRul if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/index.d.ts b/lib/services/networkManagement2/lib/operations/index.d.ts index 640408d25d..d9ff0d7af2 100644 --- a/lib/services/networkManagement2/lib/operations/index.d.ts +++ b/lib/services/networkManagement2/lib/operations/index.d.ts @@ -216,6 +216,9 @@ export interface ApplicationGateways { * @param {array} [parameters.requestRoutingRules] Request routing rules of the * application gateway resource. * + * @param {array} [parameters.rewriteRuleSets] Rewrite rules for the + * application gateway resource. + * * @param {array} [parameters.redirectConfigurations] Redirect configurations * of the application gateway resource. * @@ -287,6 +290,21 @@ export interface ApplicationGateways { * @param {array} [parameters.zones] A list of availability zones denoting * where the resource needs to come from. * + * @param {object} [parameters.identity] The identity of the application + * gateway, if configured. + * + * @param {string} [parameters.identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values + * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + * + * @param {object} [parameters.identity.userAssignedIdentities] The list of + * user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + * * @param {string} [parameters.id] Resource ID. * * @param {string} [parameters.location] Resource location. @@ -384,6 +402,9 @@ export interface ApplicationGateways { * @param {array} [parameters.requestRoutingRules] Request routing rules of the * application gateway resource. * + * @param {array} [parameters.rewriteRuleSets] Rewrite rules for the + * application gateway resource. + * * @param {array} [parameters.redirectConfigurations] Redirect configurations * of the application gateway resource. * @@ -455,6 +476,21 @@ export interface ApplicationGateways { * @param {array} [parameters.zones] A list of availability zones denoting * where the resource needs to come from. * + * @param {object} [parameters.identity] The identity of the application + * gateway, if configured. + * + * @param {string} [parameters.identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values + * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + * + * @param {object} [parameters.identity.userAssignedIdentities] The list of + * user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + * * @param {string} [parameters.id] Resource ID. * * @param {string} [parameters.location] Resource location. @@ -1204,6 +1240,9 @@ export interface ApplicationGateways { * @param {array} [parameters.requestRoutingRules] Request routing rules of the * application gateway resource. * + * @param {array} [parameters.rewriteRuleSets] Rewrite rules for the + * application gateway resource. + * * @param {array} [parameters.redirectConfigurations] Redirect configurations * of the application gateway resource. * @@ -1275,6 +1314,21 @@ export interface ApplicationGateways { * @param {array} [parameters.zones] A list of availability zones denoting * where the resource needs to come from. * + * @param {object} [parameters.identity] The identity of the application + * gateway, if configured. + * + * @param {string} [parameters.identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values + * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + * + * @param {object} [parameters.identity.userAssignedIdentities] The list of + * user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + * * @param {string} [parameters.id] Resource ID. * * @param {string} [parameters.location] Resource location. @@ -1372,6 +1426,9 @@ export interface ApplicationGateways { * @param {array} [parameters.requestRoutingRules] Request routing rules of the * application gateway resource. * + * @param {array} [parameters.rewriteRuleSets] Rewrite rules for the + * application gateway resource. + * * @param {array} [parameters.redirectConfigurations] Redirect configurations * of the application gateway resource. * @@ -1443,6 +1500,21 @@ export interface ApplicationGateways { * @param {array} [parameters.zones] A list of availability zones denoting * where the resource needs to come from. * + * @param {object} [parameters.identity] The identity of the application + * gateway, if configured. + * + * @param {string} [parameters.identity.type] The type of identity used for the + * resource. The type 'SystemAssigned, UserAssigned' includes both an + * implicitly created identity and a set of user assigned identities. The type + * 'None' will remove any identities from the virtual machine. Possible values + * include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', + * 'None' + * + * @param {object} [parameters.identity.userAssignedIdentities] The list of + * user identities associated with resource. The user identity dictionary key + * references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + * * @param {string} [parameters.id] Resource ID. * * @param {string} [parameters.location] Resource location. @@ -5947,6 +6019,72 @@ export interface ExpressRouteCircuitConnections { createOrUpdate(resourceGroupName: string, circuitName: string, peeringName: string, connectionName: string, expressRouteCircuitConnectionParameters: models.ExpressRouteCircuitConnection, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + /** + * Gets all global reach connections associated with a private peering in an + * express route circuit. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} circuitName The name of the circuit. + * + * @param {string} peeringName The name of the peering. + * + * @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. + */ + listWithHttpOperationResponse(resourceGroupName: string, circuitName: string, peeringName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all global reach connections associated with a private peering in an + * express route circuit. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} circuitName The name of the circuit. + * + * @param {string} peeringName The name of the peering. + * + * @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 {ExpressRouteCircuitConnectionListResult} - 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. + * + * {ExpressRouteCircuitConnectionListResult} [result] - The deserialized result object if an error did not occur. + * See {@link ExpressRouteCircuitConnectionListResult} 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. + */ + list(resourceGroupName: string, circuitName: string, peeringName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(resourceGroupName: string, circuitName: string, peeringName: string, callback: ServiceCallback): void; + list(resourceGroupName: string, circuitName: string, peeringName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + /** * Deletes the specified Express Route Circuit Connection from the specified * express route circuit. @@ -6145,23 +6283,14 @@ export interface ExpressRouteCircuitConnections { beginCreateOrUpdate(resourceGroupName: string, circuitName: string, peeringName: string, connectionName: string, expressRouteCircuitConnectionParameters: models.ExpressRouteCircuitConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; beginCreateOrUpdate(resourceGroupName: string, circuitName: string, peeringName: string, connectionName: string, expressRouteCircuitConnectionParameters: models.ExpressRouteCircuitConnection, callback: ServiceCallback): void; beginCreateOrUpdate(resourceGroupName: string, circuitName: string, peeringName: string, connectionName: string, expressRouteCircuitConnectionParameters: models.ExpressRouteCircuitConnection, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; -} - -/** - * @class - * ExpressRouteCircuits - * __NOTE__: An instance of this class is automatically created for an - * instance of the NetworkManagementClient. - */ -export interface ExpressRouteCircuits { /** - * Deletes the specified express route circuit. - * - * @param {string} resourceGroupName The name of the resource group. + * Gets all global reach connections associated with a private peering in an + * express route circuit. * - * @param {string} circuitName The name of the express route circuit. + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. * * @param {object} [options] Optional Parameters. * @@ -6170,18 +6299,18 @@ export interface ExpressRouteCircuits { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - deleteMethodWithHttpOperationResponse(resourceGroupName: string, circuitName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Deletes the specified express route circuit. - * - * @param {string} resourceGroupName The name of the resource group. + * Gets all global reach connections associated with a private peering in an + * express route circuit. * - * @param {string} circuitName The name of the express route circuit. + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. * * @param {object} [options] Optional Parameters. * @@ -6195,7 +6324,7 @@ export interface ExpressRouteCircuits { * * {Promise} A promise is returned. * - * @resolve {null} - The deserialized result object. + * @resolve {ExpressRouteCircuitConnectionListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -6203,23 +6332,34 @@ export interface ExpressRouteCircuits { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {null} [result] - The deserialized result object if an error did not occur. + * {ExpressRouteCircuitConnectionListResult} [result] - The deserialized result object if an error did not occur. + * See {@link ExpressRouteCircuitConnectionListResult} 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. */ - deleteMethod(resourceGroupName: string, circuitName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - deleteMethod(resourceGroupName: string, circuitName: string, callback: ServiceCallback): void; - deleteMethod(resourceGroupName: string, circuitName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * ExpressRouteCircuits + * __NOTE__: An instance of this class is automatically created for an + * instance of the NetworkManagementClient. + */ +export interface ExpressRouteCircuits { /** - * Gets information about the specified express route circuit. + * Deletes the specified express route circuit. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} circuitName The name of express route circuit. + * @param {string} circuitName The name of the express route circuit. * * @param {object} [options] Optional Parameters. * @@ -6228,18 +6368,18 @@ export interface ExpressRouteCircuits { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - getWithHttpOperationResponse(resourceGroupName: string, circuitName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + deleteMethodWithHttpOperationResponse(resourceGroupName: string, circuitName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets information about the specified express route circuit. + * Deletes the specified express route circuit. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} circuitName The name of express route circuit. + * @param {string} circuitName The name of the express route circuit. * * @param {object} [options] Optional Parameters. * @@ -6253,7 +6393,7 @@ export interface ExpressRouteCircuits { * * {Promise} A promise is returned. * - * @resolve {ExpressRouteCircuit} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -6261,95 +6401,23 @@ export interface ExpressRouteCircuits { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {ExpressRouteCircuit} [result] - The deserialized result object if an error did not occur. - * See {@link ExpressRouteCircuit} for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {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. */ - get(resourceGroupName: string, circuitName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - get(resourceGroupName: string, circuitName: string, callback: ServiceCallback): void; - get(resourceGroupName: string, circuitName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, circuitName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, circuitName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, circuitName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Creates or updates an express route circuit. + * Gets information about the specified express route circuit. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} circuitName The name of the circuit. - * - * @param {object} parameters Parameters supplied to the create or update - * express route circuit operation. - * - * @param {object} [parameters.sku] The SKU. - * - * @param {string} [parameters.sku.name] The name of the SKU. - * - * @param {string} [parameters.sku.tier] The tier of the SKU. Possible values - * are 'Standard', 'Premium' or 'Basic'. Possible values include: 'Standard', - * 'Premium', 'Basic' - * - * @param {string} [parameters.sku.family] The family of the SKU. Possible - * values are: 'UnlimitedData' and 'MeteredData'. Possible values include: - * 'UnlimitedData', 'MeteredData' - * - * @param {boolean} [parameters.allowClassicOperations] Allow classic - * operations - * - * @param {string} [parameters.circuitProvisioningState] The - * CircuitProvisioningState state of the resource. - * - * @param {string} [parameters.serviceProviderProvisioningState] The - * ServiceProviderProvisioningState state of the resource. Possible values are - * 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. - * Possible values include: 'NotProvisioned', 'Provisioning', 'Provisioned', - * 'Deprovisioning' - * - * @param {array} [parameters.authorizations] The list of authorizations. - * - * @param {array} [parameters.peerings] The list of peerings. - * - * @param {string} [parameters.serviceKey] The ServiceKey. - * - * @param {string} [parameters.serviceProviderNotes] The ServiceProviderNotes. - * - * @param {object} [parameters.serviceProviderProperties] The - * ServiceProviderProperties. - * - * @param {string} [parameters.serviceProviderProperties.serviceProviderName] - * The serviceProviderName. - * - * @param {string} [parameters.serviceProviderProperties.peeringLocation] The - * peering location. - * - * @param {number} [parameters.serviceProviderProperties.bandwidthInMbps] The - * BandwidthInMbps. - * - * @param {object} [parameters.expressRoutePort] The reference to the - * ExpressRoutePort resource when the circuit is provisioned on an - * ExpressRoutePort resource. - * - * @param {string} [parameters.expressRoutePort.id] Resource ID. - * - * @param {number} [parameters.bandwidthInGbps] The bandwidth of the circuit - * when the circuit is provisioned on an ExpressRoutePort resource. - * - * @param {string} [parameters.provisioningState] Gets the provisioning state - * of the public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * - * @param {string} [parameters.gatewayManagerEtag] The GatewayManager Etag. - * - * @param {boolean} [parameters.allowGlobalReach] Flag to enable Global Reach - * on the circuit. - * - * @param {string} [parameters.id] Resource ID. - * - * @param {string} [parameters.location] Resource location. - * - * @param {object} [parameters.tags] Resource tags. + * @param {string} circuitName The name of express route circuit. * * @param {object} [options] Optional Parameters. * @@ -6362,85 +6430,215 @@ export interface ExpressRouteCircuits { * * @reject {Error|ServiceError} - The error object. */ - createOrUpdateWithHttpOperationResponse(resourceGroupName: string, circuitName: string, parameters: models.ExpressRouteCircuit, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + getWithHttpOperationResponse(resourceGroupName: string, circuitName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Creates or updates an express route circuit. + * Gets information about the specified express route circuit. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} circuitName The name of the circuit. - * - * @param {object} parameters Parameters supplied to the create or update - * express route circuit operation. - * - * @param {object} [parameters.sku] The SKU. - * - * @param {string} [parameters.sku.name] The name of the SKU. - * - * @param {string} [parameters.sku.tier] The tier of the SKU. Possible values - * are 'Standard', 'Premium' or 'Basic'. Possible values include: 'Standard', - * 'Premium', 'Basic' - * - * @param {string} [parameters.sku.family] The family of the SKU. Possible - * values are: 'UnlimitedData' and 'MeteredData'. Possible values include: - * 'UnlimitedData', 'MeteredData' - * - * @param {boolean} [parameters.allowClassicOperations] Allow classic - * operations - * - * @param {string} [parameters.circuitProvisioningState] The - * CircuitProvisioningState state of the resource. - * - * @param {string} [parameters.serviceProviderProvisioningState] The - * ServiceProviderProvisioningState state of the resource. Possible values are - * 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. - * Possible values include: 'NotProvisioned', 'Provisioning', 'Provisioned', - * 'Deprovisioning' - * - * @param {array} [parameters.authorizations] The list of authorizations. - * - * @param {array} [parameters.peerings] The list of peerings. - * - * @param {string} [parameters.serviceKey] The ServiceKey. - * - * @param {string} [parameters.serviceProviderNotes] The ServiceProviderNotes. - * - * @param {object} [parameters.serviceProviderProperties] The - * ServiceProviderProperties. - * - * @param {string} [parameters.serviceProviderProperties.serviceProviderName] - * The serviceProviderName. - * - * @param {string} [parameters.serviceProviderProperties.peeringLocation] The - * peering location. - * - * @param {number} [parameters.serviceProviderProperties.bandwidthInMbps] The - * BandwidthInMbps. - * - * @param {object} [parameters.expressRoutePort] The reference to the - * ExpressRoutePort resource when the circuit is provisioned on an - * ExpressRoutePort resource. - * - * @param {string} [parameters.expressRoutePort.id] Resource ID. - * - * @param {number} [parameters.bandwidthInGbps] The bandwidth of the circuit - * when the circuit is provisioned on an ExpressRoutePort resource. - * - * @param {string} [parameters.provisioningState] Gets the provisioning state - * of the public IP resource. Possible values are: 'Updating', 'Deleting', and - * 'Failed'. - * - * @param {string} [parameters.gatewayManagerEtag] The GatewayManager Etag. - * - * @param {boolean} [parameters.allowGlobalReach] Flag to enable Global Reach - * on the circuit. - * - * @param {string} [parameters.id] Resource ID. - * - * @param {string} [parameters.location] Resource location. - * - * @param {object} [parameters.tags] Resource tags. + * @param {string} circuitName The name of express route circuit. + * + * @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 {ExpressRouteCircuit} - 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. + * + * {ExpressRouteCircuit} [result] - The deserialized result object if an error did not occur. + * See {@link ExpressRouteCircuit} 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. + */ + get(resourceGroupName: string, circuitName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, circuitName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, circuitName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates an express route circuit. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} circuitName The name of the circuit. + * + * @param {object} parameters Parameters supplied to the create or update + * express route circuit operation. + * + * @param {object} [parameters.sku] The SKU. + * + * @param {string} [parameters.sku.name] The name of the SKU. + * + * @param {string} [parameters.sku.tier] The tier of the SKU. Possible values + * are 'Standard', 'Premium' or 'Basic'. Possible values include: 'Standard', + * 'Premium', 'Basic' + * + * @param {string} [parameters.sku.family] The family of the SKU. Possible + * values are: 'UnlimitedData' and 'MeteredData'. Possible values include: + * 'UnlimitedData', 'MeteredData' + * + * @param {boolean} [parameters.allowClassicOperations] Allow classic + * operations + * + * @param {string} [parameters.circuitProvisioningState] The + * CircuitProvisioningState state of the resource. + * + * @param {string} [parameters.serviceProviderProvisioningState] The + * ServiceProviderProvisioningState state of the resource. Possible values are + * 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. + * Possible values include: 'NotProvisioned', 'Provisioning', 'Provisioned', + * 'Deprovisioning' + * + * @param {array} [parameters.authorizations] The list of authorizations. + * + * @param {array} [parameters.peerings] The list of peerings. + * + * @param {string} [parameters.serviceKey] The ServiceKey. + * + * @param {string} [parameters.serviceProviderNotes] The ServiceProviderNotes. + * + * @param {object} [parameters.serviceProviderProperties] The + * ServiceProviderProperties. + * + * @param {string} [parameters.serviceProviderProperties.serviceProviderName] + * The serviceProviderName. + * + * @param {string} [parameters.serviceProviderProperties.peeringLocation] The + * peering location. + * + * @param {number} [parameters.serviceProviderProperties.bandwidthInMbps] The + * BandwidthInMbps. + * + * @param {object} [parameters.expressRoutePort] The reference to the + * ExpressRoutePort resource when the circuit is provisioned on an + * ExpressRoutePort resource. + * + * @param {string} [parameters.expressRoutePort.id] Resource ID. + * + * @param {number} [parameters.bandwidthInGbps] The bandwidth of the circuit + * when the circuit is provisioned on an ExpressRoutePort resource. + * + * @param {string} [parameters.provisioningState] Gets the provisioning state + * of the public IP resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + * + * @param {string} [parameters.gatewayManagerEtag] The GatewayManager Etag. + * + * @param {boolean} [parameters.allowGlobalReach] Flag to enable Global Reach + * on the circuit. + * + * @param {string} [parameters.id] Resource ID. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, circuitName: string, parameters: models.ExpressRouteCircuit, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates an express route circuit. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} circuitName The name of the circuit. + * + * @param {object} parameters Parameters supplied to the create or update + * express route circuit operation. + * + * @param {object} [parameters.sku] The SKU. + * + * @param {string} [parameters.sku.name] The name of the SKU. + * + * @param {string} [parameters.sku.tier] The tier of the SKU. Possible values + * are 'Standard', 'Premium' or 'Basic'. Possible values include: 'Standard', + * 'Premium', 'Basic' + * + * @param {string} [parameters.sku.family] The family of the SKU. Possible + * values are: 'UnlimitedData' and 'MeteredData'. Possible values include: + * 'UnlimitedData', 'MeteredData' + * + * @param {boolean} [parameters.allowClassicOperations] Allow classic + * operations + * + * @param {string} [parameters.circuitProvisioningState] The + * CircuitProvisioningState state of the resource. + * + * @param {string} [parameters.serviceProviderProvisioningState] The + * ServiceProviderProvisioningState state of the resource. Possible values are + * 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. + * Possible values include: 'NotProvisioned', 'Provisioning', 'Provisioned', + * 'Deprovisioning' + * + * @param {array} [parameters.authorizations] The list of authorizations. + * + * @param {array} [parameters.peerings] The list of peerings. + * + * @param {string} [parameters.serviceKey] The ServiceKey. + * + * @param {string} [parameters.serviceProviderNotes] The ServiceProviderNotes. + * + * @param {object} [parameters.serviceProviderProperties] The + * ServiceProviderProperties. + * + * @param {string} [parameters.serviceProviderProperties.serviceProviderName] + * The serviceProviderName. + * + * @param {string} [parameters.serviceProviderProperties.peeringLocation] The + * peering location. + * + * @param {number} [parameters.serviceProviderProperties.bandwidthInMbps] The + * BandwidthInMbps. + * + * @param {object} [parameters.expressRoutePort] The reference to the + * ExpressRoutePort resource when the circuit is provisioned on an + * ExpressRoutePort resource. + * + * @param {string} [parameters.expressRoutePort.id] Resource ID. + * + * @param {number} [parameters.bandwidthInGbps] The bandwidth of the circuit + * when the circuit is provisioned on an ExpressRoutePort resource. + * + * @param {string} [parameters.provisioningState] Gets the provisioning state + * of the public IP resource. Possible values are: 'Updating', 'Deleting', and + * 'Failed'. + * + * @param {string} [parameters.gatewayManagerEtag] The GatewayManager Etag. + * + * @param {boolean} [parameters.allowGlobalReach] Flag to enable Global Reach + * on the circuit. + * + * @param {string} [parameters.id] Resource ID. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -22676,67 +22874,13 @@ export interface NetworkWatchers { * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable * retention. * - * @param {object} [parameters.flowAnalyticsConfiguration] + * @param {object} [parameters.format] * - * @param {object} - * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration - * - * @param {boolean} - * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.enabled - * Flag to enable/disable traffic analytics. - * - * @param {string} - * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceId - * The resource guid of the attached workspace + * @param {string} [parameters.format.type] The file type of flow log. Possible + * values include: 'JSON' * - * @param {string} - * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceRegion - * The location of the attached workspace - * - * @param {string} - * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId - * Resource Id of the attached workspace - * - * @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. - */ - setFlowLogConfigurationWithHttpOperationResponse(resourceGroupName: string, networkWatcherName: string, parameters: models.FlowLogInformation, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Configures flow log and traffic analytics (optional) on a specified - * resource. - * - * @param {string} resourceGroupName The name of the network watcher resource - * group. - * - * @param {string} networkWatcherName The name of the network watcher resource. - * - * @param {object} parameters Parameters that define the configuration of flow - * log. - * - * @param {string} parameters.targetResourceId The ID of the resource to - * configure for flow log and traffic analytics (optional) . - * - * @param {string} parameters.storageId ID of the storage account which is used - * to store the flow log. - * - * @param {boolean} parameters.enabled Flag to enable/disable flow logging. - * - * @param {object} [parameters.retentionPolicy] - * - * @param {number} [parameters.retentionPolicy.days] Number of days to retain - * flow log records. - * - * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable - * retention. + * @param {number} [parameters.format.version] The version (revision) of the + * flow log. * * @param {object} [parameters.flowAnalyticsConfiguration] * @@ -22759,6 +22903,86 @@ export interface NetworkWatchers { * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId * Resource Id of the attached workspace * + * @param {number} + * [parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service should + * do flow analytics + * + * @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. + */ + setFlowLogConfigurationWithHttpOperationResponse(resourceGroupName: string, networkWatcherName: string, parameters: models.FlowLogInformation, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Configures flow log and traffic analytics (optional) on a specified + * resource. + * + * @param {string} resourceGroupName The name of the network watcher resource + * group. + * + * @param {string} networkWatcherName The name of the network watcher resource. + * + * @param {object} parameters Parameters that define the configuration of flow + * log. + * + * @param {string} parameters.targetResourceId The ID of the resource to + * configure for flow log and traffic analytics (optional) . + * + * @param {string} parameters.storageId ID of the storage account which is used + * to store the flow log. + * + * @param {boolean} parameters.enabled Flag to enable/disable flow logging. + * + * @param {object} [parameters.retentionPolicy] + * + * @param {number} [parameters.retentionPolicy.days] Number of days to retain + * flow log records. + * + * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable + * retention. + * + * @param {object} [parameters.format] + * + * @param {string} [parameters.format.type] The file type of flow log. Possible + * values include: 'JSON' + * + * @param {number} [parameters.format.version] The version (revision) of the + * flow log. + * + * @param {object} [parameters.flowAnalyticsConfiguration] + * + * @param {object} + * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration + * + * @param {boolean} + * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.enabled + * Flag to enable/disable traffic analytics. + * + * @param {string} + * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceId + * The resource guid of the attached workspace + * + * @param {string} + * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceRegion + * The location of the attached workspace + * + * @param {string} + * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId + * Resource Id of the attached workspace + * + * @param {number} + * [parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service should + * do flow analytics + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -23815,6 +24039,14 @@ export interface NetworkWatchers { * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable * retention. * + * @param {object} [parameters.format] + * + * @param {string} [parameters.format.type] The file type of flow log. Possible + * values include: 'JSON' + * + * @param {number} [parameters.format.version] The version (revision) of the + * flow log. + * * @param {object} [parameters.flowAnalyticsConfiguration] * * @param {object} @@ -23836,6 +24068,11 @@ export interface NetworkWatchers { * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId * Resource Id of the attached workspace * + * @param {number} + * [parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service should + * do flow analytics + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -23877,6 +24114,14 @@ export interface NetworkWatchers { * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable * retention. * + * @param {object} [parameters.format] + * + * @param {string} [parameters.format.type] The file type of flow log. Possible + * values include: 'JSON' + * + * @param {number} [parameters.format.version] The version (revision) of the + * flow log. + * * @param {object} [parameters.flowAnalyticsConfiguration] * * @param {object} @@ -23898,6 +24143,11 @@ export interface NetworkWatchers { * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId * Resource Id of the attached workspace * + * @param {number} + * [parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service should + * do flow analytics + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -35123,19 +35373,340 @@ export interface VirtualNetworkPeerings { /** * @class - * VirtualNetworkTaps + * VirtualNetworkGateways * __NOTE__: An instance of this class is automatically created for an * instance of the NetworkManagementClient. */ -export interface VirtualNetworkTaps { +export interface VirtualNetworkGateways { /** - * Deletes the specified virtual network tap. + * Creates or updates a virtual network gateway in the specified resource + * group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of the virtual network tap. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @param {object} parameters Parameters supplied to create or update virtual + * network gateway operation. + * + * @param {array} [parameters.ipConfigurations] IP configurations for virtual + * network gateway. + * + * @param {string} [parameters.gatewayType] The type of this virtual network + * gateway. Possible values are: 'Vpn' and 'ExpressRoute'. Possible values + * include: 'Vpn', 'ExpressRoute' + * + * @param {string} [parameters.vpnType] The type of this virtual network + * gateway. Possible values are: 'PolicyBased' and 'RouteBased'. Possible + * values include: 'PolicyBased', 'RouteBased' + * + * @param {boolean} [parameters.enableBgp] Whether BGP is enabled for this + * virtual network gateway or not. + * + * @param {boolean} [parameters.activeActive] ActiveActive flag + * + * @param {object} [parameters.gatewayDefaultSite] The reference of the + * LocalNetworkGateway resource which represents local network site having + * default routes. Assign Null value in case of removing existing default site + * setting. + * + * @param {string} [parameters.gatewayDefaultSite.id] Resource ID. + * + * @param {object} [parameters.sku] The reference of the + * VirtualNetworkGatewaySku resource which represents the SKU selected for + * Virtual network gateway. + * + * @param {string} [parameters.sku.name] Gateway SKU name. Possible values + * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', + * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', + * 'ErGw2AZ', 'ErGw3AZ' + * + * @param {string} [parameters.sku.tier] Gateway SKU tier. Possible values + * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', + * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', + * 'ErGw2AZ', 'ErGw3AZ' + * + * @param {number} [parameters.sku.capacity] The capacity. + * + * @param {object} [parameters.vpnClientConfiguration] The reference of the + * VpnClientConfiguration resource which represents the P2S VpnClient + * configurations. + * + * @param {object} [parameters.vpnClientConfiguration.vpnClientAddressPool] The + * reference of the address space resource which represents Address space for + * P2S VpnClient. + * + * @param {array} + * [parameters.vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] A + * list of address blocks reserved for this virtual network in CIDR notation. + * + * @param {array} [parameters.vpnClientConfiguration.vpnClientRootCertificates] + * VpnClientRootCertificate for virtual network gateway. + * + * @param {array} + * [parameters.vpnClientConfiguration.vpnClientRevokedCertificates] + * VpnClientRevokedCertificate for Virtual network gateway. + * + * @param {array} [parameters.vpnClientConfiguration.vpnClientProtocols] + * VpnClientProtocols for Virtual network gateway. + * + * @param {array} [parameters.vpnClientConfiguration.vpnClientIpsecPolicies] + * VpnClientIpsecPolicies for virtual network gateway P2S client. + * + * @param {string} [parameters.vpnClientConfiguration.radiusServerAddress] The + * radius server address property of the VirtualNetworkGateway resource for vpn + * client connection. + * + * @param {string} [parameters.vpnClientConfiguration.radiusServerSecret] The + * radius secret property of the VirtualNetworkGateway resource for vpn client + * connection. + * + * @param {object} [parameters.bgpSettings] Virtual network gateway's BGP + * speaker settings. + * + * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * + * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering + * address and BGP identifier of this BGP speaker. + * + * @param {number} [parameters.bgpSettings.peerWeight] The weight added to + * routes learned from this BGP speaker. + * + * @param {string} [parameters.resourceGuid] The resource GUID property of the + * VirtualNetworkGateway resource. + * + * @param {string} [parameters.etag] Gets a unique read-only string that + * changes whenever the resource is updated. + * + * @param {string} [parameters.id] Resource ID. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a virtual network gateway in the specified resource + * group. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @param {object} parameters Parameters supplied to create or update virtual + * network gateway operation. + * + * @param {array} [parameters.ipConfigurations] IP configurations for virtual + * network gateway. + * + * @param {string} [parameters.gatewayType] The type of this virtual network + * gateway. Possible values are: 'Vpn' and 'ExpressRoute'. Possible values + * include: 'Vpn', 'ExpressRoute' + * + * @param {string} [parameters.vpnType] The type of this virtual network + * gateway. Possible values are: 'PolicyBased' and 'RouteBased'. Possible + * values include: 'PolicyBased', 'RouteBased' + * + * @param {boolean} [parameters.enableBgp] Whether BGP is enabled for this + * virtual network gateway or not. + * + * @param {boolean} [parameters.activeActive] ActiveActive flag + * + * @param {object} [parameters.gatewayDefaultSite] The reference of the + * LocalNetworkGateway resource which represents local network site having + * default routes. Assign Null value in case of removing existing default site + * setting. + * + * @param {string} [parameters.gatewayDefaultSite.id] Resource ID. + * + * @param {object} [parameters.sku] The reference of the + * VirtualNetworkGatewaySku resource which represents the SKU selected for + * Virtual network gateway. + * + * @param {string} [parameters.sku.name] Gateway SKU name. Possible values + * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', + * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', + * 'ErGw2AZ', 'ErGw3AZ' + * + * @param {string} [parameters.sku.tier] Gateway SKU tier. Possible values + * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', + * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', + * 'ErGw2AZ', 'ErGw3AZ' + * + * @param {number} [parameters.sku.capacity] The capacity. + * + * @param {object} [parameters.vpnClientConfiguration] The reference of the + * VpnClientConfiguration resource which represents the P2S VpnClient + * configurations. + * + * @param {object} [parameters.vpnClientConfiguration.vpnClientAddressPool] The + * reference of the address space resource which represents Address space for + * P2S VpnClient. + * + * @param {array} + * [parameters.vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] A + * list of address blocks reserved for this virtual network in CIDR notation. + * + * @param {array} [parameters.vpnClientConfiguration.vpnClientRootCertificates] + * VpnClientRootCertificate for virtual network gateway. + * + * @param {array} + * [parameters.vpnClientConfiguration.vpnClientRevokedCertificates] + * VpnClientRevokedCertificate for Virtual network gateway. + * + * @param {array} [parameters.vpnClientConfiguration.vpnClientProtocols] + * VpnClientProtocols for Virtual network gateway. + * + * @param {array} [parameters.vpnClientConfiguration.vpnClientIpsecPolicies] + * VpnClientIpsecPolicies for virtual network gateway P2S client. + * + * @param {string} [parameters.vpnClientConfiguration.radiusServerAddress] The + * radius server address property of the VirtualNetworkGateway resource for vpn + * client connection. + * + * @param {string} [parameters.vpnClientConfiguration.radiusServerSecret] The + * radius secret property of the VirtualNetworkGateway resource for vpn client + * connection. + * + * @param {object} [parameters.bgpSettings] Virtual network gateway's BGP + * speaker settings. + * + * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * + * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering + * address and BGP identifier of this BGP speaker. + * + * @param {number} [parameters.bgpSettings.peerWeight] The weight added to + * routes learned from this BGP speaker. + * + * @param {string} [parameters.resourceGuid] The resource GUID property of the + * VirtualNetworkGateway resource. + * + * @param {string} [parameters.etag] Gets a unique read-only string that + * changes whenever the resource is updated. + * + * @param {string} [parameters.id] Resource ID. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {VirtualNetworkGateway} - 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. + * + * {VirtualNetworkGateway} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGateway} 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. + */ + createOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets the specified virtual network gateway by resource group. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets the specified virtual network gateway by resource group. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @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 {VirtualNetworkGateway} - 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. + * + * {VirtualNetworkGateway} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGateway} 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. + */ + get(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes the specified virtual network gateway. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * * @param {object} [options] Optional Parameters. * @@ -35148,14 +35719,15 @@ export interface VirtualNetworkTaps { * * @reject {Error|ServiceError} - The error object. */ - deleteMethodWithHttpOperationResponse(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + deleteMethodWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Deletes the specified virtual network tap. + * Deletes the specified virtual network gateway. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of the virtual network tap. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * * @param {object} [options] Optional Parameters. * @@ -35183,17 +35755,23 @@ export interface VirtualNetworkTaps { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - deleteMethod(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - deleteMethod(resourceGroupName: string, tapName: string, callback: ServiceCallback): void; - deleteMethod(resourceGroupName: string, tapName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Gets information about the specified virtual network tap. + * Updates a virtual network gateway tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of virtual network tap. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @param {object} parameters Parameters supplied to update virtual network + * gateway tags. + * + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -35202,18 +35780,24 @@ export interface VirtualNetworkTaps { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - getWithHttpOperationResponse(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + updateTagsWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets information about the specified virtual network tap. + * Updates a virtual network gateway tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of virtual network tap. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @param {object} parameters Parameters supplied to update virtual network + * gateway tags. + * + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -35227,7 +35811,7 @@ export interface VirtualNetworkTaps { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkTap} - The deserialized result object. + * @resolve {VirtualNetworkGateway} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -35235,364 +35819,295 @@ export interface VirtualNetworkTaps { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkTap} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkTap} for more information. + * {VirtualNetworkGateway} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGateway} 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. */ - get(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - get(resourceGroupName: string, tapName: string, callback: ServiceCallback): void; - get(resourceGroupName: string, tapName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + updateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + updateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, callback: ServiceCallback): void; + updateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Creates or updates a Virtual Network Tap. + * Gets all virtual network gateways by resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of the virtual network tap. + * @param {object} [options] Optional Parameters. * - * @param {object} parameters Parameters supplied to the create or update - * virtual network tap operation. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {object} [parameters.destinationNetworkInterfaceIPConfiguration] The - * reference to the private IP Address of the collector nic that will receive - * the tap + * @returns {Promise} A promise is returned * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] - * The reference to Virtual Network Taps. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] - * The reference of ApplicationGatewayBackendAddressPool resource. + * @reject {Error|ServiceError} - The error object. + */ + listWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all virtual network gateways by resource group. * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] - * The reference of LoadBalancerBackendAddressPool resource. + * @param {string} resourceGroupName The name of the resource group. * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] - * A list of references of LoadBalancerInboundNatRules. + * @param {object} [options] Optional Parameters. * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddress] - * Private IP address of the IP configuration. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] - * Defines how a private IP address is assigned. Possible values are: 'Static' - * and 'Dynamic'. Possible values include: 'Static', 'Dynamic' + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] - * Available from Api-Version 2016-03-30 onwards, it represents whether the - * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. - * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', - * 'IPv6' + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @param {object} - * [parameters.destinationNetworkInterfaceIPConfiguration.subnet] Subnet bound - * to the IP configuration. + * {Promise} A promise is returned. * - * @param {boolean} - * [parameters.destinationNetworkInterfaceIPConfiguration.primary] Gets whether - * this is a primary customer address on the network interface. + * @resolve {VirtualNetworkGatewayListResult} - The deserialized result object. * - * @param {object} - * [parameters.destinationNetworkInterfaceIPConfiguration.publicIPAddress] - * Public IP address bound to the IP configuration. + * @reject {Error|ServiceError} - The error object. * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] - * Application security groups in which the IP configuration is included. + * {ServiceCallback} optionalCallback(err, result, request, response) * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.provisioningState] - * The provisioning state of the network interface IP configuration. Possible - * values are: 'Updating', 'Deleting', and 'Failed'. + * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. + * {VirtualNetworkGatewayListResult} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayListResult} for more + * information. * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.etag] - * A unique read-only string that changes whenever the resource is updated. + * {WebResource} [request] - The HTTP Request object if an error did not occur. * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.id] - * Resource ID. + * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. + */ + list(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(resourceGroupName: string, callback: ServiceCallback): void; + list(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets all the connections in a virtual network gateway. * - * @param {object} [parameters.destinationLoadBalancerFrontEndIPConfiguration] - * The reference to the private IP address on the internal Load Balancer that - * will receive the tap + * @param {string} resourceGroupName The name of the resource group. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] - * The private IP address of the IP configuration. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] - * The Private IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' + * @param {object} [options] Optional Parameters. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet] The - * reference of the subnet resource. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. + * @returns {Promise} A promise is returned * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. + * @reject {Error|ServiceError} - The error object. + */ + listConnectionsWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all the connections in a virtual network gateway. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. + * @param {string} resourceGroupName The name of the resource group. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. + * @param {object} [options] Optional Parameters. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.id] - * Resource ID. + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.location] - * Resource location. + * {Promise} A promise is returned. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.tags] - * Resource tags. + * @resolve {VirtualNetworkGatewayListConnectionsResult} - The deserialized result object. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. + * @reject {Error|ServiceError} - The error object. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. + * {ServiceCallback} optionalCallback(err, result, request, response) * - * @param {boolean} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. + * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. + * {VirtualNetworkGatewayListConnectionsResult} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayListConnectionsResult} + * for more information. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. + * {WebResource} [request] - The HTTP Request object if an error did not occur. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.id] - * Resource ID. + * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. + */ + listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Resets the primary of the virtual network gateway in the specified resource + * group. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.location] - * Resource location. + * @param {string} resourceGroupName The name of the resource group. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.tags] - * Resource tags. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. + * @param {object} [options] Optional Parameters. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. + * @param {string} [options.gatewayVip] Virtual network gateway vip address + * supplied to the begin reset of the active-active feature enabled gateway. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. + * @returns {Promise} A promise is returned * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] - * The provisioning state of the resource. + * @reject {Error|ServiceError} - The error object. + */ + resetWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Resets the primary of the virtual network gateway in the specified resource + * group. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.name] The - * name of the resource that is unique within a resource group. This name can - * be used to access the resource. + * @param {string} resourceGroupName The name of the resource group. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] A - * unique read-only string that changes whenever the resource is updated. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.id] - * Resource ID. + * @param {object} [options] Optional Parameters. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] - * The reference of the Public IP resource. + * @param {string} [options.gatewayVip] Virtual network gateway vip address + * supplied to the begin reset of the active-active feature enabled gateway. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] - * The public IP address SKU. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] - * Name of a public IP address SKU. Possible values include: 'Basic', - * 'Standard' + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] - * The public IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - * Possible values include: 'IPv4', 'IPv6' + * {Promise} A promise is returned. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] - * The FQDN of the DNS record associated with the public IP address. + * @resolve {VirtualNetworkGateway} - The deserialized result object. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] - * Gets or sets the Domain name label.The concatenation of the domain name - * label and the regionalized DNS zone make up the fully qualified domain name - * associated with the public IP address. If a domain name label is specified, - * an A DNS record is created for the public IP in the Microsoft Azure DNS - * system. + * @reject {Error|ServiceError} - The error object. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] - * Gets the FQDN, Fully qualified domain name of the A DNS record associated - * with the public IP. This is the concatenation of the domainNameLabel and the - * regionalized DNS zone. + * {ServiceCallback} optionalCallback(err, result, request, response) * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name - * that resolves to this public IP address. If the reverseFqdn is specified, - * then a PTR DNS record is created pointing from the IP address in the - * in-addr.arpa domain to the reverse FQDN. + * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] - * The list of tags associated with the public IP address. + * {VirtualNetworkGateway} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGateway} for more information. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] - * The IP address associated with the public IP address resource. + * {WebResource} [request] - The HTTP Request object if an error did not occur. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] - * The Public IP Prefix this Public IP Address should be allocated from. + * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. + */ + reset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }): Promise; + reset(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + reset(resourceGroupName: string, virtualNetworkGatewayName: string, options: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Resets the VPN client shared key of the virtual network gateway in the + * specified resource group. * - * @param {number} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] - * The idle timeout of the public IP address. + * @param {string} resourceGroupName The name of the resource group. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] - * The resource GUID property of the public IP resource. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] - * The provisioning state of the PublicIP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. + * @param {object} [options] Optional Parameters. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] - * A unique read-only string that changes whenever the resource is updated. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] - * A list of availability zones denoting the IP allocated for the resource - * needs to come from. + * @returns {Promise} A promise is returned * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.id] - * Resource ID. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.location] - * Resource location. + * @reject {Error|ServiceError} - The error object. + */ + resetVpnClientSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Resets the VPN client shared key of the virtual network gateway in the + * specified resource group. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.tags] - * Resource tags. + * @param {string} resourceGroupName The name of the resource group. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] - * The reference of the Public IP Prefix resource. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] - * Resource ID. + * @param {object} [options] Optional Parameters. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.provisioningState] - * Gets the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.name] The name of - * the resource that is unique within a resource group. This name can be used - * to access the resource. + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.etag] A unique - * read-only string that changes whenever the resource is updated. + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.zones] A list of - * availability zones denoting the IP allocated for the resource needs to come - * from. + * {Promise} A promise is returned. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.id] Resource ID. + * @resolve {null} - The deserialized result object. * - * @param {number} [parameters.destinationPort] The VXLAN destination port that - * will receive the tapped traffic. + * @reject {Error|ServiceError} - The error object. * - * @param {string} [parameters.etag] Gets a unique read-only string that - * changes whenever the resource is updated. + * {ServiceCallback} optionalCallback(err, result, request, response) * - * @param {string} [parameters.id] Resource ID. + * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * @param {string} [parameters.location] Resource location. + * {null} [result] - The deserialized result object if an error did not occur. * - * @param {object} [parameters.tags] Resource tags. + * {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. + */ + resetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + resetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + resetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Generates VPN client package for P2S client of the virtual network gateway + * in the specified resource group. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @param {object} parameters Parameters supplied to the generate virtual + * network gateway VPN client package operation. + * + * @param {string} [parameters.processorArchitecture] VPN client Processor + * Architecture. Possible values are: 'AMD64' and 'X86'. Possible values + * include: 'Amd64', 'X86' + * + * @param {string} [parameters.authenticationMethod] VPN client Authentication + * Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values + * include: 'EAPTLS', 'EAPMSCHAPv2' + * + * @param {string} [parameters.radiusServerAuthCertificate] The public + * certificate data for the radius server authentication certificate as a + * Base-64 encoded string. Required only if external radius authentication has + * been configured with EAPTLS authentication. + * + * @param {array} [parameters.clientRootCertificates] A list of client root + * certificates public certificate data encoded as Base-64 strings. Optional + * parameter for external radius based authentication with EAPTLS. * * @param {object} [options] Optional Parameters. * @@ -35601,358 +36116,40 @@ export interface VirtualNetworkTaps { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - createOrUpdateWithHttpOperationResponse(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + generatevpnclientpackageWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Creates or updates a Virtual Network Tap. + * Generates VPN client package for P2S client of the virtual network gateway + * in the specified resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of the virtual network tap. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {object} parameters Parameters supplied to the create or update - * virtual network tap operation. + * @param {object} parameters Parameters supplied to the generate virtual + * network gateway VPN client package operation. * - * @param {object} [parameters.destinationNetworkInterfaceIPConfiguration] The - * reference to the private IP Address of the collector nic that will receive - * the tap - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] - * The reference to Virtual Network Taps. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] - * The reference of ApplicationGatewayBackendAddressPool resource. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] - * The reference of LoadBalancerBackendAddressPool resource. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] - * A list of references of LoadBalancerInboundNatRules. - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddress] - * Private IP address of the IP configuration. - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] - * Defines how a private IP address is assigned. Possible values are: 'Static' - * and 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] - * Available from Api-Version 2016-03-30 onwards, it represents whether the - * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. - * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', - * 'IPv6' - * - * @param {object} - * [parameters.destinationNetworkInterfaceIPConfiguration.subnet] Subnet bound - * to the IP configuration. - * - * @param {boolean} - * [parameters.destinationNetworkInterfaceIPConfiguration.primary] Gets whether - * this is a primary customer address on the network interface. - * - * @param {object} - * [parameters.destinationNetworkInterfaceIPConfiguration.publicIPAddress] - * Public IP address bound to the IP configuration. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] - * Application security groups in which the IP configuration is included. - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.provisioningState] - * The provisioning state of the network interface IP configuration. Possible - * values are: 'Updating', 'Deleting', and 'Failed'. - * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.etag] - * A unique read-only string that changes whenever the resource is updated. - * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.id] - * Resource ID. - * - * @param {object} [parameters.destinationLoadBalancerFrontEndIPConfiguration] - * The reference to the private IP address on the internal Load Balancer that - * will receive the tap - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] - * The private IP address of the IP configuration. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] - * The Private IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet] The - * reference of the subnet resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.id] - * Resource ID. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.location] - * Resource location. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.tags] - * Resource tags. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * - * @param {boolean} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.id] - * Resource ID. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.location] - * Resource location. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.tags] - * Resource tags. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.name] The - * name of the resource that is unique within a resource group. This name can - * be used to access the resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] A - * unique read-only string that changes whenever the resource is updated. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.id] - * Resource ID. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] - * The reference of the Public IP resource. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] - * The public IP address SKU. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] - * Name of a public IP address SKU. Possible values include: 'Basic', - * 'Standard' - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] - * The public IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - * Possible values include: 'IPv4', 'IPv6' - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] - * The FQDN of the DNS record associated with the public IP address. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] - * Gets or sets the Domain name label.The concatenation of the domain name - * label and the regionalized DNS zone make up the fully qualified domain name - * associated with the public IP address. If a domain name label is specified, - * an A DNS record is created for the public IP in the Microsoft Azure DNS - * system. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] - * Gets the FQDN, Fully qualified domain name of the A DNS record associated - * with the public IP. This is the concatenation of the domainNameLabel and the - * regionalized DNS zone. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name - * that resolves to this public IP address. If the reverseFqdn is specified, - * then a PTR DNS record is created pointing from the IP address in the - * in-addr.arpa domain to the reverse FQDN. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] - * The list of tags associated with the public IP address. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] - * The IP address associated with the public IP address resource. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] - * The Public IP Prefix this Public IP Address should be allocated from. - * - * @param {number} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] - * The idle timeout of the public IP address. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] - * The resource GUID property of the public IP resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] - * The provisioning state of the PublicIP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] - * A unique read-only string that changes whenever the resource is updated. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] - * A list of availability zones denoting the IP allocated for the resource - * needs to come from. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.id] - * Resource ID. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.location] - * Resource location. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.tags] - * Resource tags. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] - * The reference of the Public IP Prefix resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] - * Resource ID. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.provisioningState] - * Gets the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.name] The name of - * the resource that is unique within a resource group. This name can be used - * to access the resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.etag] A unique - * read-only string that changes whenever the resource is updated. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.zones] A list of - * availability zones denoting the IP allocated for the resource needs to come - * from. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.id] Resource ID. - * - * @param {number} [parameters.destinationPort] The VXLAN destination port that - * will receive the tapped traffic. - * - * @param {string} [parameters.etag] Gets a unique read-only string that - * changes whenever the resource is updated. + * @param {string} [parameters.processorArchitecture] VPN client Processor + * Architecture. Possible values are: 'AMD64' and 'X86'. Possible values + * include: 'Amd64', 'X86' * - * @param {string} [parameters.id] Resource ID. + * @param {string} [parameters.authenticationMethod] VPN client Authentication + * Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values + * include: 'EAPTLS', 'EAPMSCHAPv2' * - * @param {string} [parameters.location] Resource location. + * @param {string} [parameters.radiusServerAuthCertificate] The public + * certificate data for the radius server authentication certificate as a + * Base-64 encoded string. Required only if external radius authentication has + * been configured with EAPTLS authentication. * - * @param {object} [parameters.tags] Resource tags. + * @param {array} [parameters.clientRootCertificates] A list of client root + * certificates public certificate data encoded as Base-64 strings. Optional + * parameter for external radius based authentication with EAPTLS. * * @param {object} [options] Optional Parameters. * @@ -35966,7 +36163,7 @@ export interface VirtualNetworkTaps { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkTap} - The deserialized result object. + * @resolve {String} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -35974,29 +36171,45 @@ export interface VirtualNetworkTaps { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkTap} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkTap} for more information. + * {String} [result] - The deserialized result object if an error did not occur. * * {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. */ - createOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - createOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, callback: ServiceCallback): void; - createOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + generatevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + generatevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, callback: ServiceCallback): void; + generatevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Updates an VirtualNetworkTap tags. + * Generates VPN profile for P2S client of the virtual network gateway in the + * specified resource group. Used for IKEV2 and radius based authentication. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of the tap. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {object} tapParameters Parameters supplied to update - * VirtualNetworkTap tags. + * @param {object} parameters Parameters supplied to the generate virtual + * network gateway VPN client package operation. * - * @param {object} [tapParameters.tags] Resource tags. + * @param {string} [parameters.processorArchitecture] VPN client Processor + * Architecture. Possible values are: 'AMD64' and 'X86'. Possible values + * include: 'Amd64', 'X86' + * + * @param {string} [parameters.authenticationMethod] VPN client Authentication + * Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values + * include: 'EAPTLS', 'EAPMSCHAPv2' + * + * @param {string} [parameters.radiusServerAuthCertificate] The public + * certificate data for the radius server authentication certificate as a + * Base-64 encoded string. Required only if external radius authentication has + * been configured with EAPTLS authentication. + * + * @param {array} [parameters.clientRootCertificates] A list of client root + * certificates public certificate data encoded as Base-64 strings. Optional + * parameter for external radius based authentication with EAPTLS. * * @param {object} [options] Optional Parameters. * @@ -36005,74 +36218,40 @@ export interface VirtualNetworkTaps { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - updateTagsWithHttpOperationResponse(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + generateVpnProfileWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Updates an VirtualNetworkTap tags. + * Generates VPN profile for P2S client of the virtual network gateway in the + * specified resource group. Used for IKEV2 and radius based authentication. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of the tap. - * - * @param {object} tapParameters Parameters supplied to update - * VirtualNetworkTap tags. - * - * @param {object} [tapParameters.tags] Resource tags. - * - * @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 {VirtualNetworkTap} - 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. - * - * {VirtualNetworkTap} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkTap} 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. - */ - updateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - updateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, callback: ServiceCallback): void; - updateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets all the VirtualNetworkTaps in a subscription. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {object} [options] Optional Parameters. + * @param {object} parameters Parameters supplied to the generate virtual + * network gateway VPN client package operation. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {string} [parameters.processorArchitecture] VPN client Processor + * Architecture. Possible values are: 'AMD64' and 'X86'. Possible values + * include: 'Amd64', 'X86' * - * @returns {Promise} A promise is returned + * @param {string} [parameters.authenticationMethod] VPN client Authentication + * Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values + * include: 'EAPTLS', 'EAPMSCHAPv2' * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @param {string} [parameters.radiusServerAuthCertificate] The public + * certificate data for the radius server authentication certificate as a + * Base-64 encoded string. Required only if external radius authentication has + * been configured with EAPTLS authentication. * - * @reject {Error|ServiceError} - The error object. - */ - listAllWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets all the VirtualNetworkTaps in a subscription. + * @param {array} [parameters.clientRootCertificates] A list of client root + * certificates public certificate data encoded as Base-64 strings. Optional + * parameter for external radius based authentication with EAPTLS. * * @param {object} [options] Optional Parameters. * @@ -36086,7 +36265,7 @@ export interface VirtualNetworkTaps { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkTapListResult} - The deserialized result object. + * @resolve {String} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -36094,24 +36273,27 @@ export interface VirtualNetworkTaps { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkTapListResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkTapListResult} for more - * information. + * {String} [result] - The deserialized result object if an error did not occur. * * {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. */ - listAll(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listAll(callback: ServiceCallback): void; - listAll(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + generateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + generateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, callback: ServiceCallback): void; + generateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Gets all the VirtualNetworkTaps in a subscription. + * Gets pre-generated VPN profile for P2S client of the virtual network gateway + * in the specified resource group. The profile needs to be generated first + * using generateVpnProfile. * * @param {string} resourceGroupName The name of the resource group. * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -36119,17 +36301,22 @@ export interface VirtualNetworkTaps { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - listByResourceGroupWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + getVpnProfilePackageUrlWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets all the VirtualNetworkTaps in a subscription. + * Gets pre-generated VPN profile for P2S client of the virtual network gateway + * in the specified resource group. The profile needs to be generated first + * using generateVpnProfile. * * @param {string} resourceGroupName The name of the resource group. * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -36142,7 +36329,7 @@ export interface VirtualNetworkTaps { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkTapListResult} - The deserialized result object. + * @resolve {String} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -36150,783 +36337,113 @@ export interface VirtualNetworkTaps { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkTapListResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkTapListResult} for more - * information. + * {String} [result] - The deserialized result object if an error did not occur. * * {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. */ - listByResourceGroup(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listByResourceGroup(resourceGroupName: string, callback: ServiceCallback): void; - listByResourceGroup(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + getVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + getVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + getVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Deletes the specified virtual network tap. + * The GetBgpPeerStatus operation retrieves the status of all BGP peers. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of the virtual network tap. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * * @param {object} [options] Optional Parameters. * + * @param {string} [options.peer] The IP address of the peer to retrieve the + * status of. + * * @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. - */ - beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Deletes the specified virtual network tap. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} tapName The name of the virtual network tap. - * - * @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 {null} - 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. - * - * {null} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - beginDeleteMethod(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginDeleteMethod(resourceGroupName: string, tapName: string, callback: ServiceCallback): void; - beginDeleteMethod(resourceGroupName: string, tapName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Creates or updates a Virtual Network Tap. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} tapName The name of the virtual network tap. - * - * @param {object} parameters Parameters supplied to the create or update - * virtual network tap operation. - * - * @param {object} [parameters.destinationNetworkInterfaceIPConfiguration] The - * reference to the private IP Address of the collector nic that will receive - * the tap - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] - * The reference to Virtual Network Taps. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] - * The reference of ApplicationGatewayBackendAddressPool resource. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] - * The reference of LoadBalancerBackendAddressPool resource. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] - * A list of references of LoadBalancerInboundNatRules. - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddress] - * Private IP address of the IP configuration. - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] - * Defines how a private IP address is assigned. Possible values are: 'Static' - * and 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] - * Available from Api-Version 2016-03-30 onwards, it represents whether the - * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. - * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', - * 'IPv6' - * - * @param {object} - * [parameters.destinationNetworkInterfaceIPConfiguration.subnet] Subnet bound - * to the IP configuration. - * - * @param {boolean} - * [parameters.destinationNetworkInterfaceIPConfiguration.primary] Gets whether - * this is a primary customer address on the network interface. - * - * @param {object} - * [parameters.destinationNetworkInterfaceIPConfiguration.publicIPAddress] - * Public IP address bound to the IP configuration. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] - * Application security groups in which the IP configuration is included. - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.provisioningState] - * The provisioning state of the network interface IP configuration. Possible - * values are: 'Updating', 'Deleting', and 'Failed'. - * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.etag] - * A unique read-only string that changes whenever the resource is updated. - * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.id] - * Resource ID. - * - * @param {object} [parameters.destinationLoadBalancerFrontEndIPConfiguration] - * The reference to the private IP address on the internal Load Balancer that - * will receive the tap - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] - * The private IP address of the IP configuration. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] - * The Private IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet] The - * reference of the subnet resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.id] - * Resource ID. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.location] - * Resource location. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.tags] - * Resource tags. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * - * @param {boolean} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.id] - * Resource ID. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.location] - * Resource location. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.tags] - * Resource tags. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.name] The - * name of the resource that is unique within a resource group. This name can - * be used to access the resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] A - * unique read-only string that changes whenever the resource is updated. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.id] - * Resource ID. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] - * The reference of the Public IP resource. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] - * The public IP address SKU. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] - * Name of a public IP address SKU. Possible values include: 'Basic', - * 'Standard' - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] - * The public IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - * Possible values include: 'IPv4', 'IPv6' - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] - * The FQDN of the DNS record associated with the public IP address. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] - * Gets or sets the Domain name label.The concatenation of the domain name - * label and the regionalized DNS zone make up the fully qualified domain name - * associated with the public IP address. If a domain name label is specified, - * an A DNS record is created for the public IP in the Microsoft Azure DNS - * system. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] - * Gets the FQDN, Fully qualified domain name of the A DNS record associated - * with the public IP. This is the concatenation of the domainNameLabel and the - * regionalized DNS zone. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name - * that resolves to this public IP address. If the reverseFqdn is specified, - * then a PTR DNS record is created pointing from the IP address in the - * in-addr.arpa domain to the reverse FQDN. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] - * The list of tags associated with the public IP address. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] - * The IP address associated with the public IP address resource. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] - * The Public IP Prefix this Public IP Address should be allocated from. - * - * @param {number} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] - * The idle timeout of the public IP address. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] - * The resource GUID property of the public IP resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] - * The provisioning state of the PublicIP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] - * A unique read-only string that changes whenever the resource is updated. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] - * A list of availability zones denoting the IP allocated for the resource - * needs to come from. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.id] - * Resource ID. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.location] - * Resource location. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.tags] - * Resource tags. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] - * The reference of the Public IP Prefix resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] - * Resource ID. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.provisioningState] - * Gets the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.name] The name of - * the resource that is unique within a resource group. This name can be used - * to access the resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.etag] A unique - * read-only string that changes whenever the resource is updated. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.zones] A list of - * availability zones denoting the IP allocated for the resource needs to come - * from. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.id] Resource ID. - * - * @param {number} [parameters.destinationPort] The VXLAN destination port that - * will receive the tapped traffic. - * - * @param {string} [parameters.etag] Gets a unique read-only string that - * changes whenever the resource is updated. - * - * @param {string} [parameters.id] Resource ID. - * - * @param {string} [parameters.location] Resource location. - * - * @param {object} [parameters.tags] Resource tags. - * - * @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. - */ - beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Creates or updates a Virtual Network Tap. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} tapName The name of the virtual network tap. - * - * @param {object} parameters Parameters supplied to the create or update - * virtual network tap operation. - * - * @param {object} [parameters.destinationNetworkInterfaceIPConfiguration] The - * reference to the private IP Address of the collector nic that will receive - * the tap - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] - * The reference to Virtual Network Taps. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] - * The reference of ApplicationGatewayBackendAddressPool resource. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] - * The reference of LoadBalancerBackendAddressPool resource. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] - * A list of references of LoadBalancerInboundNatRules. - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddress] - * Private IP address of the IP configuration. - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] - * Defines how a private IP address is assigned. Possible values are: 'Static' - * and 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] - * Available from Api-Version 2016-03-30 onwards, it represents whether the - * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. - * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', - * 'IPv6' - * - * @param {object} - * [parameters.destinationNetworkInterfaceIPConfiguration.subnet] Subnet bound - * to the IP configuration. - * - * @param {boolean} - * [parameters.destinationNetworkInterfaceIPConfiguration.primary] Gets whether - * this is a primary customer address on the network interface. - * - * @param {object} - * [parameters.destinationNetworkInterfaceIPConfiguration.publicIPAddress] - * Public IP address bound to the IP configuration. - * - * @param {array} - * [parameters.destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] - * Application security groups in which the IP configuration is included. - * - * @param {string} - * [parameters.destinationNetworkInterfaceIPConfiguration.provisioningState] - * The provisioning state of the network interface IP configuration. Possible - * values are: 'Updating', 'Deleting', and 'Failed'. - * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.name] - * The name of the resource that is unique within a resource group. This name - * can be used to access the resource. - * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.etag] - * A unique read-only string that changes whenever the resource is updated. - * - * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.id] - * Resource ID. - * - * @param {object} [parameters.destinationLoadBalancerFrontEndIPConfiguration] - * The reference to the private IP address on the internal Load Balancer that - * will receive the tap - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] - * The private IP address of the IP configuration. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] - * The Private IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet] The - * reference of the subnet resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] - * The address prefix for the subnet. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] - * List of address prefixes for the subnet. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] - * The reference of the NetworkSecurityGroup resource. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] - * A collection of security rules of the network security group. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] - * The default security rules of network security group. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] - * The resource GUID property of the network security group resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] - * The provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] - * A unique read-only string that changes whenever the resource is updated. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.id] - * Resource ID. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.location] - * Resource location. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.tags] - * Resource tags. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] - * The reference of the RouteTable resource. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] - * Collection of routes contained within a route table. - * - * @param {boolean} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] - * Gets or sets whether to disable the routes learned by BGP on that route - * table. True means disable. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] - * The provisioning state of the resource. Possible values are: 'Updating', - * 'Deleting', and 'Failed'. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] - * Gets a unique read-only string that changes whenever the resource is - * updated. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.id] - * Resource ID. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.location] - * Resource location. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.tags] - * Resource tags. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] - * An array of service endpoints. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] - * An array of service endpoint policies. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] - * Gets an array of references to the external resources using subnet. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] - * Gets an array of references to services injecting into this subnet. - * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] - * Gets an array of references to the delegations on the subnet. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] - * The provisioning state of the resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.name] The - * name of the resource that is unique within a resource group. This name can - * be used to access the resource. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] A - * unique read-only string that changes whenever the resource is updated. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.id] - * Resource ID. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] - * The reference of the Public IP resource. - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] - * The public IP address SKU. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] - * Name of a public IP address SKU. Possible values include: 'Basic', - * 'Standard' - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] - * The public IP allocation method. Possible values are: 'Static' and - * 'Dynamic'. Possible values include: 'Static', 'Dynamic' - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - * Possible values include: 'IPv4', 'IPv6' - * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] - * The FQDN of the DNS record associated with the public IP address. - * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] - * Gets or sets the Domain name label.The concatenation of the domain name - * label and the regionalized DNS zone make up the fully qualified domain name - * associated with the public IP address. If a domain name label is specified, - * an A DNS record is created for the public IP in the Microsoft Azure DNS - * system. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] - * Gets the FQDN, Fully qualified domain name of the A DNS record associated - * with the public IP. This is the concatenation of the domainNameLabel and the - * regionalized DNS zone. + * @reject {Error|ServiceError} - The error object. + */ + getBgpPeerStatusWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { peer? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * The GetBgpPeerStatus operation retrieves the status of all BGP peers. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name - * that resolves to this public IP address. If the reverseFqdn is specified, - * then a PTR DNS record is created pointing from the IP address in the - * in-addr.arpa domain to the reverse FQDN. + * @param {string} resourceGroupName The name of the resource group. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] - * The list of tags associated with the public IP address. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] - * The IP address associated with the public IP address resource. + * @param {object} [options] Optional Parameters. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] - * The Public IP Prefix this Public IP Address should be allocated from. + * @param {string} [options.peer] The IP address of the peer to retrieve the + * status of. * - * @param {number} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] - * The idle timeout of the public IP address. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] - * The resource GUID property of the public IP resource. + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] - * The provisioning state of the PublicIP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] - * A unique read-only string that changes whenever the resource is updated. + * {Promise} A promise is returned. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] - * A list of availability zones denoting the IP allocated for the resource - * needs to come from. + * @resolve {BgpPeerStatusListResult} - The deserialized result object. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.id] - * Resource ID. + * @reject {Error|ServiceError} - The error object. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.location] - * Resource location. + * {ServiceCallback} optionalCallback(err, result, request, response) * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.tags] - * Resource tags. + * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * @param {object} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] - * The reference of the Public IP Prefix resource. + * {BgpPeerStatusListResult} [result] - The deserialized result object if an error did not occur. + * See {@link BgpPeerStatusListResult} for more + * information. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] - * Resource ID. + * {WebResource} [request] - The HTTP Request object if an error did not occur. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.provisioningState] - * Gets the provisioning state of the public IP resource. Possible values are: - * 'Updating', 'Deleting', and 'Failed'. + * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. + */ + getBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { peer? : string, customHeaders? : { [headerName: string]: string; } }): Promise; + getBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + getBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options: { peer? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets a xml format representation for supported vpn devices. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.name] The name of - * the resource that is unique within a resource group. This name can be used - * to access the resource. + * @param {string} resourceGroupName The name of the resource group. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.etag] A unique - * read-only string that changes whenever the resource is updated. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * @param {array} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.zones] A list of - * availability zones denoting the IP allocated for the resource needs to come - * from. + * @param {object} [options] Optional Parameters. * - * @param {string} - * [parameters.destinationLoadBalancerFrontEndIPConfiguration.id] Resource ID. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {number} [parameters.destinationPort] The VXLAN destination port that - * will receive the tapped traffic. + * @returns {Promise} A promise is returned * - * @param {string} [parameters.etag] Gets a unique read-only string that - * changes whenever the resource is updated. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {string} [parameters.id] Resource ID. + * @reject {Error|ServiceError} - The error object. + */ + supportedVpnDevicesWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets a xml format representation for supported vpn devices. * - * @param {string} [parameters.location] Resource location. + * @param {string} resourceGroupName The name of the resource group. * - * @param {object} [parameters.tags] Resource tags. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * * @param {object} [options] Optional Parameters. * @@ -36940,7 +36457,7 @@ export interface VirtualNetworkTaps { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkTap} - The deserialized result object. + * @resolve {String} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -36948,29 +36465,25 @@ export interface VirtualNetworkTaps { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkTap} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkTap} for more information. + * {String} [result] - The deserialized result object if an error did not occur. * * {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. */ - beginCreateOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginCreateOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, callback: ServiceCallback): void; - beginCreateOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Updates an VirtualNetworkTap tags. + * This operation retrieves a list of routes the virtual network gateway has + * learned, including routes learned from BGP peers. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of the tap. - * - * @param {object} tapParameters Parameters supplied to update - * VirtualNetworkTap tags. - * - * @param {object} [tapParameters.tags] Resource tags. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * * @param {object} [options] Optional Parameters. * @@ -36979,23 +36492,20 @@ export interface VirtualNetworkTaps { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginUpdateTagsWithHttpOperationResponse(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + getLearnedRoutesWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Updates an VirtualNetworkTap tags. + * This operation retrieves a list of routes the virtual network gateway has + * learned, including routes learned from BGP peers. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} tapName The name of the tap. - * - * @param {object} tapParameters Parameters supplied to update - * VirtualNetworkTap tags. - * - * @param {object} [tapParameters.tags] Resource tags. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * * @param {object} [options] Optional Parameters. * @@ -37009,7 +36519,7 @@ export interface VirtualNetworkTaps { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkTap} - The deserialized result object. + * @resolve {GatewayRouteListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -37017,23 +36527,29 @@ export interface VirtualNetworkTaps { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkTap} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkTap} for more information. + * {GatewayRouteListResult} [result] - The deserialized result object if an error did not occur. + * See {@link GatewayRouteListResult} 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. */ - beginUpdateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginUpdateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, callback: ServiceCallback): void; - beginUpdateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + getLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + getLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + getLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Gets all the VirtualNetworkTaps in a subscription. + * This operation retrieves a list of routes the virtual network gateway is + * advertising to the specified peer. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @param {string} peer The IP address of the peer * * @param {object} [options] Optional Parameters. * @@ -37042,17 +36558,22 @@ export interface VirtualNetworkTaps { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - listAllNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + getAdvertisedRoutesWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets all the VirtualNetworkTaps in a subscription. + * This operation retrieves a list of routes the virtual network gateway is + * advertising to the specified peer. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @param {string} peer The IP address of the peer * * @param {object} [options] Optional Parameters. * @@ -37066,7 +36587,7 @@ export interface VirtualNetworkTaps { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkTapListResult} - The deserialized result object. + * @resolve {GatewayRouteListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -37074,24 +36595,64 @@ export interface VirtualNetworkTaps { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkTapListResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkTapListResult} for more + * {GatewayRouteListResult} [result] - The deserialized result object if an error did not occur. + * See {@link GatewayRouteListResult} 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. */ - listAllNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listAllNext(nextPageLink: string, callback: ServiceCallback): void; - listAllNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + getAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + getAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, callback: ServiceCallback): void; + getAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Gets all the VirtualNetworkTaps in a subscription. + * The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy + * for P2S client of virtual network gateway in the specified resource group + * through Network resource provider. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @param {object} vpnclientIpsecParams Parameters supplied to the Begin Set + * vpnclient ipsec parameters of Virtual Network Gateway P2S client operation + * through Network resource provider. + * + * @param {number} vpnclientIpsecParams.saLifeTimeSeconds The IPSec Security + * Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for + * P2S client. + * + * @param {number} vpnclientIpsecParams.saDataSizeKilobytes The IPSec Security + * Association (also called Quick Mode or Phase 2 SA) payload size in KB for + * P2S client.. + * + * @param {string} vpnclientIpsecParams.ipsecEncryption The IPSec encryption + * algorithm (IKE phase 1). Possible values include: 'None', 'DES', 'DES3', + * 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' + * + * @param {string} vpnclientIpsecParams.ipsecIntegrity The IPSec integrity + * algorithm (IKE phase 1). Possible values include: 'MD5', 'SHA1', 'SHA256', + * 'GCMAES128', 'GCMAES192', 'GCMAES256' + * + * @param {string} vpnclientIpsecParams.ikeEncryption The IKE encryption + * algorithm (IKE phase 2). Possible values include: 'DES', 'DES3', 'AES128', + * 'AES192', 'AES256', 'GCMAES256', 'GCMAES128' + * + * @param {string} vpnclientIpsecParams.ikeIntegrity The IKE integrity + * algorithm (IKE phase 2). Possible values include: 'MD5', 'SHA1', 'SHA256', + * 'SHA384', 'GCMAES256', 'GCMAES128' + * + * @param {string} vpnclientIpsecParams.dhGroup The DH Groups used in IKE Phase + * 1 for initial SA. Possible values include: 'None', 'DHGroup1', 'DHGroup2', + * 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24' + * + * @param {string} vpnclientIpsecParams.pfsGroup The Pfs Groups used in IKE + * Phase 2 for new child SA. Possible values include: 'None', 'PFS1', 'PFS2', + * 'PFS2048', 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM' * * @param {object} [options] Optional Parameters. * @@ -37100,17 +36661,57 @@ export interface VirtualNetworkTaps { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - listByResourceGroupNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + setVpnclientIpsecParametersWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets all the VirtualNetworkTaps in a subscription. + * The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy + * for P2S client of virtual network gateway in the specified resource group + * through Network resource provider. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. + * + * @param {object} vpnclientIpsecParams Parameters supplied to the Begin Set + * vpnclient ipsec parameters of Virtual Network Gateway P2S client operation + * through Network resource provider. + * + * @param {number} vpnclientIpsecParams.saLifeTimeSeconds The IPSec Security + * Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for + * P2S client. + * + * @param {number} vpnclientIpsecParams.saDataSizeKilobytes The IPSec Security + * Association (also called Quick Mode or Phase 2 SA) payload size in KB for + * P2S client.. + * + * @param {string} vpnclientIpsecParams.ipsecEncryption The IPSec encryption + * algorithm (IKE phase 1). Possible values include: 'None', 'DES', 'DES3', + * 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' + * + * @param {string} vpnclientIpsecParams.ipsecIntegrity The IPSec integrity + * algorithm (IKE phase 1). Possible values include: 'MD5', 'SHA1', 'SHA256', + * 'GCMAES128', 'GCMAES192', 'GCMAES256' + * + * @param {string} vpnclientIpsecParams.ikeEncryption The IKE encryption + * algorithm (IKE phase 2). Possible values include: 'DES', 'DES3', 'AES128', + * 'AES192', 'AES256', 'GCMAES256', 'GCMAES128' + * + * @param {string} vpnclientIpsecParams.ikeIntegrity The IKE integrity + * algorithm (IKE phase 2). Possible values include: 'MD5', 'SHA1', 'SHA256', + * 'SHA384', 'GCMAES256', 'GCMAES128' + * + * @param {string} vpnclientIpsecParams.dhGroup The DH Groups used in IKE Phase + * 1 for initial SA. Possible values include: 'None', 'DHGroup1', 'DHGroup2', + * 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24' + * + * @param {string} vpnclientIpsecParams.pfsGroup The Pfs Groups used in IKE + * Phase 2 for new child SA. Possible values include: 'None', 'PFS1', 'PFS2', + * 'PFS2048', 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM' * * @param {object} [options] Optional Parameters. * @@ -37124,7 +36725,7 @@ export interface VirtualNetworkTaps { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkTapListResult} - The deserialized result object. + * @resolve {VpnClientIPsecParameters} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -37132,147 +36733,164 @@ export interface VirtualNetworkTaps { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkTapListResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkTapListResult} for more + * {VpnClientIPsecParameters} [result] - The deserialized result object if an error did not occur. + * See {@link VpnClientIPsecParameters} 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. */ - listByResourceGroupNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback): void; - listByResourceGroupNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; -} - -/** - * @class - * VirtualNetworkGateways - * __NOTE__: An instance of this class is automatically created for an - * instance of the NetworkManagementClient. - */ -export interface VirtualNetworkGateways { + setVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + setVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, callback: ServiceCallback): void; + setVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Creates or updates a virtual network gateway in the specified resource - * group. + * The Get VpnclientIpsecParameters operation retrieves information about the + * vpnclient ipsec policy for P2S client of virtual network gateway in the + * specified resource group through Network resource provider. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayName The virtual network gateway name. * - * @param {object} parameters Parameters supplied to create or update virtual - * network gateway operation. + * @param {object} [options] Optional Parameters. * - * @param {array} [parameters.ipConfigurations] IP configurations for virtual - * network gateway. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} [parameters.gatewayType] The type of this virtual network - * gateway. Possible values are: 'Vpn' and 'ExpressRoute'. Possible values - * include: 'Vpn', 'ExpressRoute' + * @returns {Promise} A promise is returned * - * @param {string} [parameters.vpnType] The type of this virtual network - * gateway. Possible values are: 'PolicyBased' and 'RouteBased'. Possible - * values include: 'PolicyBased', 'RouteBased' + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {boolean} [parameters.enableBgp] Whether BGP is enabled for this - * virtual network gateway or not. + * @reject {Error|ServiceError} - The error object. + */ + getVpnclientIpsecParametersWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * The Get VpnclientIpsecParameters operation retrieves information about the + * vpnclient ipsec policy for P2S client of virtual network gateway in the + * specified resource group through Network resource provider. * - * @param {boolean} [parameters.activeActive] ActiveActive flag + * @param {string} resourceGroupName The name of the resource group. * - * @param {object} [parameters.gatewayDefaultSite] The reference of the - * LocalNetworkGateway resource which represents local network site having - * default routes. Assign Null value in case of removing existing default site - * setting. + * @param {string} virtualNetworkGatewayName The virtual network gateway name. * - * @param {string} [parameters.gatewayDefaultSite.id] Resource ID. + * @param {object} [options] Optional Parameters. * - * @param {object} [parameters.sku] The reference of the - * VirtualNetworkGatewaySku resource which represents the SKU selected for - * Virtual network gateway. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} [parameters.sku.name] Gateway SKU name. Possible values - * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', - * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', - * 'ErGw2AZ', 'ErGw3AZ' + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @param {string} [parameters.sku.tier] Gateway SKU tier. Possible values - * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', - * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', - * 'ErGw2AZ', 'ErGw3AZ' + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @param {number} [parameters.sku.capacity] The capacity. + * {Promise} A promise is returned. * - * @param {object} [parameters.vpnClientConfiguration] The reference of the - * VpnClientConfiguration resource which represents the P2S VpnClient - * configurations. + * @resolve {VpnClientIPsecParameters} - The deserialized result object. * - * @param {object} [parameters.vpnClientConfiguration.vpnClientAddressPool] The - * reference of the address space resource which represents Address space for - * P2S VpnClient. + * @reject {Error|ServiceError} - The error object. * - * @param {array} - * [parameters.vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] A - * list of address blocks reserved for this virtual network in CIDR notation. + * {ServiceCallback} optionalCallback(err, result, request, response) * - * @param {array} [parameters.vpnClientConfiguration.vpnClientRootCertificates] - * VpnClientRootCertificate for virtual network gateway. + * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * @param {array} - * [parameters.vpnClientConfiguration.vpnClientRevokedCertificates] - * VpnClientRevokedCertificate for Virtual network gateway. + * {VpnClientIPsecParameters} [result] - The deserialized result object if an error did not occur. + * See {@link VpnClientIPsecParameters} for more + * information. * - * @param {array} [parameters.vpnClientConfiguration.vpnClientProtocols] - * VpnClientProtocols for Virtual network gateway. + * {WebResource} [request] - The HTTP Request object if an error did not occur. * - * @param {array} [parameters.vpnClientConfiguration.vpnClientIpsecPolicies] - * VpnClientIpsecPolicies for virtual network gateway P2S client. + * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. + */ + getVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + getVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + getVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets a xml format representation for vpn device configuration script. * - * @param {string} [parameters.vpnClientConfiguration.radiusServerAddress] The - * radius server address property of the VirtualNetworkGateway resource for vpn - * client connection. + * @param {string} resourceGroupName The name of the resource group. * - * @param {string} [parameters.vpnClientConfiguration.radiusServerSecret] The - * radius secret property of the VirtualNetworkGateway resource for vpn client - * connection. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection for which the configuration script is generated. * - * @param {object} [parameters.bgpSettings] Virtual network gateway's BGP - * speaker settings. + * @param {object} parameters Parameters supplied to the generate vpn device + * script operation. * - * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * @param {string} [parameters.vendor] The vendor for the vpn device. * - * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering - * address and BGP identifier of this BGP speaker. + * @param {string} [parameters.deviceFamily] The device family for the vpn + * device. * - * @param {number} [parameters.bgpSettings.peerWeight] The weight added to - * routes learned from this BGP speaker. + * @param {string} [parameters.firmwareVersion] The firmware version for the + * vpn device. * - * @param {string} [parameters.resourceGuid] The resource GUID property of the - * VirtualNetworkGateway resource. + * @param {object} [options] Optional Parameters. * - * @param {string} [parameters.etag] Gets a unique read-only string that - * changes whenever the resource is updated. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} [parameters.id] Resource ID. + * @returns {Promise} A promise is returned * - * @param {string} [parameters.location] Resource location. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {object} [parameters.tags] Resource tags. + * @reject {Error|ServiceError} - The error object. + */ + vpnDeviceConfigurationScriptWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VpnDeviceScriptParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets a xml format representation for vpn device configuration script. + * + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection for which the configuration script is generated. + * + * @param {object} parameters Parameters supplied to the generate vpn device + * script operation. + * + * @param {string} [parameters.vendor] The vendor for the vpn device. + * + * @param {string} [parameters.deviceFamily] The device family for the vpn + * device. + * + * @param {string} [parameters.firmwareVersion] The firmware version for the + * vpn device. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * - * @returns {Promise} A promise is returned + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @reject {Error|ServiceError} - The error object. + * {Promise} A promise is returned. + * + * @resolve {String} - 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. + * + * {String} [result] - The deserialized result object if an error did not occur. + * + * {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. */ - createOrUpdateWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VpnDeviceScriptParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VpnDeviceScriptParameters, callback: ServiceCallback): void; + vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VpnDeviceScriptParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + /** * Creates or updates a virtual network gateway in the specified resource @@ -37386,61 +37004,120 @@ export interface VirtualNetworkGateways { * @param {object} [options.customHeaders] Headers that will be added to the * request * - * @param {ServiceCallback} [optionalCallback] - The optional callback. + * @returns {Promise} A promise is returned * - * @returns {ServiceCallback|Promise} If a callback was passed as the last - * parameter then it returns the callback else returns a Promise. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * {Promise} A promise is returned. + * @reject {Error|ServiceError} - The error object. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a virtual network gateway in the specified resource + * group. * - * @resolve {VirtualNetworkGateway} - The deserialized result object. + * @param {string} resourceGroupName The name of the resource group. * - * @reject {Error|ServiceError} - The error object. + * @param {string} virtualNetworkGatewayName The name of the virtual network + * gateway. * - * {ServiceCallback} optionalCallback(err, result, request, response) + * @param {object} parameters Parameters supplied to create or update virtual + * network gateway operation. * - * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. + * @param {array} [parameters.ipConfigurations] IP configurations for virtual + * network gateway. * - * {VirtualNetworkGateway} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGateway} for more information. + * @param {string} [parameters.gatewayType] The type of this virtual network + * gateway. Possible values are: 'Vpn' and 'ExpressRoute'. Possible values + * include: 'Vpn', 'ExpressRoute' * - * {WebResource} [request] - The HTTP Request object if an error did not occur. + * @param {string} [parameters.vpnType] The type of this virtual network + * gateway. Possible values are: 'PolicyBased' and 'RouteBased'. Possible + * values include: 'PolicyBased', 'RouteBased' * - * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. - */ - createOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - createOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, callback: ServiceCallback): void; - createOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets the specified virtual network gateway by resource group. + * @param {boolean} [parameters.enableBgp] Whether BGP is enabled for this + * virtual network gateway or not. * - * @param {string} resourceGroupName The name of the resource group. + * @param {boolean} [parameters.activeActive] ActiveActive flag * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {object} [parameters.gatewayDefaultSite] The reference of the + * LocalNetworkGateway resource which represents local network site having + * default routes. Assign Null value in case of removing existing default site + * setting. * - * @param {object} [options] Optional Parameters. + * @param {string} [parameters.gatewayDefaultSite.id] Resource ID. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {object} [parameters.sku] The reference of the + * VirtualNetworkGatewaySku resource which represents the SKU selected for + * Virtual network gateway. * - * @returns {Promise} A promise is returned + * @param {string} [parameters.sku.name] Gateway SKU name. Possible values + * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', + * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', + * 'ErGw2AZ', 'ErGw3AZ' * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @param {string} [parameters.sku.tier] Gateway SKU tier. Possible values + * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', + * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', + * 'ErGw2AZ', 'ErGw3AZ' * - * @reject {Error|ServiceError} - The error object. - */ - getWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets the specified virtual network gateway by resource group. + * @param {number} [parameters.sku.capacity] The capacity. * - * @param {string} resourceGroupName The name of the resource group. + * @param {object} [parameters.vpnClientConfiguration] The reference of the + * VpnClientConfiguration resource which represents the P2S VpnClient + * configurations. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {object} [parameters.vpnClientConfiguration.vpnClientAddressPool] The + * reference of the address space resource which represents Address space for + * P2S VpnClient. + * + * @param {array} + * [parameters.vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] A + * list of address blocks reserved for this virtual network in CIDR notation. + * + * @param {array} [parameters.vpnClientConfiguration.vpnClientRootCertificates] + * VpnClientRootCertificate for virtual network gateway. + * + * @param {array} + * [parameters.vpnClientConfiguration.vpnClientRevokedCertificates] + * VpnClientRevokedCertificate for Virtual network gateway. + * + * @param {array} [parameters.vpnClientConfiguration.vpnClientProtocols] + * VpnClientProtocols for Virtual network gateway. + * + * @param {array} [parameters.vpnClientConfiguration.vpnClientIpsecPolicies] + * VpnClientIpsecPolicies for virtual network gateway P2S client. + * + * @param {string} [parameters.vpnClientConfiguration.radiusServerAddress] The + * radius server address property of the VirtualNetworkGateway resource for vpn + * client connection. + * + * @param {string} [parameters.vpnClientConfiguration.radiusServerSecret] The + * radius secret property of the VirtualNetworkGateway resource for vpn client + * connection. + * + * @param {object} [parameters.bgpSettings] Virtual network gateway's BGP + * speaker settings. + * + * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * + * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering + * address and BGP identifier of this BGP speaker. + * + * @param {number} [parameters.bgpSettings.peerWeight] The weight added to + * routes learned from this BGP speaker. + * + * @param {string} [parameters.resourceGuid] The resource GUID property of the + * VirtualNetworkGateway resource. + * + * @param {string} [parameters.etag] Gets a unique read-only string that + * changes whenever the resource is updated. + * + * @param {string} [parameters.id] Resource ID. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -37469,9 +37146,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - get(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - get(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - get(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -37493,7 +37170,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - deleteMethodWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * Deletes the specified virtual network gateway. @@ -37529,9 +37206,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - deleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - deleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - deleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -37558,7 +37235,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - updateTagsWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginUpdateTagsWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * Updates a virtual network gateway tags. @@ -37600,127 +37277,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - updateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - updateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, callback: ServiceCallback): void; - updateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets all virtual network gateways by resource group. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @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. - */ - listWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets all virtual network gateways by resource group. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @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 {VirtualNetworkGatewayListResult} - 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. - * - * {VirtualNetworkGatewayListResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayListResult} 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. - */ - list(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - list(resourceGroupName: string, callback: ServiceCallback): void; - list(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets all the connections in a virtual network gateway. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @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. - */ - listConnectionsWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets all the connections in a virtual network gateway. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @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 {VirtualNetworkGatewayListConnectionsResult} - 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. - * - * {VirtualNetworkGatewayListConnectionsResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayListConnectionsResult} - * 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. - */ - listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, callback: ServiceCallback): void; + beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -37746,7 +37305,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - resetWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; + beginResetWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; /** * Resets the primary of the virtual network gateway in the specified resource @@ -37787,9 +37346,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - reset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }): Promise; - reset(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - reset(resourceGroupName: string, virtualNetworkGatewayName: string, options: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }): Promise; + beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, options: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -37812,7 +37371,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - resetVpnClientSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginResetVpnClientSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * Resets the VPN client shared key of the virtual network gateway in the @@ -37849,9 +37408,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - resetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - resetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - resetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginResetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginResetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + beginResetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -37894,7 +37453,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - generatevpnclientpackageWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginGeneratevpnclientpackageWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * Generates VPN client package for P2S client of the virtual network gateway @@ -37951,9 +37510,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - generatevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - generatevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, callback: ServiceCallback): void; - generatevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, callback: ServiceCallback): void; + beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -37996,7 +37555,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - generateVpnProfileWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginGenerateVpnProfileWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * Generates VPN profile for P2S client of the virtual network gateway in the @@ -38053,9 +37612,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - generateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - generateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, callback: ServiceCallback): void; - generateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginGenerateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginGenerateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, callback: ServiceCallback): void; + beginGenerateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -38079,7 +37638,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - getVpnProfilePackageUrlWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginGetVpnProfilePackageUrlWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * Gets pre-generated VPN profile for P2S client of the virtual network gateway @@ -38117,9 +37676,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - getVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - getVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - getVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -38144,7 +37703,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - getBgpPeerStatusWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { peer? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; + beginGetBgpPeerStatusWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { peer? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; /** * The GetBgpPeerStatus operation retrieves the status of all BGP peers. @@ -38185,69 +37744,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - getBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { peer? : string, customHeaders? : { [headerName: string]: string; } }): Promise; - getBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - getBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options: { peer? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets a xml format representation for supported vpn devices. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @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. - */ - supportedVpnDevicesWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets a xml format representation for supported vpn devices. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @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 {String} - 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. - * - * {String} [result] - The deserialized result object if an error did not occur. - * - * {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. - */ - supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { peer? : string, customHeaders? : { [headerName: string]: string; } }): Promise; + beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options: { peer? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -38270,7 +37769,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - getLearnedRoutesWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginGetLearnedRoutesWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * This operation retrieves a list of routes the virtual network gateway has @@ -38309,9 +37808,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - getLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - getLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - getLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -38336,7 +37835,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - getAdvertisedRoutesWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginGetAdvertisedRoutesWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * This operation retrieves a list of routes the virtual network gateway is @@ -38377,9 +37876,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - getAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - getAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, callback: ServiceCallback): void; - getAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, callback: ServiceCallback): void; + beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -38439,7 +37938,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - setVpnclientIpsecParametersWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginSetVpnclientIpsecParametersWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy @@ -38515,9 +38014,9 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - setVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - setVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, callback: ServiceCallback): void; - setVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginSetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginSetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, callback: ServiceCallback): void; + beginSetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** @@ -38540,7 +38039,7 @@ export interface VirtualNetworkGateways { * * @reject {Error|ServiceError} - The error object. */ - getVpnclientIpsecParametersWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginGetVpnclientIpsecParametersWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * The Get VpnclientIpsecParameters operation retrieves information about the @@ -38579,61 +38078,93 @@ export interface VirtualNetworkGateways { * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ - getVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - getVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - getVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; + beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Gets a xml format representation for vpn device configuration script. + * Gets all virtual network gateways by resource group. * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection for which the configuration script is generated. + * @param {object} [options] Optional Parameters. * - * @param {object} parameters Parameters supplied to the generate vpn device - * script operation. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} [parameters.vendor] The vendor for the vpn device. + * @returns {Promise} A promise is returned * - * @param {string} [parameters.deviceFamily] The device family for the vpn - * device. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {string} [parameters.firmwareVersion] The firmware version for the - * vpn device. + * @reject {Error|ServiceError} - The error object. + */ + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all virtual network gateways by resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * - * @returns {Promise} A promise is returned + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @reject {Error|ServiceError} - The error object. + * {Promise} A promise is returned. + * + * @resolve {VirtualNetworkGatewayListResult} - 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. + * + * {VirtualNetworkGatewayListResult} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayListResult} 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. */ - vpnDeviceConfigurationScriptWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VpnDeviceScriptParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + /** - * Gets a xml format representation for vpn device configuration script. + * Gets all the connections in a virtual network gateway. * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection for which the configuration script is generated. + * @param {object} [options] Optional Parameters. * - * @param {object} parameters Parameters supplied to the generate vpn device - * script operation. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} [parameters.vendor] The vendor for the vpn device. + * @returns {Promise} A promise is returned * - * @param {string} [parameters.deviceFamily] The device family for the vpn - * device. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {string} [parameters.firmwareVersion] The firmware version for the - * vpn device. + * @reject {Error|ServiceError} - The error object. + */ + listConnectionsNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all the connections in a virtual network gateway. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. * * @param {object} [options] Optional Parameters. * @@ -38647,7 +38178,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {String} - The deserialized result object. + * @resolve {VirtualNetworkGatewayListConnectionsResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -38655,114 +38186,205 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {String} [result] - The deserialized result object if an error did not occur. + * {VirtualNetworkGatewayListConnectionsResult} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayListConnectionsResult} + * 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. */ - vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VpnDeviceScriptParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VpnDeviceScriptParameters, callback: ServiceCallback): void; - vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VpnDeviceScriptParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + listConnectionsNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listConnectionsNext(nextPageLink: string, callback: ServiceCallback): void; + listConnectionsNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * VirtualNetworkGatewayConnections + * __NOTE__: An instance of this class is automatically created for an + * instance of the NetworkManagementClient. + */ +export interface VirtualNetworkGatewayConnections { /** - * Creates or updates a virtual network gateway in the specified resource - * group. + * Creates or updates a virtual network gateway connection in the specified + * resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * - * @param {object} parameters Parameters supplied to create or update virtual - * network gateway operation. + * @param {object} parameters Parameters supplied to the create or update + * virtual network gateway connection operation. * - * @param {array} [parameters.ipConfigurations] IP configurations for virtual - * network gateway. + * @param {string} [parameters.authorizationKey] The authorizationKey. * - * @param {string} [parameters.gatewayType] The type of this virtual network - * gateway. Possible values are: 'Vpn' and 'ExpressRoute'. Possible values - * include: 'Vpn', 'ExpressRoute' + * @param {object} parameters.virtualNetworkGateway1 The reference to virtual + * network gateway resource. * - * @param {string} [parameters.vpnType] The type of this virtual network - * gateway. Possible values are: 'PolicyBased' and 'RouteBased'. Possible - * values include: 'PolicyBased', 'RouteBased' + * @param {object} [parameters.virtualNetworkGateway2] The reference to virtual + * network gateway resource. * - * @param {boolean} [parameters.enableBgp] Whether BGP is enabled for this - * virtual network gateway or not. + * @param {array} [parameters.virtualNetworkGateway2.ipConfigurations] IP + * configurations for virtual network gateway. * - * @param {boolean} [parameters.activeActive] ActiveActive flag + * @param {string} [parameters.virtualNetworkGateway2.gatewayType] The type of + * this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. + * Possible values include: 'Vpn', 'ExpressRoute' * - * @param {object} [parameters.gatewayDefaultSite] The reference of the - * LocalNetworkGateway resource which represents local network site having - * default routes. Assign Null value in case of removing existing default site - * setting. + * @param {string} [parameters.virtualNetworkGateway2.vpnType] The type of this + * virtual network gateway. Possible values are: 'PolicyBased' and + * 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased' * - * @param {string} [parameters.gatewayDefaultSite.id] Resource ID. + * @param {boolean} [parameters.virtualNetworkGateway2.enableBgp] Whether BGP + * is enabled for this virtual network gateway or not. * - * @param {object} [parameters.sku] The reference of the + * @param {boolean} [parameters.virtualNetworkGateway2.activeActive] + * ActiveActive flag + * + * @param {object} [parameters.virtualNetworkGateway2.gatewayDefaultSite] The + * reference of the LocalNetworkGateway resource which represents local network + * site having default routes. Assign Null value in case of removing existing + * default site setting. + * + * @param {object} [parameters.virtualNetworkGateway2.sku] The reference of the * VirtualNetworkGatewaySku resource which represents the SKU selected for * Virtual network gateway. * - * @param {string} [parameters.sku.name] Gateway SKU name. Possible values - * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', - * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', - * 'ErGw2AZ', 'ErGw3AZ' + * @param {string} [parameters.virtualNetworkGateway2.sku.name] Gateway SKU + * name. Possible values include: 'Basic', 'HighPerformance', 'Standard', + * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', + * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + * + * @param {string} [parameters.virtualNetworkGateway2.sku.tier] Gateway SKU + * tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', + * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', + * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + * + * @param {number} [parameters.virtualNetworkGateway2.sku.capacity] The + * capacity. + * + * @param {object} [parameters.virtualNetworkGateway2.vpnClientConfiguration] + * The reference of the VpnClientConfiguration resource which represents the + * P2S VpnClient configurations. + * + * @param {object} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool] + * The reference of the address space resource which represents Address space + * for P2S VpnClient. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRootCertificates] + * VpnClientRootCertificate for virtual network gateway. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRevokedCertificates] + * VpnClientRevokedCertificate for Virtual network gateway. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientProtocols] + * VpnClientProtocols for Virtual network gateway. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientIpsecPolicies] + * VpnClientIpsecPolicies for virtual network gateway P2S client. + * + * @param {string} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerAddress] + * The radius server address property of the VirtualNetworkGateway resource for + * vpn client connection. + * + * @param {string} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerSecret] + * The radius secret property of the VirtualNetworkGateway resource for vpn + * client connection. + * + * @param {object} [parameters.virtualNetworkGateway2.bgpSettings] Virtual + * network gateway's BGP speaker settings. + * + * @param {string} [parameters.virtualNetworkGateway2.resourceGuid] The + * resource GUID property of the VirtualNetworkGateway resource. + * + * @param {string} [parameters.virtualNetworkGateway2.etag] Gets a unique + * read-only string that changes whenever the resource is updated. + * + * @param {string} [parameters.virtualNetworkGateway2.id] Resource ID. + * + * @param {string} [parameters.virtualNetworkGateway2.location] Resource + * location. + * + * @param {object} [parameters.virtualNetworkGateway2.tags] Resource tags. + * + * @param {object} [parameters.localNetworkGateway2] The reference to local + * network gateway resource. + * + * @param {object} [parameters.localNetworkGateway2.localNetworkAddressSpace] + * Local network site address space. + * + * @param {array} + * [parameters.localNetworkGateway2.localNetworkAddressSpace.addressPrefixes] A + * list of address blocks reserved for this virtual network in CIDR notation. + * + * @param {string} [parameters.localNetworkGateway2.gatewayIpAddress] IP + * address of local network gateway. + * + * @param {object} [parameters.localNetworkGateway2.bgpSettings] Local network + * gateway's BGP speaker settings. + * + * @param {number} [parameters.localNetworkGateway2.bgpSettings.asn] The BGP + * speaker's ASN. * - * @param {string} [parameters.sku.tier] Gateway SKU tier. Possible values - * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', - * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', - * 'ErGw2AZ', 'ErGw3AZ' + * @param {string} + * [parameters.localNetworkGateway2.bgpSettings.bgpPeeringAddress] The BGP + * peering address and BGP identifier of this BGP speaker. * - * @param {number} [parameters.sku.capacity] The capacity. + * @param {number} [parameters.localNetworkGateway2.bgpSettings.peerWeight] The + * weight added to routes learned from this BGP speaker. * - * @param {object} [parameters.vpnClientConfiguration] The reference of the - * VpnClientConfiguration resource which represents the P2S VpnClient - * configurations. + * @param {string} [parameters.localNetworkGateway2.resourceGuid] The resource + * GUID property of the LocalNetworkGateway resource. * - * @param {object} [parameters.vpnClientConfiguration.vpnClientAddressPool] The - * reference of the address space resource which represents Address space for - * P2S VpnClient. + * @param {string} [parameters.localNetworkGateway2.etag] A unique read-only + * string that changes whenever the resource is updated. * - * @param {array} - * [parameters.vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] A - * list of address blocks reserved for this virtual network in CIDR notation. + * @param {string} [parameters.localNetworkGateway2.id] Resource ID. * - * @param {array} [parameters.vpnClientConfiguration.vpnClientRootCertificates] - * VpnClientRootCertificate for virtual network gateway. + * @param {string} [parameters.localNetworkGateway2.location] Resource + * location. * - * @param {array} - * [parameters.vpnClientConfiguration.vpnClientRevokedCertificates] - * VpnClientRevokedCertificate for Virtual network gateway. + * @param {object} [parameters.localNetworkGateway2.tags] Resource tags. * - * @param {array} [parameters.vpnClientConfiguration.vpnClientProtocols] - * VpnClientProtocols for Virtual network gateway. + * @param {string} parameters.connectionType Gateway connection type. Possible + * values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible + * values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' * - * @param {array} [parameters.vpnClientConfiguration.vpnClientIpsecPolicies] - * VpnClientIpsecPolicies for virtual network gateway P2S client. + * @param {string} [parameters.connectionProtocol] Connection protocol used for + * this connection. Possible values include: 'IKEv2', 'IKEv1' * - * @param {string} [parameters.vpnClientConfiguration.radiusServerAddress] The - * radius server address property of the VirtualNetworkGateway resource for vpn - * client connection. + * @param {number} [parameters.routingWeight] The routing weight. * - * @param {string} [parameters.vpnClientConfiguration.radiusServerSecret] The - * radius secret property of the VirtualNetworkGateway resource for vpn client - * connection. + * @param {string} [parameters.sharedKey] The IPSec shared key. * - * @param {object} [parameters.bgpSettings] Virtual network gateway's BGP - * speaker settings. + * @param {object} [parameters.peer] The reference to peerings resource. * - * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * @param {string} [parameters.peer.id] Resource ID. * - * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering - * address and BGP identifier of this BGP speaker. + * @param {boolean} [parameters.enableBgp] EnableBgp flag * - * @param {number} [parameters.bgpSettings.peerWeight] The weight added to - * routes learned from this BGP speaker. + * @param {boolean} [parameters.usePolicyBasedTrafficSelectors] Enable + * policy-based traffic selectors. + * + * @param {array} [parameters.ipsecPolicies] The IPSec Policies to be + * considered by this connection. * * @param {string} [parameters.resourceGuid] The resource GUID property of the - * VirtualNetworkGateway resource. + * VirtualNetworkGatewayConnection resource. + * + * @param {boolean} [parameters.expressRouteGatewayBypass] Bypass ExpressRoute + * Gateway for data forwarding * * @param {string} [parameters.etag] Gets a unique read-only string that * changes whenever the resource is updated. @@ -38780,109 +38402,189 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Creates or updates a virtual network gateway in the specified resource - * group. + * Creates or updates a virtual network gateway connection in the specified + * resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * - * @param {object} parameters Parameters supplied to create or update virtual - * network gateway operation. + * @param {object} parameters Parameters supplied to the create or update + * virtual network gateway connection operation. * - * @param {array} [parameters.ipConfigurations] IP configurations for virtual - * network gateway. + * @param {string} [parameters.authorizationKey] The authorizationKey. * - * @param {string} [parameters.gatewayType] The type of this virtual network - * gateway. Possible values are: 'Vpn' and 'ExpressRoute'. Possible values - * include: 'Vpn', 'ExpressRoute' + * @param {object} parameters.virtualNetworkGateway1 The reference to virtual + * network gateway resource. * - * @param {string} [parameters.vpnType] The type of this virtual network - * gateway. Possible values are: 'PolicyBased' and 'RouteBased'. Possible - * values include: 'PolicyBased', 'RouteBased' + * @param {object} [parameters.virtualNetworkGateway2] The reference to virtual + * network gateway resource. * - * @param {boolean} [parameters.enableBgp] Whether BGP is enabled for this - * virtual network gateway or not. + * @param {array} [parameters.virtualNetworkGateway2.ipConfigurations] IP + * configurations for virtual network gateway. * - * @param {boolean} [parameters.activeActive] ActiveActive flag + * @param {string} [parameters.virtualNetworkGateway2.gatewayType] The type of + * this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. + * Possible values include: 'Vpn', 'ExpressRoute' * - * @param {object} [parameters.gatewayDefaultSite] The reference of the - * LocalNetworkGateway resource which represents local network site having - * default routes. Assign Null value in case of removing existing default site - * setting. + * @param {string} [parameters.virtualNetworkGateway2.vpnType] The type of this + * virtual network gateway. Possible values are: 'PolicyBased' and + * 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased' * - * @param {string} [parameters.gatewayDefaultSite.id] Resource ID. + * @param {boolean} [parameters.virtualNetworkGateway2.enableBgp] Whether BGP + * is enabled for this virtual network gateway or not. * - * @param {object} [parameters.sku] The reference of the + * @param {boolean} [parameters.virtualNetworkGateway2.activeActive] + * ActiveActive flag + * + * @param {object} [parameters.virtualNetworkGateway2.gatewayDefaultSite] The + * reference of the LocalNetworkGateway resource which represents local network + * site having default routes. Assign Null value in case of removing existing + * default site setting. + * + * @param {object} [parameters.virtualNetworkGateway2.sku] The reference of the * VirtualNetworkGatewaySku resource which represents the SKU selected for * Virtual network gateway. * - * @param {string} [parameters.sku.name] Gateway SKU name. Possible values - * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', - * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', - * 'ErGw2AZ', 'ErGw3AZ' + * @param {string} [parameters.virtualNetworkGateway2.sku.name] Gateway SKU + * name. Possible values include: 'Basic', 'HighPerformance', 'Standard', + * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', + * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' * - * @param {string} [parameters.sku.tier] Gateway SKU tier. Possible values - * include: 'Basic', 'HighPerformance', 'Standard', 'UltraPerformance', - * 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', 'VpnGw3AZ', 'ErGw1AZ', - * 'ErGw2AZ', 'ErGw3AZ' + * @param {string} [parameters.virtualNetworkGateway2.sku.tier] Gateway SKU + * tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', + * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', + * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' * - * @param {number} [parameters.sku.capacity] The capacity. + * @param {number} [parameters.virtualNetworkGateway2.sku.capacity] The + * capacity. * - * @param {object} [parameters.vpnClientConfiguration] The reference of the - * VpnClientConfiguration resource which represents the P2S VpnClient - * configurations. + * @param {object} [parameters.virtualNetworkGateway2.vpnClientConfiguration] + * The reference of the VpnClientConfiguration resource which represents the + * P2S VpnClient configurations. * - * @param {object} [parameters.vpnClientConfiguration.vpnClientAddressPool] The - * reference of the address space resource which represents Address space for - * P2S VpnClient. + * @param {object} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool] + * The reference of the address space resource which represents Address space + * for P2S VpnClient. * * @param {array} - * [parameters.vpnClientConfiguration.vpnClientAddressPool.addressPrefixes] A - * list of address blocks reserved for this virtual network in CIDR notation. - * - * @param {array} [parameters.vpnClientConfiguration.vpnClientRootCertificates] + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRootCertificates] * VpnClientRootCertificate for virtual network gateway. * * @param {array} - * [parameters.vpnClientConfiguration.vpnClientRevokedCertificates] + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRevokedCertificates] * VpnClientRevokedCertificate for Virtual network gateway. * - * @param {array} [parameters.vpnClientConfiguration.vpnClientProtocols] + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientProtocols] * VpnClientProtocols for Virtual network gateway. * - * @param {array} [parameters.vpnClientConfiguration.vpnClientIpsecPolicies] + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientIpsecPolicies] * VpnClientIpsecPolicies for virtual network gateway P2S client. * - * @param {string} [parameters.vpnClientConfiguration.radiusServerAddress] The - * radius server address property of the VirtualNetworkGateway resource for vpn + * @param {string} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerAddress] + * The radius server address property of the VirtualNetworkGateway resource for + * vpn client connection. + * + * @param {string} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerSecret] + * The radius secret property of the VirtualNetworkGateway resource for vpn * client connection. * - * @param {string} [parameters.vpnClientConfiguration.radiusServerSecret] The - * radius secret property of the VirtualNetworkGateway resource for vpn client - * connection. + * @param {object} [parameters.virtualNetworkGateway2.bgpSettings] Virtual + * network gateway's BGP speaker settings. * - * @param {object} [parameters.bgpSettings] Virtual network gateway's BGP - * speaker settings. + * @param {string} [parameters.virtualNetworkGateway2.resourceGuid] The + * resource GUID property of the VirtualNetworkGateway resource. * - * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * @param {string} [parameters.virtualNetworkGateway2.etag] Gets a unique + * read-only string that changes whenever the resource is updated. * - * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering - * address and BGP identifier of this BGP speaker. + * @param {string} [parameters.virtualNetworkGateway2.id] Resource ID. * - * @param {number} [parameters.bgpSettings.peerWeight] The weight added to - * routes learned from this BGP speaker. + * @param {string} [parameters.virtualNetworkGateway2.location] Resource + * location. + * + * @param {object} [parameters.virtualNetworkGateway2.tags] Resource tags. + * + * @param {object} [parameters.localNetworkGateway2] The reference to local + * network gateway resource. + * + * @param {object} [parameters.localNetworkGateway2.localNetworkAddressSpace] + * Local network site address space. + * + * @param {array} + * [parameters.localNetworkGateway2.localNetworkAddressSpace.addressPrefixes] A + * list of address blocks reserved for this virtual network in CIDR notation. + * + * @param {string} [parameters.localNetworkGateway2.gatewayIpAddress] IP + * address of local network gateway. + * + * @param {object} [parameters.localNetworkGateway2.bgpSettings] Local network + * gateway's BGP speaker settings. + * + * @param {number} [parameters.localNetworkGateway2.bgpSettings.asn] The BGP + * speaker's ASN. + * + * @param {string} + * [parameters.localNetworkGateway2.bgpSettings.bgpPeeringAddress] The BGP + * peering address and BGP identifier of this BGP speaker. + * + * @param {number} [parameters.localNetworkGateway2.bgpSettings.peerWeight] The + * weight added to routes learned from this BGP speaker. + * + * @param {string} [parameters.localNetworkGateway2.resourceGuid] The resource + * GUID property of the LocalNetworkGateway resource. + * + * @param {string} [parameters.localNetworkGateway2.etag] A unique read-only + * string that changes whenever the resource is updated. + * + * @param {string} [parameters.localNetworkGateway2.id] Resource ID. + * + * @param {string} [parameters.localNetworkGateway2.location] Resource + * location. + * + * @param {object} [parameters.localNetworkGateway2.tags] Resource tags. + * + * @param {string} parameters.connectionType Gateway connection type. Possible + * values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible + * values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' + * + * @param {string} [parameters.connectionProtocol] Connection protocol used for + * this connection. Possible values include: 'IKEv2', 'IKEv1' + * + * @param {number} [parameters.routingWeight] The routing weight. + * + * @param {string} [parameters.sharedKey] The IPSec shared key. + * + * @param {object} [parameters.peer] The reference to peerings resource. + * + * @param {string} [parameters.peer.id] Resource ID. + * + * @param {boolean} [parameters.enableBgp] EnableBgp flag + * + * @param {boolean} [parameters.usePolicyBasedTrafficSelectors] Enable + * policy-based traffic selectors. + * + * @param {array} [parameters.ipsecPolicies] The IPSec Policies to be + * considered by this connection. * * @param {string} [parameters.resourceGuid] The resource GUID property of the - * VirtualNetworkGateway resource. + * VirtualNetworkGatewayConnection resource. + * + * @param {boolean} [parameters.expressRouteGatewayBypass] Bypass ExpressRoute + * Gateway for data forwarding * * @param {string} [parameters.etag] Gets a unique read-only string that * changes whenever the resource is updated. @@ -38905,7 +38607,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGateway} - The deserialized result object. + * @resolve {VirtualNetworkGatewayConnection} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -38913,25 +38615,26 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGateway} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGateway} for more information. + * {VirtualNetworkGatewayConnection} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayConnection} 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. */ - beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, callback: ServiceCallback): void; - beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VirtualNetworkGateway, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Deletes the specified virtual network gateway. + * Gets the specified virtual network gateway connection by resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * * @param {object} [options] Optional Parameters. * @@ -38940,19 +38643,19 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + getWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Deletes the specified virtual network gateway. + * Gets the specified virtual network gateway connection by resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * * @param {object} [options] Optional Parameters. * @@ -38966,7 +38669,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {null} - The deserialized result object. + * @resolve {VirtualNetworkGatewayConnection} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -38974,29 +38677,26 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {null} [result] - The deserialized result object if an error did not occur. + * {VirtualNetworkGatewayConnection} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayConnection} 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. */ - beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + get(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Updates a virtual network gateway tags. + * Deletes the specified virtual network Gateway connection. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @param {object} parameters Parameters supplied to update virtual network - * gateway tags. - * - * @param {object} [parameters.tags] Resource tags. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * * @param {object} [options] Optional Parameters. * @@ -39005,24 +38705,19 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginUpdateTagsWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + deleteMethodWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Updates a virtual network gateway tags. + * Deletes the specified virtual network Gateway connection. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @param {object} parameters Parameters supplied to update virtual network - * gateway tags. - * - * @param {object} [parameters.tags] Resource tags. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * * @param {object} [options] Optional Parameters. * @@ -39036,7 +38731,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGateway} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39044,56 +38739,57 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGateway} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGateway} for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {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. */ - beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, callback: ServiceCallback): void; - beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Resets the primary of the virtual network gateway in the specified resource - * group. + * Updates a virtual network gateway connection tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * - * @param {object} [options] Optional Parameters. + * @param {object} parameters Parameters supplied to update virtual network + * gateway connection tags. * - * @param {string} [options.gatewayVip] Virtual network gateway vip address - * supplied to the begin reset of the active-active feature enabled gateway. + * @param {object} [parameters.tags] Resource tags. + * + * @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. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginResetWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; + updateTagsWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Resets the primary of the virtual network gateway in the specified resource - * group. + * Updates a virtual network gateway connection tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * - * @param {object} [options] Optional Parameters. + * @param {object} parameters Parameters supplied to update virtual network + * gateway connection tags. * - * @param {string} [options.gatewayVip] Virtual network gateway vip address - * supplied to the begin reset of the active-active feature enabled gateway. + * @param {object} [parameters.tags] Resource tags. + * + * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request @@ -39105,7 +38801,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGateway} - The deserialized result object. + * @resolve {VirtualNetworkGatewayConnection} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39113,26 +38809,38 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGateway} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGateway} for more information. + * {VirtualNetworkGatewayConnection} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayConnection} 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. */ - beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }): Promise; - beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, options: { gatewayVip? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + updateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + updateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, callback: ServiceCallback): void; + updateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Resets the VPN client shared key of the virtual network gateway in the - * specified resource group. + * The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual + * network gateway connection shared key for passed virtual network gateway + * connection in the specified resource group through Network resource + * provider. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The virtual network + * gateway connection name. + * + * @param {object} parameters Parameters supplied to the Begin Set Virtual + * Network Gateway connection Shared key operation throughNetwork resource + * provider. + * + * @param {string} parameters.value The virtual network connection shared key + * value. + * + * @param {string} [parameters.id] Resource ID. * * @param {object} [options] Optional Parameters. * @@ -39141,20 +38849,31 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginResetVpnClientSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + setSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Resets the VPN client shared key of the virtual network gateway in the - * specified resource group. + * The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual + * network gateway connection shared key for passed virtual network gateway + * connection in the specified resource group through Network resource + * provider. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The virtual network + * gateway connection name. + * + * @param {object} parameters Parameters supplied to the Begin Set Virtual + * Network Gateway connection Shared key operation throughNetwork resource + * provider. + * + * @param {string} parameters.value The virtual network connection shared key + * value. + * + * @param {string} [parameters.id] Resource ID. * * @param {object} [options] Optional Parameters. * @@ -39168,7 +38887,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {null} - The deserialized result object. + * @resolve {ConnectionSharedKey} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39176,45 +38895,27 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {null} [result] - The deserialized result object if an error did not occur. + * {ConnectionSharedKey} [result] - The deserialized result object if an error did not occur. + * See {@link ConnectionSharedKey} 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. */ - beginResetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginResetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - beginResetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + setSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + setSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, callback: ServiceCallback): void; + setSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Generates VPN client package for P2S client of the virtual network gateway - * in the specified resource group. + * The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves + * information about the specified virtual network gateway connection shared + * key through Network resource provider. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @param {object} parameters Parameters supplied to the generate virtual - * network gateway VPN client package operation. - * - * @param {string} [parameters.processorArchitecture] VPN client Processor - * Architecture. Possible values are: 'AMD64' and 'X86'. Possible values - * include: 'Amd64', 'X86' - * - * @param {string} [parameters.authenticationMethod] VPN client Authentication - * Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values - * include: 'EAPTLS', 'EAPMSCHAPv2' - * - * @param {string} [parameters.radiusServerAuthCertificate] The public - * certificate data for the radius server authentication certificate as a - * Base-64 encoded string. Required only if external radius authentication has - * been configured with EAPTLS authentication. - * - * @param {array} [parameters.clientRootCertificates] A list of client root - * certificates public certificate data encoded as Base-64 strings. Optional - * parameter for external radius based authentication with EAPTLS. + * @param {string} virtualNetworkGatewayConnectionName The virtual network + * gateway connection shared key name. * * @param {object} [options] Optional Parameters. * @@ -39223,40 +38924,21 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginGeneratevpnclientpackageWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + getSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Generates VPN client package for P2S client of the virtual network gateway - * in the specified resource group. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @param {object} parameters Parameters supplied to the generate virtual - * network gateway VPN client package operation. - * - * @param {string} [parameters.processorArchitecture] VPN client Processor - * Architecture. Possible values are: 'AMD64' and 'X86'. Possible values - * include: 'Amd64', 'X86' - * - * @param {string} [parameters.authenticationMethod] VPN client Authentication - * Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values - * include: 'EAPTLS', 'EAPMSCHAPv2' - * - * @param {string} [parameters.radiusServerAuthCertificate] The public - * certificate data for the radius server authentication certificate as a - * Base-64 encoded string. Required only if external radius authentication has - * been configured with EAPTLS authentication. + * The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves + * information about the specified virtual network gateway connection shared + * key through Network resource provider. * - * @param {array} [parameters.clientRootCertificates] A list of client root - * certificates public certificate data encoded as Base-64 strings. Optional - * parameter for external radius based authentication with EAPTLS. + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayConnectionName The virtual network + * gateway connection shared key name. * * @param {object} [options] Optional Parameters. * @@ -39270,7 +38952,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {String} - The deserialized result object. + * @resolve {ConnectionSharedKey} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39278,46 +38960,24 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {String} [result] - The deserialized result object if an error did not occur. + * {ConnectionSharedKey} [result] - The deserialized result object if an error did not occur. + * See {@link ConnectionSharedKey} 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. */ - beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, callback: ServiceCallback): void; - beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + getSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + getSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, callback: ServiceCallback): void; + getSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Generates VPN profile for P2S client of the virtual network gateway in the - * specified resource group. Used for IKEV2 and radius based authentication. + * The List VirtualNetworkGatewayConnections operation retrieves all the + * virtual network gateways connections created. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @param {object} parameters Parameters supplied to the generate virtual - * network gateway VPN client package operation. - * - * @param {string} [parameters.processorArchitecture] VPN client Processor - * Architecture. Possible values are: 'AMD64' and 'X86'. Possible values - * include: 'Amd64', 'X86' - * - * @param {string} [parameters.authenticationMethod] VPN client Authentication - * Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values - * include: 'EAPTLS', 'EAPMSCHAPv2' - * - * @param {string} [parameters.radiusServerAuthCertificate] The public - * certificate data for the radius server authentication certificate as a - * Base-64 encoded string. Required only if external radius authentication has - * been configured with EAPTLS authentication. - * - * @param {array} [parameters.clientRootCertificates] A list of client root - * certificates public certificate data encoded as Base-64 strings. Optional - * parameter for external radius based authentication with EAPTLS. - * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -39325,41 +38985,18 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginGenerateVpnProfileWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + listWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Generates VPN profile for P2S client of the virtual network gateway in the - * specified resource group. Used for IKEV2 and radius based authentication. + * The List VirtualNetworkGatewayConnections operation retrieves all the + * virtual network gateways connections created. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @param {object} parameters Parameters supplied to the generate virtual - * network gateway VPN client package operation. - * - * @param {string} [parameters.processorArchitecture] VPN client Processor - * Architecture. Possible values are: 'AMD64' and 'X86'. Possible values - * include: 'Amd64', 'X86' - * - * @param {string} [parameters.authenticationMethod] VPN client Authentication - * Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'. Possible values - * include: 'EAPTLS', 'EAPMSCHAPv2' - * - * @param {string} [parameters.radiusServerAuthCertificate] The public - * certificate data for the radius server authentication certificate as a - * Base-64 encoded string. Required only if external radius authentication has - * been configured with EAPTLS authentication. - * - * @param {array} [parameters.clientRootCertificates] A list of client root - * certificates public certificate data encoded as Base-64 strings. Optional - * parameter for external radius based authentication with EAPTLS. - * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -39372,7 +39009,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {String} - The deserialized result object. + * @resolve {VirtualNetworkGatewayConnectionListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39380,26 +39017,36 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {String} [result] - The deserialized result object if an error did not occur. + * {VirtualNetworkGatewayConnectionListResult} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayConnectionListResult} + * 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. */ - beginGenerateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginGenerateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, callback: ServiceCallback): void; - beginGenerateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: models.VpnClientParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + list(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(resourceGroupName: string, callback: ServiceCallback): void; + list(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Gets pre-generated VPN profile for P2S client of the virtual network gateway - * in the specified resource group. The profile needs to be generated first - * using generateVpnProfile. + * The VirtualNetworkGatewayConnectionResetSharedKey operation resets the + * virtual network gateway connection shared key for passed virtual network + * gateway connection in the specified resource group through Network resource + * provider. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The virtual network + * gateway connection reset shared key Name. + * + * @param {object} parameters Parameters supplied to the begin reset virtual + * network gateway connection shared key operation through network resource + * provider. + * + * @param {number} parameters.keyLength The virtual network connection reset + * shared key length, should between 1 and 128. * * @param {object} [options] Optional Parameters. * @@ -39408,21 +39055,29 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginGetVpnProfilePackageUrlWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + resetSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets pre-generated VPN profile for P2S client of the virtual network gateway - * in the specified resource group. The profile needs to be generated first - * using generateVpnProfile. + * The VirtualNetworkGatewayConnectionResetSharedKey operation resets the + * virtual network gateway connection shared key for passed virtual network + * gateway connection in the specified resource group through Network resource + * provider. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The virtual network + * gateway connection reset shared key Name. + * + * @param {object} parameters Parameters supplied to the begin reset virtual + * network gateway connection shared key operation through network resource + * provider. + * + * @param {number} parameters.keyLength The virtual network connection reset + * shared key length, should between 1 and 128. * * @param {object} [options] Optional Parameters. * @@ -39436,7 +39091,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {String} - The deserialized result object. + * @resolve {ConnectionResetSharedKey} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39444,115 +39099,405 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {String} [result] - The deserialized result object if an error did not occur. + * {ConnectionResetSharedKey} [result] - The deserialized result object if an error did not occur. + * See {@link ConnectionResetSharedKey} 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. */ - beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + resetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + resetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, callback: ServiceCallback): void; + resetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * The GetBgpPeerStatus operation retrieves the status of all BGP peers. + * Creates or updates a virtual network gateway connection in the specified + * resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * - * @param {object} [options] Optional Parameters. + * @param {object} parameters Parameters supplied to the create or update + * virtual network gateway connection operation. * - * @param {string} [options.peer] The IP address of the peer to retrieve the - * status of. + * @param {string} [parameters.authorizationKey] The authorizationKey. + * + * @param {object} parameters.virtualNetworkGateway1 The reference to virtual + * network gateway resource. + * + * @param {object} [parameters.virtualNetworkGateway2] The reference to virtual + * network gateway resource. + * + * @param {array} [parameters.virtualNetworkGateway2.ipConfigurations] IP + * configurations for virtual network gateway. + * + * @param {string} [parameters.virtualNetworkGateway2.gatewayType] The type of + * this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. + * Possible values include: 'Vpn', 'ExpressRoute' + * + * @param {string} [parameters.virtualNetworkGateway2.vpnType] The type of this + * virtual network gateway. Possible values are: 'PolicyBased' and + * 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased' + * + * @param {boolean} [parameters.virtualNetworkGateway2.enableBgp] Whether BGP + * is enabled for this virtual network gateway or not. + * + * @param {boolean} [parameters.virtualNetworkGateway2.activeActive] + * ActiveActive flag + * + * @param {object} [parameters.virtualNetworkGateway2.gatewayDefaultSite] The + * reference of the LocalNetworkGateway resource which represents local network + * site having default routes. Assign Null value in case of removing existing + * default site setting. + * + * @param {object} [parameters.virtualNetworkGateway2.sku] The reference of the + * VirtualNetworkGatewaySku resource which represents the SKU selected for + * Virtual network gateway. + * + * @param {string} [parameters.virtualNetworkGateway2.sku.name] Gateway SKU + * name. Possible values include: 'Basic', 'HighPerformance', 'Standard', + * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', + * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + * + * @param {string} [parameters.virtualNetworkGateway2.sku.tier] Gateway SKU + * tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', + * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', + * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + * + * @param {number} [parameters.virtualNetworkGateway2.sku.capacity] The + * capacity. + * + * @param {object} [parameters.virtualNetworkGateway2.vpnClientConfiguration] + * The reference of the VpnClientConfiguration resource which represents the + * P2S VpnClient configurations. + * + * @param {object} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool] + * The reference of the address space resource which represents Address space + * for P2S VpnClient. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRootCertificates] + * VpnClientRootCertificate for virtual network gateway. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRevokedCertificates] + * VpnClientRevokedCertificate for Virtual network gateway. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientProtocols] + * VpnClientProtocols for Virtual network gateway. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientIpsecPolicies] + * VpnClientIpsecPolicies for virtual network gateway P2S client. + * + * @param {string} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerAddress] + * The radius server address property of the VirtualNetworkGateway resource for + * vpn client connection. + * + * @param {string} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerSecret] + * The radius secret property of the VirtualNetworkGateway resource for vpn + * client connection. + * + * @param {object} [parameters.virtualNetworkGateway2.bgpSettings] Virtual + * network gateway's BGP speaker settings. + * + * @param {string} [parameters.virtualNetworkGateway2.resourceGuid] The + * resource GUID property of the VirtualNetworkGateway resource. + * + * @param {string} [parameters.virtualNetworkGateway2.etag] Gets a unique + * read-only string that changes whenever the resource is updated. + * + * @param {string} [parameters.virtualNetworkGateway2.id] Resource ID. + * + * @param {string} [parameters.virtualNetworkGateway2.location] Resource + * location. + * + * @param {object} [parameters.virtualNetworkGateway2.tags] Resource tags. + * + * @param {object} [parameters.localNetworkGateway2] The reference to local + * network gateway resource. + * + * @param {object} [parameters.localNetworkGateway2.localNetworkAddressSpace] + * Local network site address space. + * + * @param {array} + * [parameters.localNetworkGateway2.localNetworkAddressSpace.addressPrefixes] A + * list of address blocks reserved for this virtual network in CIDR notation. + * + * @param {string} [parameters.localNetworkGateway2.gatewayIpAddress] IP + * address of local network gateway. + * + * @param {object} [parameters.localNetworkGateway2.bgpSettings] Local network + * gateway's BGP speaker settings. + * + * @param {number} [parameters.localNetworkGateway2.bgpSettings.asn] The BGP + * speaker's ASN. + * + * @param {string} + * [parameters.localNetworkGateway2.bgpSettings.bgpPeeringAddress] The BGP + * peering address and BGP identifier of this BGP speaker. + * + * @param {number} [parameters.localNetworkGateway2.bgpSettings.peerWeight] The + * weight added to routes learned from this BGP speaker. + * + * @param {string} [parameters.localNetworkGateway2.resourceGuid] The resource + * GUID property of the LocalNetworkGateway resource. + * + * @param {string} [parameters.localNetworkGateway2.etag] A unique read-only + * string that changes whenever the resource is updated. + * + * @param {string} [parameters.localNetworkGateway2.id] Resource ID. + * + * @param {string} [parameters.localNetworkGateway2.location] Resource + * location. + * + * @param {object} [parameters.localNetworkGateway2.tags] Resource tags. + * + * @param {string} parameters.connectionType Gateway connection type. Possible + * values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible + * values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' + * + * @param {string} [parameters.connectionProtocol] Connection protocol used for + * this connection. Possible values include: 'IKEv2', 'IKEv1' + * + * @param {number} [parameters.routingWeight] The routing weight. + * + * @param {string} [parameters.sharedKey] The IPSec shared key. + * + * @param {object} [parameters.peer] The reference to peerings resource. + * + * @param {string} [parameters.peer.id] Resource ID. + * + * @param {boolean} [parameters.enableBgp] EnableBgp flag + * + * @param {boolean} [parameters.usePolicyBasedTrafficSelectors] Enable + * policy-based traffic selectors. + * + * @param {array} [parameters.ipsecPolicies] The IPSec Policies to be + * considered by this connection. + * + * @param {string} [parameters.resourceGuid] The resource GUID property of the + * VirtualNetworkGatewayConnection resource. + * + * @param {boolean} [parameters.expressRouteGatewayBypass] Bypass ExpressRoute + * Gateway for data forwarding + * + * @param {string} [parameters.etag] Gets a unique read-only string that + * changes whenever the resource is updated. + * + * @param {string} [parameters.id] Resource ID. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginGetBgpPeerStatusWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { peer? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * The GetBgpPeerStatus operation retrieves the status of all BGP peers. + * Creates or updates a virtual network gateway connection in the specified + * resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * - * @param {object} [options] Optional Parameters. + * @param {object} parameters Parameters supplied to the create or update + * virtual network gateway connection operation. * - * @param {string} [options.peer] The IP address of the peer to retrieve the - * status of. + * @param {string} [parameters.authorizationKey] The authorizationKey. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {object} parameters.virtualNetworkGateway1 The reference to virtual + * network gateway resource. * - * @param {ServiceCallback} [optionalCallback] - The optional callback. + * @param {object} [parameters.virtualNetworkGateway2] The reference to virtual + * network gateway resource. * - * @returns {ServiceCallback|Promise} If a callback was passed as the last - * parameter then it returns the callback else returns a Promise. + * @param {array} [parameters.virtualNetworkGateway2.ipConfigurations] IP + * configurations for virtual network gateway. * - * {Promise} A promise is returned. + * @param {string} [parameters.virtualNetworkGateway2.gatewayType] The type of + * this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. + * Possible values include: 'Vpn', 'ExpressRoute' * - * @resolve {BgpPeerStatusListResult} - The deserialized result object. + * @param {string} [parameters.virtualNetworkGateway2.vpnType] The type of this + * virtual network gateway. Possible values are: 'PolicyBased' and + * 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased' * - * @reject {Error|ServiceError} - The error object. + * @param {boolean} [parameters.virtualNetworkGateway2.enableBgp] Whether BGP + * is enabled for this virtual network gateway or not. * - * {ServiceCallback} optionalCallback(err, result, request, response) + * @param {boolean} [parameters.virtualNetworkGateway2.activeActive] + * ActiveActive flag * - * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. + * @param {object} [parameters.virtualNetworkGateway2.gatewayDefaultSite] The + * reference of the LocalNetworkGateway resource which represents local network + * site having default routes. Assign Null value in case of removing existing + * default site setting. * - * {BgpPeerStatusListResult} [result] - The deserialized result object if an error did not occur. - * See {@link BgpPeerStatusListResult} for more - * information. + * @param {object} [parameters.virtualNetworkGateway2.sku] The reference of the + * VirtualNetworkGatewaySku resource which represents the SKU selected for + * Virtual network gateway. * - * {WebResource} [request] - The HTTP Request object if an error did not occur. + * @param {string} [parameters.virtualNetworkGateway2.sku.name] Gateway SKU + * name. Possible values include: 'Basic', 'HighPerformance', 'Standard', + * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', + * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' * - * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. - */ - beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { peer? : string, customHeaders? : { [headerName: string]: string; } }): Promise; - beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options: { peer? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * This operation retrieves a list of routes the virtual network gateway has - * learned, including routes learned from BGP peers. + * @param {string} [parameters.virtualNetworkGateway2.sku.tier] Gateway SKU + * tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', + * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', + * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' * - * @param {string} resourceGroupName The name of the resource group. + * @param {number} [parameters.virtualNetworkGateway2.sku.capacity] The + * capacity. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {object} [parameters.virtualNetworkGateway2.vpnClientConfiguration] + * The reference of the VpnClientConfiguration resource which represents the + * P2S VpnClient configurations. + * + * @param {object} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool] + * The reference of the address space resource which represents Address space + * for P2S VpnClient. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRootCertificates] + * VpnClientRootCertificate for virtual network gateway. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRevokedCertificates] + * VpnClientRevokedCertificate for Virtual network gateway. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientProtocols] + * VpnClientProtocols for Virtual network gateway. + * + * @param {array} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientIpsecPolicies] + * VpnClientIpsecPolicies for virtual network gateway P2S client. + * + * @param {string} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerAddress] + * The radius server address property of the VirtualNetworkGateway resource for + * vpn client connection. + * + * @param {string} + * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerSecret] + * The radius secret property of the VirtualNetworkGateway resource for vpn + * client connection. + * + * @param {object} [parameters.virtualNetworkGateway2.bgpSettings] Virtual + * network gateway's BGP speaker settings. + * + * @param {string} [parameters.virtualNetworkGateway2.resourceGuid] The + * resource GUID property of the VirtualNetworkGateway resource. + * + * @param {string} [parameters.virtualNetworkGateway2.etag] Gets a unique + * read-only string that changes whenever the resource is updated. + * + * @param {string} [parameters.virtualNetworkGateway2.id] Resource ID. + * + * @param {string} [parameters.virtualNetworkGateway2.location] Resource + * location. + * + * @param {object} [parameters.virtualNetworkGateway2.tags] Resource tags. + * + * @param {object} [parameters.localNetworkGateway2] The reference to local + * network gateway resource. + * + * @param {object} [parameters.localNetworkGateway2.localNetworkAddressSpace] + * Local network site address space. + * + * @param {array} + * [parameters.localNetworkGateway2.localNetworkAddressSpace.addressPrefixes] A + * list of address blocks reserved for this virtual network in CIDR notation. + * + * @param {string} [parameters.localNetworkGateway2.gatewayIpAddress] IP + * address of local network gateway. + * + * @param {object} [parameters.localNetworkGateway2.bgpSettings] Local network + * gateway's BGP speaker settings. + * + * @param {number} [parameters.localNetworkGateway2.bgpSettings.asn] The BGP + * speaker's ASN. + * + * @param {string} + * [parameters.localNetworkGateway2.bgpSettings.bgpPeeringAddress] The BGP + * peering address and BGP identifier of this BGP speaker. + * + * @param {number} [parameters.localNetworkGateway2.bgpSettings.peerWeight] The + * weight added to routes learned from this BGP speaker. + * + * @param {string} [parameters.localNetworkGateway2.resourceGuid] The resource + * GUID property of the LocalNetworkGateway resource. + * + * @param {string} [parameters.localNetworkGateway2.etag] A unique read-only + * string that changes whenever the resource is updated. + * + * @param {string} [parameters.localNetworkGateway2.id] Resource ID. + * + * @param {string} [parameters.localNetworkGateway2.location] Resource + * location. + * + * @param {object} [parameters.localNetworkGateway2.tags] Resource tags. + * + * @param {string} parameters.connectionType Gateway connection type. Possible + * values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible + * values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' + * + * @param {string} [parameters.connectionProtocol] Connection protocol used for + * this connection. Possible values include: 'IKEv2', 'IKEv1' + * + * @param {number} [parameters.routingWeight] The routing weight. + * + * @param {string} [parameters.sharedKey] The IPSec shared key. + * + * @param {object} [parameters.peer] The reference to peerings resource. + * + * @param {string} [parameters.peer.id] Resource ID. + * + * @param {boolean} [parameters.enableBgp] EnableBgp flag * - * @param {object} [options] Optional Parameters. + * @param {boolean} [parameters.usePolicyBasedTrafficSelectors] Enable + * policy-based traffic selectors. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {array} [parameters.ipsecPolicies] The IPSec Policies to be + * considered by this connection. * - * @returns {Promise} A promise is returned + * @param {string} [parameters.resourceGuid] The resource GUID property of the + * VirtualNetworkGatewayConnection resource. * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @param {boolean} [parameters.expressRouteGatewayBypass] Bypass ExpressRoute + * Gateway for data forwarding * - * @reject {Error|ServiceError} - The error object. - */ - beginGetLearnedRoutesWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * This operation retrieves a list of routes the virtual network gateway has - * learned, including routes learned from BGP peers. + * @param {string} [parameters.etag] Gets a unique read-only string that + * changes whenever the resource is updated. * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} [parameters.id] Resource ID. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -39566,7 +39511,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {GatewayRouteListResult} - The deserialized result object. + * @resolve {VirtualNetworkGatewayConnection} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39574,29 +39519,26 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {GatewayRouteListResult} [result] - The deserialized result object if an error did not occur. - * See {@link GatewayRouteListResult} for more + * {VirtualNetworkGatewayConnection} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayConnection} 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. */ - beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * This operation retrieves a list of routes the virtual network gateway is - * advertising to the specified peer. + * Deletes the specified virtual network Gateway connection. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @param {string} peer The IP address of the peer + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * * @param {object} [options] Optional Parameters. * @@ -39605,22 +39547,19 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginGetAdvertisedRoutesWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * This operation retrieves a list of routes the virtual network gateway is - * advertising to the specified peer. + * Deletes the specified virtual network Gateway connection. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @param {string} peer The IP address of the peer + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * * @param {object} [options] Optional Parameters. * @@ -39634,7 +39573,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {GatewayRouteListResult} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39642,64 +39581,29 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {GatewayRouteListResult} [result] - The deserialized result object if an error did not occur. - * See {@link GatewayRouteListResult} for more - * information. + * {null} [result] - The deserialized result object if an error did not occur. * * {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. */ - beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, callback: ServiceCallback): void; - beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy - * for P2S client of virtual network gateway in the specified resource group - * through Network resource provider. + * Updates a virtual network gateway connection tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @param {object} vpnclientIpsecParams Parameters supplied to the Begin Set - * vpnclient ipsec parameters of Virtual Network Gateway P2S client operation - * through Network resource provider. - * - * @param {number} vpnclientIpsecParams.saLifeTimeSeconds The IPSec Security - * Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for - * P2S client. - * - * @param {number} vpnclientIpsecParams.saDataSizeKilobytes The IPSec Security - * Association (also called Quick Mode or Phase 2 SA) payload size in KB for - * P2S client.. - * - * @param {string} vpnclientIpsecParams.ipsecEncryption The IPSec encryption - * algorithm (IKE phase 1). Possible values include: 'None', 'DES', 'DES3', - * 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' - * - * @param {string} vpnclientIpsecParams.ipsecIntegrity The IPSec integrity - * algorithm (IKE phase 1). Possible values include: 'MD5', 'SHA1', 'SHA256', - * 'GCMAES128', 'GCMAES192', 'GCMAES256' - * - * @param {string} vpnclientIpsecParams.ikeEncryption The IKE encryption - * algorithm (IKE phase 2). Possible values include: 'DES', 'DES3', 'AES128', - * 'AES192', 'AES256', 'GCMAES256', 'GCMAES128' - * - * @param {string} vpnclientIpsecParams.ikeIntegrity The IKE integrity - * algorithm (IKE phase 2). Possible values include: 'MD5', 'SHA1', 'SHA256', - * 'SHA384', 'GCMAES256', 'GCMAES128' + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * - * @param {string} vpnclientIpsecParams.dhGroup The DH Groups used in IKE Phase - * 1 for initial SA. Possible values include: 'None', 'DHGroup1', 'DHGroup2', - * 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24' + * @param {object} parameters Parameters supplied to update virtual network + * gateway connection tags. * - * @param {string} vpnclientIpsecParams.pfsGroup The Pfs Groups used in IKE - * Phase 2 for new child SA. Possible values include: 'None', 'PFS1', 'PFS2', - * 'PFS2048', 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM' + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -39708,57 +39612,24 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginSetVpnclientIpsecParametersWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginUpdateTagsWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy - * for P2S client of virtual network gateway in the specified resource group - * through Network resource provider. + * Updates a virtual network gateway connection tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The name of the virtual network - * gateway. - * - * @param {object} vpnclientIpsecParams Parameters supplied to the Begin Set - * vpnclient ipsec parameters of Virtual Network Gateway P2S client operation - * through Network resource provider. - * - * @param {number} vpnclientIpsecParams.saLifeTimeSeconds The IPSec Security - * Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for - * P2S client. - * - * @param {number} vpnclientIpsecParams.saDataSizeKilobytes The IPSec Security - * Association (also called Quick Mode or Phase 2 SA) payload size in KB for - * P2S client.. - * - * @param {string} vpnclientIpsecParams.ipsecEncryption The IPSec encryption - * algorithm (IKE phase 1). Possible values include: 'None', 'DES', 'DES3', - * 'AES128', 'AES192', 'AES256', 'GCMAES128', 'GCMAES192', 'GCMAES256' - * - * @param {string} vpnclientIpsecParams.ipsecIntegrity The IPSec integrity - * algorithm (IKE phase 1). Possible values include: 'MD5', 'SHA1', 'SHA256', - * 'GCMAES128', 'GCMAES192', 'GCMAES256' - * - * @param {string} vpnclientIpsecParams.ikeEncryption The IKE encryption - * algorithm (IKE phase 2). Possible values include: 'DES', 'DES3', 'AES128', - * 'AES192', 'AES256', 'GCMAES256', 'GCMAES128' - * - * @param {string} vpnclientIpsecParams.ikeIntegrity The IKE integrity - * algorithm (IKE phase 2). Possible values include: 'MD5', 'SHA1', 'SHA256', - * 'SHA384', 'GCMAES256', 'GCMAES128' + * @param {string} virtualNetworkGatewayConnectionName The name of the virtual + * network gateway connection. * - * @param {string} vpnclientIpsecParams.dhGroup The DH Groups used in IKE Phase - * 1 for initial SA. Possible values include: 'None', 'DHGroup1', 'DHGroup2', - * 'DHGroup14', 'DHGroup2048', 'ECP256', 'ECP384', 'DHGroup24' + * @param {object} parameters Parameters supplied to update virtual network + * gateway connection tags. * - * @param {string} vpnclientIpsecParams.pfsGroup The Pfs Groups used in IKE - * Phase 2 for new child SA. Possible values include: 'None', 'PFS1', 'PFS2', - * 'PFS2048', 'ECP256', 'ECP384', 'PFS24', 'PFS14', 'PFSMM' + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -39772,7 +39643,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {VpnClientIPsecParameters} - The deserialized result object. + * @resolve {VirtualNetworkGatewayConnection} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39780,27 +39651,38 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VpnClientIPsecParameters} [result] - The deserialized result object if an error did not occur. - * See {@link VpnClientIPsecParameters} for more + * {VirtualNetworkGatewayConnection} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayConnection} 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. */ - beginSetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginSetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, callback: ServiceCallback): void; - beginSetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: models.VpnClientIPsecParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, callback: ServiceCallback): void; + beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * The Get VpnclientIpsecParameters operation retrieves information about the - * vpnclient ipsec policy for P2S client of virtual network gateway in the - * specified resource group through Network resource provider. + * The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual + * network gateway connection shared key for passed virtual network gateway + * connection in the specified resource group through Network resource + * provider. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The virtual network gateway name. + * @param {string} virtualNetworkGatewayConnectionName The virtual network + * gateway connection name. + * + * @param {object} parameters Parameters supplied to the Begin Set Virtual + * Network Gateway connection Shared key operation throughNetwork resource + * provider. + * + * @param {string} parameters.value The virtual network connection shared key + * value. + * + * @param {string} [parameters.id] Resource ID. * * @param {object} [options] Optional Parameters. * @@ -39809,20 +39691,31 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginGetVpnclientIpsecParametersWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginSetSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * The Get VpnclientIpsecParameters operation retrieves information about the - * vpnclient ipsec policy for P2S client of virtual network gateway in the - * specified resource group through Network resource provider. + * The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual + * network gateway connection shared key for passed virtual network gateway + * connection in the specified resource group through Network resource + * provider. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayName The virtual network gateway name. + * @param {string} virtualNetworkGatewayConnectionName The virtual network + * gateway connection name. + * + * @param {object} parameters Parameters supplied to the Begin Set Virtual + * Network Gateway connection Shared key operation throughNetwork resource + * provider. + * + * @param {string} parameters.value The virtual network connection shared key + * value. + * + * @param {string} [parameters.id] Resource ID. * * @param {object} [options] Optional Parameters. * @@ -39836,7 +39729,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {VpnClientIPsecParameters} - The deserialized result object. + * @resolve {ConnectionSharedKey} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39844,24 +39737,35 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VpnClientIPsecParameters} [result] - The deserialized result object if an error did not occur. - * See {@link VpnClientIPsecParameters} for more - * information. + * {ConnectionSharedKey} [result] - The deserialized result object if an error did not occur. + * See {@link ConnectionSharedKey} 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. */ - beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, callback: ServiceCallback): void; - beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginSetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginSetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, callback: ServiceCallback): void; + beginSetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Gets all virtual network gateways by resource group. + * The VirtualNetworkGatewayConnectionResetSharedKey operation resets the + * virtual network gateway connection shared key for passed virtual network + * gateway connection in the specified resource group through Network resource + * provider. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayConnectionName The virtual network + * gateway connection reset shared key Name. + * + * @param {object} parameters Parameters supplied to the begin reset virtual + * network gateway connection shared key operation through network resource + * provider. + * + * @param {number} parameters.keyLength The virtual network connection reset + * shared key length, should between 1 and 128. * * @param {object} [options] Optional Parameters. * @@ -39870,17 +39774,29 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginResetSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets all virtual network gateways by resource group. + * The VirtualNetworkGatewayConnectionResetSharedKey operation resets the + * virtual network gateway connection shared key for passed virtual network + * gateway connection in the specified resource group through Network resource + * provider. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} virtualNetworkGatewayConnectionName The virtual network + * gateway connection reset shared key Name. + * + * @param {object} parameters Parameters supplied to the begin reset virtual + * network gateway connection shared key operation through network resource + * provider. + * + * @param {number} parameters.keyLength The virtual network connection reset + * shared key length, should between 1 and 128. * * @param {object} [options] Optional Parameters. * @@ -39894,7 +39810,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGatewayListResult} - The deserialized result object. + * @resolve {ConnectionResetSharedKey} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39902,21 +39818,22 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGatewayListResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayListResult} for more + * {ConnectionResetSharedKey} [result] - The deserialized result object if an error did not occur. + * See {@link ConnectionResetSharedKey} 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. */ - listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listNext(nextPageLink: string, callback: ServiceCallback): void; - listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginResetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginResetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, callback: ServiceCallback): void; + beginResetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Gets all the connections in a virtual network gateway. + * The List VirtualNetworkGatewayConnections operation retrieves all the + * virtual network gateways connections created. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -39928,14 +39845,15 @@ export interface VirtualNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - listConnectionsNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets all the connections in a virtual network gateway. + * The List VirtualNetworkGatewayConnections operation retrieves all the + * virtual network gateways connections created. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -39952,7 +39870,7 @@ export interface VirtualNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGatewayListConnectionsResult} - The deserialized result object. + * @resolve {VirtualNetworkGatewayConnectionListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -39960,208 +39878,120 @@ export interface VirtualNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGatewayListConnectionsResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayListConnectionsResult} + * {VirtualNetworkGatewayConnectionListResult} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkGatewayConnectionListResult} * 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. */ - listConnectionsNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listConnectionsNext(nextPageLink: string, callback: ServiceCallback): void; - listConnectionsNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; } /** * @class - * VirtualNetworkGatewayConnections + * LocalNetworkGateways * __NOTE__: An instance of this class is automatically created for an * instance of the NetworkManagementClient. */ -export interface VirtualNetworkGatewayConnections { +export interface LocalNetworkGateways { /** - * Creates or updates a virtual network gateway connection in the specified - * resource group. + * Creates or updates a local network gateway in the specified resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. - * - * @param {object} parameters Parameters supplied to the create or update - * virtual network gateway connection operation. - * - * @param {string} [parameters.authorizationKey] The authorizationKey. - * - * @param {object} parameters.virtualNetworkGateway1 The reference to virtual - * network gateway resource. - * - * @param {object} [parameters.virtualNetworkGateway2] The reference to virtual - * network gateway resource. - * - * @param {array} [parameters.virtualNetworkGateway2.ipConfigurations] IP - * configurations for virtual network gateway. - * - * @param {string} [parameters.virtualNetworkGateway2.gatewayType] The type of - * this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - * Possible values include: 'Vpn', 'ExpressRoute' - * - * @param {string} [parameters.virtualNetworkGateway2.vpnType] The type of this - * virtual network gateway. Possible values are: 'PolicyBased' and - * 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased' - * - * @param {boolean} [parameters.virtualNetworkGateway2.enableBgp] Whether BGP - * is enabled for this virtual network gateway or not. - * - * @param {boolean} [parameters.virtualNetworkGateway2.activeActive] - * ActiveActive flag - * - * @param {object} [parameters.virtualNetworkGateway2.gatewayDefaultSite] The - * reference of the LocalNetworkGateway resource which represents local network - * site having default routes. Assign Null value in case of removing existing - * default site setting. - * - * @param {object} [parameters.virtualNetworkGateway2.sku] The reference of the - * VirtualNetworkGatewaySku resource which represents the SKU selected for - * Virtual network gateway. - * - * @param {string} [parameters.virtualNetworkGateway2.sku.name] Gateway SKU - * name. Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' - * - * @param {string} [parameters.virtualNetworkGateway2.sku.tier] Gateway SKU - * tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' - * - * @param {number} [parameters.virtualNetworkGateway2.sku.capacity] The - * capacity. - * - * @param {object} [parameters.virtualNetworkGateway2.vpnClientConfiguration] - * The reference of the VpnClientConfiguration resource which represents the - * P2S VpnClient configurations. - * - * @param {object} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool] - * The reference of the address space resource which represents Address space - * for P2S VpnClient. - * - * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRootCertificates] - * VpnClientRootCertificate for virtual network gateway. - * - * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRevokedCertificates] - * VpnClientRevokedCertificate for Virtual network gateway. - * - * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientProtocols] - * VpnClientProtocols for Virtual network gateway. - * - * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientIpsecPolicies] - * VpnClientIpsecPolicies for virtual network gateway P2S client. - * - * @param {string} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerAddress] - * The radius server address property of the VirtualNetworkGateway resource for - * vpn client connection. - * - * @param {string} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerSecret] - * The radius secret property of the VirtualNetworkGateway resource for vpn - * client connection. - * - * @param {object} [parameters.virtualNetworkGateway2.bgpSettings] Virtual - * network gateway's BGP speaker settings. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * - * @param {string} [parameters.virtualNetworkGateway2.resourceGuid] The - * resource GUID property of the VirtualNetworkGateway resource. + * @param {object} parameters Parameters supplied to the create or update local + * network gateway operation. * - * @param {string} [parameters.virtualNetworkGateway2.etag] Gets a unique - * read-only string that changes whenever the resource is updated. + * @param {object} [parameters.localNetworkAddressSpace] Local network site + * address space. * - * @param {string} [parameters.virtualNetworkGateway2.id] Resource ID. + * @param {array} [parameters.localNetworkAddressSpace.addressPrefixes] A list + * of address blocks reserved for this virtual network in CIDR notation. * - * @param {string} [parameters.virtualNetworkGateway2.location] Resource - * location. + * @param {string} [parameters.gatewayIpAddress] IP address of local network + * gateway. * - * @param {object} [parameters.virtualNetworkGateway2.tags] Resource tags. + * @param {object} [parameters.bgpSettings] Local network gateway's BGP speaker + * settings. * - * @param {object} [parameters.localNetworkGateway2] The reference to local - * network gateway resource. + * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. * - * @param {object} [parameters.localNetworkGateway2.localNetworkAddressSpace] - * Local network site address space. + * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering + * address and BGP identifier of this BGP speaker. * - * @param {array} - * [parameters.localNetworkGateway2.localNetworkAddressSpace.addressPrefixes] A - * list of address blocks reserved for this virtual network in CIDR notation. + * @param {number} [parameters.bgpSettings.peerWeight] The weight added to + * routes learned from this BGP speaker. * - * @param {string} [parameters.localNetworkGateway2.gatewayIpAddress] IP - * address of local network gateway. + * @param {string} [parameters.resourceGuid] The resource GUID property of the + * LocalNetworkGateway resource. * - * @param {object} [parameters.localNetworkGateway2.bgpSettings] Local network - * gateway's BGP speaker settings. + * @param {string} [parameters.etag] A unique read-only string that changes + * whenever the resource is updated. * - * @param {number} [parameters.localNetworkGateway2.bgpSettings.asn] The BGP - * speaker's ASN. + * @param {string} [parameters.id] Resource ID. * - * @param {string} - * [parameters.localNetworkGateway2.bgpSettings.bgpPeeringAddress] The BGP - * peering address and BGP identifier of this BGP speaker. + * @param {string} [parameters.location] Resource location. * - * @param {number} [parameters.localNetworkGateway2.bgpSettings.peerWeight] The - * weight added to routes learned from this BGP speaker. + * @param {object} [parameters.tags] Resource tags. * - * @param {string} [parameters.localNetworkGateway2.resourceGuid] The resource - * GUID property of the LocalNetworkGateway resource. + * @param {object} [options] Optional Parameters. * - * @param {string} [parameters.localNetworkGateway2.etag] A unique read-only - * string that changes whenever the resource is updated. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} [parameters.localNetworkGateway2.id] Resource ID. + * @returns {Promise} A promise is returned * - * @param {string} [parameters.localNetworkGateway2.location] Resource - * location. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {object} [parameters.localNetworkGateway2.tags] Resource tags. + * @reject {Error|ServiceError} - The error object. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a local network gateway in the specified resource group. * - * @param {string} parameters.connectionType Gateway connection type. Possible - * values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible - * values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' + * @param {string} resourceGroupName The name of the resource group. * - * @param {string} [parameters.connectionProtocol] Connection protocol used for - * this connection. Possible values include: 'IKEv2', 'IKEv1' + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * - * @param {number} [parameters.routingWeight] The routing weight. + * @param {object} parameters Parameters supplied to the create or update local + * network gateway operation. * - * @param {string} [parameters.sharedKey] The IPSec shared key. + * @param {object} [parameters.localNetworkAddressSpace] Local network site + * address space. * - * @param {object} [parameters.peer] The reference to peerings resource. + * @param {array} [parameters.localNetworkAddressSpace.addressPrefixes] A list + * of address blocks reserved for this virtual network in CIDR notation. * - * @param {string} [parameters.peer.id] Resource ID. + * @param {string} [parameters.gatewayIpAddress] IP address of local network + * gateway. * - * @param {boolean} [parameters.enableBgp] EnableBgp flag + * @param {object} [parameters.bgpSettings] Local network gateway's BGP speaker + * settings. * - * @param {boolean} [parameters.usePolicyBasedTrafficSelectors] Enable - * policy-based traffic selectors. + * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. * - * @param {array} [parameters.ipsecPolicies] The IPSec Policies to be - * considered by this connection. + * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering + * address and BGP identifier of this BGP speaker. * - * @param {string} [parameters.resourceGuid] The resource GUID property of the - * VirtualNetworkGatewayConnection resource. + * @param {number} [parameters.bgpSettings.peerWeight] The weight added to + * routes learned from this BGP speaker. * - * @param {boolean} [parameters.expressRouteGatewayBypass] Bypass ExpressRoute - * Gateway for data forwarding + * @param {string} [parameters.resourceGuid] The resource GUID property of the + * LocalNetworkGateway resource. * - * @param {string} [parameters.etag] Gets a unique read-only string that - * changes whenever the resource is updated. + * @param {string} [parameters.etag] A unique read-only string that changes + * whenever the resource is updated. * * @param {string} [parameters.id] Resource ID. * @@ -40174,198 +40004,190 @@ export interface VirtualNetworkGatewayConnections { * @param {object} [options.customHeaders] Headers that will be added to the * request * - * @returns {Promise} A promise is returned + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @reject {Error|ServiceError} - The error object. + * {Promise} A promise is returned. + * + * @resolve {LocalNetworkGateway} - 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. + * + * {LocalNetworkGateway} [result] - The deserialized result object if an error did not occur. + * See {@link LocalNetworkGateway} 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. */ - createOrUpdateWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + createOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + /** - * Creates or updates a virtual network gateway connection in the specified - * resource group. + * Gets the specified local network gateway in a resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. - * - * @param {object} parameters Parameters supplied to the create or update - * virtual network gateway connection operation. - * - * @param {string} [parameters.authorizationKey] The authorizationKey. - * - * @param {object} parameters.virtualNetworkGateway1 The reference to virtual - * network gateway resource. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * - * @param {object} [parameters.virtualNetworkGateway2] The reference to virtual - * network gateway resource. + * @param {object} [options] Optional Parameters. * - * @param {array} [parameters.virtualNetworkGateway2.ipConfigurations] IP - * configurations for virtual network gateway. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} [parameters.virtualNetworkGateway2.gatewayType] The type of - * this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - * Possible values include: 'Vpn', 'ExpressRoute' + * @returns {Promise} A promise is returned * - * @param {string} [parameters.virtualNetworkGateway2.vpnType] The type of this - * virtual network gateway. Possible values are: 'PolicyBased' and - * 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased' + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {boolean} [parameters.virtualNetworkGateway2.enableBgp] Whether BGP - * is enabled for this virtual network gateway or not. + * @reject {Error|ServiceError} - The error object. + */ + getWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets the specified local network gateway in a resource group. * - * @param {boolean} [parameters.virtualNetworkGateway2.activeActive] - * ActiveActive flag + * @param {string} resourceGroupName The name of the resource group. * - * @param {object} [parameters.virtualNetworkGateway2.gatewayDefaultSite] The - * reference of the LocalNetworkGateway resource which represents local network - * site having default routes. Assign Null value in case of removing existing - * default site setting. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * - * @param {object} [parameters.virtualNetworkGateway2.sku] The reference of the - * VirtualNetworkGatewaySku resource which represents the SKU selected for - * Virtual network gateway. + * @param {object} [options] Optional Parameters. * - * @param {string} [parameters.virtualNetworkGateway2.sku.name] Gateway SKU - * name. Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} [parameters.virtualNetworkGateway2.sku.tier] Gateway SKU - * tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @param {number} [parameters.virtualNetworkGateway2.sku.capacity] The - * capacity. + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @param {object} [parameters.virtualNetworkGateway2.vpnClientConfiguration] - * The reference of the VpnClientConfiguration resource which represents the - * P2S VpnClient configurations. + * {Promise} A promise is returned. * - * @param {object} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool] - * The reference of the address space resource which represents Address space - * for P2S VpnClient. + * @resolve {LocalNetworkGateway} - The deserialized result object. * - * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRootCertificates] - * VpnClientRootCertificate for virtual network gateway. + * @reject {Error|ServiceError} - The error object. * - * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRevokedCertificates] - * VpnClientRevokedCertificate for Virtual network gateway. + * {ServiceCallback} optionalCallback(err, result, request, response) * - * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientProtocols] - * VpnClientProtocols for Virtual network gateway. + * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientIpsecPolicies] - * VpnClientIpsecPolicies for virtual network gateway P2S client. + * {LocalNetworkGateway} [result] - The deserialized result object if an error did not occur. + * See {@link LocalNetworkGateway} for more information. * - * @param {string} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerAddress] - * The radius server address property of the VirtualNetworkGateway resource for - * vpn client connection. + * {WebResource} [request] - The HTTP Request object if an error did not occur. * - * @param {string} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerSecret] - * The radius secret property of the VirtualNetworkGateway resource for vpn - * client connection. + * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. + */ + get(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, localNetworkGatewayName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, localNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes the specified local network gateway. * - * @param {object} [parameters.virtualNetworkGateway2.bgpSettings] Virtual - * network gateway's BGP speaker settings. + * @param {string} resourceGroupName The name of the resource group. * - * @param {string} [parameters.virtualNetworkGateway2.resourceGuid] The - * resource GUID property of the VirtualNetworkGateway resource. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * - * @param {string} [parameters.virtualNetworkGateway2.etag] Gets a unique - * read-only string that changes whenever the resource is updated. + * @param {object} [options] Optional Parameters. * - * @param {string} [parameters.virtualNetworkGateway2.id] Resource ID. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {string} [parameters.virtualNetworkGateway2.location] Resource - * location. + * @returns {Promise} A promise is returned * - * @param {object} [parameters.virtualNetworkGateway2.tags] Resource tags. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {object} [parameters.localNetworkGateway2] The reference to local - * network gateway resource. + * @reject {Error|ServiceError} - The error object. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes the specified local network gateway. * - * @param {object} [parameters.localNetworkGateway2.localNetworkAddressSpace] - * Local network site address space. + * @param {string} resourceGroupName The name of the resource group. * - * @param {array} - * [parameters.localNetworkGateway2.localNetworkAddressSpace.addressPrefixes] A - * list of address blocks reserved for this virtual network in CIDR notation. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * - * @param {string} [parameters.localNetworkGateway2.gatewayIpAddress] IP - * address of local network gateway. + * @param {object} [options] Optional Parameters. * - * @param {object} [parameters.localNetworkGateway2.bgpSettings] Local network - * gateway's BGP speaker settings. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {number} [parameters.localNetworkGateway2.bgpSettings.asn] The BGP - * speaker's ASN. + * @param {ServiceCallback} [optionalCallback] - The optional callback. * - * @param {string} - * [parameters.localNetworkGateway2.bgpSettings.bgpPeeringAddress] The BGP - * peering address and BGP identifier of this BGP speaker. + * @returns {ServiceCallback|Promise} If a callback was passed as the last + * parameter then it returns the callback else returns a Promise. * - * @param {number} [parameters.localNetworkGateway2.bgpSettings.peerWeight] The - * weight added to routes learned from this BGP speaker. + * {Promise} A promise is returned. * - * @param {string} [parameters.localNetworkGateway2.resourceGuid] The resource - * GUID property of the LocalNetworkGateway resource. + * @resolve {null} - The deserialized result object. * - * @param {string} [parameters.localNetworkGateway2.etag] A unique read-only - * string that changes whenever the resource is updated. + * @reject {Error|ServiceError} - The error object. * - * @param {string} [parameters.localNetworkGateway2.id] Resource ID. + * {ServiceCallback} optionalCallback(err, result, request, response) * - * @param {string} [parameters.localNetworkGateway2.location] Resource - * location. + * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * @param {object} [parameters.localNetworkGateway2.tags] Resource tags. + * {null} [result] - The deserialized result object if an error did not occur. * - * @param {string} parameters.connectionType Gateway connection type. Possible - * values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible - * values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' + * {WebResource} [request] - The HTTP Request object if an error did not occur. * - * @param {string} [parameters.connectionProtocol] Connection protocol used for - * this connection. Possible values include: 'IKEv2', 'IKEv1' + * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. + */ + deleteMethod(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, localNetworkGatewayName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, localNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates a local network gateway tags. * - * @param {number} [parameters.routingWeight] The routing weight. + * @param {string} resourceGroupName The name of the resource group. * - * @param {string} [parameters.sharedKey] The IPSec shared key. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * - * @param {object} [parameters.peer] The reference to peerings resource. + * @param {object} parameters Parameters supplied to update local network + * gateway tags. * - * @param {string} [parameters.peer.id] Resource ID. + * @param {object} [parameters.tags] Resource tags. * - * @param {boolean} [parameters.enableBgp] EnableBgp flag + * @param {object} [options] Optional Parameters. * - * @param {boolean} [parameters.usePolicyBasedTrafficSelectors] Enable - * policy-based traffic selectors. + * @param {object} [options.customHeaders] Headers that will be added to the + * request * - * @param {array} [parameters.ipsecPolicies] The IPSec Policies to be - * considered by this connection. + * @returns {Promise} A promise is returned * - * @param {string} [parameters.resourceGuid] The resource GUID property of the - * VirtualNetworkGatewayConnection resource. + * @resolve {HttpOperationResponse} - The deserialized result object. * - * @param {boolean} [parameters.expressRouteGatewayBypass] Bypass ExpressRoute - * Gateway for data forwarding + * @reject {Error|ServiceError} - The error object. + */ + updateTagsWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates a local network gateway tags. * - * @param {string} [parameters.etag] Gets a unique read-only string that - * changes whenever the resource is updated. + * @param {string} resourceGroupName The name of the resource group. * - * @param {string} [parameters.id] Resource ID. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * - * @param {string} [parameters.location] Resource location. + * @param {object} parameters Parameters supplied to update local network + * gateway tags. * * @param {object} [parameters.tags] Resource tags. * @@ -40381,7 +40203,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGatewayConnection} - The deserialized result object. + * @resolve {LocalNetworkGateway} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -40389,27 +40211,23 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGatewayConnection} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayConnection} for more - * information. + * {LocalNetworkGateway} [result] - The deserialized result object if an error did not occur. + * See {@link LocalNetworkGateway} 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. */ - createOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - createOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, callback: ServiceCallback): void; - createOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + updateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + updateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, callback: ServiceCallback): void; + updateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Gets the specified virtual network gateway connection by resource group. + * Gets all the local network gateways in a resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. - * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -40417,20 +40235,17 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - getWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + listWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets the specified virtual network gateway connection by resource group. + * Gets all the local network gateways in a resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. - * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -40443,7 +40258,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGatewayConnection} - The deserialized result object. + * @resolve {LocalNetworkGatewayListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -40451,26 +40266,61 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGatewayConnection} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayConnection} for more + * {LocalNetworkGatewayListResult} [result] - The deserialized result object if an error did not occur. + * See {@link LocalNetworkGatewayListResult} 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. */ - get(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - get(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, callback: ServiceCallback): void; - get(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + list(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(resourceGroupName: string, callback: ServiceCallback): void; + list(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Deletes the specified virtual network Gateway connection. + * Creates or updates a local network gateway in the specified resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. + * + * @param {object} parameters Parameters supplied to the create or update local + * network gateway operation. + * + * @param {object} [parameters.localNetworkAddressSpace] Local network site + * address space. + * + * @param {array} [parameters.localNetworkAddressSpace.addressPrefixes] A list + * of address blocks reserved for this virtual network in CIDR notation. + * + * @param {string} [parameters.gatewayIpAddress] IP address of local network + * gateway. + * + * @param {object} [parameters.bgpSettings] Local network gateway's BGP speaker + * settings. + * + * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * + * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering + * address and BGP identifier of this BGP speaker. + * + * @param {number} [parameters.bgpSettings.peerWeight] The weight added to + * routes learned from this BGP speaker. + * + * @param {string} [parameters.resourceGuid] The resource GUID property of the + * LocalNetworkGateway resource. + * + * @param {string} [parameters.etag] A unique read-only string that changes + * whenever the resource is updated. + * + * @param {string} [parameters.id] Resource ID. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -40479,19 +40329,54 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - deleteMethodWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Deletes the specified virtual network Gateway connection. + * Creates or updates a local network gateway in the specified resource group. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. + * + * @param {object} parameters Parameters supplied to the create or update local + * network gateway operation. + * + * @param {object} [parameters.localNetworkAddressSpace] Local network site + * address space. + * + * @param {array} [parameters.localNetworkAddressSpace.addressPrefixes] A list + * of address blocks reserved for this virtual network in CIDR notation. + * + * @param {string} [parameters.gatewayIpAddress] IP address of local network + * gateway. + * + * @param {object} [parameters.bgpSettings] Local network gateway's BGP speaker + * settings. + * + * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * + * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering + * address and BGP identifier of this BGP speaker. + * + * @param {number} [parameters.bgpSettings.peerWeight] The weight added to + * routes learned from this BGP speaker. + * + * @param {string} [parameters.resourceGuid] The resource GUID property of the + * LocalNetworkGateway resource. + * + * @param {string} [parameters.etag] A unique read-only string that changes + * whenever the resource is updated. + * + * @param {string} [parameters.id] Resource ID. + * + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -40505,7 +40390,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {null} - The deserialized result object. + * @resolve {LocalNetworkGateway} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -40513,29 +40398,25 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {null} [result] - The deserialized result object if an error did not occur. + * {LocalNetworkGateway} [result] - The deserialized result object if an error did not occur. + * See {@link LocalNetworkGateway} 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. */ - deleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - deleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, callback: ServiceCallback): void; - deleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginCreateOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Updates a virtual network gateway connection tags. + * Deletes the specified local network gateway. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. - * - * @param {object} parameters Parameters supplied to update virtual network - * gateway connection tags. - * - * @param {object} [parameters.tags] Resource tags. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * * @param {object} [options] Optional Parameters. * @@ -40544,24 +40425,19 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - updateTagsWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Updates a virtual network gateway connection tags. + * Deletes the specified local network gateway. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. - * - * @param {object} parameters Parameters supplied to update virtual network - * gateway connection tags. - * - * @param {object} [parameters.tags] Resource tags. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * * @param {object} [options] Optional Parameters. * @@ -40575,7 +40451,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGatewayConnection} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -40583,38 +40459,29 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGatewayConnection} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayConnection} for more - * information. + * {null} [result] - The deserialized result object if an error did not occur. * * {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. */ - updateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - updateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, callback: ServiceCallback): void; - updateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginDeleteMethod(resourceGroupName: string, localNetworkGatewayName: string, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, localNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual - * network gateway connection shared key for passed virtual network gateway - * connection in the specified resource group through Network resource - * provider. + * Updates a local network gateway tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The virtual network - * gateway connection name. - * - * @param {object} parameters Parameters supplied to the Begin Set Virtual - * Network Gateway connection Shared key operation throughNetwork resource - * provider. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * - * @param {string} parameters.value The virtual network connection shared key - * value. + * @param {object} parameters Parameters supplied to update local network + * gateway tags. * - * @param {string} [parameters.id] Resource ID. + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -40623,31 +40490,24 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - setSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginUpdateTagsWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual - * network gateway connection shared key for passed virtual network gateway - * connection in the specified resource group through Network resource - * provider. + * Updates a local network gateway tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The virtual network - * gateway connection name. - * - * @param {object} parameters Parameters supplied to the Begin Set Virtual - * Network Gateway connection Shared key operation throughNetwork resource - * provider. + * @param {string} localNetworkGatewayName The name of the local network + * gateway. * - * @param {string} parameters.value The virtual network connection shared key - * value. + * @param {object} parameters Parameters supplied to update local network + * gateway tags. * - * @param {string} [parameters.id] Resource ID. + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -40661,7 +40521,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {ConnectionSharedKey} - The deserialized result object. + * @resolve {LocalNetworkGateway} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -40669,27 +40529,23 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {ConnectionSharedKey} [result] - The deserialized result object if an error did not occur. - * See {@link ConnectionSharedKey} for more information. + * {LocalNetworkGateway} [result] - The deserialized result object if an error did not occur. + * See {@link LocalNetworkGateway} 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. */ - setSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - setSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, callback: ServiceCallback): void; - setSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginUpdateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginUpdateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, callback: ServiceCallback): void; + beginUpdateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves - * information about the specified virtual network gateway connection shared - * key through Network resource provider. - * - * @param {string} resourceGroupName The name of the resource group. + * Gets all the local network gateways in a resource group. * - * @param {string} virtualNetworkGatewayConnectionName The virtual network - * gateway connection shared key name. + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. * * @param {object} [options] Optional Parameters. * @@ -40698,21 +40554,17 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - getSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves - * information about the specified virtual network gateway connection shared - * key through Network resource provider. - * - * @param {string} resourceGroupName The name of the resource group. + * Gets all the local network gateways in a resource group. * - * @param {string} virtualNetworkGatewayConnectionName The virtual network - * gateway connection shared key name. + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. * * @param {object} [options] Optional Parameters. * @@ -40726,7 +40578,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {ConnectionSharedKey} - The deserialized result object. + * @resolve {LocalNetworkGatewayListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -40734,24 +40586,35 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {ConnectionSharedKey} [result] - The deserialized result object if an error did not occur. - * See {@link ConnectionSharedKey} for more information. + * {LocalNetworkGatewayListResult} [result] - The deserialized result object if an error did not occur. + * See {@link LocalNetworkGatewayListResult} 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. */ - getSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - getSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, callback: ServiceCallback): void; - getSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * VirtualNetworkTaps + * __NOTE__: An instance of this class is automatically created for an + * instance of the NetworkManagementClient. + */ +export interface VirtualNetworkTaps { /** - * The List VirtualNetworkGatewayConnections operation retrieves all the - * virtual network gateways connections created. + * Deletes the specified virtual network tap. * * @param {string} resourceGroupName The name of the resource group. * + * @param {string} tapName The name of the virtual network tap. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -40759,18 +40622,19 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - listWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + deleteMethodWithHttpOperationResponse(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * The List VirtualNetworkGatewayConnections operation retrieves all the - * virtual network gateways connections created. + * Deletes the specified virtual network tap. * * @param {string} resourceGroupName The name of the resource group. * + * @param {string} tapName The name of the virtual network tap. + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -40783,7 +40647,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGatewayConnectionListResult} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -40791,36 +40655,23 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGatewayConnectionListResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayConnectionListResult} - * for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {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. */ - list(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - list(resourceGroupName: string, callback: ServiceCallback): void; - list(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, tapName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, tapName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * The VirtualNetworkGatewayConnectionResetSharedKey operation resets the - * virtual network gateway connection shared key for passed virtual network - * gateway connection in the specified resource group through Network resource - * provider. + * Gets information about the specified virtual network tap. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The virtual network - * gateway connection reset shared key Name. - * - * @param {object} parameters Parameters supplied to the begin reset virtual - * network gateway connection shared key operation through network resource - * provider. - * - * @param {number} parameters.keyLength The virtual network connection reset - * shared key length, should between 1 and 128. + * @param {string} tapName The name of virtual network tap. * * @param {object} [options] Optional Parameters. * @@ -40829,29 +40680,18 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - resetSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + getWithHttpOperationResponse(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * The VirtualNetworkGatewayConnectionResetSharedKey operation resets the - * virtual network gateway connection shared key for passed virtual network - * gateway connection in the specified resource group through Network resource - * provider. + * Gets information about the specified virtual network tap. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The virtual network - * gateway connection reset shared key Name. - * - * @param {object} parameters Parameters supplied to the begin reset virtual - * network gateway connection shared key operation through network resource - * provider. - * - * @param {number} parameters.keyLength The virtual network connection reset - * shared key length, should between 1 and 128. + * @param {string} tapName The name of virtual network tap. * * @param {object} [options] Optional Parameters. * @@ -40865,7 +40705,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {ConnectionResetSharedKey} - The deserialized result object. + * @resolve {VirtualNetworkTap} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -40873,196 +40713,355 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {ConnectionResetSharedKey} [result] - The deserialized result object if an error did not occur. - * See {@link ConnectionResetSharedKey} for more - * information. + * {VirtualNetworkTap} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkTap} 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. */ - resetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - resetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, callback: ServiceCallback): void; - resetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + get(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, tapName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, tapName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Creates or updates a virtual network gateway connection in the specified - * resource group. + * Creates or updates a Virtual Network Tap. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. + * @param {string} tapName The name of the virtual network tap. * * @param {object} parameters Parameters supplied to the create or update - * virtual network gateway connection operation. + * virtual network tap operation. * - * @param {string} [parameters.authorizationKey] The authorizationKey. + * @param {object} [parameters.destinationNetworkInterfaceIPConfiguration] The + * reference to the private IP Address of the collector nic that will receive + * the tap * - * @param {object} parameters.virtualNetworkGateway1 The reference to virtual - * network gateway resource. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] + * The reference to Virtual Network Taps. * - * @param {object} [parameters.virtualNetworkGateway2] The reference to virtual - * network gateway resource. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] + * The reference of ApplicationGatewayBackendAddressPool resource. * - * @param {array} [parameters.virtualNetworkGateway2.ipConfigurations] IP - * configurations for virtual network gateway. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] + * The reference of LoadBalancerBackendAddressPool resource. * - * @param {string} [parameters.virtualNetworkGateway2.gatewayType] The type of - * this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - * Possible values include: 'Vpn', 'ExpressRoute' + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] + * A list of references of LoadBalancerInboundNatRules. * - * @param {string} [parameters.virtualNetworkGateway2.vpnType] The type of this - * virtual network gateway. Possible values are: 'PolicyBased' and - * 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased' + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddress] + * Private IP address of the IP configuration. * - * @param {boolean} [parameters.virtualNetworkGateway2.enableBgp] Whether BGP - * is enabled for this virtual network gateway or not. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] + * Defines how a private IP address is assigned. Possible values are: 'Static' + * and 'Dynamic'. Possible values include: 'Static', 'Dynamic' * - * @param {boolean} [parameters.virtualNetworkGateway2.activeActive] - * ActiveActive flag + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] + * Available from Api-Version 2016-03-30 onwards, it represents whether the + * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. + * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', + * 'IPv6' * - * @param {object} [parameters.virtualNetworkGateway2.gatewayDefaultSite] The - * reference of the LocalNetworkGateway resource which represents local network - * site having default routes. Assign Null value in case of removing existing - * default site setting. + * @param {object} + * [parameters.destinationNetworkInterfaceIPConfiguration.subnet] Subnet bound + * to the IP configuration. * - * @param {object} [parameters.virtualNetworkGateway2.sku] The reference of the - * VirtualNetworkGatewaySku resource which represents the SKU selected for - * Virtual network gateway. + * @param {boolean} + * [parameters.destinationNetworkInterfaceIPConfiguration.primary] Gets whether + * this is a primary customer address on the network interface. * - * @param {string} [parameters.virtualNetworkGateway2.sku.name] Gateway SKU - * name. Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + * @param {object} + * [parameters.destinationNetworkInterfaceIPConfiguration.publicIPAddress] + * Public IP address bound to the IP configuration. * - * @param {string} [parameters.virtualNetworkGateway2.sku.tier] Gateway SKU - * tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] + * Application security groups in which the IP configuration is included. * - * @param {number} [parameters.virtualNetworkGateway2.sku.capacity] The - * capacity. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.provisioningState] + * The provisioning state of the network interface IP configuration. Possible + * values are: 'Updating', 'Deleting', and 'Failed'. * - * @param {object} [parameters.virtualNetworkGateway2.vpnClientConfiguration] - * The reference of the VpnClientConfiguration resource which represents the - * P2S VpnClient configurations. + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.name] + * The name of the resource that is unique within a resource group. This name + * can be used to access the resource. + * + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.etag] + * A unique read-only string that changes whenever the resource is updated. + * + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.id] + * Resource ID. + * + * @param {object} [parameters.destinationLoadBalancerFrontEndIPConfiguration] + * The reference to the private IP address on the internal Load Balancer that + * will receive the tap + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] + * The private IP address of the IP configuration. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] + * The Private IP allocation method. Possible values are: 'Static' and + * 'Dynamic'. Possible values include: 'Static', 'Dynamic' * * @param {object} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool] - * The reference of the address space resource which represents Address space - * for P2S VpnClient. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet] The + * reference of the subnet resource. * - * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRootCertificates] - * VpnClientRootCertificate for virtual network gateway. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] + * The address prefix for the subnet. * * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRevokedCertificates] - * VpnClientRevokedCertificate for Virtual network gateway. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] + * List of address prefixes for the subnet. + * + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] + * The reference of the NetworkSecurityGroup resource. * * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientProtocols] - * VpnClientProtocols for Virtual network gateway. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] + * A collection of security rules of the network security group. * * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientIpsecPolicies] - * VpnClientIpsecPolicies for virtual network gateway P2S client. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] + * The default security rules of network security group. * * @param {string} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerAddress] - * The radius server address property of the VirtualNetworkGateway resource for - * vpn client connection. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] + * The resource GUID property of the network security group resource. * * @param {string} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerSecret] - * The radius secret property of the VirtualNetworkGateway resource for vpn - * client connection. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] + * The provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. * - * @param {object} [parameters.virtualNetworkGateway2.bgpSettings] Virtual - * network gateway's BGP speaker settings. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] + * A unique read-only string that changes whenever the resource is updated. * - * @param {string} [parameters.virtualNetworkGateway2.resourceGuid] The - * resource GUID property of the VirtualNetworkGateway resource. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.id] + * Resource ID. * - * @param {string} [parameters.virtualNetworkGateway2.etag] Gets a unique - * read-only string that changes whenever the resource is updated. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.location] + * Resource location. * - * @param {string} [parameters.virtualNetworkGateway2.id] Resource ID. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.tags] + * Resource tags. * - * @param {string} [parameters.virtualNetworkGateway2.location] Resource - * location. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] + * The reference of the RouteTable resource. * - * @param {object} [parameters.virtualNetworkGateway2.tags] Resource tags. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] + * Collection of routes contained within a route table. * - * @param {object} [parameters.localNetworkGateway2] The reference to local - * network gateway resource. + * @param {boolean} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] + * Gets or sets whether to disable the routes learned by BGP on that route + * table. True means disable. * - * @param {object} [parameters.localNetworkGateway2.localNetworkAddressSpace] - * Local network site address space. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] + * The provisioning state of the resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] + * Gets a unique read-only string that changes whenever the resource is + * updated. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.id] + * Resource ID. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.location] + * Resource location. + * + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.tags] + * Resource tags. * * @param {array} - * [parameters.localNetworkGateway2.localNetworkAddressSpace.addressPrefixes] A - * list of address blocks reserved for this virtual network in CIDR notation. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] + * An array of service endpoints. * - * @param {string} [parameters.localNetworkGateway2.gatewayIpAddress] IP - * address of local network gateway. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] + * An array of service endpoint policies. * - * @param {object} [parameters.localNetworkGateway2.bgpSettings] Local network - * gateway's BGP speaker settings. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] + * Gets an array of references to the external resources using subnet. * - * @param {number} [parameters.localNetworkGateway2.bgpSettings.asn] The BGP - * speaker's ASN. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] + * Gets an array of references to services injecting into this subnet. + * + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] + * Gets an array of references to the delegations on the subnet. * * @param {string} - * [parameters.localNetworkGateway2.bgpSettings.bgpPeeringAddress] The BGP - * peering address and BGP identifier of this BGP speaker. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] + * The provisioning state of the resource. * - * @param {number} [parameters.localNetworkGateway2.bgpSettings.peerWeight] The - * weight added to routes learned from this BGP speaker. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.name] The + * name of the resource that is unique within a resource group. This name can + * be used to access the resource. * - * @param {string} [parameters.localNetworkGateway2.resourceGuid] The resource - * GUID property of the LocalNetworkGateway resource. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] A + * unique read-only string that changes whenever the resource is updated. * - * @param {string} [parameters.localNetworkGateway2.etag] A unique read-only - * string that changes whenever the resource is updated. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.id] + * Resource ID. * - * @param {string} [parameters.localNetworkGateway2.id] Resource ID. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] + * The reference of the Public IP resource. * - * @param {string} [parameters.localNetworkGateway2.location] Resource - * location. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] + * The public IP address SKU. * - * @param {object} [parameters.localNetworkGateway2.tags] Resource tags. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] + * Name of a public IP address SKU. Possible values include: 'Basic', + * 'Standard' * - * @param {string} parameters.connectionType Gateway connection type. Possible - * values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible - * values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] + * The public IP allocation method. Possible values are: 'Static' and + * 'Dynamic'. Possible values include: 'Static', 'Dynamic' * - * @param {string} [parameters.connectionProtocol] Connection protocol used for - * this connection. Possible values include: 'IKEv2', 'IKEv1' + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] + * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. + * Possible values include: 'IPv4', 'IPv6' * - * @param {number} [parameters.routingWeight] The routing weight. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] + * The FQDN of the DNS record associated with the public IP address. * - * @param {string} [parameters.sharedKey] The IPSec shared key. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] + * Gets or sets the Domain name label.The concatenation of the domain name + * label and the regionalized DNS zone make up the fully qualified domain name + * associated with the public IP address. If a domain name label is specified, + * an A DNS record is created for the public IP in the Microsoft Azure DNS + * system. * - * @param {object} [parameters.peer] The reference to peerings resource. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] + * Gets the FQDN, Fully qualified domain name of the A DNS record associated + * with the public IP. This is the concatenation of the domainNameLabel and the + * regionalized DNS zone. * - * @param {string} [parameters.peer.id] Resource ID. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] + * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name + * that resolves to this public IP address. If the reverseFqdn is specified, + * then a PTR DNS record is created pointing from the IP address in the + * in-addr.arpa domain to the reverse FQDN. * - * @param {boolean} [parameters.enableBgp] EnableBgp flag + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] + * The list of tags associated with the public IP address. * - * @param {boolean} [parameters.usePolicyBasedTrafficSelectors] Enable - * policy-based traffic selectors. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] + * The IP address associated with the public IP address resource. * - * @param {array} [parameters.ipsecPolicies] The IPSec Policies to be - * considered by this connection. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] + * The Public IP Prefix this Public IP Address should be allocated from. * - * @param {string} [parameters.resourceGuid] The resource GUID property of the - * VirtualNetworkGatewayConnection resource. + * @param {number} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] + * The idle timeout of the public IP address. * - * @param {boolean} [parameters.expressRouteGatewayBypass] Bypass ExpressRoute - * Gateway for data forwarding + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] + * The resource GUID property of the public IP resource. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] + * The provisioning state of the PublicIP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] + * A unique read-only string that changes whenever the resource is updated. + * + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] + * A list of availability zones denoting the IP allocated for the resource + * needs to come from. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.id] + * Resource ID. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.location] + * Resource location. + * + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.tags] + * Resource tags. + * + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] + * The reference of the Public IP Prefix resource. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] + * Resource ID. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.provisioningState] + * Gets the provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.name] The name of + * the resource that is unique within a resource group. This name can be used + * to access the resource. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.etag] A unique + * read-only string that changes whenever the resource is updated. + * + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.zones] A list of + * availability zones denoting the IP allocated for the resource needs to come + * from. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.id] Resource ID. + * + * @param {number} [parameters.destinationPort] The VXLAN destination port that + * will receive the tapped traffic. * * @param {string} [parameters.etag] Gets a unique read-only string that * changes whenever the resource is updated. @@ -41080,260 +41079,358 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Creates or updates a virtual network gateway connection in the specified - * resource group. + * Creates or updates a Virtual Network Tap. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. + * @param {string} tapName The name of the virtual network tap. * * @param {object} parameters Parameters supplied to the create or update - * virtual network gateway connection operation. + * virtual network tap operation. + * + * @param {object} [parameters.destinationNetworkInterfaceIPConfiguration] The + * reference to the private IP Address of the collector nic that will receive + * the tap + * + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] + * The reference to Virtual Network Taps. + * + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] + * The reference of ApplicationGatewayBackendAddressPool resource. + * + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] + * The reference of LoadBalancerBackendAddressPool resource. + * + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] + * A list of references of LoadBalancerInboundNatRules. * - * @param {string} [parameters.authorizationKey] The authorizationKey. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddress] + * Private IP address of the IP configuration. * - * @param {object} parameters.virtualNetworkGateway1 The reference to virtual - * network gateway resource. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] + * Defines how a private IP address is assigned. Possible values are: 'Static' + * and 'Dynamic'. Possible values include: 'Static', 'Dynamic' * - * @param {object} [parameters.virtualNetworkGateway2] The reference to virtual - * network gateway resource. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] + * Available from Api-Version 2016-03-30 onwards, it represents whether the + * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. + * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', + * 'IPv6' * - * @param {array} [parameters.virtualNetworkGateway2.ipConfigurations] IP - * configurations for virtual network gateway. + * @param {object} + * [parameters.destinationNetworkInterfaceIPConfiguration.subnet] Subnet bound + * to the IP configuration. * - * @param {string} [parameters.virtualNetworkGateway2.gatewayType] The type of - * this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - * Possible values include: 'Vpn', 'ExpressRoute' + * @param {boolean} + * [parameters.destinationNetworkInterfaceIPConfiguration.primary] Gets whether + * this is a primary customer address on the network interface. * - * @param {string} [parameters.virtualNetworkGateway2.vpnType] The type of this - * virtual network gateway. Possible values are: 'PolicyBased' and - * 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased' + * @param {object} + * [parameters.destinationNetworkInterfaceIPConfiguration.publicIPAddress] + * Public IP address bound to the IP configuration. * - * @param {boolean} [parameters.virtualNetworkGateway2.enableBgp] Whether BGP - * is enabled for this virtual network gateway or not. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] + * Application security groups in which the IP configuration is included. * - * @param {boolean} [parameters.virtualNetworkGateway2.activeActive] - * ActiveActive flag + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.provisioningState] + * The provisioning state of the network interface IP configuration. Possible + * values are: 'Updating', 'Deleting', and 'Failed'. * - * @param {object} [parameters.virtualNetworkGateway2.gatewayDefaultSite] The - * reference of the LocalNetworkGateway resource which represents local network - * site having default routes. Assign Null value in case of removing existing - * default site setting. + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.name] + * The name of the resource that is unique within a resource group. This name + * can be used to access the resource. * - * @param {object} [parameters.virtualNetworkGateway2.sku] The reference of the - * VirtualNetworkGatewaySku resource which represents the SKU selected for - * Virtual network gateway. + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.etag] + * A unique read-only string that changes whenever the resource is updated. * - * @param {string} [parameters.virtualNetworkGateway2.sku.name] Gateway SKU - * name. Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.id] + * Resource ID. * - * @param {string} [parameters.virtualNetworkGateway2.sku.tier] Gateway SKU - * tier. Possible values include: 'Basic', 'HighPerformance', 'Standard', - * 'UltraPerformance', 'VpnGw1', 'VpnGw2', 'VpnGw3', 'VpnGw1AZ', 'VpnGw2AZ', - * 'VpnGw3AZ', 'ErGw1AZ', 'ErGw2AZ', 'ErGw3AZ' + * @param {object} [parameters.destinationLoadBalancerFrontEndIPConfiguration] + * The reference to the private IP address on the internal Load Balancer that + * will receive the tap * - * @param {number} [parameters.virtualNetworkGateway2.sku.capacity] The - * capacity. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] + * The private IP address of the IP configuration. * - * @param {object} [parameters.virtualNetworkGateway2.vpnClientConfiguration] - * The reference of the VpnClientConfiguration resource which represents the - * P2S VpnClient configurations. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] + * The Private IP allocation method. Possible values are: 'Static' and + * 'Dynamic'. Possible values include: 'Static', 'Dynamic' * * @param {object} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientAddressPool] - * The reference of the address space resource which represents Address space - * for P2S VpnClient. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet] The + * reference of the subnet resource. * - * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRootCertificates] - * VpnClientRootCertificate for virtual network gateway. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] + * The address prefix for the subnet. * * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientRevokedCertificates] - * VpnClientRevokedCertificate for Virtual network gateway. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] + * List of address prefixes for the subnet. + * + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] + * The reference of the NetworkSecurityGroup resource. * * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientProtocols] - * VpnClientProtocols for Virtual network gateway. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] + * A collection of security rules of the network security group. * * @param {array} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.vpnClientIpsecPolicies] - * VpnClientIpsecPolicies for virtual network gateway P2S client. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] + * The default security rules of network security group. * * @param {string} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerAddress] - * The radius server address property of the VirtualNetworkGateway resource for - * vpn client connection. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] + * The resource GUID property of the network security group resource. * * @param {string} - * [parameters.virtualNetworkGateway2.vpnClientConfiguration.radiusServerSecret] - * The radius secret property of the VirtualNetworkGateway resource for vpn - * client connection. - * - * @param {object} [parameters.virtualNetworkGateway2.bgpSettings] Virtual - * network gateway's BGP speaker settings. - * - * @param {string} [parameters.virtualNetworkGateway2.resourceGuid] The - * resource GUID property of the VirtualNetworkGateway resource. - * - * @param {string} [parameters.virtualNetworkGateway2.etag] Gets a unique - * read-only string that changes whenever the resource is updated. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] + * The provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. * - * @param {string} [parameters.virtualNetworkGateway2.id] Resource ID. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] + * A unique read-only string that changes whenever the resource is updated. * - * @param {string} [parameters.virtualNetworkGateway2.location] Resource - * location. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.id] + * Resource ID. * - * @param {object} [parameters.virtualNetworkGateway2.tags] Resource tags. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.location] + * Resource location. * - * @param {object} [parameters.localNetworkGateway2] The reference to local - * network gateway resource. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.tags] + * Resource tags. * - * @param {object} [parameters.localNetworkGateway2.localNetworkAddressSpace] - * Local network site address space. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] + * The reference of the RouteTable resource. * * @param {array} - * [parameters.localNetworkGateway2.localNetworkAddressSpace.addressPrefixes] A - * list of address blocks reserved for this virtual network in CIDR notation. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] + * Collection of routes contained within a route table. * - * @param {string} [parameters.localNetworkGateway2.gatewayIpAddress] IP - * address of local network gateway. + * @param {boolean} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] + * Gets or sets whether to disable the routes learned by BGP on that route + * table. True means disable. * - * @param {object} [parameters.localNetworkGateway2.bgpSettings] Local network - * gateway's BGP speaker settings. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] + * The provisioning state of the resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. * - * @param {number} [parameters.localNetworkGateway2.bgpSettings.asn] The BGP - * speaker's ASN. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] + * Gets a unique read-only string that changes whenever the resource is + * updated. * * @param {string} - * [parameters.localNetworkGateway2.bgpSettings.bgpPeeringAddress] The BGP - * peering address and BGP identifier of this BGP speaker. + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.id] + * Resource ID. * - * @param {number} [parameters.localNetworkGateway2.bgpSettings.peerWeight] The - * weight added to routes learned from this BGP speaker. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.location] + * Resource location. * - * @param {string} [parameters.localNetworkGateway2.resourceGuid] The resource - * GUID property of the LocalNetworkGateway resource. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.tags] + * Resource tags. * - * @param {string} [parameters.localNetworkGateway2.etag] A unique read-only - * string that changes whenever the resource is updated. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] + * An array of service endpoints. * - * @param {string} [parameters.localNetworkGateway2.id] Resource ID. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] + * An array of service endpoint policies. * - * @param {string} [parameters.localNetworkGateway2.location] Resource - * location. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] + * Gets an array of references to the external resources using subnet. * - * @param {object} [parameters.localNetworkGateway2.tags] Resource tags. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] + * Gets an array of references to services injecting into this subnet. * - * @param {string} parameters.connectionType Gateway connection type. Possible - * values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible - * values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient' + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] + * Gets an array of references to the delegations on the subnet. * - * @param {string} [parameters.connectionProtocol] Connection protocol used for - * this connection. Possible values include: 'IKEv2', 'IKEv1' + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] + * The provisioning state of the resource. * - * @param {number} [parameters.routingWeight] The routing weight. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.name] The + * name of the resource that is unique within a resource group. This name can + * be used to access the resource. * - * @param {string} [parameters.sharedKey] The IPSec shared key. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] A + * unique read-only string that changes whenever the resource is updated. * - * @param {object} [parameters.peer] The reference to peerings resource. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.id] + * Resource ID. * - * @param {string} [parameters.peer.id] Resource ID. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] + * The reference of the Public IP resource. * - * @param {boolean} [parameters.enableBgp] EnableBgp flag + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] + * The public IP address SKU. * - * @param {boolean} [parameters.usePolicyBasedTrafficSelectors] Enable - * policy-based traffic selectors. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] + * Name of a public IP address SKU. Possible values include: 'Basic', + * 'Standard' * - * @param {array} [parameters.ipsecPolicies] The IPSec Policies to be - * considered by this connection. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] + * The public IP allocation method. Possible values are: 'Static' and + * 'Dynamic'. Possible values include: 'Static', 'Dynamic' * - * @param {string} [parameters.resourceGuid] The resource GUID property of the - * VirtualNetworkGatewayConnection resource. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] + * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. + * Possible values include: 'IPv4', 'IPv6' * - * @param {boolean} [parameters.expressRouteGatewayBypass] Bypass ExpressRoute - * Gateway for data forwarding + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] + * The FQDN of the DNS record associated with the public IP address. * - * @param {string} [parameters.etag] Gets a unique read-only string that - * changes whenever the resource is updated. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] + * Gets or sets the Domain name label.The concatenation of the domain name + * label and the regionalized DNS zone make up the fully qualified domain name + * associated with the public IP address. If a domain name label is specified, + * an A DNS record is created for the public IP in the Microsoft Azure DNS + * system. * - * @param {string} [parameters.id] Resource ID. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] + * Gets the FQDN, Fully qualified domain name of the A DNS record associated + * with the public IP. This is the concatenation of the domainNameLabel and the + * regionalized DNS zone. * - * @param {string} [parameters.location] Resource location. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] + * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name + * that resolves to this public IP address. If the reverseFqdn is specified, + * then a PTR DNS record is created pointing from the IP address in the + * in-addr.arpa domain to the reverse FQDN. * - * @param {object} [parameters.tags] Resource tags. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] + * The list of tags associated with the public IP address. * - * @param {object} [options] Optional Parameters. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] + * The IP address associated with the public IP address resource. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] + * The Public IP Prefix this Public IP Address should be allocated from. * - * @param {ServiceCallback} [optionalCallback] - The optional callback. + * @param {number} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] + * The idle timeout of the public IP address. * - * @returns {ServiceCallback|Promise} If a callback was passed as the last - * parameter then it returns the callback else returns a Promise. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] + * The resource GUID property of the public IP resource. * - * {Promise} A promise is returned. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] + * The provisioning state of the PublicIP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. * - * @resolve {VirtualNetworkGatewayConnection} - The deserialized result object. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] + * A unique read-only string that changes whenever the resource is updated. * - * @reject {Error|ServiceError} - The error object. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] + * A list of availability zones denoting the IP allocated for the resource + * needs to come from. * - * {ServiceCallback} optionalCallback(err, result, request, response) + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.id] + * Resource ID. * - * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.location] + * Resource location. * - * {VirtualNetworkGatewayConnection} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayConnection} for more - * information. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.tags] + * Resource tags. * - * {WebResource} [request] - The HTTP Request object if an error did not occur. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] + * The reference of the Public IP Prefix resource. * - * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. - */ - beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, callback: ServiceCallback): void; - beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.VirtualNetworkGatewayConnection, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Deletes the specified virtual network Gateway connection. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] + * Resource ID. * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.provisioningState] + * Gets the provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.name] The name of + * the resource that is unique within a resource group. This name can be used + * to access the resource. * - * @param {object} [options] Optional Parameters. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.etag] A unique + * read-only string that changes whenever the resource is updated. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.zones] A list of + * availability zones denoting the IP allocated for the resource needs to come + * from. * - * @returns {Promise} A promise is returned + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.id] Resource ID. * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @param {number} [parameters.destinationPort] The VXLAN destination port that + * will receive the tapped traffic. * - * @reject {Error|ServiceError} - The error object. - */ - beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Deletes the specified virtual network Gateway connection. + * @param {string} [parameters.etag] Gets a unique read-only string that + * changes whenever the resource is updated. * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} [parameters.id] Resource ID. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. + * @param {string} [parameters.location] Resource location. + * + * @param {object} [parameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -41347,7 +41444,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {null} - The deserialized result object. + * @resolve {VirtualNetworkTap} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -41355,29 +41452,29 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {null} [result] - The deserialized result object if an error did not occur. + * {VirtualNetworkTap} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkTap} 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. */ - beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, callback: ServiceCallback): void; - beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Updates a virtual network gateway connection tags. + * Updates an VirtualNetworkTap tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. + * @param {string} tapName The name of the tap. * - * @param {object} parameters Parameters supplied to update virtual network - * gateway connection tags. + * @param {object} tapParameters Parameters supplied to update + * VirtualNetworkTap tags. * - * @param {object} [parameters.tags] Resource tags. + * @param {object} [tapParameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -41386,24 +41483,23 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginUpdateTagsWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + updateTagsWithHttpOperationResponse(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Updates a virtual network gateway connection tags. + * Updates an VirtualNetworkTap tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The name of the virtual - * network gateway connection. + * @param {string} tapName The name of the tap. * - * @param {object} parameters Parameters supplied to update virtual network - * gateway connection tags. + * @param {object} tapParameters Parameters supplied to update + * VirtualNetworkTap tags. * - * @param {object} [parameters.tags] Resource tags. + * @param {object} [tapParameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -41417,7 +41513,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGatewayConnection} - The deserialized result object. + * @resolve {VirtualNetworkTap} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -41425,38 +41521,20 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGatewayConnection} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayConnection} for more - * information. + * {VirtualNetworkTap} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkTap} 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. */ - beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, callback: ServiceCallback): void; - beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + updateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + updateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, callback: ServiceCallback): void; + updateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual - * network gateway connection shared key for passed virtual network gateway - * connection in the specified resource group through Network resource - * provider. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} virtualNetworkGatewayConnectionName The virtual network - * gateway connection name. - * - * @param {object} parameters Parameters supplied to the Begin Set Virtual - * Network Gateway connection Shared key operation throughNetwork resource - * provider. - * - * @param {string} parameters.value The virtual network connection shared key - * value. - * - * @param {string} [parameters.id] Resource ID. + * Gets all the VirtualNetworkTaps in a subscription. * * @param {object} [options] Optional Parameters. * @@ -41465,31 +41543,14 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginSetSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + listAllWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual - * network gateway connection shared key for passed virtual network gateway - * connection in the specified resource group through Network resource - * provider. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} virtualNetworkGatewayConnectionName The virtual network - * gateway connection name. - * - * @param {object} parameters Parameters supplied to the Begin Set Virtual - * Network Gateway connection Shared key operation throughNetwork resource - * provider. - * - * @param {string} parameters.value The virtual network connection shared key - * value. - * - * @param {string} [parameters.id] Resource ID. + * Gets all the VirtualNetworkTaps in a subscription. * * @param {object} [options] Optional Parameters. * @@ -41503,7 +41564,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {ConnectionSharedKey} - The deserialized result object. + * @resolve {VirtualNetworkTapListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -41511,35 +41572,23 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {ConnectionSharedKey} [result] - The deserialized result object if an error did not occur. - * See {@link ConnectionSharedKey} for more information. + * {VirtualNetworkTapListResult} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkTapListResult} 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. */ - beginSetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginSetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, callback: ServiceCallback): void; - beginSetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionSharedKey, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + listAll(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listAll(callback: ServiceCallback): void; + listAll(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - /** - * The VirtualNetworkGatewayConnectionResetSharedKey operation resets the - * virtual network gateway connection shared key for passed virtual network - * gateway connection in the specified resource group through Network resource - * provider. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} virtualNetworkGatewayConnectionName The virtual network - * gateway connection reset shared key Name. - * - * @param {object} parameters Parameters supplied to the begin reset virtual - * network gateway connection shared key operation through network resource - * provider. + /** + * Gets all the VirtualNetworkTaps in a subscription. * - * @param {number} parameters.keyLength The virtual network connection reset - * shared key length, should between 1 and 128. + * @param {string} resourceGroupName The name of the resource group. * * @param {object} [options] Optional Parameters. * @@ -41548,30 +41597,17 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginResetSharedKeyWithHttpOperationResponse(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + listByResourceGroupWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * The VirtualNetworkGatewayConnectionResetSharedKey operation resets the - * virtual network gateway connection shared key for passed virtual network - * gateway connection in the specified resource group through Network resource - * provider. + * Gets all the VirtualNetworkTaps in a subscription. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} virtualNetworkGatewayConnectionName The virtual network - * gateway connection reset shared key Name. - * - * @param {object} parameters Parameters supplied to the begin reset virtual - * network gateway connection shared key operation through network resource - * provider. - * - * @param {number} parameters.keyLength The virtual network connection reset - * shared key length, should between 1 and 128. - * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -41584,7 +41620,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {ConnectionResetSharedKey} - The deserialized result object. + * @resolve {VirtualNetworkTapListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -41592,25 +41628,25 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {ConnectionResetSharedKey} [result] - The deserialized result object if an error did not occur. - * See {@link ConnectionResetSharedKey} for more + * {VirtualNetworkTapListResult} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkTapListResult} 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. */ - beginResetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginResetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, callback: ServiceCallback): void; - beginResetSharedKey(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: models.ConnectionResetSharedKey, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + listByResourceGroup(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByResourceGroup(resourceGroupName: string, callback: ServiceCallback): void; + listByResourceGroup(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * The List VirtualNetworkGatewayConnections operation retrieves all the - * virtual network gateways connections created. + * Deletes the specified virtual network tap. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} tapName The name of the virtual network tap. * * @param {object} [options] Optional Parameters. * @@ -41619,18 +41655,18 @@ export interface VirtualNetworkGatewayConnections { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * The List VirtualNetworkGatewayConnections operation retrieves all the - * virtual network gateways connections created. + * Deletes the specified virtual network tap. * - * @param {string} nextPageLink The NextLink from the previous successful call - * to List operation. + * @param {string} resourceGroupName The name of the resource group. + * + * @param {string} tapName The name of the virtual network tap. * * @param {object} [options] Optional Parameters. * @@ -41644,7 +41680,7 @@ export interface VirtualNetworkGatewayConnections { * * {Promise} A promise is returned. * - * @resolve {VirtualNetworkGatewayConnectionListResult} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -41652,290 +41688,361 @@ export interface VirtualNetworkGatewayConnections { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {VirtualNetworkGatewayConnectionListResult} [result] - The deserialized result object if an error did not occur. - * See {@link VirtualNetworkGatewayConnectionListResult} - * for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {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. */ - listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listNext(nextPageLink: string, callback: ServiceCallback): void; - listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; -} - -/** - * @class - * LocalNetworkGateways - * __NOTE__: An instance of this class is automatically created for an - * instance of the NetworkManagementClient. - */ -export interface LocalNetworkGateways { + beginDeleteMethod(resourceGroupName: string, tapName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginDeleteMethod(resourceGroupName: string, tapName: string, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, tapName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Creates or updates a local network gateway in the specified resource group. + * Creates or updates a Virtual Network Tap. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. - * - * @param {object} parameters Parameters supplied to the create or update local - * network gateway operation. - * - * @param {object} [parameters.localNetworkAddressSpace] Local network site - * address space. - * - * @param {array} [parameters.localNetworkAddressSpace.addressPrefixes] A list - * of address blocks reserved for this virtual network in CIDR notation. - * - * @param {string} [parameters.gatewayIpAddress] IP address of local network - * gateway. - * - * @param {object} [parameters.bgpSettings] Local network gateway's BGP speaker - * settings. - * - * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. - * - * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering - * address and BGP identifier of this BGP speaker. - * - * @param {number} [parameters.bgpSettings.peerWeight] The weight added to - * routes learned from this BGP speaker. - * - * @param {string} [parameters.resourceGuid] The resource GUID property of the - * LocalNetworkGateway resource. - * - * @param {string} [parameters.etag] A unique read-only string that changes - * whenever the resource is updated. + * @param {string} tapName The name of the virtual network tap. * - * @param {string} [parameters.id] Resource ID. + * @param {object} parameters Parameters supplied to the create or update + * virtual network tap operation. * - * @param {string} [parameters.location] Resource location. + * @param {object} [parameters.destinationNetworkInterfaceIPConfiguration] The + * reference to the private IP Address of the collector nic that will receive + * the tap * - * @param {object} [parameters.tags] Resource tags. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] + * The reference to Virtual Network Taps. * - * @param {object} [options] Optional Parameters. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] + * The reference of ApplicationGatewayBackendAddressPool resource. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] + * The reference of LoadBalancerBackendAddressPool resource. * - * @returns {Promise} A promise is returned + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] + * A list of references of LoadBalancerInboundNatRules. * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddress] + * Private IP address of the IP configuration. * - * @reject {Error|ServiceError} - The error object. - */ - createOrUpdateWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Creates or updates a local network gateway in the specified resource group. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] + * Defines how a private IP address is assigned. Possible values are: 'Static' + * and 'Dynamic'. Possible values include: 'Static', 'Dynamic' * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] + * Available from Api-Version 2016-03-30 onwards, it represents whether the + * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. + * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', + * 'IPv6' * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {object} + * [parameters.destinationNetworkInterfaceIPConfiguration.subnet] Subnet bound + * to the IP configuration. * - * @param {object} parameters Parameters supplied to the create or update local - * network gateway operation. + * @param {boolean} + * [parameters.destinationNetworkInterfaceIPConfiguration.primary] Gets whether + * this is a primary customer address on the network interface. * - * @param {object} [parameters.localNetworkAddressSpace] Local network site - * address space. + * @param {object} + * [parameters.destinationNetworkInterfaceIPConfiguration.publicIPAddress] + * Public IP address bound to the IP configuration. * - * @param {array} [parameters.localNetworkAddressSpace.addressPrefixes] A list - * of address blocks reserved for this virtual network in CIDR notation. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] + * Application security groups in which the IP configuration is included. * - * @param {string} [parameters.gatewayIpAddress] IP address of local network - * gateway. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.provisioningState] + * The provisioning state of the network interface IP configuration. Possible + * values are: 'Updating', 'Deleting', and 'Failed'. * - * @param {object} [parameters.bgpSettings] Local network gateway's BGP speaker - * settings. + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.name] + * The name of the resource that is unique within a resource group. This name + * can be used to access the resource. * - * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.etag] + * A unique read-only string that changes whenever the resource is updated. * - * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering - * address and BGP identifier of this BGP speaker. + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.id] + * Resource ID. * - * @param {number} [parameters.bgpSettings.peerWeight] The weight added to - * routes learned from this BGP speaker. + * @param {object} [parameters.destinationLoadBalancerFrontEndIPConfiguration] + * The reference to the private IP address on the internal Load Balancer that + * will receive the tap * - * @param {string} [parameters.resourceGuid] The resource GUID property of the - * LocalNetworkGateway resource. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] + * The private IP address of the IP configuration. * - * @param {string} [parameters.etag] A unique read-only string that changes - * whenever the resource is updated. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] + * The Private IP allocation method. Possible values are: 'Static' and + * 'Dynamic'. Possible values include: 'Static', 'Dynamic' * - * @param {string} [parameters.id] Resource ID. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet] The + * reference of the subnet resource. * - * @param {string} [parameters.location] Resource location. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] + * The address prefix for the subnet. * - * @param {object} [parameters.tags] Resource tags. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] + * List of address prefixes for the subnet. * - * @param {object} [options] Optional Parameters. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] + * The reference of the NetworkSecurityGroup resource. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] + * A collection of security rules of the network security group. * - * @param {ServiceCallback} [optionalCallback] - The optional callback. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] + * The default security rules of network security group. * - * @returns {ServiceCallback|Promise} If a callback was passed as the last - * parameter then it returns the callback else returns a Promise. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] + * The resource GUID property of the network security group resource. * - * {Promise} A promise is returned. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] + * The provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. * - * @resolve {LocalNetworkGateway} - The deserialized result object. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] + * A unique read-only string that changes whenever the resource is updated. * - * @reject {Error|ServiceError} - The error object. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.id] + * Resource ID. * - * {ServiceCallback} optionalCallback(err, result, request, response) + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.location] + * Resource location. * - * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.tags] + * Resource tags. * - * {LocalNetworkGateway} [result] - The deserialized result object if an error did not occur. - * See {@link LocalNetworkGateway} for more information. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] + * The reference of the RouteTable resource. * - * {WebResource} [request] - The HTTP Request object if an error did not occur. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] + * Collection of routes contained within a route table. * - * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. - */ - createOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - createOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, callback: ServiceCallback): void; - createOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets the specified local network gateway in a resource group. + * @param {boolean} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] + * Gets or sets whether to disable the routes learned by BGP on that route + * table. True means disable. * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] + * The provisioning state of the resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] + * Gets a unique read-only string that changes whenever the resource is + * updated. * - * @param {object} [options] Optional Parameters. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.id] + * Resource ID. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.location] + * Resource location. * - * @returns {Promise} A promise is returned + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.tags] + * Resource tags. * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] + * An array of service endpoints. * - * @reject {Error|ServiceError} - The error object. - */ - getWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets the specified local network gateway in a resource group. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] + * An array of service endpoint policies. * - * @param {string} resourceGroupName The name of the resource group. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] + * Gets an array of references to the external resources using subnet. * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] + * Gets an array of references to services injecting into this subnet. * - * @param {object} [options] Optional Parameters. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] + * Gets an array of references to the delegations on the subnet. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] + * The provisioning state of the resource. * - * @param {ServiceCallback} [optionalCallback] - The optional callback. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.name] The + * name of the resource that is unique within a resource group. This name can + * be used to access the resource. * - * @returns {ServiceCallback|Promise} If a callback was passed as the last - * parameter then it returns the callback else returns a Promise. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] A + * unique read-only string that changes whenever the resource is updated. * - * {Promise} A promise is returned. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.id] + * Resource ID. * - * @resolve {LocalNetworkGateway} - The deserialized result object. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] + * The reference of the Public IP resource. * - * @reject {Error|ServiceError} - The error object. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] + * The public IP address SKU. * - * {ServiceCallback} optionalCallback(err, result, request, response) + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] + * Name of a public IP address SKU. Possible values include: 'Basic', + * 'Standard' * - * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] + * The public IP allocation method. Possible values are: 'Static' and + * 'Dynamic'. Possible values include: 'Static', 'Dynamic' * - * {LocalNetworkGateway} [result] - The deserialized result object if an error did not occur. - * See {@link LocalNetworkGateway} for more information. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] + * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. + * Possible values include: 'IPv4', 'IPv6' * - * {WebResource} [request] - The HTTP Request object if an error did not occur. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] + * The FQDN of the DNS record associated with the public IP address. * - * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. - */ - get(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - get(resourceGroupName: string, localNetworkGatewayName: string, callback: ServiceCallback): void; - get(resourceGroupName: string, localNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Deletes the specified local network gateway. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] + * Gets or sets the Domain name label.The concatenation of the domain name + * label and the regionalized DNS zone make up the fully qualified domain name + * associated with the public IP address. If a domain name label is specified, + * an A DNS record is created for the public IP in the Microsoft Azure DNS + * system. * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] + * Gets the FQDN, Fully qualified domain name of the A DNS record associated + * with the public IP. This is the concatenation of the domainNameLabel and the + * regionalized DNS zone. * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] + * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name + * that resolves to this public IP address. If the reverseFqdn is specified, + * then a PTR DNS record is created pointing from the IP address in the + * in-addr.arpa domain to the reverse FQDN. * - * @param {object} [options] Optional Parameters. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] + * The list of tags associated with the public IP address. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] + * The IP address associated with the public IP address resource. * - * @returns {Promise} A promise is returned + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] + * The Public IP Prefix this Public IP Address should be allocated from. * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @param {number} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] + * The idle timeout of the public IP address. * - * @reject {Error|ServiceError} - The error object. - */ - deleteMethodWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Deletes the specified local network gateway. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] + * The resource GUID property of the public IP resource. * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] + * The provisioning state of the PublicIP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] + * A unique read-only string that changes whenever the resource is updated. * - * @param {object} [options] Optional Parameters. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] + * A list of availability zones denoting the IP allocated for the resource + * needs to come from. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.id] + * Resource ID. * - * @param {ServiceCallback} [optionalCallback] - The optional callback. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.location] + * Resource location. * - * @returns {ServiceCallback|Promise} If a callback was passed as the last - * parameter then it returns the callback else returns a Promise. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.tags] + * Resource tags. * - * {Promise} A promise is returned. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] + * The reference of the Public IP Prefix resource. * - * @resolve {null} - The deserialized result object. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] + * Resource ID. * - * @reject {Error|ServiceError} - The error object. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.provisioningState] + * Gets the provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. * - * {ServiceCallback} optionalCallback(err, result, request, response) + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.name] The name of + * the resource that is unique within a resource group. This name can be used + * to access the resource. * - * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.etag] A unique + * read-only string that changes whenever the resource is updated. * - * {null} [result] - The deserialized result object if an error did not occur. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.zones] A list of + * availability zones denoting the IP allocated for the resource needs to come + * from. * - * {WebResource} [request] - The HTTP Request object if an error did not occur. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.id] Resource ID. * - * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. - */ - deleteMethod(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - deleteMethod(resourceGroupName: string, localNetworkGatewayName: string, callback: ServiceCallback): void; - deleteMethod(resourceGroupName: string, localNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Updates a local network gateway tags. + * @param {number} [parameters.destinationPort] The VXLAN destination port that + * will receive the tapped traffic. * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} [parameters.etag] Gets a unique read-only string that + * changes whenever the resource is updated. * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {string} [parameters.id] Resource ID. * - * @param {object} parameters Parameters supplied to update local network - * gateway tags. + * @param {string} [parameters.location] Resource location. * * @param {object} [parameters.tags] Resource tags. * @@ -41946,205 +42053,352 @@ export interface LocalNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - updateTagsWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Updates a local network gateway tags. + * Creates or updates a Virtual Network Tap. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {string} tapName The name of the virtual network tap. * - * @param {object} parameters Parameters supplied to update local network - * gateway tags. + * @param {object} parameters Parameters supplied to the create or update + * virtual network tap operation. * - * @param {object} [parameters.tags] Resource tags. + * @param {object} [parameters.destinationNetworkInterfaceIPConfiguration] The + * reference to the private IP Address of the collector nic that will receive + * the tap * - * @param {object} [options] Optional Parameters. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.virtualNetworkTaps] + * The reference to Virtual Network Taps. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.applicationGatewayBackendAddressPools] + * The reference of ApplicationGatewayBackendAddressPool resource. * - * @param {ServiceCallback} [optionalCallback] - The optional callback. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerBackendAddressPools] + * The reference of LoadBalancerBackendAddressPool resource. * - * @returns {ServiceCallback|Promise} If a callback was passed as the last - * parameter then it returns the callback else returns a Promise. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.loadBalancerInboundNatRules] + * A list of references of LoadBalancerInboundNatRules. * - * {Promise} A promise is returned. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddress] + * Private IP address of the IP configuration. * - * @resolve {LocalNetworkGateway} - The deserialized result object. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAllocationMethod] + * Defines how a private IP address is assigned. Possible values are: 'Static' + * and 'Dynamic'. Possible values include: 'Static', 'Dynamic' * - * @reject {Error|ServiceError} - The error object. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.privateIPAddressVersion] + * Available from Api-Version 2016-03-30 onwards, it represents whether the + * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. + * Possible values are: 'IPv4' and 'IPv6'. Possible values include: 'IPv4', + * 'IPv6' * - * {ServiceCallback} optionalCallback(err, result, request, response) + * @param {object} + * [parameters.destinationNetworkInterfaceIPConfiguration.subnet] Subnet bound + * to the IP configuration. * - * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. + * @param {boolean} + * [parameters.destinationNetworkInterfaceIPConfiguration.primary] Gets whether + * this is a primary customer address on the network interface. * - * {LocalNetworkGateway} [result] - The deserialized result object if an error did not occur. - * See {@link LocalNetworkGateway} for more information. + * @param {object} + * [parameters.destinationNetworkInterfaceIPConfiguration.publicIPAddress] + * Public IP address bound to the IP configuration. * - * {WebResource} [request] - The HTTP Request object if an error did not occur. + * @param {array} + * [parameters.destinationNetworkInterfaceIPConfiguration.applicationSecurityGroups] + * Application security groups in which the IP configuration is included. * - * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. - */ - updateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - updateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, callback: ServiceCallback): void; - updateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Gets all the local network gateways in a resource group. + * @param {string} + * [parameters.destinationNetworkInterfaceIPConfiguration.provisioningState] + * The provisioning state of the network interface IP configuration. Possible + * values are: 'Updating', 'Deleting', and 'Failed'. * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.name] + * The name of the resource that is unique within a resource group. This name + * can be used to access the resource. * - * @param {object} [options] Optional Parameters. + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.etag] + * A unique read-only string that changes whenever the resource is updated. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {string} [parameters.destinationNetworkInterfaceIPConfiguration.id] + * Resource ID. * - * @returns {Promise} A promise is returned + * @param {object} [parameters.destinationLoadBalancerFrontEndIPConfiguration] + * The reference to the private IP address on the internal Load Balancer that + * will receive the tap * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAddress] + * The private IP address of the IP configuration. * - * @reject {Error|ServiceError} - The error object. - */ - listWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Gets all the local network gateways in a resource group. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.privateIPAllocationMethod] + * The Private IP allocation method. Possible values are: 'Static' and + * 'Dynamic'. Possible values include: 'Static', 'Dynamic' * - * @param {string} resourceGroupName The name of the resource group. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet] The + * reference of the subnet resource. * - * @param {object} [options] Optional Parameters. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefix] + * The address prefix for the subnet. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.addressPrefixes] + * List of address prefixes for the subnet. * - * @param {ServiceCallback} [optionalCallback] - The optional callback. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup] + * The reference of the NetworkSecurityGroup resource. * - * @returns {ServiceCallback|Promise} If a callback was passed as the last - * parameter then it returns the callback else returns a Promise. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.securityRules] + * A collection of security rules of the network security group. * - * {Promise} A promise is returned. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.defaultSecurityRules] + * The default security rules of network security group. * - * @resolve {LocalNetworkGatewayListResult} - The deserialized result object. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.resourceGuid] + * The resource GUID property of the network security group resource. * - * @reject {Error|ServiceError} - The error object. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.provisioningState] + * The provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. * - * {ServiceCallback} optionalCallback(err, result, request, response) + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.etag] + * A unique read-only string that changes whenever the resource is updated. * - * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.id] + * Resource ID. * - * {LocalNetworkGatewayListResult} [result] - The deserialized result object if an error did not occur. - * See {@link LocalNetworkGatewayListResult} for more - * information. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.location] + * Resource location. * - * {WebResource} [request] - The HTTP Request object if an error did not occur. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.networkSecurityGroup.tags] + * Resource tags. * - * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. - */ - list(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - list(resourceGroupName: string, callback: ServiceCallback): void; - list(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; - - - /** - * Creates or updates a local network gateway in the specified resource group. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable] + * The reference of the RouteTable resource. * - * @param {string} resourceGroupName The name of the resource group. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.routes] + * Collection of routes contained within a route table. * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {boolean} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.disableBgpRoutePropagation] + * Gets or sets whether to disable the routes learned by BGP on that route + * table. True means disable. * - * @param {object} parameters Parameters supplied to the create or update local - * network gateway operation. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.provisioningState] + * The provisioning state of the resource. Possible values are: 'Updating', + * 'Deleting', and 'Failed'. * - * @param {object} [parameters.localNetworkAddressSpace] Local network site - * address space. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.etag] + * Gets a unique read-only string that changes whenever the resource is + * updated. * - * @param {array} [parameters.localNetworkAddressSpace.addressPrefixes] A list - * of address blocks reserved for this virtual network in CIDR notation. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.id] + * Resource ID. * - * @param {string} [parameters.gatewayIpAddress] IP address of local network - * gateway. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.location] + * Resource location. * - * @param {object} [parameters.bgpSettings] Local network gateway's BGP speaker - * settings. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.routeTable.tags] + * Resource tags. * - * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpoints] + * An array of service endpoints. * - * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering - * address and BGP identifier of this BGP speaker. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceEndpointPolicies] + * An array of service endpoint policies. * - * @param {number} [parameters.bgpSettings.peerWeight] The weight added to - * routes learned from this BGP speaker. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.resourceNavigationLinks] + * Gets an array of references to the external resources using subnet. * - * @param {string} [parameters.resourceGuid] The resource GUID property of the - * LocalNetworkGateway resource. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.serviceAssociationLinks] + * Gets an array of references to services injecting into this subnet. * - * @param {string} [parameters.etag] A unique read-only string that changes - * whenever the resource is updated. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.delegations] + * Gets an array of references to the delegations on the subnet. * - * @param {string} [parameters.id] Resource ID. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.provisioningState] + * The provisioning state of the resource. * - * @param {string} [parameters.location] Resource location. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.name] The + * name of the resource that is unique within a resource group. This name can + * be used to access the resource. * - * @param {object} [parameters.tags] Resource tags. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.etag] A + * unique read-only string that changes whenever the resource is updated. * - * @param {object} [options] Optional Parameters. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.subnet.id] + * Resource ID. * - * @param {object} [options.customHeaders] Headers that will be added to the - * request + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress] + * The reference of the Public IP resource. * - * @returns {Promise} A promise is returned + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku] + * The public IP address SKU. * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.sku.name] + * Name of a public IP address SKU. Possible values include: 'Basic', + * 'Standard' * - * @reject {Error|ServiceError} - The error object. - */ - beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; - - /** - * Creates or updates a local network gateway in the specified resource group. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAllocationMethod] + * The public IP allocation method. Possible values are: 'Static' and + * 'Dynamic'. Possible values include: 'Static', 'Dynamic' * - * @param {string} resourceGroupName The name of the resource group. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPAddressVersion] + * The public IP address version. Possible values are: 'IPv4' and 'IPv6'. + * Possible values include: 'IPv4', 'IPv6' * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings] + * The FQDN of the DNS record associated with the public IP address. * - * @param {object} parameters Parameters supplied to the create or update local - * network gateway operation. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.domainNameLabel] + * Gets or sets the Domain name label.The concatenation of the domain name + * label and the regionalized DNS zone make up the fully qualified domain name + * associated with the public IP address. If a domain name label is specified, + * an A DNS record is created for the public IP in the Microsoft Azure DNS + * system. * - * @param {object} [parameters.localNetworkAddressSpace] Local network site - * address space. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.fqdn] + * Gets the FQDN, Fully qualified domain name of the A DNS record associated + * with the public IP. This is the concatenation of the domainNameLabel and the + * regionalized DNS zone. * - * @param {array} [parameters.localNetworkAddressSpace.addressPrefixes] A list - * of address blocks reserved for this virtual network in CIDR notation. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.dnsSettings.reverseFqdn] + * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name + * that resolves to this public IP address. If the reverseFqdn is specified, + * then a PTR DNS record is created pointing from the IP address in the + * in-addr.arpa domain to the reverse FQDN. * - * @param {string} [parameters.gatewayIpAddress] IP address of local network - * gateway. + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipTags] + * The list of tags associated with the public IP address. * - * @param {object} [parameters.bgpSettings] Local network gateway's BGP speaker - * settings. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.ipAddress] + * The IP address associated with the public IP address resource. * - * @param {number} [parameters.bgpSettings.asn] The BGP speaker's ASN. + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.publicIPPrefix] + * The Public IP Prefix this Public IP Address should be allocated from. * - * @param {string} [parameters.bgpSettings.bgpPeeringAddress] The BGP peering - * address and BGP identifier of this BGP speaker. + * @param {number} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.idleTimeoutInMinutes] + * The idle timeout of the public IP address. * - * @param {number} [parameters.bgpSettings.peerWeight] The weight added to - * routes learned from this BGP speaker. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.resourceGuid] + * The resource GUID property of the public IP resource. * - * @param {string} [parameters.resourceGuid] The resource GUID property of the - * LocalNetworkGateway resource. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.provisioningState] + * The provisioning state of the PublicIP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. * - * @param {string} [parameters.etag] A unique read-only string that changes - * whenever the resource is updated. + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.etag] + * A unique read-only string that changes whenever the resource is updated. + * + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.zones] + * A list of availability zones denoting the IP allocated for the resource + * needs to come from. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.id] + * Resource ID. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.location] + * Resource location. + * + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPAddress.tags] + * Resource tags. + * + * @param {object} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix] + * The reference of the Public IP Prefix resource. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.publicIPPrefix.id] + * Resource ID. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.provisioningState] + * Gets the provisioning state of the public IP resource. Possible values are: + * 'Updating', 'Deleting', and 'Failed'. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.name] The name of + * the resource that is unique within a resource group. This name can be used + * to access the resource. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.etag] A unique + * read-only string that changes whenever the resource is updated. + * + * @param {array} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.zones] A list of + * availability zones denoting the IP allocated for the resource needs to come + * from. + * + * @param {string} + * [parameters.destinationLoadBalancerFrontEndIPConfiguration.id] Resource ID. + * + * @param {number} [parameters.destinationPort] The VXLAN destination port that + * will receive the tapped traffic. + * + * @param {string} [parameters.etag] Gets a unique read-only string that + * changes whenever the resource is updated. * * @param {string} [parameters.id] Resource ID. * @@ -42164,7 +42418,7 @@ export interface LocalNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {LocalNetworkGateway} - The deserialized result object. + * @resolve {VirtualNetworkTap} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -42172,25 +42426,29 @@ export interface LocalNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {LocalNetworkGateway} [result] - The deserialized result object if an error did not occur. - * See {@link LocalNetworkGateway} for more information. + * {VirtualNetworkTap} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkTap} 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. */ - beginCreateOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginCreateOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, callback: ServiceCallback): void; - beginCreateOrUpdate(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.LocalNetworkGateway, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginCreateOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, tapName: string, parameters: models.VirtualNetworkTap, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Deletes the specified local network gateway. + * Updates an VirtualNetworkTap tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {string} tapName The name of the tap. + * + * @param {object} tapParameters Parameters supplied to update + * VirtualNetworkTap tags. + * + * @param {object} [tapParameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -42199,19 +42457,23 @@ export interface LocalNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + beginUpdateTagsWithHttpOperationResponse(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Deletes the specified local network gateway. + * Updates an VirtualNetworkTap tags. * * @param {string} resourceGroupName The name of the resource group. * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. + * @param {string} tapName The name of the tap. + * + * @param {object} tapParameters Parameters supplied to update + * VirtualNetworkTap tags. + * + * @param {object} [tapParameters.tags] Resource tags. * * @param {object} [options] Optional Parameters. * @@ -42225,7 +42487,7 @@ export interface LocalNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {null} - The deserialized result object. + * @resolve {VirtualNetworkTap} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -42233,29 +42495,23 @@ export interface LocalNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {null} [result] - The deserialized result object if an error did not occur. + * {VirtualNetworkTap} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkTap} 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. */ - beginDeleteMethod(resourceGroupName: string, localNetworkGatewayName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginDeleteMethod(resourceGroupName: string, localNetworkGatewayName: string, callback: ServiceCallback): void; - beginDeleteMethod(resourceGroupName: string, localNetworkGatewayName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + beginUpdateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginUpdateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, callback: ServiceCallback): void; + beginUpdateTags(resourceGroupName: string, tapName: string, tapParameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Updates a local network gateway tags. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. - * - * @param {object} parameters Parameters supplied to update local network - * gateway tags. + * Gets all the VirtualNetworkTaps in a subscription. * - * @param {object} [parameters.tags] Resource tags. + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. * * @param {object} [options] Optional Parameters. * @@ -42264,24 +42520,17 @@ export interface LocalNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - beginUpdateTagsWithHttpOperationResponse(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + listAllNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Updates a local network gateway tags. - * - * @param {string} resourceGroupName The name of the resource group. - * - * @param {string} localNetworkGatewayName The name of the local network - * gateway. - * - * @param {object} parameters Parameters supplied to update local network - * gateway tags. + * Gets all the VirtualNetworkTaps in a subscription. * - * @param {object} [parameters.tags] Resource tags. + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. * * @param {object} [options] Optional Parameters. * @@ -42295,7 +42544,7 @@ export interface LocalNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {LocalNetworkGateway} - The deserialized result object. + * @resolve {VirtualNetworkTapListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -42303,20 +42552,21 @@ export interface LocalNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {LocalNetworkGateway} [result] - The deserialized result object if an error did not occur. - * See {@link LocalNetworkGateway} for more information. + * {VirtualNetworkTapListResult} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkTapListResult} 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. */ - beginUpdateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - beginUpdateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, callback: ServiceCallback): void; - beginUpdateTags(resourceGroupName: string, localNetworkGatewayName: string, parameters: models.TagsObject, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + listAllNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listAllNext(nextPageLink: string, callback: ServiceCallback): void; + listAllNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** - * Gets all the local network gateways in a resource group. + * Gets all the VirtualNetworkTaps in a subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -42328,14 +42578,14 @@ export interface LocalNetworkGateways { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ - listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + listByResourceGroupNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Gets all the local network gateways in a resource group. + * Gets all the VirtualNetworkTaps in a subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -42352,7 +42602,7 @@ export interface LocalNetworkGateways { * * {Promise} A promise is returned. * - * @resolve {LocalNetworkGatewayListResult} - The deserialized result object. + * @resolve {VirtualNetworkTapListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * @@ -42360,17 +42610,17 @@ export interface LocalNetworkGateways { * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * - * {LocalNetworkGatewayListResult} [result] - The deserialized result object if an error did not occur. - * See {@link LocalNetworkGatewayListResult} for more + * {VirtualNetworkTapListResult} [result] - The deserialized result object if an error did not occur. + * See {@link VirtualNetworkTapListResult} 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. */ - listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; - listNext(nextPageLink: string, callback: ServiceCallback): void; - listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + listByResourceGroupNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback): void; + listByResourceGroupNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; } /** diff --git a/lib/services/networkManagement2/lib/operations/index.js b/lib/services/networkManagement2/lib/operations/index.js index 6866063f4f..75d648518a 100644 --- a/lib/services/networkManagement2/lib/operations/index.js +++ b/lib/services/networkManagement2/lib/operations/index.js @@ -68,10 +68,10 @@ exports.Usages = require('./usages'); exports.VirtualNetworks = require('./virtualNetworks'); exports.Subnets = require('./subnets'); exports.VirtualNetworkPeerings = require('./virtualNetworkPeerings'); -exports.VirtualNetworkTaps = require('./virtualNetworkTaps'); exports.VirtualNetworkGateways = require('./virtualNetworkGateways'); exports.VirtualNetworkGatewayConnections = require('./virtualNetworkGatewayConnections'); exports.LocalNetworkGateways = require('./localNetworkGateways'); +exports.VirtualNetworkTaps = require('./virtualNetworkTaps'); exports.VirtualWans = require('./virtualWans'); exports.VpnSites = require('./vpnSites'); exports.VpnSitesConfiguration = require('./vpnSitesConfiguration'); diff --git a/lib/services/networkManagement2/lib/operations/interfaceEndpoints.js b/lib/services/networkManagement2/lib/operations/interfaceEndpoints.js index bfa2cd7128..b0ee50b968 100644 --- a/lib/services/networkManagement2/lib/operations/interfaceEndpoints.js +++ b/lib/services/networkManagement2/lib/operations/interfaceEndpoints.js @@ -115,7 +115,7 @@ function _get(resourceGroupName, interfaceEndpointName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -447,7 +447,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -583,7 +583,7 @@ function _listBySubscription(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -717,7 +717,7 @@ function _beginDeleteMethod(resourceGroupName, interfaceEndpointName, options, c if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -949,7 +949,7 @@ function _beginCreateOrUpdate(resourceGroupName, interfaceEndpointName, paramete if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/loadBalancerBackendAddressPools.js b/lib/services/networkManagement2/lib/operations/loadBalancerBackendAddressPools.js index d63d6ff367..ae3306f158 100644 --- a/lib/services/networkManagement2/lib/operations/loadBalancerBackendAddressPools.js +++ b/lib/services/networkManagement2/lib/operations/loadBalancerBackendAddressPools.js @@ -50,7 +50,7 @@ function _list(resourceGroupName, loadBalancerName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -195,7 +195,7 @@ function _get(resourceGroupName, loadBalancerName, backendAddressPoolName, optio if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/loadBalancerFrontendIPConfigurations.js b/lib/services/networkManagement2/lib/operations/loadBalancerFrontendIPConfigurations.js index 39aadcbb11..741a76dfe8 100644 --- a/lib/services/networkManagement2/lib/operations/loadBalancerFrontendIPConfigurations.js +++ b/lib/services/networkManagement2/lib/operations/loadBalancerFrontendIPConfigurations.js @@ -51,7 +51,7 @@ function _list(resourceGroupName, loadBalancerName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -198,7 +198,7 @@ function _get(resourceGroupName, loadBalancerName, frontendIPConfigurationName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/loadBalancerLoadBalancingRules.js b/lib/services/networkManagement2/lib/operations/loadBalancerLoadBalancingRules.js index d6dfb45567..76530a651c 100644 --- a/lib/services/networkManagement2/lib/operations/loadBalancerLoadBalancingRules.js +++ b/lib/services/networkManagement2/lib/operations/loadBalancerLoadBalancingRules.js @@ -50,7 +50,7 @@ function _list(resourceGroupName, loadBalancerName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -195,7 +195,7 @@ function _get(resourceGroupName, loadBalancerName, loadBalancingRuleName, option if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/loadBalancerNetworkInterfaces.js b/lib/services/networkManagement2/lib/operations/loadBalancerNetworkInterfaces.js index 83d0b03698..b677a57843 100644 --- a/lib/services/networkManagement2/lib/operations/loadBalancerNetworkInterfaces.js +++ b/lib/services/networkManagement2/lib/operations/loadBalancerNetworkInterfaces.js @@ -50,7 +50,7 @@ function _list(resourceGroupName, loadBalancerName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/loadBalancerOutboundRules.js b/lib/services/networkManagement2/lib/operations/loadBalancerOutboundRules.js index c3651470b2..f98dc32618 100644 --- a/lib/services/networkManagement2/lib/operations/loadBalancerOutboundRules.js +++ b/lib/services/networkManagement2/lib/operations/loadBalancerOutboundRules.js @@ -50,7 +50,7 @@ function _list(resourceGroupName, loadBalancerName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -195,7 +195,7 @@ function _get(resourceGroupName, loadBalancerName, outboundRuleName, options, ca if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/loadBalancerProbes.js b/lib/services/networkManagement2/lib/operations/loadBalancerProbes.js index 913ad65b12..2851e03a53 100644 --- a/lib/services/networkManagement2/lib/operations/loadBalancerProbes.js +++ b/lib/services/networkManagement2/lib/operations/loadBalancerProbes.js @@ -50,7 +50,7 @@ function _list(resourceGroupName, loadBalancerName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -195,7 +195,7 @@ function _get(resourceGroupName, loadBalancerName, probeName, options, callback) if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/loadBalancers.js b/lib/services/networkManagement2/lib/operations/loadBalancers.js index d1921be156..5dfcb5fdc1 100644 --- a/lib/services/networkManagement2/lib/operations/loadBalancers.js +++ b/lib/services/networkManagement2/lib/operations/loadBalancers.js @@ -115,7 +115,7 @@ function _get(resourceGroupName, loadBalancerName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -476,7 +476,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -610,7 +610,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -748,7 +748,7 @@ function _beginDeleteMethod(resourceGroupName, loadBalancerName, options, callba if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -929,7 +929,7 @@ function _beginCreateOrUpdate(resourceGroupName, loadBalancerName, parameters, o if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1110,7 +1110,7 @@ function _beginUpdateTags(resourceGroupName, loadBalancerName, parameters, optio if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/localNetworkGateways.js b/lib/services/networkManagement2/lib/operations/localNetworkGateways.js index f36707e4a4..eb535b3b36 100644 --- a/lib/services/networkManagement2/lib/operations/localNetworkGateways.js +++ b/lib/services/networkManagement2/lib/operations/localNetworkGateways.js @@ -164,7 +164,7 @@ function _get(resourceGroupName, localNetworkGatewayName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -460,7 +460,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -635,7 +635,7 @@ function _beginCreateOrUpdate(resourceGroupName, localNetworkGatewayName, parame if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -818,7 +818,7 @@ function _beginDeleteMethod(resourceGroupName, localNetworkGatewayName, options, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -956,7 +956,7 @@ function _beginUpdateTags(resourceGroupName, localNetworkGatewayName, parameters if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/networkInterfaceIPConfigurations.js b/lib/services/networkManagement2/lib/operations/networkInterfaceIPConfigurations.js index cd257fcb68..16dc14bbbc 100644 --- a/lib/services/networkManagement2/lib/operations/networkInterfaceIPConfigurations.js +++ b/lib/services/networkManagement2/lib/operations/networkInterfaceIPConfigurations.js @@ -50,7 +50,7 @@ function _list(resourceGroupName, networkInterfaceName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -196,7 +196,7 @@ function _get(resourceGroupName, networkInterfaceName, ipConfigurationName, opti if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/networkInterfaceLoadBalancers.js b/lib/services/networkManagement2/lib/operations/networkInterfaceLoadBalancers.js index 36c542364a..9edcfdf8d2 100644 --- a/lib/services/networkManagement2/lib/operations/networkInterfaceLoadBalancers.js +++ b/lib/services/networkManagement2/lib/operations/networkInterfaceLoadBalancers.js @@ -50,7 +50,7 @@ function _list(resourceGroupName, networkInterfaceName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/networkInterfaceTapConfigurations.js b/lib/services/networkManagement2/lib/operations/networkInterfaceTapConfigurations.js index cae3fe9818..913636d8df 100644 --- a/lib/services/networkManagement2/lib/operations/networkInterfaceTapConfigurations.js +++ b/lib/services/networkManagement2/lib/operations/networkInterfaceTapConfigurations.js @@ -117,7 +117,7 @@ function _get(resourceGroupName, networkInterfaceName, tapConfigurationName, opt if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -708,7 +708,7 @@ function _list(resourceGroupName, networkInterfaceName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -852,7 +852,7 @@ function _beginDeleteMethod(resourceGroupName, networkInterfaceName, tapConfigur if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1347,7 +1347,7 @@ function _beginCreateOrUpdate(resourceGroupName, networkInterfaceName, tapConfig if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/networkInterfaces.js b/lib/services/networkManagement2/lib/operations/networkInterfaces.js index 078ae20a4e..e3283aa2b1 100644 --- a/lib/services/networkManagement2/lib/operations/networkInterfaces.js +++ b/lib/services/networkManagement2/lib/operations/networkInterfaces.js @@ -115,7 +115,7 @@ function _get(resourceGroupName, networkInterfaceName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -511,7 +511,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -645,7 +645,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1743,7 +1743,7 @@ function _beginDeleteMethod(resourceGroupName, networkInterfaceName, options, ca if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1958,7 +1958,7 @@ function _beginCreateOrUpdate(resourceGroupName, networkInterfaceName, parameter if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2140,7 +2140,7 @@ function _beginUpdateTags(resourceGroupName, networkInterfaceName, parameters, o if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2301,7 +2301,7 @@ function _beginGetEffectiveRouteTable(resourceGroupName, networkInterfaceName, o if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2445,7 +2445,7 @@ function _beginListEffectiveNetworkSecurityGroups(resourceGroupName, networkInte if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/networkProfiles.js b/lib/services/networkManagement2/lib/operations/networkProfiles.js index cf3d7ea1c9..59c60dcfd0 100644 --- a/lib/services/networkManagement2/lib/operations/networkProfiles.js +++ b/lib/services/networkManagement2/lib/operations/networkProfiles.js @@ -48,7 +48,7 @@ function _deleteMethod(resourceGroupName, networkProfileName, options, callback) if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -177,7 +177,7 @@ function _get(resourceGroupName, networkProfileName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -344,7 +344,7 @@ function _createOrUpdate(resourceGroupName, networkProfileName, parameters, opti if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -526,7 +526,7 @@ function _updateTags(resourceGroupName, networkProfileName, parameters, options, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -683,7 +683,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -817,7 +817,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/networkSecurityGroups.js b/lib/services/networkManagement2/lib/operations/networkSecurityGroups.js index ebad706473..a864f1bc10 100644 --- a/lib/services/networkManagement2/lib/operations/networkSecurityGroups.js +++ b/lib/services/networkManagement2/lib/operations/networkSecurityGroups.js @@ -117,7 +117,7 @@ function _get(resourceGroupName, networkSecurityGroupName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -451,7 +451,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -585,7 +585,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -724,7 +724,7 @@ function _beginDeleteMethod(resourceGroupName, networkSecurityGroupName, options if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -876,7 +876,7 @@ function _beginCreateOrUpdate(resourceGroupName, networkSecurityGroupName, param if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1059,7 +1059,7 @@ function _beginUpdateTags(resourceGroupName, networkSecurityGroupName, parameter if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/networkWatchers.js b/lib/services/networkManagement2/lib/operations/networkWatchers.js index f8994335d6..56466a02ac 100644 --- a/lib/services/networkManagement2/lib/operations/networkWatchers.js +++ b/lib/services/networkManagement2/lib/operations/networkWatchers.js @@ -61,7 +61,7 @@ function _createOrUpdate(resourceGroupName, networkWatcherName, parameters, opti if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -239,7 +239,7 @@ function _get(resourceGroupName, networkWatcherName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -451,7 +451,7 @@ function _updateTags(resourceGroupName, networkWatcherName, parameters, options, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -611,7 +611,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -748,7 +748,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -898,7 +898,7 @@ function _getTopology(resourceGroupName, networkWatcherName, parameters, options if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1513,6 +1513,14 @@ function _getTroubleshootingResult(resourceGroupName, networkWatcherName, parame * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable * retention. * + * @param {object} [parameters.format] + * + * @param {string} [parameters.format.type] The file type of flow log. Possible + * values include: 'JSON' + * + * @param {number} [parameters.format.version] The version (revision) of the + * flow log. + * * @param {object} [parameters.flowAnalyticsConfiguration] * * @param {object} @@ -1534,6 +1542,11 @@ function _getTroubleshootingResult(resourceGroupName, networkWatcherName, parame * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId * Resource Id of the attached workspace * + * @param {number} + * [parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service should + * do flow analytics + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -2135,7 +2148,7 @@ function _beginDeleteMethod(resourceGroupName, networkWatcherName, options, call if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2294,7 +2307,7 @@ function _beginVerifyIPFlow(resourceGroupName, networkWatcherName, parameters, o if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2486,7 +2499,7 @@ function _beginGetNextHop(resourceGroupName, networkWatcherName, parameters, opt if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2670,7 +2683,7 @@ function _beginGetVMSecurityRules(resourceGroupName, networkWatcherName, paramet if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2860,7 +2873,7 @@ function _beginGetTroubleshooting(resourceGroupName, networkWatcherName, paramet if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3044,7 +3057,7 @@ function _beginGetTroubleshootingResult(resourceGroupName, networkWatcherName, p if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3215,6 +3228,14 @@ function _beginGetTroubleshootingResult(resourceGroupName, networkWatcherName, p * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable * retention. * + * @param {object} [parameters.format] + * + * @param {string} [parameters.format.type] The file type of flow log. Possible + * values include: 'JSON' + * + * @param {number} [parameters.format.version] The version (revision) of the + * flow log. + * * @param {object} [parameters.flowAnalyticsConfiguration] * * @param {object} @@ -3236,6 +3257,11 @@ function _beginGetTroubleshootingResult(resourceGroupName, networkWatcherName, p * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId * Resource Id of the attached workspace * + * @param {number} + * [parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service should + * do flow analytics + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -3264,7 +3290,7 @@ function _beginSetFlowLogConfiguration(resourceGroupName, networkWatcherName, pa if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3450,7 +3476,7 @@ function _beginGetFlowLogStatus(resourceGroupName, networkWatcherName, parameter if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3671,7 +3697,7 @@ function _beginCheckConnectivity(resourceGroupName, networkWatcherName, paramete if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3875,7 +3901,7 @@ function _beginGetAzureReachabilityReport(resourceGroupName, networkWatcherName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -4068,7 +4094,7 @@ function _beginListAvailableProviders(resourceGroupName, networkWatcherName, par if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -4261,7 +4287,7 @@ function _beginGetNetworkConfigurationDiagnostic(resourceGroupName, networkWatch if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -5693,6 +5719,14 @@ class NetworkWatchers { * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable * retention. * + * @param {object} [parameters.format] + * + * @param {string} [parameters.format.type] The file type of flow log. Possible + * values include: 'JSON' + * + * @param {number} [parameters.format.version] The version (revision) of the + * flow log. + * * @param {object} [parameters.flowAnalyticsConfiguration] * * @param {object} @@ -5714,6 +5748,11 @@ class NetworkWatchers { * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId * Resource Id of the attached workspace * + * @param {number} + * [parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service should + * do flow analytics + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -5767,6 +5806,14 @@ class NetworkWatchers { * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable * retention. * + * @param {object} [parameters.format] + * + * @param {string} [parameters.format.type] The file type of flow log. Possible + * values include: 'JSON' + * + * @param {number} [parameters.format.version] The version (revision) of the + * flow log. + * * @param {object} [parameters.flowAnalyticsConfiguration] * * @param {object} @@ -5788,6 +5835,11 @@ class NetworkWatchers { * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId * Resource Id of the attached workspace * + * @param {number} + * [parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service should + * do flow analytics + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -7156,6 +7208,14 @@ class NetworkWatchers { * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable * retention. * + * @param {object} [parameters.format] + * + * @param {string} [parameters.format.type] The file type of flow log. Possible + * values include: 'JSON' + * + * @param {number} [parameters.format.version] The version (revision) of the + * flow log. + * * @param {object} [parameters.flowAnalyticsConfiguration] * * @param {object} @@ -7177,6 +7237,11 @@ class NetworkWatchers { * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId * Resource Id of the attached workspace * + * @param {number} + * [parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service should + * do flow analytics + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the @@ -7230,6 +7295,14 @@ class NetworkWatchers { * @param {boolean} [parameters.retentionPolicy.enabled] Flag to enable/disable * retention. * + * @param {object} [parameters.format] + * + * @param {string} [parameters.format.type] The file type of flow log. Possible + * values include: 'JSON' + * + * @param {number} [parameters.format.version] The version (revision) of the + * flow log. + * * @param {object} [parameters.flowAnalyticsConfiguration] * * @param {object} @@ -7251,6 +7324,11 @@ class NetworkWatchers { * parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.workspaceResourceId * Resource Id of the attached workspace * + * @param {number} + * [parameters.flowAnalyticsConfiguration.networkWatcherFlowAnalyticsConfiguration.trafficAnalyticsInterval] + * The interval in minutes which would decide how frequently TA service should + * do flow analytics + * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the diff --git a/lib/services/networkManagement2/lib/operations/operations.js b/lib/services/networkManagement2/lib/operations/operations.js index 93f0ea4539..47a5471c24 100644 --- a/lib/services/networkManagement2/lib/operations/operations.js +++ b/lib/services/networkManagement2/lib/operations/operations.js @@ -45,7 +45,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.acceptLanguage !== null && this.client.acceptLanguage !== undefined && typeof this.client.acceptLanguage.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/p2sVpnGateways.js b/lib/services/networkManagement2/lib/operations/p2sVpnGateways.js index 003585e3b2..51e93a72ef 100644 --- a/lib/services/networkManagement2/lib/operations/p2sVpnGateways.js +++ b/lib/services/networkManagement2/lib/operations/p2sVpnGateways.js @@ -50,7 +50,7 @@ function _get(resourceGroupName, gatewayName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -455,7 +455,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -592,7 +592,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -849,7 +849,7 @@ function _beginCreateOrUpdate(resourceGroupName, gatewayName, p2SVpnGatewayParam if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1033,7 +1033,7 @@ function _beginUpdateTags(resourceGroupName, gatewayName, p2SVpnGatewayParameter if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1211,7 +1211,7 @@ function _beginDeleteMethod(resourceGroupName, gatewayName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1346,7 +1346,7 @@ function _beginGenerateVpnProfile(resourceGroupName, gatewayName, parameters, op if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/p2sVpnServerConfigurations.js b/lib/services/networkManagement2/lib/operations/p2sVpnServerConfigurations.js index 5a0e611476..256005dfc3 100644 --- a/lib/services/networkManagement2/lib/operations/p2sVpnServerConfigurations.js +++ b/lib/services/networkManagement2/lib/operations/p2sVpnServerConfigurations.js @@ -54,7 +54,7 @@ function _get(resourceGroupName, virtualWanName, p2SVpnServerConfigurationName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -402,7 +402,7 @@ function _listByVirtualWan(resourceGroupName, virtualWanName, options, callback) if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -600,7 +600,7 @@ function _beginCreateOrUpdate(resourceGroupName, virtualWanName, p2SVpnServerCon if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -785,7 +785,7 @@ function _beginDeleteMethod(resourceGroupName, virtualWanName, p2SVpnServerConfi if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/packetCaptures.js b/lib/services/networkManagement2/lib/operations/packetCaptures.js index 7e41b1ca6b..7a12dfc8de 100644 --- a/lib/services/networkManagement2/lib/operations/packetCaptures.js +++ b/lib/services/networkManagement2/lib/operations/packetCaptures.js @@ -163,7 +163,7 @@ function _get(resourceGroupName, networkWatcherName, packetCaptureName, options, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -524,7 +524,7 @@ function _list(resourceGroupName, networkWatcherName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -702,7 +702,7 @@ function _beginCreate(resourceGroupName, networkWatcherName, packetCaptureName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -868,7 +868,7 @@ function _beginDeleteMethod(resourceGroupName, networkWatcherName, packetCapture if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1000,7 +1000,7 @@ function _beginStop(resourceGroupName, networkWatcherName, packetCaptureName, op if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1135,7 +1135,7 @@ function _beginGetStatus(resourceGroupName, networkWatcherName, packetCaptureNam if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/publicIPAddresses.js b/lib/services/networkManagement2/lib/operations/publicIPAddresses.js index 5ea27d8207..f4474386fb 100644 --- a/lib/services/networkManagement2/lib/operations/publicIPAddresses.js +++ b/lib/services/networkManagement2/lib/operations/publicIPAddresses.js @@ -115,7 +115,7 @@ function _get(resourceGroupName, publicIpAddressName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -490,7 +490,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -624,7 +624,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1249,7 +1249,7 @@ function _beginDeleteMethod(resourceGroupName, publicIpAddressName, options, cal if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1443,7 +1443,7 @@ function _beginCreateOrUpdate(resourceGroupName, publicIpAddressName, parameters if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1625,7 +1625,7 @@ function _beginUpdateTags(resourceGroupName, publicIpAddressName, parameters, op if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/publicIPPrefixes.js b/lib/services/networkManagement2/lib/operations/publicIPPrefixes.js index 8b3c0e85ec..e91ac2a11c 100644 --- a/lib/services/networkManagement2/lib/operations/publicIPPrefixes.js +++ b/lib/services/networkManagement2/lib/operations/publicIPPrefixes.js @@ -115,7 +115,7 @@ function _get(resourceGroupName, publicIpPrefixName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -464,7 +464,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -598,7 +598,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -736,7 +736,7 @@ function _beginDeleteMethod(resourceGroupName, publicIpPrefixName, options, call if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -904,7 +904,7 @@ function _beginCreateOrUpdate(resourceGroupName, publicIpPrefixName, parameters, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1086,7 +1086,7 @@ function _beginUpdateTags(resourceGroupName, publicIpPrefixName, parameters, opt if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/routeFilterRules.js b/lib/services/networkManagement2/lib/operations/routeFilterRules.js index 4bd2c48399..c4ad4d0f9f 100644 --- a/lib/services/networkManagement2/lib/operations/routeFilterRules.js +++ b/lib/services/networkManagement2/lib/operations/routeFilterRules.js @@ -116,7 +116,7 @@ function _get(resourceGroupName, routeFilterName, ruleName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -454,7 +454,7 @@ function _listByRouteFilter(resourceGroupName, routeFilterName, options, callbac if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -598,7 +598,7 @@ function _beginDeleteMethod(resourceGroupName, routeFilterName, ruleName, option if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -752,7 +752,7 @@ function _beginCreateOrUpdate(resourceGroupName, routeFilterName, ruleName, rout { routeFilterRuleParameters = {}; } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -951,7 +951,7 @@ function _beginUpdate(resourceGroupName, routeFilterName, ruleName, routeFilterR { routeFilterRuleParameters = {}; } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/routeFilters.js b/lib/services/networkManagement2/lib/operations/routeFilters.js index 081ffbef2f..668f338414 100644 --- a/lib/services/networkManagement2/lib/operations/routeFilters.js +++ b/lib/services/networkManagement2/lib/operations/routeFilters.js @@ -116,7 +116,7 @@ function _get(resourceGroupName, routeFilterName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -447,7 +447,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -582,7 +582,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -716,7 +716,7 @@ function _beginDeleteMethod(resourceGroupName, routeFilterName, options, callbac if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -857,7 +857,7 @@ function _beginCreateOrUpdate(resourceGroupName, routeFilterName, routeFilterPar if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1047,7 +1047,7 @@ function _beginUpdate(resourceGroupName, routeFilterName, routeFilterParameters, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/routeTables.js b/lib/services/networkManagement2/lib/operations/routeTables.js index 16bd1cbb7f..3820157eea 100644 --- a/lib/services/networkManagement2/lib/operations/routeTables.js +++ b/lib/services/networkManagement2/lib/operations/routeTables.js @@ -115,7 +115,7 @@ function _get(resourceGroupName, routeTableName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -444,7 +444,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -579,7 +579,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -713,7 +713,7 @@ function _beginDeleteMethod(resourceGroupName, routeTableName, options, callback if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -861,7 +861,7 @@ function _beginCreateOrUpdate(resourceGroupName, routeTableName, parameters, opt if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1042,7 +1042,7 @@ function _beginUpdateTags(resourceGroupName, routeTableName, parameters, options if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/routes.js b/lib/services/networkManagement2/lib/operations/routes.js index 176b87e8e6..4ae9b61e22 100644 --- a/lib/services/networkManagement2/lib/operations/routes.js +++ b/lib/services/networkManagement2/lib/operations/routes.js @@ -116,7 +116,7 @@ function _get(resourceGroupName, routeTableName, routeName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -371,7 +371,7 @@ function _list(resourceGroupName, routeTableName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -515,7 +515,7 @@ function _beginDeleteMethod(resourceGroupName, routeTableName, routeName, option if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -675,7 +675,7 @@ function _beginCreateOrUpdate(resourceGroupName, routeTableName, routeName, rout if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/securityRules.js b/lib/services/networkManagement2/lib/operations/securityRules.js index dcdd95ec78..de8ea23ef5 100644 --- a/lib/services/networkManagement2/lib/operations/securityRules.js +++ b/lib/services/networkManagement2/lib/operations/securityRules.js @@ -118,7 +118,7 @@ function _get(resourceGroupName, networkSecurityGroupName, securityRuleName, opt if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -422,7 +422,7 @@ function _list(resourceGroupName, networkSecurityGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -567,7 +567,7 @@ function _beginDeleteMethod(resourceGroupName, networkSecurityGroupName, securit if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -774,7 +774,7 @@ function _beginCreateOrUpdate(resourceGroupName, networkSecurityGroupName, secur if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/serviceEndpointPolicies.js b/lib/services/networkManagement2/lib/operations/serviceEndpointPolicies.js index 6e840059a3..7f4bcb01d2 100644 --- a/lib/services/networkManagement2/lib/operations/serviceEndpointPolicies.js +++ b/lib/services/networkManagement2/lib/operations/serviceEndpointPolicies.js @@ -117,7 +117,7 @@ function _get(resourceGroupName, serviceEndpointPolicyName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -441,7 +441,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -575,7 +575,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -714,7 +714,7 @@ function _beginDeleteMethod(resourceGroupName, serviceEndpointPolicyName, option if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -856,7 +856,7 @@ function _beginCreateOrUpdate(resourceGroupName, serviceEndpointPolicyName, para if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1039,7 +1039,7 @@ function _beginUpdate(resourceGroupName, serviceEndpointPolicyName, parameters, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/serviceEndpointPolicyDefinitions.js b/lib/services/networkManagement2/lib/operations/serviceEndpointPolicyDefinitions.js index 391a2c1767..5753e68c43 100644 --- a/lib/services/networkManagement2/lib/operations/serviceEndpointPolicyDefinitions.js +++ b/lib/services/networkManagement2/lib/operations/serviceEndpointPolicyDefinitions.js @@ -122,7 +122,7 @@ function _get(resourceGroupName, serviceEndpointPolicyName, serviceEndpointPolic if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -376,7 +376,7 @@ function _listByResourceGroup(resourceGroupName, serviceEndpointPolicyName, opti if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -522,7 +522,7 @@ function _beginDeleteMethod(resourceGroupName, serviceEndpointPolicyName, servic if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -679,7 +679,7 @@ function _beginCreateOrUpdate(resourceGroupName, serviceEndpointPolicyName, serv if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/subnets.js b/lib/services/networkManagement2/lib/operations/subnets.js index ca4b7adb3e..c2434e3f62 100644 --- a/lib/services/networkManagement2/lib/operations/subnets.js +++ b/lib/services/networkManagement2/lib/operations/subnets.js @@ -119,7 +119,7 @@ function _get(resourceGroupName, virtualNetworkName, subnetName, options, callba throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -437,7 +437,7 @@ function _list(resourceGroupName, virtualNetworkName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -581,7 +581,7 @@ function _beginDeleteMethod(resourceGroupName, virtualNetworkName, subnetName, o if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -798,7 +798,7 @@ function _beginCreateOrUpdate(resourceGroupName, virtualNetworkName, subnetName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/usages.js b/lib/services/networkManagement2/lib/operations/usages.js index b548655258..01254efcdb 100644 --- a/lib/services/networkManagement2/lib/operations/usages.js +++ b/lib/services/networkManagement2/lib/operations/usages.js @@ -47,7 +47,7 @@ function _list(location, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (location === null || location === undefined || typeof location.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/virtualHubs.js b/lib/services/networkManagement2/lib/operations/virtualHubs.js index 8f5651474b..50b0b11327 100644 --- a/lib/services/networkManagement2/lib/operations/virtualHubs.js +++ b/lib/services/networkManagement2/lib/operations/virtualHubs.js @@ -49,7 +49,7 @@ function _get(resourceGroupName, virtualHubName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -454,7 +454,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -590,7 +590,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -765,7 +765,7 @@ function _beginCreateOrUpdate(resourceGroupName, virtualHubName, virtualHubParam if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -948,7 +948,7 @@ function _beginUpdateTags(resourceGroupName, virtualHubName, virtualHubParameter if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1125,7 +1125,7 @@ function _beginDeleteMethod(resourceGroupName, virtualHubName, options, callback if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/virtualNetworkGatewayConnections.js b/lib/services/networkManagement2/lib/operations/virtualNetworkGatewayConnections.js index 9be0c9847d..3013c37738 100644 --- a/lib/services/networkManagement2/lib/operations/virtualNetworkGatewayConnections.js +++ b/lib/services/networkManagement2/lib/operations/virtualNetworkGatewayConnections.js @@ -310,7 +310,7 @@ function _get(resourceGroupName, virtualNetworkGatewayConnectionName, options, c if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -696,7 +696,7 @@ function _getSharedKey(resourceGroupName, virtualNetworkGatewayConnectionName, o if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -839,7 +839,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1249,7 +1249,7 @@ function _beginCreateOrUpdate(resourceGroupName, virtualNetworkGatewayConnection if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1426,7 +1426,7 @@ function _beginDeleteMethod(resourceGroupName, virtualNetworkGatewayConnectionNa if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1559,7 +1559,7 @@ function _beginUpdateTags(resourceGroupName, virtualNetworkGatewayConnectionName if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1732,7 +1732,7 @@ function _beginSetSharedKey(resourceGroupName, virtualNetworkGatewayConnectionNa if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1921,7 +1921,7 @@ function _beginResetSharedKey(resourceGroupName, virtualNetworkGatewayConnection if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/virtualNetworkGateways.js b/lib/services/networkManagement2/lib/operations/virtualNetworkGateways.js index 959d65f7b4..0c2a155956 100644 --- a/lib/services/networkManagement2/lib/operations/virtualNetworkGateways.js +++ b/lib/services/networkManagement2/lib/operations/virtualNetworkGateways.js @@ -228,7 +228,7 @@ function _get(resourceGroupName, virtualNetworkGatewayName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -518,7 +518,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -659,7 +659,7 @@ function _listConnections(resourceGroupName, virtualNetworkGatewayName, options, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1329,7 +1329,7 @@ function _supportedVpnDevices(resourceGroupName, virtualNetworkGatewayName, opti if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1852,7 +1852,7 @@ function _vpnDeviceConfigurationScript(resourceGroupName, virtualNetworkGatewayC if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2118,7 +2118,7 @@ function _beginCreateOrUpdate(resourceGroupName, virtualNetworkGatewayName, para if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2295,7 +2295,7 @@ function _beginDeleteMethod(resourceGroupName, virtualNetworkGatewayName, option if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2427,7 +2427,7 @@ function _beginUpdateTags(resourceGroupName, virtualNetworkGatewayName, paramete if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2593,7 +2593,7 @@ function _beginReset(resourceGroupName, virtualNetworkGatewayName, options, call throw new Error('callback cannot be null.'); } let gatewayVip = (options && options.gatewayVip !== undefined) ? options.gatewayVip : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2743,7 +2743,7 @@ function _beginResetVpnClientSharedKey(resourceGroupName, virtualNetworkGatewayN if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -2890,7 +2890,7 @@ function _beginGeneratevpnclientpackage(resourceGroupName, virtualNetworkGateway if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3077,7 +3077,7 @@ function _beginGenerateVpnProfile(resourceGroupName, virtualNetworkGatewayName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3245,7 +3245,7 @@ function _beginGetVpnProfilePackageUrl(resourceGroupName, virtualNetworkGatewayN if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3400,7 +3400,7 @@ function _beginGetBgpPeerStatus(resourceGroupName, virtualNetworkGatewayName, op throw new Error('callback cannot be null.'); } let peer = (options && options.peer !== undefined) ? options.peer : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3552,7 +3552,7 @@ function _beginGetLearnedRoutes(resourceGroupName, virtualNetworkGatewayName, op if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3700,7 +3700,7 @@ function _beginGetAdvertisedRoutes(resourceGroupName, virtualNetworkGatewayName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -3887,7 +3887,7 @@ function _beginSetVpnclientIpsecParameters(resourceGroupName, virtualNetworkGate if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -4050,7 +4050,7 @@ function _beginGetVpnclientIpsecParameters(resourceGroupName, virtualNetworkGate if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/virtualNetworkPeerings.js b/lib/services/networkManagement2/lib/operations/virtualNetworkPeerings.js index e946a2872b..1cc1930e3c 100644 --- a/lib/services/networkManagement2/lib/operations/virtualNetworkPeerings.js +++ b/lib/services/networkManagement2/lib/operations/virtualNetworkPeerings.js @@ -118,7 +118,7 @@ function _get(resourceGroupName, virtualNetworkName, virtualNetworkPeeringName, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -401,7 +401,7 @@ function _list(resourceGroupName, virtualNetworkName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -546,7 +546,7 @@ function _beginDeleteMethod(resourceGroupName, virtualNetworkName, virtualNetwor if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -733,7 +733,7 @@ function _beginCreateOrUpdate(resourceGroupName, virtualNetworkName, virtualNetw if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/virtualNetworkTaps.js b/lib/services/networkManagement2/lib/operations/virtualNetworkTaps.js index beaf85d7c9..83e0052323 100644 --- a/lib/services/networkManagement2/lib/operations/virtualNetworkTaps.js +++ b/lib/services/networkManagement2/lib/operations/virtualNetworkTaps.js @@ -112,7 +112,7 @@ function _get(resourceGroupName, tapName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -753,7 +753,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -887,7 +887,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1025,7 +1025,7 @@ function _beginDeleteMethod(resourceGroupName, tapName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1491,7 +1491,7 @@ function _beginCreateOrUpdate(resourceGroupName, tapName, parameters, options, c if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1673,7 +1673,7 @@ function _beginUpdateTags(resourceGroupName, tapName, tapParameters, options, ca if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/virtualNetworks.js b/lib/services/networkManagement2/lib/operations/virtualNetworks.js index 24ce994c54..1920e40b27 100644 --- a/lib/services/networkManagement2/lib/operations/virtualNetworks.js +++ b/lib/services/networkManagement2/lib/operations/virtualNetworks.js @@ -115,7 +115,7 @@ function _get(resourceGroupName, virtualNetworkName, options, callback) { throw new Error('callback cannot be null.'); } let expand = (options && options.expand !== undefined) ? options.expand : undefined; - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -470,7 +470,7 @@ function _listAll(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -604,7 +604,7 @@ function _list(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -746,7 +746,7 @@ function _checkIPAddressAvailability(resourceGroupName, virtualNetworkName, ipAd if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -894,7 +894,7 @@ function _listUsage(resourceGroupName, virtualNetworkName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1036,7 +1036,7 @@ function _beginDeleteMethod(resourceGroupName, virtualNetworkName, options, call if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1210,7 +1210,7 @@ function _beginCreateOrUpdate(resourceGroupName, virtualNetworkName, parameters, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -1392,7 +1392,7 @@ function _beginUpdateTags(resourceGroupName, virtualNetworkName, parameters, opt if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/virtualWans.js b/lib/services/networkManagement2/lib/operations/virtualWans.js index f0a7956eab..be3c50d7e1 100644 --- a/lib/services/networkManagement2/lib/operations/virtualWans.js +++ b/lib/services/networkManagement2/lib/operations/virtualWans.js @@ -49,7 +49,7 @@ function _get(resourceGroupName, virtualWANName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (resourceGroupName === null || resourceGroupName === undefined || typeof resourceGroupName.valueOf() !== 'string') { @@ -448,7 +448,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -584,7 +584,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -754,7 +754,7 @@ function _beginCreateOrUpdate(resourceGroupName, virtualWANName, wANParameters, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -936,7 +936,7 @@ function _beginUpdateTags(resourceGroupName, virtualWANName, wANParameters, opti if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1113,7 +1113,7 @@ function _beginDeleteMethod(resourceGroupName, virtualWANName, options, callback if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/vpnConnections.js b/lib/services/networkManagement2/lib/operations/vpnConnections.js index 16f5bb8136..8a32bac10a 100644 --- a/lib/services/networkManagement2/lib/operations/vpnConnections.js +++ b/lib/services/networkManagement2/lib/operations/vpnConnections.js @@ -51,7 +51,7 @@ function _get(resourceGroupName, gatewayName, connectionName, options, callback) if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -391,7 +391,7 @@ function _listByVpnGateway(resourceGroupName, gatewayName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -583,7 +583,7 @@ function _beginCreateOrUpdate(resourceGroupName, gatewayName, connectionName, vp if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -766,7 +766,7 @@ function _beginDeleteMethod(resourceGroupName, gatewayName, connectionName, opti if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/vpnGateways.js b/lib/services/networkManagement2/lib/operations/vpnGateways.js index 6fae3465b6..6a9ae378d8 100644 --- a/lib/services/networkManagement2/lib/operations/vpnGateways.js +++ b/lib/services/networkManagement2/lib/operations/vpnGateways.js @@ -49,7 +49,7 @@ function _get(resourceGroupName, gatewayName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -452,7 +452,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -588,7 +588,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -761,7 +761,7 @@ function _beginCreateOrUpdate(resourceGroupName, gatewayName, vpnGatewayParamete if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -944,7 +944,7 @@ function _beginUpdateTags(resourceGroupName, gatewayName, vpnGatewayParameters, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1121,7 +1121,7 @@ function _beginDeleteMethod(resourceGroupName, gatewayName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/vpnSites.js b/lib/services/networkManagement2/lib/operations/vpnSites.js index a4120590ad..4d8f48db2a 100644 --- a/lib/services/networkManagement2/lib/operations/vpnSites.js +++ b/lib/services/networkManagement2/lib/operations/vpnSites.js @@ -49,7 +49,7 @@ function _get(resourceGroupName, vpnSiteName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -470,7 +470,7 @@ function _listByResourceGroup(resourceGroupName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -606,7 +606,7 @@ function _list(options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -797,7 +797,7 @@ function _beginCreateOrUpdate(resourceGroupName, vpnSiteName, vpnSiteParameters, if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -980,7 +980,7 @@ function _beginUpdateTags(resourceGroupName, vpnSiteName, vpnSiteParameters, opt if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { @@ -1157,7 +1157,7 @@ function _beginDeleteMethod(resourceGroupName, vpnSiteName, options, callback) { if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/lib/operations/vpnSitesConfiguration.js b/lib/services/networkManagement2/lib/operations/vpnSitesConfiguration.js index 1dc950747f..a992dff912 100644 --- a/lib/services/networkManagement2/lib/operations/vpnSitesConfiguration.js +++ b/lib/services/networkManagement2/lib/operations/vpnSitesConfiguration.js @@ -133,7 +133,7 @@ function _beginDownload(resourceGroupName, virtualWANName, request, options, cal if (!callback) { throw new Error('callback cannot be null.'); } - let apiVersion = '2018-08-01'; + let apiVersion = '2018-10-01'; // Validate try { if (this.client.subscriptionId === null || this.client.subscriptionId === undefined || typeof this.client.subscriptionId.valueOf() !== 'string') { diff --git a/lib/services/networkManagement2/package.json b/lib/services/networkManagement2/package.json index 0ae6d091cd..2ea1e79aa6 100644 --- a/lib/services/networkManagement2/package.json +++ b/lib/services/networkManagement2/package.json @@ -2,7 +2,7 @@ "name": "azure-arm-network", "author": "Microsoft Corporation", "description": "NetworkManagementClient Library with typescript type definitions for node", - "version": "10.0.0", + "version": "11.0.1", "dependencies": { "ms-rest": "^2.3.3", "ms-rest-azure": "^2.5.5" diff --git a/lib/services/resourceManagement/lib/models/appliance.js b/lib/services/resourceManagement/lib/models/appliance.js index ff12efe83c..81f348a1ac 100644 --- a/lib/services/resourceManagement/lib/models/appliance.js +++ b/lib/services/resourceManagement/lib/models/appliance.js @@ -184,7 +184,7 @@ class Appliance extends models['GenericResource'] { required: false, serializedName: 'kind', constraints: { - Pattern: '^[-\w\._,\(\)]+$' + Pattern: /^[-\w\._,\(\)]+$/ }, type: { name: 'String' diff --git a/lib/services/resourceManagement/lib/models/appliancePatchable.js b/lib/services/resourceManagement/lib/models/appliancePatchable.js index 6ead938d89..3d1ecdb633 100644 --- a/lib/services/resourceManagement/lib/models/appliancePatchable.js +++ b/lib/services/resourceManagement/lib/models/appliancePatchable.js @@ -184,7 +184,7 @@ class AppliancePatchable extends models['GenericResource'] { required: false, serializedName: 'kind', constraints: { - Pattern: '^[-\w\._,\(\)]+$' + Pattern: /^[-\w\._,\(\)]+$/ }, type: { name: 'String' diff --git a/lib/services/resourceManagement/lib/resource/models/genericResource.js b/lib/services/resourceManagement/lib/resource/models/genericResource.js index e0b781be14..e68870b34f 100644 --- a/lib/services/resourceManagement/lib/resource/models/genericResource.js +++ b/lib/services/resourceManagement/lib/resource/models/genericResource.js @@ -131,7 +131,7 @@ class GenericResource extends models['Resource'] { required: false, serializedName: 'kind', constraints: { - Pattern: '^[-\w\._,\(\)]+$' + Pattern: /^[-\w\._,\(\)]+$/ }, type: { name: 'String' diff --git a/lib/services/resourceManagement/package.json b/lib/services/resourceManagement/package.json index 5791af254e..85db6c2e51 100644 --- a/lib/services/resourceManagement/package.json +++ b/lib/services/resourceManagement/package.json @@ -6,7 +6,7 @@ "Zavery, Amar ", "Srinivasan, Vivek " ], - "version": "7.2.0", + "version": "7.2.1", "description": "Microsoft Azure Resource Management Client Library for node", "tags": [ "azure", diff --git a/lib/services/sqlvirtualmachineManagement/LICENSE.txt b/lib/services/sqlvirtualmachineManagement/LICENSE.txt new file mode 100644 index 0000000000..a70e8cf660 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 Microsoft + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/lib/services/sqlvirtualmachineManagement/README.md b/lib/services/sqlvirtualmachineManagement/README.md new file mode 100644 index 0000000000..05a38f90e7 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/README.md @@ -0,0 +1,46 @@ +--- +uid: azure-arm-sqlvirtualmachine +summary: *content + +--- +**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 - SqlVirtualMachineManagementClient + +This project provides a Node.js package for accessing Azure. Right now it supports: +- **Node.js version 6.x.x or higher** + +### Features + + +### How to Install + +```bash +npm install azure-arm-sqlvirtualmachine +``` + +### How to use + +#### Authentication, client creation, and get availabilityGroupListeners as an example. + +```javascript +const msRestAzure = require("ms-rest-azure"); +const SqlVirtualMachineManagementClient = require("azure-arm-sqlvirtualmachine"); +msRestAzure.interactiveLogin().then((creds) => { + const subscriptionId = ""; + const client = new SqlVirtualMachineManagementClient(creds, subscriptionId); + const resourceGroupName = "testresourceGroupName"; + const sqlVirtualMachineGroupName = "testsqlVirtualMachineGroupName"; + const availabilityGroupListenerName = "testavailabilityGroupListenerName"; + + return client.availabilityGroupListeners.get(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName).then((result) => { + console.log("The result is:"); + console.log(result); + }); +}).catch((err) => { + console.log('An error occurred:'); + console.dir(err, {depth: null, colors: true}); +}); +``` +### Related projects + +- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/additionalFeaturesServerConfigurations.js b/lib/services/sqlvirtualmachineManagement/lib/models/additionalFeaturesServerConfigurations.js new file mode 100644 index 0000000000..2e00b1a708 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/additionalFeaturesServerConfigurations.js @@ -0,0 +1,62 @@ +/* + * 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'; + +/** + * Additional SQL Server feature settings. + * + */ +class AdditionalFeaturesServerConfigurations { + /** + * Create a AdditionalFeaturesServerConfigurations. + * @property {boolean} [isRServicesEnabled] Enable or disable R services (SQL + * 2016 onwards). + * @property {boolean} [backupPermissionsForAzureBackupSvc] Enable or disable + * Azure Backup service. + */ + constructor() { + } + + /** + * Defines the metadata of AdditionalFeaturesServerConfigurations + * + * @returns {object} metadata of AdditionalFeaturesServerConfigurations + * + */ + mapper() { + return { + required: false, + serializedName: 'AdditionalFeaturesServerConfigurations', + type: { + name: 'Composite', + className: 'AdditionalFeaturesServerConfigurations', + modelProperties: { + isRServicesEnabled: { + required: false, + serializedName: 'isRServicesEnabled', + type: { + name: 'Boolean' + } + }, + backupPermissionsForAzureBackupSvc: { + required: false, + serializedName: 'backupPermissionsForAzureBackupSvc', + type: { + name: 'Boolean' + } + } + } + } + }; + } +} + +module.exports = AdditionalFeaturesServerConfigurations; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/autoBackupSettings.js b/lib/services/sqlvirtualmachineManagement/lib/models/autoBackupSettings.js new file mode 100644 index 0000000000..a9dd7a2366 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/autoBackupSettings.js @@ -0,0 +1,152 @@ +/* + * 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'; + +/** + * Configure backups for databases in your SQL virtual machine. + * + */ +class AutoBackupSettings { + /** + * Create a AutoBackupSettings. + * @property {boolean} [enable] Enable or disable autobackup on SQL virtual + * machine. + * @property {boolean} [enableEncryption] Enable or disable encryption for + * backup on SQL virtual machine. + * @property {number} [retentionPeriod] Retention period of backup: 1-30 + * days. + * @property {string} [storageAccountUrl] Storage account url where backup + * will be taken to. + * @property {string} [storageAccessKey] Storage account key where backup + * will be taken to. + * @property {string} [password] Password for encryption on backup. + * @property {boolean} [backupSystemDbs] Include or exclude system databases + * from auto backup. + * @property {string} [backupScheduleType] Backup schedule type. Possible + * values include: 'Manual', 'Automated' + * @property {string} [fullBackupFrequency] Frequency of full backups. In + * both cases, full backups begin during the next scheduled time window. + * Possible values include: 'Daily', 'Weekly' + * @property {number} [fullBackupStartTime] Start time of a given day during + * which full backups can take place. 0-23 hours. + * @property {number} [fullBackupWindowHours] Duration of the time window of + * a given day during which full backups can take place. 1-23 hours. + * @property {number} [logBackupFrequency] Frequency of log backups. 5-60 + * minutes. + */ + constructor() { + } + + /** + * Defines the metadata of AutoBackupSettings + * + * @returns {object} metadata of AutoBackupSettings + * + */ + mapper() { + return { + required: false, + serializedName: 'AutoBackupSettings', + type: { + name: 'Composite', + className: 'AutoBackupSettings', + modelProperties: { + enable: { + required: false, + serializedName: 'enable', + type: { + name: 'Boolean' + } + }, + enableEncryption: { + required: false, + serializedName: 'enableEncryption', + type: { + name: 'Boolean' + } + }, + retentionPeriod: { + required: false, + serializedName: 'retentionPeriod', + type: { + name: 'Number' + } + }, + storageAccountUrl: { + required: false, + serializedName: 'storageAccountUrl', + type: { + name: 'String' + } + }, + storageAccessKey: { + required: false, + serializedName: 'storageAccessKey', + type: { + name: 'String' + } + }, + password: { + required: false, + serializedName: 'password', + type: { + name: 'String' + } + }, + backupSystemDbs: { + required: false, + serializedName: 'backupSystemDbs', + type: { + name: 'Boolean' + } + }, + backupScheduleType: { + required: false, + serializedName: 'backupScheduleType', + type: { + name: 'String' + } + }, + fullBackupFrequency: { + required: false, + serializedName: 'fullBackupFrequency', + type: { + name: 'String' + } + }, + fullBackupStartTime: { + required: false, + serializedName: 'fullBackupStartTime', + type: { + name: 'Number' + } + }, + fullBackupWindowHours: { + required: false, + serializedName: 'fullBackupWindowHours', + type: { + name: 'Number' + } + }, + logBackupFrequency: { + required: false, + serializedName: 'logBackupFrequency', + type: { + name: 'Number' + } + } + } + } + }; + } +} + +module.exports = AutoBackupSettings; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/autoPatchingSettings.js b/lib/services/sqlvirtualmachineManagement/lib/models/autoPatchingSettings.js new file mode 100644 index 0000000000..ff32cf8646 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/autoPatchingSettings.js @@ -0,0 +1,81 @@ +/* + * 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'; + +/** + * Set a patching window during which Windows and SQL patches will be applied. + * + */ +class AutoPatchingSettings { + /** + * Create a AutoPatchingSettings. + * @property {boolean} [enable] Enable or disable autopatching on SQL virtual + * machine. + * @property {string} [dayOfWeek] Day of week to apply the patch on. Possible + * values include: 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', + * 'Saturday', 'Sunday' + * @property {number} [maintenanceWindowStartingHour] Hour of the day when + * patching is initiated. Local VM time. + * @property {number} [maintenanceWindowDuration] Duration of patching. + */ + constructor() { + } + + /** + * Defines the metadata of AutoPatchingSettings + * + * @returns {object} metadata of AutoPatchingSettings + * + */ + mapper() { + return { + required: false, + serializedName: 'AutoPatchingSettings', + type: { + name: 'Composite', + className: 'AutoPatchingSettings', + modelProperties: { + enable: { + required: false, + serializedName: 'enable', + type: { + name: 'Boolean' + } + }, + dayOfWeek: { + required: false, + serializedName: 'dayOfWeek', + type: { + name: 'Enum', + allowedValues: [ 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' ] + } + }, + maintenanceWindowStartingHour: { + required: false, + serializedName: 'maintenanceWindowStartingHour', + type: { + name: 'Number' + } + }, + maintenanceWindowDuration: { + required: false, + serializedName: 'maintenanceWindowDuration', + type: { + name: 'Number' + } + } + } + } + }; + } +} + +module.exports = AutoPatchingSettings; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/availabilityGroupListener.js b/lib/services/sqlvirtualmachineManagement/lib/models/availabilityGroupListener.js new file mode 100644 index 0000000000..f50d661862 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/availabilityGroupListener.js @@ -0,0 +1,124 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * A SQL Server availability group listener. + * + * @extends models['ProxyResource'] + */ +class AvailabilityGroupListener extends models['ProxyResource'] { + /** + * Create a AvailabilityGroupListener. + * @property {string} [provisioningState] Provisioning state to track the + * aysnc operation status. + * @property {string} [availabilityGroupName] Name of the availability group. + * @property {array} [loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. + * @property {boolean} [createDefaultAvailabilityGroupIfNotExist] Create a + * default availability group if it does not exist. + * @property {number} [port] Listener port. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of AvailabilityGroupListener + * + * @returns {object} metadata of AvailabilityGroupListener + * + */ + mapper() { + return { + required: false, + serializedName: 'AvailabilityGroupListener', + type: { + name: 'Composite', + className: 'AvailabilityGroupListener', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + provisioningState: { + required: false, + readOnly: true, + serializedName: 'properties.provisioningState', + type: { + name: 'String' + } + }, + availabilityGroupName: { + required: false, + serializedName: 'properties.availabilityGroupName', + type: { + name: 'String' + } + }, + loadBalancerConfigurations: { + required: false, + serializedName: 'properties.loadBalancerConfigurations', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'LoadBalancerConfigurationElementType', + type: { + name: 'Composite', + className: 'LoadBalancerConfiguration' + } + } + } + }, + createDefaultAvailabilityGroupIfNotExist: { + required: false, + serializedName: 'properties.createDefaultAvailabilityGroupIfNotExist', + type: { + name: 'Boolean' + } + }, + port: { + required: false, + serializedName: 'properties.port', + type: { + name: 'Number' + } + } + } + } + }; + } +} + +module.exports = AvailabilityGroupListener; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/availabilityGroupListenerListResult.js b/lib/services/sqlvirtualmachineManagement/lib/models/availabilityGroupListenerListResult.js new file mode 100644 index 0000000000..c71503e95c --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/availabilityGroupListenerListResult.js @@ -0,0 +1,69 @@ +/* + * 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'; + +/** + * A list of availability group listeners. + */ +class AvailabilityGroupListenerListResult extends Array { + /** + * Create a AvailabilityGroupListenerListResult. + * @property {string} [nextLink] Link to retrieve next page of results. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of AvailabilityGroupListenerListResult + * + * @returns {object} metadata of AvailabilityGroupListenerListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'AvailabilityGroupListenerListResult', + type: { + name: 'Composite', + className: 'AvailabilityGroupListenerListResult', + modelProperties: { + value: { + required: false, + readOnly: true, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'AvailabilityGroupListenerElementType', + type: { + name: 'Composite', + className: 'AvailabilityGroupListener' + } + } + } + }, + nextLink: { + required: false, + readOnly: true, + serializedName: 'nextLink', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = AvailabilityGroupListenerListResult; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/index.d.ts b/lib/services/sqlvirtualmachineManagement/lib/models/index.d.ts new file mode 100644 index 0000000000..5415e425e5 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/index.d.ts @@ -0,0 +1,582 @@ +/* + * 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. + */ + +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; + +export { + + BaseResource, + CloudError +}; + +/** + * A private IP address bound to the availability group listener. + */ +export interface PrivateIPAddress { + /** + * Private IP address bound to the availability group listener. + */ + ipAddress?: string; + /** + * Subnet used to include private IP. + */ + subnetResourceId?: string; +} + +/** + * A load balancer configuration for an availability group listener. + */ +export interface LoadBalancerConfiguration { + /** + * Private IP address. + */ + privateIpAddress?: PrivateIPAddress; + /** + * Resource id of the public IP. + */ + publicIpAddressResourceId?: string; + /** + * Subnet used to include private IP. + */ + loadBalancerResourceId?: string; + /** + * Probe port. + */ + probePort?: number; + /** + * List of the SQL virtual machine instance resource id's that are enrolled into the availability + * group listener. + */ + sqlVirtualMachineInstances?: string[]; +} + +/** + * ARM resource. + */ +export interface Resource extends BaseResource { + /** + * Resource ID. + */ + readonly id?: string; + /** + * Resource name. + */ + readonly name?: string; + /** + * Resource type. + */ + readonly type?: string; +} + +/** + * ARM proxy resource. + */ +export interface ProxyResource extends Resource { +} + +/** + * A SQL Server availability group listener. + */ +export interface AvailabilityGroupListener extends ProxyResource { + /** + * Provisioning state to track the aysnc operation status. + */ + readonly provisioningState?: string; + /** + * Name of the availability group. + */ + availabilityGroupName?: string; + /** + * List of load balancer configurations for an availability group listener. + */ + loadBalancerConfigurations?: LoadBalancerConfiguration[]; + /** + * Create a default availability group if it does not exist. + */ + createDefaultAvailabilityGroupIfNotExist?: boolean; + /** + * Listener port. + */ + port?: number; +} + +/** + * Display metadata associated with the operation. + */ +export interface OperationDisplay { + /** + * The localized friendly form of the resource provider name. + */ + readonly provider?: string; + /** + * The localized friendly form of the resource type related to this action/operation. + */ + readonly resource?: string; + /** + * The localized friendly name for the operation. + */ + readonly operation?: string; + /** + * The localized friendly description for the operation. + */ + readonly description?: string; +} + +/** + * SQL REST API operation definition. + */ +export interface Operation { + /** + * The name of the operation being performed on this particular object. + */ + readonly name?: string; + /** + * The localized display information for this particular operation / action. + */ + readonly display?: OperationDisplay; + /** + * The intended executor of the operation. Possible values include: 'user', 'system' + */ + readonly origin?: string; + /** + * Additional descriptions for the operation. + */ + readonly properties?: { [propertyName: string]: any }; +} + +/** + * Active Directory account details to operate Windows Server Failover Cluster. + */ +export interface WsfcDomainProfile { + /** + * Fully qualified name of the domain. + */ + domainFqdn?: string; + /** + * Organizational Unit path in which the nodes and cluster will be present. + */ + ouPath?: string; + /** + * Account name used for creating cluster (at minimum needs permissions to 'Create Computer + * Objects' in domain). + */ + clusterBootstrapAccount?: string; + /** + * Account name used for operating cluster i.e. will be part of administrators group on all the + * participating virtual machines in the cluster. + */ + clusterOperatorAccount?: string; + /** + * Account name under which SQL service will run on all participating SQL virtual machines in the + * cluster. + */ + sqlServiceAccount?: string; + /** + * Optional path for fileshare witness. + */ + fileShareWitnessPath?: string; + /** + * Fully qualified ARM resource id of the witness storage account. + */ + storageAccountUrl?: string; + /** + * Primary key of the witness storage account. + */ + storageAccountPrimaryKey?: string; +} + +/** + * ARM tracked top level resource. + */ +export interface TrackedResource extends Resource { + /** + * Resource location. + */ + location: string; + /** + * Resource tags. + */ + tags?: { [propertyName: string]: string }; +} + +/** + * A SQL virtual machine group. + */ +export interface SqlVirtualMachineGroup extends TrackedResource { + /** + * Provisioning state to track the aysnc operation status. + */ + readonly provisioningState?: string; + /** + * SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. + */ + sqlImageOffer?: string; + /** + * SQL image sku. Possible values include: 'Developer', 'Express', 'Standard', 'Enterprise', + * 'Web' + */ + sqlImageSku?: string; + /** + * Scale type. Possible values include: 'HA' + */ + readonly scaleType?: string; + /** + * Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of + * the group and the OS type. Possible values include: 'WSFC' + */ + readonly clusterManagerType?: string; + /** + * Cluster type. Possible values include: 'Domainful' + */ + readonly clusterConfiguration?: string; + /** + * Cluster Active Directory domain profile. + */ + wsfcDomainProfile?: WsfcDomainProfile; +} + +/** + * An update to a SQL virtual machine group. + */ +export interface SqlVirtualMachineGroupUpdate { + /** + * Resource tags. + */ + tags?: { [propertyName: string]: string }; +} + +/** + * Azure Active Directory identity configuration for a resource. + */ +export interface ResourceIdentity { + /** + * The Azure Active Directory principal id. + */ + readonly principalId?: string; + /** + * The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an + * Azure Active Directory principal for the resource. Possible values include: 'SystemAssigned' + */ + type?: string; + /** + * The Azure Active Directory tenant id. + */ + readonly tenantId?: string; +} + +/** + * Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. + */ +export interface WsfcDomainCredentials { + /** + * Cluster bootstrap account password. + */ + clusterBootstrapAccountPassword?: string; + /** + * Cluster operator account password. + */ + clusterOperatorAccountPassword?: string; + /** + * SQL service account password. + */ + sqlServiceAccountPassword?: string; +} + +/** + * Set a patching window during which Windows and SQL patches will be applied. + */ +export interface AutoPatchingSettings { + /** + * Enable or disable autopatching on SQL virtual machine. + */ + enable?: boolean; + /** + * Day of week to apply the patch on. Possible values include: 'Monday', 'Tuesday', 'Wednesday', + * 'Thursday', 'Friday', 'Saturday', 'Sunday' + */ + dayOfWeek?: string; + /** + * Hour of the day when patching is initiated. Local VM time. + */ + maintenanceWindowStartingHour?: number; + /** + * Duration of patching. + */ + maintenanceWindowDuration?: number; +} + +/** + * Configure backups for databases in your SQL virtual machine. + */ +export interface AutoBackupSettings { + /** + * Enable or disable autobackup on SQL virtual machine. + */ + enable?: boolean; + /** + * Enable or disable encryption for backup on SQL virtual machine. + */ + enableEncryption?: boolean; + /** + * Retention period of backup: 1-30 days. + */ + retentionPeriod?: number; + /** + * Storage account url where backup will be taken to. + */ + storageAccountUrl?: string; + /** + * Storage account key where backup will be taken to. + */ + storageAccessKey?: string; + /** + * Password for encryption on backup. + */ + password?: string; + /** + * Include or exclude system databases from auto backup. + */ + backupSystemDbs?: boolean; + /** + * Backup schedule type. Possible values include: 'Manual', 'Automated' + */ + backupScheduleType?: string; + /** + * Frequency of full backups. In both cases, full backups begin during the next scheduled time + * window. Possible values include: 'Daily', 'Weekly' + */ + fullBackupFrequency?: string; + /** + * Start time of a given day during which full backups can take place. 0-23 hours. + */ + fullBackupStartTime?: number; + /** + * Duration of the time window of a given day during which full backups can take place. 1-23 + * hours. + */ + fullBackupWindowHours?: number; + /** + * Frequency of log backups. 5-60 minutes. + */ + logBackupFrequency?: number; +} + +/** + * Configure your SQL virtual machine to be able to connect to the Azure Key Vault service. + */ +export interface KeyVaultCredentialSettings { + /** + * Enable or disable key vault credential setting. + */ + enable?: boolean; + /** + * Credential name. + */ + credentialName?: string; + /** + * Azure Key Vault url. + */ + azureKeyVaultUrl?: string; + /** + * Service principal name to access key vault. + */ + servicePrincipalName?: string; + /** + * Service principal name secret to access key vault. + */ + servicePrincipalSecret?: string; +} + +/** + * Set the access level and network port settings for SQL Server. + */ +export interface SqlConnectivityUpdateSettings { + /** + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', 'PUBLIC' + */ + connectivityType?: string; + /** + * SQL Server port. + */ + port?: number; + /** + * SQL Server sysadmin login to create. + */ + sqlAuthUpdateUserName?: string; + /** + * SQL Server sysadmin login password. + */ + sqlAuthUpdatePassword?: string; +} + +/** + * Set workload type to optimize storage for SQL Server. + */ +export interface SqlWorkloadTypeUpdateSettings { + /** + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + */ + sqlWorkloadType?: string; +} + +/** + * Set disk storage settings for SQL Server. + */ +export interface SqlStorageUpdateSettings { + /** + * Virtual machine disk count. + */ + diskCount?: number; + /** + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', 'EXTEND', 'ADD' + */ + diskConfigurationType?: string; +} + +/** + * Additional SQL Server feature settings. + */ +export interface AdditionalFeaturesServerConfigurations { + /** + * Enable or disable R services (SQL 2016 onwards). + */ + isRServicesEnabled?: boolean; + /** + * Enable or disable Azure Backup service. + */ + backupPermissionsForAzureBackupSvc?: boolean; +} + +/** + * Set the connectivity, storage and workload settings. + */ +export interface ServerConfigurationsManagementSettings { + /** + * SQL connectivity type settings. + */ + sqlConnectivityUpdateSettings?: SqlConnectivityUpdateSettings; + /** + * SQL workload type settings. + */ + sqlWorkloadTypeUpdateSettings?: SqlWorkloadTypeUpdateSettings; + /** + * SQL storage update settings. + */ + sqlStorageUpdateSettings?: SqlStorageUpdateSettings; + /** + * Additional SQL feature settings. + */ + additionalFeaturesServerConfigurations?: AdditionalFeaturesServerConfigurations; +} + +/** + * A SQL virtual machine. + */ +export interface SqlVirtualMachine extends TrackedResource { + /** + * Azure Active Directory identity of the server. + */ + identity?: ResourceIdentity; + /** + * ARM Resource id of underlying virtual machine created from SQL marketplace image. + */ + virtualMachineResourceId?: string; + /** + * Provisioning state to track the aysnc operation status. + */ + readonly provisioningState?: string; + /** + * SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. + */ + readonly sqlImageOffer?: string; + /** + * SQL Server license type. Possible values include: 'PAYG', 'AHUB' + */ + sqlServerLicenseType?: string; + /** + * SQL image sku. Possible values include: 'Developer', 'Express', 'Standard', 'Enterprise', + * 'Web' + */ + readonly sqlImageSku?: string; + /** + * ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part + * of. + */ + sqlVirtualMachineGroupResourceId?: string; + /** + * Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. + */ + wsfcDomainCredentials?: WsfcDomainCredentials; + /** + * Auto patching settings for applying critical security updates to SQL virtual machine. + */ + autoPatchingSettings?: AutoPatchingSettings; + /** + * Auto backup settings for SQL Server. + */ + autoBackupSettings?: AutoBackupSettings; + /** + * Key vault credential settings. + */ + keyVaultCredentialSettings?: KeyVaultCredentialSettings; + /** + * SQL Server configuration management settings. + */ + serverConfigurationsManagementSettings?: ServerConfigurationsManagementSettings; +} + +/** + * An update to a SQL virtual machine. + */ +export interface SqlVirtualMachineUpdate { + /** + * Resource tags. + */ + tags?: { [propertyName: string]: string }; +} + +/** + * A list of availability group listeners. + */ +export interface AvailabilityGroupListenerListResult extends Array { + /** + * Link to retrieve next page of results. + */ + readonly nextLink?: string; +} + +/** + * Result of the request to list SQL operations. + */ +export interface OperationListResult extends Array { + /** + * Link to retrieve next page of results. + */ + readonly nextLink?: string; +} + +/** + * A list of SQL virtual machine groups. + */ +export interface SqlVirtualMachineGroupListResult extends Array { + /** + * Link to retrieve next page of results. + */ + readonly nextLink?: string; +} + +/** + * A list of SQL virtual machines. + */ +export interface SqlVirtualMachineListResult extends Array { + /** + * Link to retrieve next page of results. + */ + readonly nextLink?: string; +} diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/index.js b/lib/services/sqlvirtualmachineManagement/lib/models/index.js new file mode 100644 index 0000000000..2eddd0259c --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/index.js @@ -0,0 +1,47 @@ +/* + * 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. + */ + +/* jshint latedef:false */ +/* jshint forin:false */ +/* jshint noempty:false */ + +'use strict'; + +var msRestAzure = require('ms-rest-azure'); + +exports.BaseResource = msRestAzure.BaseResource; +exports.CloudError = msRestAzure.CloudError; +exports.PrivateIPAddress = require('./privateIPAddress'); +exports.LoadBalancerConfiguration = require('./loadBalancerConfiguration'); +exports.Resource = require('./resource'); +exports.ProxyResource = require('./proxyResource'); +exports.AvailabilityGroupListener = require('./availabilityGroupListener'); +exports.OperationDisplay = require('./operationDisplay'); +exports.Operation = require('./operation'); +exports.WsfcDomainProfile = require('./wsfcDomainProfile'); +exports.TrackedResource = require('./trackedResource'); +exports.SqlVirtualMachineGroup = require('./sqlVirtualMachineGroup'); +exports.SqlVirtualMachineGroupUpdate = require('./sqlVirtualMachineGroupUpdate'); +exports.ResourceIdentity = require('./resourceIdentity'); +exports.WsfcDomainCredentials = require('./wsfcDomainCredentials'); +exports.AutoPatchingSettings = require('./autoPatchingSettings'); +exports.AutoBackupSettings = require('./autoBackupSettings'); +exports.KeyVaultCredentialSettings = require('./keyVaultCredentialSettings'); +exports.SqlConnectivityUpdateSettings = require('./sqlConnectivityUpdateSettings'); +exports.SqlWorkloadTypeUpdateSettings = require('./sqlWorkloadTypeUpdateSettings'); +exports.SqlStorageUpdateSettings = require('./sqlStorageUpdateSettings'); +exports.AdditionalFeaturesServerConfigurations = require('./additionalFeaturesServerConfigurations'); +exports.ServerConfigurationsManagementSettings = require('./serverConfigurationsManagementSettings'); +exports.SqlVirtualMachine = require('./sqlVirtualMachine'); +exports.SqlVirtualMachineUpdate = require('./sqlVirtualMachineUpdate'); +exports.AvailabilityGroupListenerListResult = require('./availabilityGroupListenerListResult'); +exports.OperationListResult = require('./operationListResult'); +exports.SqlVirtualMachineGroupListResult = require('./sqlVirtualMachineGroupListResult'); +exports.SqlVirtualMachineListResult = require('./sqlVirtualMachineListResult'); diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/keyVaultCredentialSettings.js b/lib/services/sqlvirtualmachineManagement/lib/models/keyVaultCredentialSettings.js new file mode 100644 index 0000000000..b4d674ae7c --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/keyVaultCredentialSettings.js @@ -0,0 +1,88 @@ +/* + * 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'; + +/** + * Configure your SQL virtual machine to be able to connect to the Azure Key + * Vault service. + * + */ +class KeyVaultCredentialSettings { + /** + * Create a KeyVaultCredentialSettings. + * @property {boolean} [enable] Enable or disable key vault credential + * setting. + * @property {string} [credentialName] Credential name. + * @property {string} [azureKeyVaultUrl] Azure Key Vault url. + * @property {string} [servicePrincipalName] Service principal name to access + * key vault. + * @property {string} [servicePrincipalSecret] Service principal name secret + * to access key vault. + */ + constructor() { + } + + /** + * Defines the metadata of KeyVaultCredentialSettings + * + * @returns {object} metadata of KeyVaultCredentialSettings + * + */ + mapper() { + return { + required: false, + serializedName: 'KeyVaultCredentialSettings', + type: { + name: 'Composite', + className: 'KeyVaultCredentialSettings', + modelProperties: { + enable: { + required: false, + serializedName: 'enable', + type: { + name: 'Boolean' + } + }, + credentialName: { + required: false, + serializedName: 'credentialName', + type: { + name: 'String' + } + }, + azureKeyVaultUrl: { + required: false, + serializedName: 'azureKeyVaultUrl', + type: { + name: 'String' + } + }, + servicePrincipalName: { + required: false, + serializedName: 'servicePrincipalName', + type: { + name: 'String' + } + }, + servicePrincipalSecret: { + required: false, + serializedName: 'servicePrincipalSecret', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = KeyVaultCredentialSettings; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/loadBalancerConfiguration.js b/lib/services/sqlvirtualmachineManagement/lib/models/loadBalancerConfiguration.js new file mode 100644 index 0000000000..2803be704a --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/loadBalancerConfiguration.js @@ -0,0 +1,100 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * A load balancer configuration for an availability group listener. + * + */ +class LoadBalancerConfiguration { + /** + * Create a LoadBalancerConfiguration. + * @property {object} [privateIpAddress] Private IP address. + * @property {string} [privateIpAddress.ipAddress] Private IP address bound + * to the availability group listener. + * @property {string} [privateIpAddress.subnetResourceId] Subnet used to + * include private IP. + * @property {string} [publicIpAddressResourceId] Resource id of the public + * IP. + * @property {string} [loadBalancerResourceId] Subnet used to include private + * IP. + * @property {number} [probePort] Probe port. + * @property {array} [sqlVirtualMachineInstances] List of the SQL virtual + * machine instance resource id's that are enrolled into the availability + * group listener. + */ + constructor() { + } + + /** + * Defines the metadata of LoadBalancerConfiguration + * + * @returns {object} metadata of LoadBalancerConfiguration + * + */ + mapper() { + return { + required: false, + serializedName: 'LoadBalancerConfiguration', + type: { + name: 'Composite', + className: 'LoadBalancerConfiguration', + modelProperties: { + privateIpAddress: { + required: false, + serializedName: 'privateIpAddress', + type: { + name: 'Composite', + className: 'PrivateIPAddress' + } + }, + publicIpAddressResourceId: { + required: false, + serializedName: 'publicIpAddressResourceId', + type: { + name: 'String' + } + }, + loadBalancerResourceId: { + required: false, + serializedName: 'loadBalancerResourceId', + type: { + name: 'String' + } + }, + probePort: { + required: false, + serializedName: 'probePort', + type: { + name: 'Number' + } + }, + sqlVirtualMachineInstances: { + required: false, + serializedName: 'sqlVirtualMachineInstances', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = LoadBalancerConfiguration; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/operation.js b/lib/services/sqlvirtualmachineManagement/lib/models/operation.js new file mode 100644 index 0000000000..9f2a00e1af --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/operation.js @@ -0,0 +1,99 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * SQL REST API operation definition. + * + */ +class Operation { + /** + * Create a Operation. + * @property {string} [name] The name of the operation being performed on + * this particular object. + * @property {object} [display] The localized display information for this + * particular operation / action. + * @property {string} [display.provider] The localized friendly form of the + * resource provider name. + * @property {string} [display.resource] The localized friendly form of the + * resource type related to this action/operation. + * @property {string} [display.operation] The localized friendly name for the + * operation. + * @property {string} [display.description] The localized friendly + * description for the operation. + * @property {string} [origin] The intended executor of the operation. + * Possible values include: 'user', 'system' + * @property {object} [properties] Additional descriptions for the operation. + */ + constructor() { + } + + /** + * Defines the metadata of Operation + * + * @returns {object} metadata of Operation + * + */ + mapper() { + return { + required: false, + serializedName: 'Operation', + type: { + name: 'Composite', + className: 'Operation', + modelProperties: { + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + display: { + required: false, + readOnly: true, + serializedName: 'display', + type: { + name: 'Composite', + className: 'OperationDisplay' + } + }, + origin: { + required: false, + readOnly: true, + serializedName: 'origin', + type: { + name: 'String' + } + }, + properties: { + required: false, + readOnly: true, + serializedName: 'properties', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'ObjectElementType', + type: { + name: 'Object' + } + } + } + } + } + } + }; + } +} + +module.exports = Operation; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/operationDisplay.js b/lib/services/sqlvirtualmachineManagement/lib/models/operationDisplay.js new file mode 100644 index 0000000000..8ed41f761d --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/operationDisplay.js @@ -0,0 +1,84 @@ +/* + * 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'; + +/** + * Display metadata associated with the operation. + * + */ +class OperationDisplay { + /** + * Create a OperationDisplay. + * @property {string} [provider] The localized friendly form of the resource + * provider name. + * @property {string} [resource] The localized friendly form of the resource + * type related to this action/operation. + * @property {string} [operation] The localized friendly name for the + * operation. + * @property {string} [description] The localized friendly description for + * the operation. + */ + constructor() { + } + + /** + * Defines the metadata of OperationDisplay + * + * @returns {object} metadata of OperationDisplay + * + */ + mapper() { + return { + required: false, + serializedName: 'OperationDisplay', + type: { + name: 'Composite', + className: 'OperationDisplay', + modelProperties: { + provider: { + required: false, + readOnly: true, + serializedName: 'provider', + type: { + name: 'String' + } + }, + resource: { + required: false, + readOnly: true, + serializedName: 'resource', + type: { + name: 'String' + } + }, + operation: { + required: false, + readOnly: true, + serializedName: 'operation', + type: { + name: 'String' + } + }, + description: { + required: false, + readOnly: true, + serializedName: 'description', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = OperationDisplay; diff --git a/lib/services/dataLake.Store/lib/account/models/dataLakeStoreAccountListResult.js b/lib/services/sqlvirtualmachineManagement/lib/models/operationListResult.js similarity index 62% rename from lib/services/dataLake.Store/lib/account/models/dataLakeStoreAccountListResult.js rename to lib/services/sqlvirtualmachineManagement/lib/models/operationListResult.js index 7b0f0f80a0..a6179c8d07 100644 --- a/lib/services/dataLake.Store/lib/account/models/dataLakeStoreAccountListResult.js +++ b/lib/services/sqlvirtualmachineManagement/lib/models/operationListResult.js @@ -11,30 +11,30 @@ 'use strict'; /** - * Data Lake Store account list information response. + * Result of the request to list SQL operations. */ -class DataLakeStoreAccountListResult extends Array { +class OperationListResult extends Array { /** - * Create a DataLakeStoreAccountListResult. - * @property {string} [nextLink] The link (url) to the next page of results. + * Create a OperationListResult. + * @property {string} [nextLink] Link to retrieve next page of results. */ constructor() { super(); } /** - * Defines the metadata of DataLakeStoreAccountListResult + * Defines the metadata of OperationListResult * - * @returns {object} metadata of DataLakeStoreAccountListResult + * @returns {object} metadata of OperationListResult * */ mapper() { return { required: false, - serializedName: 'DataLakeStoreAccountListResult', + serializedName: 'OperationListResult', type: { name: 'Composite', - className: 'DataLakeStoreAccountListResult', + className: 'OperationListResult', modelProperties: { value: { required: false, @@ -44,10 +44,10 @@ class DataLakeStoreAccountListResult extends Array { name: 'Sequence', element: { required: false, - serializedName: 'DataLakeStoreAccountBasicElementType', + serializedName: 'OperationElementType', type: { name: 'Composite', - className: 'DataLakeStoreAccountBasic' + className: 'Operation' } } } @@ -66,4 +66,4 @@ class DataLakeStoreAccountListResult extends Array { } } -module.exports = DataLakeStoreAccountListResult; +module.exports = OperationListResult; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/privateIPAddress.js b/lib/services/sqlvirtualmachineManagement/lib/models/privateIPAddress.js new file mode 100644 index 0000000000..774e4cf7fb --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/privateIPAddress.js @@ -0,0 +1,61 @@ +/* + * 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'; + +/** + * A private IP address bound to the availability group listener. + * + */ +class PrivateIPAddress { + /** + * Create a PrivateIPAddress. + * @property {string} [ipAddress] Private IP address bound to the + * availability group listener. + * @property {string} [subnetResourceId] Subnet used to include private IP. + */ + constructor() { + } + + /** + * Defines the metadata of PrivateIPAddress + * + * @returns {object} metadata of PrivateIPAddress + * + */ + mapper() { + return { + required: false, + serializedName: 'PrivateIPAddress', + type: { + name: 'Composite', + className: 'PrivateIPAddress', + modelProperties: { + ipAddress: { + required: false, + serializedName: 'ipAddress', + type: { + name: 'String' + } + }, + subnetResourceId: { + required: false, + serializedName: 'subnetResourceId', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = PrivateIPAddress; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/proxyResource.js b/lib/services/sqlvirtualmachineManagement/lib/models/proxyResource.js new file mode 100644 index 0000000000..4ea685046e --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/proxyResource.js @@ -0,0 +1,72 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * ARM proxy resource. + * + * @extends models['Resource'] + */ +class ProxyResource extends models['Resource'] { + /** + * Create a ProxyResource. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of ProxyResource + * + * @returns {object} metadata of ProxyResource + * + */ + mapper() { + return { + required: false, + serializedName: 'ProxyResource', + type: { + name: 'Composite', + className: 'ProxyResource', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = ProxyResource; diff --git a/lib/services/dataLake.Store/lib/account/models/subResource.js b/lib/services/sqlvirtualmachineManagement/lib/models/resource.js similarity index 71% rename from lib/services/dataLake.Store/lib/account/models/subResource.js rename to lib/services/sqlvirtualmachineManagement/lib/models/resource.js index 5684e40ed8..9ccac357d1 100644 --- a/lib/services/dataLake.Store/lib/account/models/subResource.js +++ b/lib/services/sqlvirtualmachineManagement/lib/models/resource.js @@ -13,34 +13,34 @@ const models = require('./index'); /** - * The resource model definition for a nested resource. + * ARM resource. * * @extends models['BaseResource'] */ -class SubResource extends models['BaseResource'] { +class Resource extends models['BaseResource'] { /** - * Create a SubResource. - * @property {string} [id] The resource identifier. - * @property {string} [name] The resource name. - * @property {string} [type] The resource type. + * Create a Resource. + * @property {string} [id] Resource ID. + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. */ constructor() { super(); } /** - * Defines the metadata of SubResource + * Defines the metadata of Resource * - * @returns {object} metadata of SubResource + * @returns {object} metadata of Resource * */ mapper() { return { required: false, - serializedName: 'SubResource', + serializedName: 'Resource', type: { name: 'Composite', - className: 'SubResource', + className: 'Resource', modelProperties: { id: { required: false, @@ -72,4 +72,4 @@ class SubResource extends models['BaseResource'] { } } -module.exports = SubResource; +module.exports = Resource; diff --git a/lib/services/dataLake.Store/lib/account/models/encryptionIdentity.js b/lib/services/sqlvirtualmachineManagement/lib/models/resourceIdentity.js similarity index 59% rename from lib/services/dataLake.Store/lib/account/models/encryptionIdentity.js rename to lib/services/sqlvirtualmachineManagement/lib/models/resourceIdentity.js index 319cac9cc2..7082928fc1 100644 --- a/lib/services/dataLake.Store/lib/account/models/encryptionIdentity.js +++ b/lib/services/sqlvirtualmachineManagement/lib/models/resourceIdentity.js @@ -11,47 +11,46 @@ 'use strict'; /** - * The encryption identity properties. + * Azure Active Directory identity configuration for a resource. * */ -class EncryptionIdentity { +class ResourceIdentity { /** - * Create a EncryptionIdentity. - * @property {uuid} [principalId] The principal identifier associated with - * the encryption. - * @property {uuid} [tenantId] The tenant identifier associated with the - * encryption. + * Create a ResourceIdentity. + * @property {uuid} [principalId] The Azure Active Directory principal id. + * @property {string} [type] The identity type. Set this to 'SystemAssigned' + * in order to automatically create and assign an Azure Active Directory + * principal for the resource. Possible values include: 'SystemAssigned' + * @property {uuid} [tenantId] The Azure Active Directory tenant id. */ constructor() { } /** - * Defines the metadata of EncryptionIdentity + * Defines the metadata of ResourceIdentity * - * @returns {object} metadata of EncryptionIdentity + * @returns {object} metadata of ResourceIdentity * */ mapper() { return { required: false, - serializedName: 'EncryptionIdentity', + serializedName: 'ResourceIdentity', type: { name: 'Composite', - className: 'EncryptionIdentity', + className: 'ResourceIdentity', modelProperties: { - type: { - required: true, - isConstant: true, - serializedName: 'type', - defaultValue: 'SystemAssigned', + principalId: { + required: false, + readOnly: true, + serializedName: 'principalId', type: { name: 'String' } }, - principalId: { + type: { required: false, - readOnly: true, - serializedName: 'principalId', + serializedName: 'type', type: { name: 'String' } @@ -70,4 +69,4 @@ class EncryptionIdentity { } } -module.exports = EncryptionIdentity; +module.exports = ResourceIdentity; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/serverConfigurationsManagementSettings.js b/lib/services/sqlvirtualmachineManagement/lib/models/serverConfigurationsManagementSettings.js new file mode 100644 index 0000000000..cd2b88c46c --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/serverConfigurationsManagementSettings.js @@ -0,0 +1,104 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Set the connectivity, storage and workload settings. + * + */ +class ServerConfigurationsManagementSettings { + /** + * Create a ServerConfigurationsManagementSettings. + * @property {object} [sqlConnectivityUpdateSettings] SQL connectivity type + * settings. + * @property {string} [sqlConnectivityUpdateSettings.connectivityType] SQL + * Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * @property {number} [sqlConnectivityUpdateSettings.port] SQL Server port. + * @property {string} [sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * @property {string} [sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * @property {object} [sqlWorkloadTypeUpdateSettings] SQL workload type + * settings. + * @property {string} [sqlWorkloadTypeUpdateSettings.sqlWorkloadType] SQL + * Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * @property {object} [sqlStorageUpdateSettings] SQL storage update settings. + * @property {number} [sqlStorageUpdateSettings.diskCount] Virtual machine + * disk count. + * @property {string} [sqlStorageUpdateSettings.diskConfigurationType] Disk + * configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * @property {object} [additionalFeaturesServerConfigurations] Additional SQL + * feature settings. + * @property {boolean} + * [additionalFeaturesServerConfigurations.isRServicesEnabled] Enable or + * disable R services (SQL 2016 onwards). + * @property {boolean} + * [additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + */ + constructor() { + } + + /** + * Defines the metadata of ServerConfigurationsManagementSettings + * + * @returns {object} metadata of ServerConfigurationsManagementSettings + * + */ + mapper() { + return { + required: false, + serializedName: 'ServerConfigurationsManagementSettings', + type: { + name: 'Composite', + className: 'ServerConfigurationsManagementSettings', + modelProperties: { + sqlConnectivityUpdateSettings: { + required: false, + serializedName: 'sqlConnectivityUpdateSettings', + type: { + name: 'Composite', + className: 'SqlConnectivityUpdateSettings' + } + }, + sqlWorkloadTypeUpdateSettings: { + required: false, + serializedName: 'sqlWorkloadTypeUpdateSettings', + type: { + name: 'Composite', + className: 'SqlWorkloadTypeUpdateSettings' + } + }, + sqlStorageUpdateSettings: { + required: false, + serializedName: 'sqlStorageUpdateSettings', + type: { + name: 'Composite', + className: 'SqlStorageUpdateSettings' + } + }, + additionalFeaturesServerConfigurations: { + required: false, + serializedName: 'additionalFeaturesServerConfigurations', + type: { + name: 'Composite', + className: 'AdditionalFeaturesServerConfigurations' + } + } + } + } + }; + } +} + +module.exports = ServerConfigurationsManagementSettings; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/sqlConnectivityUpdateSettings.js b/lib/services/sqlvirtualmachineManagement/lib/models/sqlConnectivityUpdateSettings.js new file mode 100644 index 0000000000..305f96edba --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/sqlConnectivityUpdateSettings.js @@ -0,0 +1,79 @@ +/* + * 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'; + +/** + * Set the access level and network port settings for SQL Server. + * + */ +class SqlConnectivityUpdateSettings { + /** + * Create a SqlConnectivityUpdateSettings. + * @property {string} [connectivityType] SQL Server connectivity option. + * Possible values include: 'LOCAL', 'PRIVATE', 'PUBLIC' + * @property {number} [port] SQL Server port. + * @property {string} [sqlAuthUpdateUserName] SQL Server sysadmin login to + * create. + * @property {string} [sqlAuthUpdatePassword] SQL Server sysadmin login + * password. + */ + constructor() { + } + + /** + * Defines the metadata of SqlConnectivityUpdateSettings + * + * @returns {object} metadata of SqlConnectivityUpdateSettings + * + */ + mapper() { + return { + required: false, + serializedName: 'SqlConnectivityUpdateSettings', + type: { + name: 'Composite', + className: 'SqlConnectivityUpdateSettings', + modelProperties: { + connectivityType: { + required: false, + serializedName: 'connectivityType', + type: { + name: 'String' + } + }, + port: { + required: false, + serializedName: 'port', + type: { + name: 'Number' + } + }, + sqlAuthUpdateUserName: { + required: false, + serializedName: 'sqlAuthUpdateUserName', + type: { + name: 'String' + } + }, + sqlAuthUpdatePassword: { + required: false, + serializedName: 'sqlAuthUpdatePassword', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = SqlConnectivityUpdateSettings; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/sqlStorageUpdateSettings.js b/lib/services/sqlvirtualmachineManagement/lib/models/sqlStorageUpdateSettings.js new file mode 100644 index 0000000000..72c535f7c1 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/sqlStorageUpdateSettings.js @@ -0,0 +1,61 @@ +/* + * 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'; + +/** + * Set disk storage settings for SQL Server. + * + */ +class SqlStorageUpdateSettings { + /** + * Create a SqlStorageUpdateSettings. + * @property {number} [diskCount] Virtual machine disk count. + * @property {string} [diskConfigurationType] Disk configuration to apply to + * SQL Server. Possible values include: 'NEW', 'EXTEND', 'ADD' + */ + constructor() { + } + + /** + * Defines the metadata of SqlStorageUpdateSettings + * + * @returns {object} metadata of SqlStorageUpdateSettings + * + */ + mapper() { + return { + required: false, + serializedName: 'SqlStorageUpdateSettings', + type: { + name: 'Composite', + className: 'SqlStorageUpdateSettings', + modelProperties: { + diskCount: { + required: false, + serializedName: 'diskCount', + type: { + name: 'Number' + } + }, + diskConfigurationType: { + required: false, + serializedName: 'diskConfigurationType', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = SqlStorageUpdateSettings; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachine.js b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachine.js new file mode 100644 index 0000000000..2d89e44544 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachine.js @@ -0,0 +1,310 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * A SQL virtual machine. + * + * @extends models['TrackedResource'] + */ +class SqlVirtualMachine extends models['TrackedResource'] { + /** + * Create a SqlVirtualMachine. + * @property {object} [identity] Azure Active Directory identity of the + * server. + * @property {uuid} [identity.principalId] The Azure Active Directory + * principal id. + * @property {string} [identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure + * Active Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * @property {uuid} [identity.tenantId] The Azure Active Directory tenant id. + * @property {string} [virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * @property {string} [provisioningState] Provisioning state to track the + * aysnc operation status. + * @property {string} [sqlImageOffer] SQL image offer. Examples include + * SQL2016-WS2016, SQL2017-WS2016. + * @property {string} [sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * @property {string} [sqlImageSku] SQL image sku. Possible values include: + * 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * @property {string} [sqlVirtualMachineGroupResourceId] ARM resource id of + * the SQL virtual machine group this SQL virtual machine is or will be part + * of. + * @property {object} [wsfcDomainCredentials] Domain credentials for setting + * up Windows Server Failover Cluster for SQL availability group. + * @property {string} [wsfcDomainCredentials.clusterBootstrapAccountPassword] + * Cluster bootstrap account password. + * @property {string} [wsfcDomainCredentials.clusterOperatorAccountPassword] + * Cluster operator account password. + * @property {string} [wsfcDomainCredentials.sqlServiceAccountPassword] SQL + * service account password. + * @property {object} [autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * @property {boolean} [autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * @property {string} [autoPatchingSettings.dayOfWeek] Day of week to apply + * the patch on. Possible values include: 'Monday', 'Tuesday', 'Wednesday', + * 'Thursday', 'Friday', 'Saturday', 'Sunday' + * @property {number} [autoPatchingSettings.maintenanceWindowStartingHour] + * Hour of the day when patching is initiated. Local VM time. + * @property {number} [autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * @property {object} [autoBackupSettings] Auto backup settings for SQL + * Server. + * @property {boolean} [autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * @property {boolean} [autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * @property {number} [autoBackupSettings.retentionPeriod] Retention period + * of backup: 1-30 days. + * @property {string} [autoBackupSettings.storageAccountUrl] Storage account + * url where backup will be taken to. + * @property {string} [autoBackupSettings.storageAccessKey] Storage account + * key where backup will be taken to. + * @property {string} [autoBackupSettings.password] Password for encryption + * on backup. + * @property {boolean} [autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * @property {string} [autoBackupSettings.backupScheduleType] Backup schedule + * type. Possible values include: 'Manual', 'Automated' + * @property {string} [autoBackupSettings.fullBackupFrequency] Frequency of + * full backups. In both cases, full backups begin during the next scheduled + * time window. Possible values include: 'Daily', 'Weekly' + * @property {number} [autoBackupSettings.fullBackupStartTime] Start time of + * a given day during which full backups can take place. 0-23 hours. + * @property {number} [autoBackupSettings.fullBackupWindowHours] Duration of + * the time window of a given day during which full backups can take place. + * 1-23 hours. + * @property {number} [autoBackupSettings.logBackupFrequency] Frequency of + * log backups. 5-60 minutes. + * @property {object} [keyVaultCredentialSettings] Key vault credential + * settings. + * @property {boolean} [keyVaultCredentialSettings.enable] Enable or disable + * key vault credential setting. + * @property {string} [keyVaultCredentialSettings.credentialName] Credential + * name. + * @property {string} [keyVaultCredentialSettings.azureKeyVaultUrl] Azure Key + * Vault url. + * @property {string} [keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * @property {string} [keyVaultCredentialSettings.servicePrincipalSecret] + * Service principal name secret to access key vault. + * @property {object} [serverConfigurationsManagementSettings] SQL Server + * configuration management settings. + * @property {object} + * [serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] SQL + * connectivity type settings. + * @property {string} + * [serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', + * 'PRIVATE', 'PUBLIC' + * @property {number} + * [serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * @property {string} + * [serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * @property {string} + * [serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * @property {object} + * [serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] SQL + * workload type settings. + * @property {string} + * [serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * @property {object} + * [serverConfigurationsManagementSettings.sqlStorageUpdateSettings] SQL + * storage update settings. + * @property {number} + * [serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * @property {string} + * [serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * @property {object} + * [serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * @property {boolean} + * [serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * @property {boolean} + * [serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of SqlVirtualMachine + * + * @returns {object} metadata of SqlVirtualMachine + * + */ + mapper() { + return { + required: false, + serializedName: 'SqlVirtualMachine', + type: { + name: 'Composite', + className: 'SqlVirtualMachine', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + location: { + required: true, + serializedName: 'location', + type: { + name: 'String' + } + }, + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + identity: { + required: false, + serializedName: 'identity', + type: { + name: 'Composite', + className: 'ResourceIdentity' + } + }, + virtualMachineResourceId: { + required: false, + serializedName: 'properties.virtualMachineResourceId', + type: { + name: 'String' + } + }, + provisioningState: { + required: false, + readOnly: true, + serializedName: 'properties.provisioningState', + type: { + name: 'String' + } + }, + sqlImageOffer: { + required: false, + readOnly: true, + serializedName: 'properties.sqlImageOffer', + type: { + name: 'String' + } + }, + sqlServerLicenseType: { + required: false, + serializedName: 'properties.sqlServerLicenseType', + type: { + name: 'String' + } + }, + sqlImageSku: { + required: false, + readOnly: true, + serializedName: 'properties.sqlImageSku', + type: { + name: 'String' + } + }, + sqlVirtualMachineGroupResourceId: { + required: false, + serializedName: 'properties.sqlVirtualMachineGroupResourceId', + type: { + name: 'String' + } + }, + wsfcDomainCredentials: { + required: false, + serializedName: 'properties.wsfcDomainCredentials', + type: { + name: 'Composite', + className: 'WsfcDomainCredentials' + } + }, + autoPatchingSettings: { + required: false, + serializedName: 'properties.autoPatchingSettings', + type: { + name: 'Composite', + className: 'AutoPatchingSettings' + } + }, + autoBackupSettings: { + required: false, + serializedName: 'properties.autoBackupSettings', + type: { + name: 'Composite', + className: 'AutoBackupSettings' + } + }, + keyVaultCredentialSettings: { + required: false, + serializedName: 'properties.keyVaultCredentialSettings', + type: { + name: 'Composite', + className: 'KeyVaultCredentialSettings' + } + }, + serverConfigurationsManagementSettings: { + required: false, + serializedName: 'properties.serverConfigurationsManagementSettings', + type: { + name: 'Composite', + className: 'ServerConfigurationsManagementSettings' + } + } + } + } + }; + } +} + +module.exports = SqlVirtualMachine; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineGroup.js b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineGroup.js new file mode 100644 index 0000000000..cf083f65da --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineGroup.js @@ -0,0 +1,180 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * A SQL virtual machine group. + * + * @extends models['TrackedResource'] + */ +class SqlVirtualMachineGroup extends models['TrackedResource'] { + /** + * Create a SqlVirtualMachineGroup. + * @property {string} [provisioningState] Provisioning state to track the + * aysnc operation status. + * @property {string} [sqlImageOffer] SQL image offer. Examples may include + * SQL2016-WS2016, SQL2017-WS2016. + * @property {string} [sqlImageSku] SQL image sku. Possible values include: + * 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * @property {string} [scaleType] Scale type. Possible values include: 'HA' + * @property {string} [clusterManagerType] Type of cluster manager: Windows + * Server Failover Cluster (WSFC), implied by the scale type of the group and + * the OS type. Possible values include: 'WSFC' + * @property {string} [clusterConfiguration] Cluster type. Possible values + * include: 'Domainful' + * @property {object} [wsfcDomainProfile] Cluster Active Directory domain + * profile. + * @property {string} [wsfcDomainProfile.domainFqdn] Fully qualified name of + * the domain. + * @property {string} [wsfcDomainProfile.ouPath] Organizational Unit path in + * which the nodes and cluster will be present. + * @property {string} [wsfcDomainProfile.clusterBootstrapAccount] Account + * name used for creating cluster (at minimum needs permissions to 'Create + * Computer Objects' in domain). + * @property {string} [wsfcDomainProfile.clusterOperatorAccount] Account name + * used for operating cluster i.e. will be part of administrators group on + * all the participating virtual machines in the cluster. + * @property {string} [wsfcDomainProfile.sqlServiceAccount] Account name + * under which SQL service will run on all participating SQL virtual machines + * in the cluster. + * @property {string} [wsfcDomainProfile.fileShareWitnessPath] Optional path + * for fileshare witness. + * @property {string} [wsfcDomainProfile.storageAccountUrl] Fully qualified + * ARM resource id of the witness storage account. + * @property {string} [wsfcDomainProfile.storageAccountPrimaryKey] Primary + * key of the witness storage account. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of SqlVirtualMachineGroup + * + * @returns {object} metadata of SqlVirtualMachineGroup + * + */ + mapper() { + return { + required: false, + serializedName: 'SqlVirtualMachineGroup', + type: { + name: 'Composite', + className: 'SqlVirtualMachineGroup', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + location: { + required: true, + serializedName: 'location', + type: { + name: 'String' + } + }, + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + }, + provisioningState: { + required: false, + readOnly: true, + serializedName: 'properties.provisioningState', + type: { + name: 'String' + } + }, + sqlImageOffer: { + required: false, + serializedName: 'properties.sqlImageOffer', + type: { + name: 'String' + } + }, + sqlImageSku: { + required: false, + serializedName: 'properties.sqlImageSku', + type: { + name: 'String' + } + }, + scaleType: { + required: false, + readOnly: true, + serializedName: 'properties.scaleType', + type: { + name: 'String' + } + }, + clusterManagerType: { + required: false, + readOnly: true, + serializedName: 'properties.clusterManagerType', + type: { + name: 'String' + } + }, + clusterConfiguration: { + required: false, + readOnly: true, + serializedName: 'properties.clusterConfiguration', + type: { + name: 'String' + } + }, + wsfcDomainProfile: { + required: false, + serializedName: 'properties.wsfcDomainProfile', + type: { + name: 'Composite', + className: 'WsfcDomainProfile' + } + } + } + } + }; + } +} + +module.exports = SqlVirtualMachineGroup; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineGroupListResult.js b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineGroupListResult.js new file mode 100644 index 0000000000..99aad9497e --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineGroupListResult.js @@ -0,0 +1,69 @@ +/* + * 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'; + +/** + * A list of SQL virtual machine groups. + */ +class SqlVirtualMachineGroupListResult extends Array { + /** + * Create a SqlVirtualMachineGroupListResult. + * @property {string} [nextLink] Link to retrieve next page of results. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of SqlVirtualMachineGroupListResult + * + * @returns {object} metadata of SqlVirtualMachineGroupListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'SqlVirtualMachineGroupListResult', + type: { + name: 'Composite', + className: 'SqlVirtualMachineGroupListResult', + modelProperties: { + value: { + required: false, + readOnly: true, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'SqlVirtualMachineGroupElementType', + type: { + name: 'Composite', + className: 'SqlVirtualMachineGroup' + } + } + } + }, + nextLink: { + required: false, + readOnly: true, + serializedName: 'nextLink', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = SqlVirtualMachineGroupListResult; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineGroupUpdate.js b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineGroupUpdate.js new file mode 100644 index 0000000000..8fd50fa7ca --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineGroupUpdate.js @@ -0,0 +1,59 @@ +/* + * 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'; + +/** + * An update to a SQL virtual machine group. + * + */ +class SqlVirtualMachineGroupUpdate { + /** + * Create a SqlVirtualMachineGroupUpdate. + * @property {object} [tags] Resource tags. + */ + constructor() { + } + + /** + * Defines the metadata of SqlVirtualMachineGroupUpdate + * + * @returns {object} metadata of SqlVirtualMachineGroupUpdate + * + */ + mapper() { + return { + required: false, + serializedName: 'SqlVirtualMachineGroupUpdate', + type: { + name: 'Composite', + className: 'SqlVirtualMachineGroupUpdate', + modelProperties: { + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = SqlVirtualMachineGroupUpdate; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineListResult.js b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineListResult.js new file mode 100644 index 0000000000..abf5f670f6 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineListResult.js @@ -0,0 +1,69 @@ +/* + * 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'; + +/** + * A list of SQL virtual machines. + */ +class SqlVirtualMachineListResult extends Array { + /** + * Create a SqlVirtualMachineListResult. + * @property {string} [nextLink] Link to retrieve next page of results. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of SqlVirtualMachineListResult + * + * @returns {object} metadata of SqlVirtualMachineListResult + * + */ + mapper() { + return { + required: false, + serializedName: 'SqlVirtualMachineListResult', + type: { + name: 'Composite', + className: 'SqlVirtualMachineListResult', + modelProperties: { + value: { + required: false, + readOnly: true, + serializedName: '', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'SqlVirtualMachineElementType', + type: { + name: 'Composite', + className: 'SqlVirtualMachine' + } + } + } + }, + nextLink: { + required: false, + readOnly: true, + serializedName: 'nextLink', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = SqlVirtualMachineListResult; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineUpdate.js b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineUpdate.js new file mode 100644 index 0000000000..ae01a045b4 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/sqlVirtualMachineUpdate.js @@ -0,0 +1,59 @@ +/* + * 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'; + +/** + * An update to a SQL virtual machine. + * + */ +class SqlVirtualMachineUpdate { + /** + * Create a SqlVirtualMachineUpdate. + * @property {object} [tags] Resource tags. + */ + constructor() { + } + + /** + * Defines the metadata of SqlVirtualMachineUpdate + * + * @returns {object} metadata of SqlVirtualMachineUpdate + * + */ + mapper() { + return { + required: false, + serializedName: 'SqlVirtualMachineUpdate', + type: { + name: 'Composite', + className: 'SqlVirtualMachineUpdate', + modelProperties: { + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = SqlVirtualMachineUpdate; diff --git a/lib/services/dataLake.Store/lib/account/models/updateTrustedIdProviderParameters.js b/lib/services/sqlvirtualmachineManagement/lib/models/sqlWorkloadTypeUpdateSettings.js similarity index 51% rename from lib/services/dataLake.Store/lib/account/models/updateTrustedIdProviderParameters.js rename to lib/services/sqlvirtualmachineManagement/lib/models/sqlWorkloadTypeUpdateSettings.js index 03247b4ba6..c454754d55 100644 --- a/lib/services/dataLake.Store/lib/account/models/updateTrustedIdProviderParameters.js +++ b/lib/services/sqlvirtualmachineManagement/lib/models/sqlWorkloadTypeUpdateSettings.js @@ -11,34 +11,35 @@ 'use strict'; /** - * The parameters used to update a trusted identity provider. + * Set workload type to optimize storage for SQL Server. * */ -class UpdateTrustedIdProviderParameters { +class SqlWorkloadTypeUpdateSettings { /** - * Create a UpdateTrustedIdProviderParameters. - * @property {string} [idProvider] The URL of this trusted identity provider. + * Create a SqlWorkloadTypeUpdateSettings. + * @property {string} [sqlWorkloadType] SQL Server workload type. Possible + * values include: 'GENERAL', 'OLTP', 'DW' */ constructor() { } /** - * Defines the metadata of UpdateTrustedIdProviderParameters + * Defines the metadata of SqlWorkloadTypeUpdateSettings * - * @returns {object} metadata of UpdateTrustedIdProviderParameters + * @returns {object} metadata of SqlWorkloadTypeUpdateSettings * */ mapper() { return { required: false, - serializedName: 'UpdateTrustedIdProviderParameters', + serializedName: 'SqlWorkloadTypeUpdateSettings', type: { name: 'Composite', - className: 'UpdateTrustedIdProviderParameters', + className: 'SqlWorkloadTypeUpdateSettings', modelProperties: { - idProvider: { + sqlWorkloadType: { required: false, - serializedName: 'properties.idProvider', + serializedName: 'sqlWorkloadType', type: { name: 'String' } @@ -49,4 +50,4 @@ class UpdateTrustedIdProviderParameters { } } -module.exports = UpdateTrustedIdProviderParameters; +module.exports = SqlWorkloadTypeUpdateSettings; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/trackedResource.js b/lib/services/sqlvirtualmachineManagement/lib/models/trackedResource.js new file mode 100644 index 0000000000..0fe6d7d553 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/trackedResource.js @@ -0,0 +1,95 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const models = require('./index'); + +/** + * ARM tracked top level resource. + * + * @extends models['Resource'] + */ +class TrackedResource extends models['Resource'] { + /** + * Create a TrackedResource. + * @property {string} location Resource location. + * @property {object} [tags] Resource tags. + */ + constructor() { + super(); + } + + /** + * Defines the metadata of TrackedResource + * + * @returns {object} metadata of TrackedResource + * + */ + mapper() { + return { + required: false, + serializedName: 'TrackedResource', + type: { + name: 'Composite', + className: 'TrackedResource', + modelProperties: { + id: { + required: false, + readOnly: true, + serializedName: 'id', + type: { + name: 'String' + } + }, + name: { + required: false, + readOnly: true, + serializedName: 'name', + type: { + name: 'String' + } + }, + type: { + required: false, + readOnly: true, + serializedName: 'type', + type: { + name: 'String' + } + }, + location: { + required: true, + serializedName: 'location', + type: { + name: 'String' + } + }, + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = TrackedResource; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/wsfcDomainCredentials.js b/lib/services/sqlvirtualmachineManagement/lib/models/wsfcDomainCredentials.js new file mode 100644 index 0000000000..fe83d2bde0 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/wsfcDomainCredentials.js @@ -0,0 +1,72 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Domain credentials for setting up Windows Server Failover Cluster for SQL + * availability group. + * + */ +class WsfcDomainCredentials { + /** + * Create a WsfcDomainCredentials. + * @property {string} [clusterBootstrapAccountPassword] Cluster bootstrap + * account password. + * @property {string} [clusterOperatorAccountPassword] Cluster operator + * account password. + * @property {string} [sqlServiceAccountPassword] SQL service account + * password. + */ + constructor() { + } + + /** + * Defines the metadata of WsfcDomainCredentials + * + * @returns {object} metadata of WsfcDomainCredentials + * + */ + mapper() { + return { + required: false, + serializedName: 'WsfcDomainCredentials', + type: { + name: 'Composite', + className: 'WsfcDomainCredentials', + modelProperties: { + clusterBootstrapAccountPassword: { + required: false, + serializedName: 'clusterBootstrapAccountPassword', + type: { + name: 'String' + } + }, + clusterOperatorAccountPassword: { + required: false, + serializedName: 'clusterOperatorAccountPassword', + type: { + name: 'String' + } + }, + sqlServiceAccountPassword: { + required: false, + serializedName: 'sqlServiceAccountPassword', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = WsfcDomainCredentials; diff --git a/lib/services/sqlvirtualmachineManagement/lib/models/wsfcDomainProfile.js b/lib/services/sqlvirtualmachineManagement/lib/models/wsfcDomainProfile.js new file mode 100644 index 0000000000..40c7b6e3e8 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/models/wsfcDomainProfile.js @@ -0,0 +1,117 @@ +/* + * 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'; + +/** + * Active Directory account details to operate Windows Server Failover Cluster. + * + */ +class WsfcDomainProfile { + /** + * Create a WsfcDomainProfile. + * @property {string} [domainFqdn] Fully qualified name of the domain. + * @property {string} [ouPath] Organizational Unit path in which the nodes + * and cluster will be present. + * @property {string} [clusterBootstrapAccount] Account name used for + * creating cluster (at minimum needs permissions to 'Create Computer + * Objects' in domain). + * @property {string} [clusterOperatorAccount] Account name used for + * operating cluster i.e. will be part of administrators group on all the + * participating virtual machines in the cluster. + * @property {string} [sqlServiceAccount] Account name under which SQL + * service will run on all participating SQL virtual machines in the cluster. + * @property {string} [fileShareWitnessPath] Optional path for fileshare + * witness. + * @property {string} [storageAccountUrl] Fully qualified ARM resource id of + * the witness storage account. + * @property {string} [storageAccountPrimaryKey] Primary key of the witness + * storage account. + */ + constructor() { + } + + /** + * Defines the metadata of WsfcDomainProfile + * + * @returns {object} metadata of WsfcDomainProfile + * + */ + mapper() { + return { + required: false, + serializedName: 'WsfcDomainProfile', + type: { + name: 'Composite', + className: 'WsfcDomainProfile', + modelProperties: { + domainFqdn: { + required: false, + serializedName: 'domainFqdn', + type: { + name: 'String' + } + }, + ouPath: { + required: false, + serializedName: 'ouPath', + type: { + name: 'String' + } + }, + clusterBootstrapAccount: { + required: false, + serializedName: 'clusterBootstrapAccount', + type: { + name: 'String' + } + }, + clusterOperatorAccount: { + required: false, + serializedName: 'clusterOperatorAccount', + type: { + name: 'String' + } + }, + sqlServiceAccount: { + required: false, + serializedName: 'sqlServiceAccount', + type: { + name: 'String' + } + }, + fileShareWitnessPath: { + required: false, + serializedName: 'fileShareWitnessPath', + type: { + name: 'String' + } + }, + storageAccountUrl: { + required: false, + serializedName: 'storageAccountUrl', + type: { + name: 'String' + } + }, + storageAccountPrimaryKey: { + required: false, + serializedName: 'storageAccountPrimaryKey', + type: { + name: 'String' + } + } + } + } + }; + } +} + +module.exports = WsfcDomainProfile; diff --git a/lib/services/dataLake.Store/lib/account/operations/trustedIdProviders.js b/lib/services/sqlvirtualmachineManagement/lib/operations/availabilityGroupListeners.js similarity index 61% rename from lib/services/dataLake.Store/lib/account/operations/trustedIdProviders.js rename to lib/services/sqlvirtualmachineManagement/lib/operations/availabilityGroupListeners.js index 36d1d4b9b6..668f9e4a1c 100644 --- a/lib/services/dataLake.Store/lib/account/operations/trustedIdProviders.js +++ b/lib/services/sqlvirtualmachineManagement/lib/operations/availabilityGroupListeners.js @@ -15,12 +15,17 @@ const msRestAzure = require('ms-rest-azure'); const WebResource = msRest.WebResource; /** - * Lists the Data Lake Store trusted identity providers within the specified - * Data Lake Store account. + * Gets an availability group listener. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * * @param {object} [options] Optional Parameters. * @@ -34,14 +39,14 @@ const WebResource = msRest.WebResource; * {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 TrustedIdProviderListResult} for more + * See {@link AvailabilityGroupListener} 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 _listByAccount(resourceGroupName, accountName, options, callback) { +function _get(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -53,14 +58,17 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { } // 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 (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); + if (sqlVirtualMachineGroupName === null || sqlVirtualMachineGroupName === undefined || typeof sqlVirtualMachineGroupName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineGroupName cannot be null or undefined and it must be of type string.'); + } + if (availabilityGroupListenerName === null || availabilityGroupListenerName === undefined || typeof availabilityGroupListenerName.valueOf() !== 'string') { + throw new Error('availabilityGroupListenerName cannot be null or undefined and it must be of type string.'); + } + 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 (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.'); @@ -74,10 +82,11 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders'; - requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}'; requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{accountName}', encodeURIComponent(accountName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineGroupName}', encodeURIComponent(sqlVirtualMachineGroupName)); + requestUrl = requestUrl.replace('{availabilityGroupListenerName}', encodeURIComponent(availabilityGroupListenerName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); let queryParameters = []; queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); if (queryParameters.length > 0) { @@ -146,7 +155,7 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['TrustedIdProviderListResult']().mapper(); + let resultMapper = new client.models['AvailabilityGroupListener']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -161,23 +170,32 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { }); } + /** - * Creates or updates the specified trusted identity provider. During update, - * the trusted identity provider with the specified name will be replaced with - * this new provider + * Creates or updates an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {object} parameters The availability group listener. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider. This is used for differentiation of providers in the account. + * @param {string} [parameters.availabilityGroupName] Name of the availability + * group. * - * @param {object} parameters Parameters supplied to create or replace the - * trusted identity provider. + * @param {array} [parameters.loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. * - * @param {string} parameters.idProvider The URL of this trusted identity - * provider. + * @param {boolean} [parameters.createDefaultAvailabilityGroupIfNotExist] + * Create a default availability group if it does not exist. + * + * @param {number} [parameters.port] Listener port. * * @param {object} [options] Optional Parameters. * @@ -191,139 +209,51 @@ function _listByAccount(resourceGroupName, accountName, options, callback) { * {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 TrustedIdProvider} for more information. + * See {@link AvailabilityGroupListener} 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 _createOrUpdate(resourceGroupName, accountName, trustedIdProviderName, parameters, options, callback) { +function _createOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, 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 (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); - } - if (trustedIdProviderName === null || trustedIdProviderName === undefined || typeof trustedIdProviderName.valueOf() !== 'string') { - throw new Error('trustedIdProviderName cannot be null or undefined and it must be of type string.'); - } - if (parameters === null || parameters === undefined) { - throw new Error('parameters cannot be null or undefined.'); - } - 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 (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.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}'; - requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); - requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{accountName}', encodeURIComponent(accountName)); - requestUrl = requestUrl.replace('{trustedIdProviderName}', encodeURIComponent(trustedIdProviderName)); - let queryParameters = []; - queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); - if (queryParameters.length > 0) { - requestUrl += '?' + queryParameters.join('&'); - } + // Send request + this.beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); - // Create HTTP transport objects - let httpRequest = new WebResource(); - httpRequest.method = 'PUT'; - 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 (parameters !== null && parameters !== undefined) { - let requestModelMapper = new client.models['CreateOrUpdateTrustedIdProviderParameters']().mapper(); - requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); - requestContent = JSON.stringify(requestModel); - } - } catch (error) { - let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + - `payload - ${JSON.stringify(parameters, 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); + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; 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) { + + // Deserialize Response let parsedResponse = null; try { parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['TrustedIdProvider']().mapper(); + let resultMapper = new client.models['AvailabilityGroupListener']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -332,21 +262,90 @@ function _createOrUpdate(resourceGroupName, accountName, trustedIdProviderName, deserializationError.response = msRest.stripResponse(response); return callback(deserializationError); } - } - return callback(null, result, httpRequest, response); + return callback(null, result, httpRequest, response); + }); }); } + /** - * Gets the specified Data Lake Store trusted identity provider. + * Deletes an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @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) * - * @param {string} resourceGroupName The name of the Azure resource group. + * {Error} err - The Error object if an error occurred, null otherwise. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _deleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, 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.'); + } + + // Send request + this.beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + + return callback(null, result, httpRequest, response); + }); + }); +} + +/** + * Lists all availability group listeners in a SQL virtual machine group. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider to retrieve. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * * @param {object} [options] Optional Parameters. * @@ -360,13 +359,14 @@ function _createOrUpdate(resourceGroupName, accountName, trustedIdProviderName, * {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 TrustedIdProvider} for more information. + * See {@link AvailabilityGroupListenerListResult} 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 _get(resourceGroupName, accountName, trustedIdProviderName, options, callback) { +function _listByGroup(resourceGroupName, sqlVirtualMachineGroupName, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -378,17 +378,14 @@ function _get(resourceGroupName, accountName, trustedIdProviderName, options, ca } // 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 (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); + if (sqlVirtualMachineGroupName === null || sqlVirtualMachineGroupName === undefined || typeof sqlVirtualMachineGroupName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineGroupName cannot be null or undefined and it must be of type string.'); } - if (trustedIdProviderName === null || trustedIdProviderName === undefined || typeof trustedIdProviderName.valueOf() !== 'string') { - throw new Error('trustedIdProviderName cannot be null or undefined and it must be of type string.'); + 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 (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.'); @@ -402,11 +399,10 @@ function _get(resourceGroupName, accountName, trustedIdProviderName, options, ca // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}'; - requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners'; requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{accountName}', encodeURIComponent(accountName)); - requestUrl = requestUrl.replace('{trustedIdProviderName}', encodeURIComponent(trustedIdProviderName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineGroupName}', encodeURIComponent(sqlVirtualMachineGroupName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); let queryParameters = []; queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); if (queryParameters.length > 0) { @@ -475,7 +471,7 @@ function _get(resourceGroupName, accountName, trustedIdProviderName, options, ca parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['TrustedIdProvider']().mapper(); + let resultMapper = new client.models['AvailabilityGroupListenerListResult']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -491,22 +487,32 @@ function _get(resourceGroupName, accountName, trustedIdProviderName, options, ca } /** - * Updates the specified trusted identity provider. + * Creates or updates an availability group listener. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider. This is used for differentiation of providers in the account. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * - * @param {object} [options] Optional Parameters. + * @param {object} parameters The availability group listener. + * + * @param {string} [parameters.availabilityGroupName] Name of the availability + * group. * - * @param {object} [options.parameters] Parameters supplied to update the - * trusted identity provider. + * @param {array} [parameters.loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. * - * @param {string} [options.parameters.idProvider] The URL of this trusted - * identity provider. + * @param {boolean} [parameters.createDefaultAvailabilityGroupIfNotExist] + * Create a default availability group if it does not exist. + * + * @param {number} [parameters.port] Listener port. + * + * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request @@ -518,13 +524,14 @@ function _get(resourceGroupName, accountName, trustedIdProviderName, options, ca * {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 TrustedIdProvider} for more information. + * See {@link AvailabilityGroupListener} 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 _update(resourceGroupName, accountName, trustedIdProviderName, options, callback) { +function _beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -534,20 +541,22 @@ function _update(resourceGroupName, accountName, trustedIdProviderName, options, if (!callback) { throw new Error('callback cannot be null.'); } - let parameters = (options && options.parameters !== undefined) ? options.parameters : undefined; // 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 (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); + if (sqlVirtualMachineGroupName === null || sqlVirtualMachineGroupName === undefined || typeof sqlVirtualMachineGroupName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineGroupName cannot be null or undefined and it must be of type string.'); + } + if (availabilityGroupListenerName === null || availabilityGroupListenerName === undefined || typeof availabilityGroupListenerName.valueOf() !== 'string') { + throw new Error('availabilityGroupListenerName cannot be null or undefined and it must be of type string.'); } - if (trustedIdProviderName === null || trustedIdProviderName === undefined || typeof trustedIdProviderName.valueOf() !== 'string') { - throw new Error('trustedIdProviderName cannot be null or undefined and it must be of type string.'); + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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.'); @@ -561,11 +570,11 @@ function _update(resourceGroupName, accountName, trustedIdProviderName, options, // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}'; - requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}'; requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{accountName}', encodeURIComponent(accountName)); - requestUrl = requestUrl.replace('{trustedIdProviderName}', encodeURIComponent(trustedIdProviderName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineGroupName}', encodeURIComponent(sqlVirtualMachineGroupName)); + requestUrl = requestUrl.replace('{availabilityGroupListenerName}', encodeURIComponent(availabilityGroupListenerName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); let queryParameters = []; queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); if (queryParameters.length > 0) { @@ -574,7 +583,7 @@ function _update(resourceGroupName, accountName, trustedIdProviderName, options, // Create HTTP transport objects let httpRequest = new WebResource(); - httpRequest.method = 'PATCH'; + httpRequest.method = 'PUT'; httpRequest.url = requestUrl; httpRequest.headers = {}; // Set Headers @@ -597,7 +606,7 @@ function _update(resourceGroupName, accountName, trustedIdProviderName, options, let requestModel = null; try { if (parameters !== null && parameters !== undefined) { - let requestModelMapper = new client.models['UpdateTrustedIdProviderParameters']().mapper(); + let requestModelMapper = new client.models['AvailabilityGroupListener']().mapper(); requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); requestContent = JSON.stringify(requestModel); } @@ -613,7 +622,7 @@ function _update(resourceGroupName, accountName, trustedIdProviderName, options, return callback(err); } let statusCode = response.statusCode; - if (statusCode !== 200) { + if (statusCode !== 200 && statusCode !== 201) { let error = new Error(responseBody); error.statusCode = response.statusCode; error.request = msRest.stripRequest(httpRequest); @@ -648,7 +657,7 @@ function _update(resourceGroupName, accountName, trustedIdProviderName, options, parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['TrustedIdProvider']().mapper(); + let resultMapper = new client.models['AvailabilityGroupListener']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -658,21 +667,40 @@ function _update(resourceGroupName, accountName, trustedIdProviderName, options, return callback(deserializationError); } } + // Deserialize Response + if (statusCode === 201) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['AvailabilityGroupListener']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError1.request = msRest.stripRequest(httpRequest); + deserializationError1.response = msRest.stripResponse(response); + return callback(deserializationError1); + } + } return callback(null, result, httpRequest, response); }); } /** - * Deletes the specified trusted identity provider from the specified Data Lake - * Store account + * Deletes an availability group listener. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider to delete. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * * @param {object} [options] Optional Parameters. * @@ -691,7 +719,7 @@ function _update(resourceGroupName, accountName, trustedIdProviderName, options, * * {stream} [response] - The HTTP Response stream if an error did not occur. */ -function _deleteMethod(resourceGroupName, accountName, trustedIdProviderName, options, callback) { +function _beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -703,17 +731,17 @@ function _deleteMethod(resourceGroupName, accountName, trustedIdProviderName, op } // 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 (accountName === null || accountName === undefined || typeof accountName.valueOf() !== 'string') { - throw new Error('accountName cannot be null or undefined and it must be of type string.'); + if (sqlVirtualMachineGroupName === null || sqlVirtualMachineGroupName === undefined || typeof sqlVirtualMachineGroupName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineGroupName cannot be null or undefined and it must be of type string.'); + } + if (availabilityGroupListenerName === null || availabilityGroupListenerName === undefined || typeof availabilityGroupListenerName.valueOf() !== 'string') { + throw new Error('availabilityGroupListenerName cannot be null or undefined and it must be of type string.'); } - if (trustedIdProviderName === null || trustedIdProviderName === undefined || typeof trustedIdProviderName.valueOf() !== 'string') { - throw new Error('trustedIdProviderName cannot be null or undefined and it must be of type string.'); + 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 (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.'); @@ -727,11 +755,11 @@ function _deleteMethod(resourceGroupName, accountName, trustedIdProviderName, op // Construct URL let baseUrl = this.client.baseUri; - let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}'; - requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + let requestUrl = baseUrl + (baseUrl.endsWith('/') ? '' : '/') + 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}'; requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); - requestUrl = requestUrl.replace('{accountName}', encodeURIComponent(accountName)); - requestUrl = requestUrl.replace('{trustedIdProviderName}', encodeURIComponent(trustedIdProviderName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineGroupName}', encodeURIComponent(sqlVirtualMachineGroupName)); + requestUrl = requestUrl.replace('{availabilityGroupListenerName}', encodeURIComponent(availabilityGroupListenerName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); let queryParameters = []; queryParameters.push('api-version=' + encodeURIComponent(this.client.apiVersion)); if (queryParameters.length > 0) { @@ -765,7 +793,7 @@ function _deleteMethod(resourceGroupName, accountName, trustedIdProviderName, op return callback(err); } let statusCode = response.statusCode; - if (statusCode !== 200 && statusCode !== 204) { + if (statusCode !== 200 && statusCode !== 202 && statusCode !== 204) { let error = new Error(responseBody); error.statusCode = response.statusCode; error.request = msRest.stripRequest(httpRequest); @@ -799,8 +827,7 @@ function _deleteMethod(resourceGroupName, accountName, trustedIdProviderName, op } /** - * Lists the Data Lake Store trusted identity providers within the specified - * Data Lake Store account. + * Lists all availability group listeners in a SQL virtual machine group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -817,14 +844,14 @@ function _deleteMethod(resourceGroupName, accountName, trustedIdProviderName, op * {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 TrustedIdProviderListResult} for more - * information. + * See {@link AvailabilityGroupListenerListResult} 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 _listByAccountNext(nextPageLink, options, callback) { +function _listByGroupNext(nextPageLink, options, callback) { /* jshint validthis: true */ let client = this.client; if(!callback && typeof options === 'function') { @@ -912,7 +939,7 @@ function _listByAccountNext(nextPageLink, options, callback) { parsedResponse = JSON.parse(responseBody); result = JSON.parse(responseBody); if (parsedResponse !== null && parsedResponse !== undefined) { - let resultMapper = new client.models['TrustedIdProviderListResult']().mapper(); + let resultMapper = new client.models['AvailabilityGroupListenerListResult']().mapper(); result = client.deserialize(resultMapper, parsedResponse, 'result'); } } catch (error) { @@ -927,29 +954,35 @@ function _listByAccountNext(nextPageLink, options, callback) { }); } -/** Class representing a TrustedIdProviders. */ -class TrustedIdProviders { +/** Class representing a AvailabilityGroupListeners. */ +class AvailabilityGroupListeners { /** - * Create a TrustedIdProviders. - * @param {DataLakeStoreAccountManagementClient} client Reference to the service client. + * Create a AvailabilityGroupListeners. + * @param {SqlVirtualMachineManagementClient} client Reference to the service client. */ constructor(client) { this.client = client; - this._listByAccount = _listByAccount; - this._createOrUpdate = _createOrUpdate; this._get = _get; - this._update = _update; + this._createOrUpdate = _createOrUpdate; this._deleteMethod = _deleteMethod; - this._listByAccountNext = _listByAccountNext; + this._listByGroup = _listByGroup; + this._beginCreateOrUpdate = _beginCreateOrUpdate; + this._beginDeleteMethod = _beginDeleteMethod; + this._listByGroupNext = _listByGroupNext; } /** - * Lists the Data Lake Store trusted identity providers within the specified - * Data Lake Store account. + * Gets an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * * @param {object} [options] Optional Parameters. * @@ -958,15 +991,15 @@ class TrustedIdProviders { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - listByAccountWithHttpOperationResponse(resourceGroupName, accountName, options) { + getWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._listByAccount(resourceGroupName, accountName, options, (err, result, request, response) => { + self._get(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -977,12 +1010,17 @@ class TrustedIdProviders { } /** - * Lists the Data Lake Store trusted identity providers within the specified - * Data Lake Store account. + * Gets an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * * @param {object} [options] Optional Parameters. * @@ -996,7 +1034,7 @@ class TrustedIdProviders { * * {Promise} A promise is returned * - * @resolve {TrustedIdProviderListResult} - The deserialized result object. + * @resolve {AvailabilityGroupListener} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1005,14 +1043,14 @@ class TrustedIdProviders { * {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 TrustedIdProviderListResult} for more + * See {@link AvailabilityGroupListener} 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. */ - listByAccount(resourceGroupName, accountName, options, optionalCallback) { + get(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1021,34 +1059,42 @@ class TrustedIdProviders { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._listByAccount(resourceGroupName, accountName, options, (err, result, request, response) => { + self._get(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._listByAccount(resourceGroupName, accountName, options, optionalCallback); + return self._get(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, optionalCallback); } } /** - * Creates or updates the specified trusted identity provider. During update, - * the trusted identity provider with the specified name will be replaced with - * this new provider + * Creates or updates an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {object} parameters The availability group listener. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider. This is used for differentiation of providers in the account. + * @param {string} [parameters.availabilityGroupName] Name of the availability + * group. * - * @param {object} parameters Parameters supplied to create or replace the - * trusted identity provider. + * @param {array} [parameters.loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. * - * @param {string} parameters.idProvider The URL of this trusted identity - * provider. + * @param {boolean} [parameters.createDefaultAvailabilityGroupIfNotExist] + * Create a default availability group if it does not exist. + * + * @param {number} [parameters.port] Listener port. * * @param {object} [options] Optional Parameters. * @@ -1057,15 +1103,15 @@ class TrustedIdProviders { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - createOrUpdateWithHttpOperationResponse(resourceGroupName, accountName, trustedIdProviderName, parameters, options) { + createOrUpdateWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._createOrUpdate(resourceGroupName, accountName, trustedIdProviderName, parameters, options, (err, result, request, response) => { + self._createOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1076,22 +1122,30 @@ class TrustedIdProviders { } /** - * Creates or updates the specified trusted identity provider. During update, - * the trusted identity provider with the specified name will be replaced with - * this new provider + * Creates or updates an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {object} parameters The availability group listener. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider. This is used for differentiation of providers in the account. + * @param {string} [parameters.availabilityGroupName] Name of the availability + * group. * - * @param {object} parameters Parameters supplied to create or replace the - * trusted identity provider. + * @param {array} [parameters.loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. * - * @param {string} parameters.idProvider The URL of this trusted identity - * provider. + * @param {boolean} [parameters.createDefaultAvailabilityGroupIfNotExist] + * Create a default availability group if it does not exist. + * + * @param {number} [parameters.port] Listener port. * * @param {object} [options] Optional Parameters. * @@ -1105,7 +1159,7 @@ class TrustedIdProviders { * * {Promise} A promise is returned * - * @resolve {TrustedIdProvider} - The deserialized result object. + * @resolve {AvailabilityGroupListener} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1114,13 +1168,14 @@ class TrustedIdProviders { * {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 TrustedIdProvider} for more information. + * See {@link AvailabilityGroupListener} 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. */ - createOrUpdate(resourceGroupName, accountName, trustedIdProviderName, parameters, options, optionalCallback) { + createOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1129,26 +1184,29 @@ class TrustedIdProviders { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._createOrUpdate(resourceGroupName, accountName, trustedIdProviderName, parameters, options, (err, result, request, response) => { + self._createOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._createOrUpdate(resourceGroupName, accountName, trustedIdProviderName, parameters, options, optionalCallback); + return self._createOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options, optionalCallback); } } /** - * Gets the specified Data Lake Store trusted identity provider. + * Deletes an availability group listener. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider to retrieve. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * * @param {object} [options] Optional Parameters. * @@ -1157,15 +1215,15 @@ class TrustedIdProviders { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - getWithHttpOperationResponse(resourceGroupName, accountName, trustedIdProviderName, options) { + deleteMethodWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._get(resourceGroupName, accountName, trustedIdProviderName, options, (err, result, request, response) => { + self._deleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1176,14 +1234,17 @@ class TrustedIdProviders { } /** - * Gets the specified Data Lake Store trusted identity provider. + * Deletes an availability group listener. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider to retrieve. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * * @param {object} [options] Optional Parameters. * @@ -1197,7 +1258,7 @@ class TrustedIdProviders { * * {Promise} A promise is returned * - * @resolve {TrustedIdProvider} - The deserialized result object. + * @resolve {null} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1205,14 +1266,13 @@ class TrustedIdProviders { * * {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 TrustedIdProvider} for more information. + * {null} [result] - The deserialized result object if an error did not occur. * * {object} [request] - The HTTP Request object if an error did not occur. * * {stream} [response] - The HTTP Response stream if an error did not occur. */ - get(resourceGroupName, accountName, trustedIdProviderName, options, optionalCallback) { + deleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1221,49 +1281,152 @@ class TrustedIdProviders { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._get(resourceGroupName, accountName, trustedIdProviderName, options, (err, result, request, response) => { + self._deleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._get(resourceGroupName, accountName, trustedIdProviderName, options, optionalCallback); + return self._deleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, optionalCallback); } } /** - * Updates the specified trusted identity provider. + * Lists all availability group listeners in a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @reject {Error} - The error object. + */ + listByGroupWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listByGroup(resourceGroupName, sqlVirtualMachineGroupName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists all availability group listeners in a SQL virtual machine group. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider. This is used for differentiation of providers in the account. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * * @param {object} [options] Optional Parameters. * - * @param {object} [options.parameters] Parameters supplied to update the - * trusted identity provider. + * @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 {AvailabilityGroupListenerListResult} - The deserialized result object. * - * @param {string} [options.parameters.idProvider] The URL of this trusted - * identity provider. + * @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 AvailabilityGroupListenerListResult} 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. + */ + listByGroup(resourceGroupName, sqlVirtualMachineGroupName, 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._listByGroup(resourceGroupName, sqlVirtualMachineGroupName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listByGroup(resourceGroupName, sqlVirtualMachineGroupName, options, optionalCallback); + } + } + + /** + * Creates or updates an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @param {object} parameters The availability group listener. + * + * @param {string} [parameters.availabilityGroupName] Name of the availability + * group. + * + * @param {array} [parameters.loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. + * + * @param {boolean} [parameters.createDefaultAvailabilityGroupIfNotExist] + * Create a default availability group if it does not exist. + * + * @param {number} [parameters.port] Listener port. + * + * @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. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - updateWithHttpOperationResponse(resourceGroupName, accountName, trustedIdProviderName, options) { + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._update(resourceGroupName, accountName, trustedIdProviderName, options, (err, result, request, response) => { + self._beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1274,22 +1437,32 @@ class TrustedIdProviders { } /** - * Updates the specified trusted identity provider. + * Creates or updates an availability group listener. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider. This is used for differentiation of providers in the account. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * - * @param {object} [options] Optional Parameters. + * @param {object} parameters The availability group listener. + * + * @param {string} [parameters.availabilityGroupName] Name of the availability + * group. + * + * @param {array} [parameters.loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. * - * @param {object} [options.parameters] Parameters supplied to update the - * trusted identity provider. + * @param {boolean} [parameters.createDefaultAvailabilityGroupIfNotExist] + * Create a default availability group if it does not exist. * - * @param {string} [options.parameters.idProvider] The URL of this trusted - * identity provider. + * @param {number} [parameters.port] Listener port. + * + * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request @@ -1301,7 +1474,7 @@ class TrustedIdProviders { * * {Promise} A promise is returned * - * @resolve {TrustedIdProvider} - The deserialized result object. + * @resolve {AvailabilityGroupListener} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1310,13 +1483,14 @@ class TrustedIdProviders { * {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 TrustedIdProvider} for more information. + * See {@link AvailabilityGroupListener} 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. */ - update(resourceGroupName, accountName, trustedIdProviderName, options, optionalCallback) { + beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1325,27 +1499,29 @@ class TrustedIdProviders { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._update(resourceGroupName, accountName, trustedIdProviderName, options, (err, result, request, response) => { + self._beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._update(resourceGroupName, accountName, trustedIdProviderName, options, optionalCallback); + return self._beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, parameters, options, optionalCallback); } } /** - * Deletes the specified trusted identity provider from the specified Data Lake - * Store account + * Deletes an availability group listener. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider to delete. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * * @param {object} [options] Optional Parameters. * @@ -1358,11 +1534,11 @@ class TrustedIdProviders { * * @reject {Error} - The error object. */ - deleteMethodWithHttpOperationResponse(resourceGroupName, accountName, trustedIdProviderName, options) { + beginDeleteMethodWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._deleteMethod(resourceGroupName, accountName, trustedIdProviderName, options, (err, result, request, response) => { + self._beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1373,15 +1549,17 @@ class TrustedIdProviders { } /** - * Deletes the specified trusted identity provider from the specified Data Lake - * Store account + * Deletes an availability group listener. * - * @param {string} resourceGroupName The name of the Azure resource group. + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. * - * @param {string} accountName The name of the Data Lake Store account. + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. * - * @param {string} trustedIdProviderName The name of the trusted identity - * provider to delete. + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. * * @param {object} [options] Optional Parameters. * @@ -1409,7 +1587,7 @@ class TrustedIdProviders { * * {stream} [response] - The HTTP Response stream if an error did not occur. */ - deleteMethod(resourceGroupName, accountName, trustedIdProviderName, options, optionalCallback) { + beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1418,20 +1596,19 @@ class TrustedIdProviders { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._deleteMethod(resourceGroupName, accountName, trustedIdProviderName, options, (err, result, request, response) => { + self._beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._deleteMethod(resourceGroupName, accountName, trustedIdProviderName, options, optionalCallback); + return self._beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, availabilityGroupListenerName, options, optionalCallback); } } /** - * Lists the Data Lake Store trusted identity providers within the specified - * Data Lake Store account. + * Lists all availability group listeners in a SQL virtual machine group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1443,15 +1620,15 @@ class TrustedIdProviders { * * @returns {Promise} A promise is returned * - * @resolve {HttpOperationResponse} - The deserialized result object. + * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error} - The error object. */ - listByAccountNextWithHttpOperationResponse(nextPageLink, options) { + listByGroupNextWithHttpOperationResponse(nextPageLink, options) { let client = this.client; let self = this; return new Promise((resolve, reject) => { - self._listByAccountNext(nextPageLink, options, (err, result, request, response) => { + self._listByGroupNext(nextPageLink, options, (err, result, request, response) => { let httpOperationResponse = new msRest.HttpOperationResponse(request, response); httpOperationResponse.body = result; if (err) { reject(err); } @@ -1462,8 +1639,7 @@ class TrustedIdProviders { } /** - * Lists the Data Lake Store trusted identity providers within the specified - * Data Lake Store account. + * Lists all availability group listeners in a SQL virtual machine group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. @@ -1480,7 +1656,7 @@ class TrustedIdProviders { * * {Promise} A promise is returned * - * @resolve {TrustedIdProviderListResult} - The deserialized result object. + * @resolve {AvailabilityGroupListenerListResult} - The deserialized result object. * * @reject {Error} - The error object. * @@ -1489,14 +1665,14 @@ class TrustedIdProviders { * {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 TrustedIdProviderListResult} for more - * information. + * See {@link AvailabilityGroupListenerListResult} 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. */ - listByAccountNext(nextPageLink, options, optionalCallback) { + listByGroupNext(nextPageLink, options, optionalCallback) { let client = this.client; let self = this; if (!optionalCallback && typeof options === 'function') { @@ -1505,17 +1681,17 @@ class TrustedIdProviders { } if (!optionalCallback) { return new Promise((resolve, reject) => { - self._listByAccountNext(nextPageLink, options, (err, result, request, response) => { + self._listByGroupNext(nextPageLink, options, (err, result, request, response) => { if (err) { reject(err); } else { resolve(result); } return; }); }); } else { - return self._listByAccountNext(nextPageLink, options, optionalCallback); + return self._listByGroupNext(nextPageLink, options, optionalCallback); } } } -module.exports = TrustedIdProviders; +module.exports = AvailabilityGroupListeners; diff --git a/lib/services/sqlvirtualmachineManagement/lib/operations/index.d.ts b/lib/services/sqlvirtualmachineManagement/lib/operations/index.d.ts new file mode 100644 index 0000000000..828a2ff3b5 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/operations/index.d.ts @@ -0,0 +1,2936 @@ +/* + * 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. +*/ + +import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse } from 'ms-rest'; +import * as models from '../models'; + + +/** + * @class + * AvailabilityGroupListeners + * __NOTE__: An instance of this class is automatically created for an + * instance of the SqlVirtualMachineManagementClient. + */ +export interface AvailabilityGroupListeners { + + + /** + * Gets an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @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 {AvailabilityGroupListener} - 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. + * + * {AvailabilityGroupListener} [result] - The deserialized result object if an error did not occur. + * See {@link AvailabilityGroupListener} 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. + */ + get(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @param {object} parameters The availability group listener. + * + * @param {string} [parameters.availabilityGroupName] Name of the availability + * group. + * + * @param {array} [parameters.loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. + * + * @param {boolean} [parameters.createDefaultAvailabilityGroupIfNotExist] + * Create a default availability group if it does not exist. + * + * @param {number} [parameters.port] Listener port. + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, parameters: models.AvailabilityGroupListener, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @param {object} parameters The availability group listener. + * + * @param {string} [parameters.availabilityGroupName] Name of the availability + * group. + * + * @param {array} [parameters.loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. + * + * @param {boolean} [parameters.createDefaultAvailabilityGroupIfNotExist] + * Create a default availability group if it does not exist. + * + * @param {number} [parameters.port] Listener port. + * + * @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 {AvailabilityGroupListener} - 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. + * + * {AvailabilityGroupListener} [result] - The deserialized result object if an error did not occur. + * See {@link AvailabilityGroupListener} 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. + */ + createOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, parameters: models.AvailabilityGroupListener, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, parameters: models.AvailabilityGroupListener, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, parameters: models.AvailabilityGroupListener, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + deleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists all availability group listeners in a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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. + */ + listByGroupWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all availability group listeners in a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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 {AvailabilityGroupListenerListResult} - 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. + * + * {AvailabilityGroupListenerListResult} [result] - The deserialized result object if an error did not occur. + * See {@link AvailabilityGroupListenerListResult} 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. + */ + listByGroup(resourceGroupName: string, sqlVirtualMachineGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByGroup(resourceGroupName: string, sqlVirtualMachineGroupName: string, callback: ServiceCallback): void; + listByGroup(resourceGroupName: string, sqlVirtualMachineGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @param {object} parameters The availability group listener. + * + * @param {string} [parameters.availabilityGroupName] Name of the availability + * group. + * + * @param {array} [parameters.loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. + * + * @param {boolean} [parameters.createDefaultAvailabilityGroupIfNotExist] + * Create a default availability group if it does not exist. + * + * @param {number} [parameters.port] Listener port. + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, parameters: models.AvailabilityGroupListener, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @param {object} parameters The availability group listener. + * + * @param {string} [parameters.availabilityGroupName] Name of the availability + * group. + * + * @param {array} [parameters.loadBalancerConfigurations] List of load balancer + * configurations for an availability group listener. + * + * @param {boolean} [parameters.createDefaultAvailabilityGroupIfNotExist] + * Create a default availability group if it does not exist. + * + * @param {number} [parameters.port] Listener port. + * + * @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 {AvailabilityGroupListener} - 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. + * + * {AvailabilityGroupListener} [result] - The deserialized result object if an error did not occur. + * See {@link AvailabilityGroupListener} 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. + */ + beginCreateOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, parameters: models.AvailabilityGroupListener, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginCreateOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, parameters: models.AvailabilityGroupListener, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, parameters: models.AvailabilityGroupListener, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes an availability group listener. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {string} availabilityGroupListenerName Name of the availability group + * listener. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + beginDeleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginDeleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, availabilityGroupListenerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists all availability group listeners in a SQL virtual machine group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listByGroupNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all availability group listeners in a SQL virtual machine group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {AvailabilityGroupListenerListResult} - 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. + * + * {AvailabilityGroupListenerListResult} [result] - The deserialized result object if an error did not occur. + * See {@link AvailabilityGroupListenerListResult} 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. + */ + listByGroupNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByGroupNext(nextPageLink: string, callback: ServiceCallback): void; + listByGroupNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * Operations + * __NOTE__: An instance of this class is automatically created for an + * instance of the SqlVirtualMachineManagementClient. + */ +export interface Operations { + + + /** + * Lists all of the available SQL Rest API operations. + * + * @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. + */ + listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all of the available SQL Rest API operations. + * + * @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 {OperationListResult} - 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. + * + * {OperationListResult} [result] - The deserialized result object if an error did not occur. + * See {@link OperationListResult} 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. + */ + list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(callback: ServiceCallback): void; + list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Lists all of the available SQL Rest API operations. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Lists all of the available SQL Rest API operations. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {OperationListResult} - 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. + * + * {OperationListResult} [result] - The deserialized result object if an error did not occur. + * See {@link OperationListResult} 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. + */ + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * SqlVirtualMachineGroups + * __NOTE__: An instance of this class is automatically created for an + * instance of the SqlVirtualMachineManagementClient. + */ +export interface SqlVirtualMachineGroups { + + + /** + * Gets a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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 {SqlVirtualMachineGroup} - 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. + * + * {SqlVirtualMachineGroup} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineGroup} 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. + */ + get(resourceGroupName: string, sqlVirtualMachineGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, sqlVirtualMachineGroupName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, sqlVirtualMachineGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {string} [parameters.sqlImageOffer] SQL image offer. Examples may + * include SQL2016-WS2016, SQL2017-WS2016. + * + * @param {string} [parameters.sqlImageSku] SQL image sku. Possible values + * include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * + * @param {object} [parameters.wsfcDomainProfile] Cluster Active Directory + * domain profile. + * + * @param {string} [parameters.wsfcDomainProfile.domainFqdn] Fully qualified + * name of the domain. + * + * @param {string} [parameters.wsfcDomainProfile.ouPath] Organizational Unit + * path in which the nodes and cluster will be present. + * + * @param {string} [parameters.wsfcDomainProfile.clusterBootstrapAccount] + * Account name used for creating cluster (at minimum needs permissions to + * 'Create Computer Objects' in domain). + * + * @param {string} [parameters.wsfcDomainProfile.clusterOperatorAccount] + * Account name used for operating cluster i.e. will be part of administrators + * group on all the participating virtual machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.sqlServiceAccount] Account + * name under which SQL service will run on all participating SQL virtual + * machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.fileShareWitnessPath] Optional + * path for fileshare witness. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountUrl] Fully + * qualified ARM resource id of the witness storage account. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountPrimaryKey] + * Primary key of the witness storage account. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroup, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {string} [parameters.sqlImageOffer] SQL image offer. Examples may + * include SQL2016-WS2016, SQL2017-WS2016. + * + * @param {string} [parameters.sqlImageSku] SQL image sku. Possible values + * include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * + * @param {object} [parameters.wsfcDomainProfile] Cluster Active Directory + * domain profile. + * + * @param {string} [parameters.wsfcDomainProfile.domainFqdn] Fully qualified + * name of the domain. + * + * @param {string} [parameters.wsfcDomainProfile.ouPath] Organizational Unit + * path in which the nodes and cluster will be present. + * + * @param {string} [parameters.wsfcDomainProfile.clusterBootstrapAccount] + * Account name used for creating cluster (at minimum needs permissions to + * 'Create Computer Objects' in domain). + * + * @param {string} [parameters.wsfcDomainProfile.clusterOperatorAccount] + * Account name used for operating cluster i.e. will be part of administrators + * group on all the participating virtual machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.sqlServiceAccount] Account + * name under which SQL service will run on all participating SQL virtual + * machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.fileShareWitnessPath] Optional + * path for fileshare witness. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountUrl] Fully + * qualified ARM resource id of the witness storage account. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountPrimaryKey] + * Primary key of the witness storage account. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachineGroup} - 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. + * + * {SqlVirtualMachineGroup} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineGroup} 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. + */ + createOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroup, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroup, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroup, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + deleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates SQL virtual machine group tags. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroupUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates SQL virtual machine group tags. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachineGroup} - 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. + * + * {SqlVirtualMachineGroup} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineGroup} 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. + */ + update(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroupUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + update(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroupUpdate, callback: ServiceCallback): void; + update(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroupUpdate, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets all SQL virtual machine groups in a resource group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @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. + */ + listByResourceGroupWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all SQL virtual machine groups in a resource group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @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 {SqlVirtualMachineGroupListResult} - 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. + * + * {SqlVirtualMachineGroupListResult} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineGroupListResult} 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. + */ + listByResourceGroup(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByResourceGroup(resourceGroupName: string, callback: ServiceCallback): void; + listByResourceGroup(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets all SQL virtual machine groups in a subscription. + * + * @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. + */ + listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all SQL virtual machine groups in a subscription. + * + * @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 {SqlVirtualMachineGroupListResult} - 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. + * + * {SqlVirtualMachineGroupListResult} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineGroupListResult} 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. + */ + list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(callback: ServiceCallback): void; + list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {string} [parameters.sqlImageOffer] SQL image offer. Examples may + * include SQL2016-WS2016, SQL2017-WS2016. + * + * @param {string} [parameters.sqlImageSku] SQL image sku. Possible values + * include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * + * @param {object} [parameters.wsfcDomainProfile] Cluster Active Directory + * domain profile. + * + * @param {string} [parameters.wsfcDomainProfile.domainFqdn] Fully qualified + * name of the domain. + * + * @param {string} [parameters.wsfcDomainProfile.ouPath] Organizational Unit + * path in which the nodes and cluster will be present. + * + * @param {string} [parameters.wsfcDomainProfile.clusterBootstrapAccount] + * Account name used for creating cluster (at minimum needs permissions to + * 'Create Computer Objects' in domain). + * + * @param {string} [parameters.wsfcDomainProfile.clusterOperatorAccount] + * Account name used for operating cluster i.e. will be part of administrators + * group on all the participating virtual machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.sqlServiceAccount] Account + * name under which SQL service will run on all participating SQL virtual + * machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.fileShareWitnessPath] Optional + * path for fileshare witness. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountUrl] Fully + * qualified ARM resource id of the witness storage account. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountPrimaryKey] + * Primary key of the witness storage account. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroup, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {string} [parameters.sqlImageOffer] SQL image offer. Examples may + * include SQL2016-WS2016, SQL2017-WS2016. + * + * @param {string} [parameters.sqlImageSku] SQL image sku. Possible values + * include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * + * @param {object} [parameters.wsfcDomainProfile] Cluster Active Directory + * domain profile. + * + * @param {string} [parameters.wsfcDomainProfile.domainFqdn] Fully qualified + * name of the domain. + * + * @param {string} [parameters.wsfcDomainProfile.ouPath] Organizational Unit + * path in which the nodes and cluster will be present. + * + * @param {string} [parameters.wsfcDomainProfile.clusterBootstrapAccount] + * Account name used for creating cluster (at minimum needs permissions to + * 'Create Computer Objects' in domain). + * + * @param {string} [parameters.wsfcDomainProfile.clusterOperatorAccount] + * Account name used for operating cluster i.e. will be part of administrators + * group on all the participating virtual machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.sqlServiceAccount] Account + * name under which SQL service will run on all participating SQL virtual + * machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.fileShareWitnessPath] Optional + * path for fileshare witness. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountUrl] Fully + * qualified ARM resource id of the witness storage account. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountPrimaryKey] + * Primary key of the witness storage account. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachineGroup} - 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. + * + * {SqlVirtualMachineGroup} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineGroup} 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. + */ + beginCreateOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroup, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginCreateOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroup, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroup, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + beginDeleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginDeleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, sqlVirtualMachineGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates SQL virtual machine group tags. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + beginUpdateWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroupUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates SQL virtual machine group tags. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachineGroup} - 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. + * + * {SqlVirtualMachineGroup} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineGroup} 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. + */ + beginUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroupUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroupUpdate, callback: ServiceCallback): void; + beginUpdate(resourceGroupName: string, sqlVirtualMachineGroupName: string, parameters: models.SqlVirtualMachineGroupUpdate, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets all SQL virtual machine groups in a resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listByResourceGroupNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all SQL virtual machine groups in a resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {SqlVirtualMachineGroupListResult} - 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. + * + * {SqlVirtualMachineGroupListResult} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineGroupListResult} 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. + */ + listByResourceGroupNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback): void; + listByResourceGroupNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets all SQL virtual machine groups in a subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all SQL virtual machine groups in a subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {SqlVirtualMachineGroupListResult} - 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. + * + * {SqlVirtualMachineGroupListResult} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineGroupListResult} 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. + */ + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} + +/** + * @class + * SqlVirtualMachines + * __NOTE__: An instance of this class is automatically created for an + * instance of the SqlVirtualMachineManagementClient. + */ +export interface SqlVirtualMachines { + + + /** + * Gets a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} [options] Optional Parameters. + * + * @param {string} [options.expand] The child resources to include in the + * response. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineName: string, options?: { expand? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} [options] Optional Parameters. + * + * @param {string} [options.expand] The child resources to include in the + * response. + * + * @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 {SqlVirtualMachine} - 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. + * + * {SqlVirtualMachine} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachine} 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. + */ + get(resourceGroupName: string, sqlVirtualMachineName: string, options?: { expand? : string, customHeaders? : { [headerName: string]: string; } }): Promise; + get(resourceGroupName: string, sqlVirtualMachineName: string, callback: ServiceCallback): void; + get(resourceGroupName: string, sqlVirtualMachineName: string, options: { expand? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.identity] Azure Active Directory identity of the + * server. + * + * @param {string} [parameters.identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure Active + * Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * + * @param {string} [parameters.virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * + * @param {string} [parameters.sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * + * @param {string} [parameters.sqlVirtualMachineGroupResourceId] ARM resource + * id of the SQL virtual machine group this SQL virtual machine is or will be + * part of. + * + * @param {object} [parameters.wsfcDomainCredentials] Domain credentials for + * setting up Windows Server Failover Cluster for SQL availability group. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterBootstrapAccountPassword] Cluster + * bootstrap account password. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterOperatorAccountPassword] Cluster + * operator account password. + * + * @param {string} [parameters.wsfcDomainCredentials.sqlServiceAccountPassword] + * SQL service account password. + * + * @param {object} [parameters.autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * + * @param {boolean} [parameters.autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * + * @param {string} [parameters.autoPatchingSettings.dayOfWeek] Day of week to + * apply the patch on. Possible values include: 'Monday', 'Tuesday', + * 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' + * + * @param {number} + * [parameters.autoPatchingSettings.maintenanceWindowStartingHour] Hour of the + * day when patching is initiated. Local VM time. + * + * @param {number} [parameters.autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * + * @param {object} [parameters.autoBackupSettings] Auto backup settings for SQL + * Server. + * + * @param {boolean} [parameters.autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * + * @param {boolean} [parameters.autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * + * @param {number} [parameters.autoBackupSettings.retentionPeriod] Retention + * period of backup: 1-30 days. + * + * @param {string} [parameters.autoBackupSettings.storageAccountUrl] Storage + * account url where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.storageAccessKey] Storage + * account key where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.password] Password for + * encryption on backup. + * + * @param {boolean} [parameters.autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * + * @param {string} [parameters.autoBackupSettings.backupScheduleType] Backup + * schedule type. Possible values include: 'Manual', 'Automated' + * + * @param {string} [parameters.autoBackupSettings.fullBackupFrequency] + * Frequency of full backups. In both cases, full backups begin during the next + * scheduled time window. Possible values include: 'Daily', 'Weekly' + * + * @param {number} [parameters.autoBackupSettings.fullBackupStartTime] Start + * time of a given day during which full backups can take place. 0-23 hours. + * + * @param {number} [parameters.autoBackupSettings.fullBackupWindowHours] + * Duration of the time window of a given day during which full backups can + * take place. 1-23 hours. + * + * @param {number} [parameters.autoBackupSettings.logBackupFrequency] Frequency + * of log backups. 5-60 minutes. + * + * @param {object} [parameters.keyVaultCredentialSettings] Key vault credential + * settings. + * + * @param {boolean} [parameters.keyVaultCredentialSettings.enable] Enable or + * disable key vault credential setting. + * + * @param {string} [parameters.keyVaultCredentialSettings.credentialName] + * Credential name. + * + * @param {string} [parameters.keyVaultCredentialSettings.azureKeyVaultUrl] + * Azure Key Vault url. + * + * @param {string} [parameters.keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * + * @param {string} + * [parameters.keyVaultCredentialSettings.servicePrincipalSecret] Service + * principal name secret to access key vault. + * + * @param {object} [parameters.serverConfigurationsManagementSettings] SQL + * Server configuration management settings. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] + * SQL connectivity type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] + * SQL workload type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings] + * SQL storage update settings. + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachine, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.identity] Azure Active Directory identity of the + * server. + * + * @param {string} [parameters.identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure Active + * Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * + * @param {string} [parameters.virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * + * @param {string} [parameters.sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * + * @param {string} [parameters.sqlVirtualMachineGroupResourceId] ARM resource + * id of the SQL virtual machine group this SQL virtual machine is or will be + * part of. + * + * @param {object} [parameters.wsfcDomainCredentials] Domain credentials for + * setting up Windows Server Failover Cluster for SQL availability group. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterBootstrapAccountPassword] Cluster + * bootstrap account password. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterOperatorAccountPassword] Cluster + * operator account password. + * + * @param {string} [parameters.wsfcDomainCredentials.sqlServiceAccountPassword] + * SQL service account password. + * + * @param {object} [parameters.autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * + * @param {boolean} [parameters.autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * + * @param {string} [parameters.autoPatchingSettings.dayOfWeek] Day of week to + * apply the patch on. Possible values include: 'Monday', 'Tuesday', + * 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' + * + * @param {number} + * [parameters.autoPatchingSettings.maintenanceWindowStartingHour] Hour of the + * day when patching is initiated. Local VM time. + * + * @param {number} [parameters.autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * + * @param {object} [parameters.autoBackupSettings] Auto backup settings for SQL + * Server. + * + * @param {boolean} [parameters.autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * + * @param {boolean} [parameters.autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * + * @param {number} [parameters.autoBackupSettings.retentionPeriod] Retention + * period of backup: 1-30 days. + * + * @param {string} [parameters.autoBackupSettings.storageAccountUrl] Storage + * account url where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.storageAccessKey] Storage + * account key where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.password] Password for + * encryption on backup. + * + * @param {boolean} [parameters.autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * + * @param {string} [parameters.autoBackupSettings.backupScheduleType] Backup + * schedule type. Possible values include: 'Manual', 'Automated' + * + * @param {string} [parameters.autoBackupSettings.fullBackupFrequency] + * Frequency of full backups. In both cases, full backups begin during the next + * scheduled time window. Possible values include: 'Daily', 'Weekly' + * + * @param {number} [parameters.autoBackupSettings.fullBackupStartTime] Start + * time of a given day during which full backups can take place. 0-23 hours. + * + * @param {number} [parameters.autoBackupSettings.fullBackupWindowHours] + * Duration of the time window of a given day during which full backups can + * take place. 1-23 hours. + * + * @param {number} [parameters.autoBackupSettings.logBackupFrequency] Frequency + * of log backups. 5-60 minutes. + * + * @param {object} [parameters.keyVaultCredentialSettings] Key vault credential + * settings. + * + * @param {boolean} [parameters.keyVaultCredentialSettings.enable] Enable or + * disable key vault credential setting. + * + * @param {string} [parameters.keyVaultCredentialSettings.credentialName] + * Credential name. + * + * @param {string} [parameters.keyVaultCredentialSettings.azureKeyVaultUrl] + * Azure Key Vault url. + * + * @param {string} [parameters.keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * + * @param {string} + * [parameters.keyVaultCredentialSettings.servicePrincipalSecret] Service + * principal name secret to access key vault. + * + * @param {object} [parameters.serverConfigurationsManagementSettings] SQL + * Server configuration management settings. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] + * SQL connectivity type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] + * SQL workload type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings] + * SQL storage update settings. + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachine} - 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. + * + * {SqlVirtualMachine} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachine} 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. + */ + createOrUpdate(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachine, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + createOrUpdate(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachine, callback: ServiceCallback): void; + createOrUpdate(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachine, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + deleteMethod(resourceGroupName: string, sqlVirtualMachineName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + deleteMethod(resourceGroupName: string, sqlVirtualMachineName: string, callback: ServiceCallback): void; + deleteMethod(resourceGroupName: string, sqlVirtualMachineName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachineUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachine} - 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. + * + * {SqlVirtualMachine} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachine} 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. + */ + update(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachineUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + update(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachineUpdate, callback: ServiceCallback): void; + update(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachineUpdate, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets all SQL virtual machines in a resource group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @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. + */ + listByResourceGroupWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all SQL virtual machines in a resource group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @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 {SqlVirtualMachineListResult} - 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. + * + * {SqlVirtualMachineListResult} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineListResult} 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. + */ + listByResourceGroup(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByResourceGroup(resourceGroupName: string, callback: ServiceCallback): void; + listByResourceGroup(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets all SQL virtual machines in a subscription. + * + * @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. + */ + listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all SQL virtual machines in a subscription. + * + * @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 {SqlVirtualMachineListResult} - 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. + * + * {SqlVirtualMachineListResult} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineListResult} 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. + */ + list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + list(callback: ServiceCallback): void; + list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Creates or updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.identity] Azure Active Directory identity of the + * server. + * + * @param {string} [parameters.identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure Active + * Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * + * @param {string} [parameters.virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * + * @param {string} [parameters.sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * + * @param {string} [parameters.sqlVirtualMachineGroupResourceId] ARM resource + * id of the SQL virtual machine group this SQL virtual machine is or will be + * part of. + * + * @param {object} [parameters.wsfcDomainCredentials] Domain credentials for + * setting up Windows Server Failover Cluster for SQL availability group. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterBootstrapAccountPassword] Cluster + * bootstrap account password. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterOperatorAccountPassword] Cluster + * operator account password. + * + * @param {string} [parameters.wsfcDomainCredentials.sqlServiceAccountPassword] + * SQL service account password. + * + * @param {object} [parameters.autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * + * @param {boolean} [parameters.autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * + * @param {string} [parameters.autoPatchingSettings.dayOfWeek] Day of week to + * apply the patch on. Possible values include: 'Monday', 'Tuesday', + * 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' + * + * @param {number} + * [parameters.autoPatchingSettings.maintenanceWindowStartingHour] Hour of the + * day when patching is initiated. Local VM time. + * + * @param {number} [parameters.autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * + * @param {object} [parameters.autoBackupSettings] Auto backup settings for SQL + * Server. + * + * @param {boolean} [parameters.autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * + * @param {boolean} [parameters.autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * + * @param {number} [parameters.autoBackupSettings.retentionPeriod] Retention + * period of backup: 1-30 days. + * + * @param {string} [parameters.autoBackupSettings.storageAccountUrl] Storage + * account url where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.storageAccessKey] Storage + * account key where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.password] Password for + * encryption on backup. + * + * @param {boolean} [parameters.autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * + * @param {string} [parameters.autoBackupSettings.backupScheduleType] Backup + * schedule type. Possible values include: 'Manual', 'Automated' + * + * @param {string} [parameters.autoBackupSettings.fullBackupFrequency] + * Frequency of full backups. In both cases, full backups begin during the next + * scheduled time window. Possible values include: 'Daily', 'Weekly' + * + * @param {number} [parameters.autoBackupSettings.fullBackupStartTime] Start + * time of a given day during which full backups can take place. 0-23 hours. + * + * @param {number} [parameters.autoBackupSettings.fullBackupWindowHours] + * Duration of the time window of a given day during which full backups can + * take place. 1-23 hours. + * + * @param {number} [parameters.autoBackupSettings.logBackupFrequency] Frequency + * of log backups. 5-60 minutes. + * + * @param {object} [parameters.keyVaultCredentialSettings] Key vault credential + * settings. + * + * @param {boolean} [parameters.keyVaultCredentialSettings.enable] Enable or + * disable key vault credential setting. + * + * @param {string} [parameters.keyVaultCredentialSettings.credentialName] + * Credential name. + * + * @param {string} [parameters.keyVaultCredentialSettings.azureKeyVaultUrl] + * Azure Key Vault url. + * + * @param {string} [parameters.keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * + * @param {string} + * [parameters.keyVaultCredentialSettings.servicePrincipalSecret] Service + * principal name secret to access key vault. + * + * @param {object} [parameters.serverConfigurationsManagementSettings] SQL + * Server configuration management settings. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] + * SQL connectivity type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] + * SQL workload type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings] + * SQL storage update settings. + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachine, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Creates or updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.identity] Azure Active Directory identity of the + * server. + * + * @param {string} [parameters.identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure Active + * Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * + * @param {string} [parameters.virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * + * @param {string} [parameters.sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * + * @param {string} [parameters.sqlVirtualMachineGroupResourceId] ARM resource + * id of the SQL virtual machine group this SQL virtual machine is or will be + * part of. + * + * @param {object} [parameters.wsfcDomainCredentials] Domain credentials for + * setting up Windows Server Failover Cluster for SQL availability group. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterBootstrapAccountPassword] Cluster + * bootstrap account password. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterOperatorAccountPassword] Cluster + * operator account password. + * + * @param {string} [parameters.wsfcDomainCredentials.sqlServiceAccountPassword] + * SQL service account password. + * + * @param {object} [parameters.autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * + * @param {boolean} [parameters.autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * + * @param {string} [parameters.autoPatchingSettings.dayOfWeek] Day of week to + * apply the patch on. Possible values include: 'Monday', 'Tuesday', + * 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' + * + * @param {number} + * [parameters.autoPatchingSettings.maintenanceWindowStartingHour] Hour of the + * day when patching is initiated. Local VM time. + * + * @param {number} [parameters.autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * + * @param {object} [parameters.autoBackupSettings] Auto backup settings for SQL + * Server. + * + * @param {boolean} [parameters.autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * + * @param {boolean} [parameters.autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * + * @param {number} [parameters.autoBackupSettings.retentionPeriod] Retention + * period of backup: 1-30 days. + * + * @param {string} [parameters.autoBackupSettings.storageAccountUrl] Storage + * account url where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.storageAccessKey] Storage + * account key where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.password] Password for + * encryption on backup. + * + * @param {boolean} [parameters.autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * + * @param {string} [parameters.autoBackupSettings.backupScheduleType] Backup + * schedule type. Possible values include: 'Manual', 'Automated' + * + * @param {string} [parameters.autoBackupSettings.fullBackupFrequency] + * Frequency of full backups. In both cases, full backups begin during the next + * scheduled time window. Possible values include: 'Daily', 'Weekly' + * + * @param {number} [parameters.autoBackupSettings.fullBackupStartTime] Start + * time of a given day during which full backups can take place. 0-23 hours. + * + * @param {number} [parameters.autoBackupSettings.fullBackupWindowHours] + * Duration of the time window of a given day during which full backups can + * take place. 1-23 hours. + * + * @param {number} [parameters.autoBackupSettings.logBackupFrequency] Frequency + * of log backups. 5-60 minutes. + * + * @param {object} [parameters.keyVaultCredentialSettings] Key vault credential + * settings. + * + * @param {boolean} [parameters.keyVaultCredentialSettings.enable] Enable or + * disable key vault credential setting. + * + * @param {string} [parameters.keyVaultCredentialSettings.credentialName] + * Credential name. + * + * @param {string} [parameters.keyVaultCredentialSettings.azureKeyVaultUrl] + * Azure Key Vault url. + * + * @param {string} [parameters.keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * + * @param {string} + * [parameters.keyVaultCredentialSettings.servicePrincipalSecret] Service + * principal name secret to access key vault. + * + * @param {object} [parameters.serverConfigurationsManagementSettings] SQL + * Server configuration management settings. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] + * SQL connectivity type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] + * SQL workload type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings] + * SQL storage update settings. + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachine} - 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. + * + * {SqlVirtualMachine} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachine} 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. + */ + beginCreateOrUpdate(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachine, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginCreateOrUpdate(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachine, callback: ServiceCallback): void; + beginCreateOrUpdate(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachine, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Deletes a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Deletes a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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. + */ + beginDeleteMethod(resourceGroupName: string, sqlVirtualMachineName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginDeleteMethod(resourceGroupName: string, sqlVirtualMachineName: string, callback: ServiceCallback): void; + beginDeleteMethod(resourceGroupName: string, sqlVirtualMachineName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + beginUpdateWithHttpOperationResponse(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachineUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachine} - 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. + * + * {SqlVirtualMachine} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachine} 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. + */ + beginUpdate(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachineUpdate, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + beginUpdate(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachineUpdate, callback: ServiceCallback): void; + beginUpdate(resourceGroupName: string, sqlVirtualMachineName: string, parameters: models.SqlVirtualMachineUpdate, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets all SQL virtual machines in a resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listByResourceGroupNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all SQL virtual machines in a resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {SqlVirtualMachineListResult} - 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. + * + * {SqlVirtualMachineListResult} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineListResult} 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. + */ + listByResourceGroupNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback): void; + listByResourceGroupNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; + + + /** + * Gets all SQL virtual machines in a subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; + + /** + * Gets all SQL virtual machines in a subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {SqlVirtualMachineListResult} - 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. + * + * {SqlVirtualMachineListResult} [result] - The deserialized result object if an error did not occur. + * See {@link SqlVirtualMachineListResult} 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. + */ + listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; + listNext(nextPageLink: string, callback: ServiceCallback): void; + listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; +} diff --git a/lib/services/sqlvirtualmachineManagement/lib/operations/index.js b/lib/services/sqlvirtualmachineManagement/lib/operations/index.js new file mode 100644 index 0000000000..77f5ae862d --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/operations/index.js @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/* jshint latedef:false */ +/* jshint forin:false */ +/* jshint noempty:false */ + +'use strict'; + +exports.AvailabilityGroupListeners = require('./availabilityGroupListeners'); +exports.Operations = require('./operations'); +exports.SqlVirtualMachineGroups = require('./sqlVirtualMachineGroups'); +exports.SqlVirtualMachines = require('./sqlVirtualMachines'); diff --git a/lib/services/sqlvirtualmachineManagement/lib/operations/operations.js b/lib/services/sqlvirtualmachineManagement/lib/operations/operations.js new file mode 100644 index 0000000000..188df77128 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/operations/operations.js @@ -0,0 +1,449 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * Lists all of the available SQL Rest API operations. + * + * @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 OperationListResult} 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 _list(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.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 (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('/') ? '' : '/') + 'providers/Microsoft.SqlVirtualMachine/operations'; + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['OperationListResult']().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 all of the available SQL Rest API operations. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 OperationListResult} 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 _listNext(nextPageLink, 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 (nextPageLink === null || nextPageLink === undefined || typeof nextPageLink.valueOf() !== 'string') { + throw new Error('nextPageLink cannot be null or undefined and it must be of type string.'); + } + 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 requestUrl = '{nextLink}'; + requestUrl = requestUrl.replace('{nextLink}', nextPageLink); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['OperationListResult']().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); + }); +} + +/** Class representing a Operations. */ +class Operations { + /** + * Create a Operations. + * @param {SqlVirtualMachineManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._list = _list; + this._listNext = _listNext; + } + + /** + * Lists all of the available SQL Rest API operations. + * + * @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. + */ + listWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists all of the available SQL Rest API operations. + * + * @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 {OperationListResult} - 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 OperationListResult} 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. + */ + list(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._list(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(options, optionalCallback); + } + } + + /** + * Lists all of the available SQL Rest API operations. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listNext(nextPageLink, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Lists all of the available SQL Rest API operations. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {OperationListResult} - 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 OperationListResult} 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. + */ + listNext(nextPageLink, 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._listNext(nextPageLink, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listNext(nextPageLink, options, optionalCallback); + } + } + +} + +module.exports = Operations; diff --git a/lib/services/sqlvirtualmachineManagement/lib/operations/sqlVirtualMachineGroups.js b/lib/services/sqlvirtualmachineManagement/lib/operations/sqlVirtualMachineGroups.js new file mode 100644 index 0000000000..8b6373bd46 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/operations/sqlVirtualMachineGroups.js @@ -0,0 +1,2689 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * Gets a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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 SqlVirtualMachineGroup} 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 _get(resourceGroupName, sqlVirtualMachineGroupName, 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 (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 (sqlVirtualMachineGroupName === null || sqlVirtualMachineGroupName === undefined || typeof sqlVirtualMachineGroupName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineGroupName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineGroupName}', encodeURIComponent(sqlVirtualMachineGroupName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SqlVirtualMachineGroup']().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); + }); +} + + +/** + * Creates or updates a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {string} [parameters.sqlImageOffer] SQL image offer. Examples may + * include SQL2016-WS2016, SQL2017-WS2016. + * + * @param {string} [parameters.sqlImageSku] SQL image sku. Possible values + * include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * + * @param {object} [parameters.wsfcDomainProfile] Cluster Active Directory + * domain profile. + * + * @param {string} [parameters.wsfcDomainProfile.domainFqdn] Fully qualified + * name of the domain. + * + * @param {string} [parameters.wsfcDomainProfile.ouPath] Organizational Unit + * path in which the nodes and cluster will be present. + * + * @param {string} [parameters.wsfcDomainProfile.clusterBootstrapAccount] + * Account name used for creating cluster (at minimum needs permissions to + * 'Create Computer Objects' in domain). + * + * @param {string} [parameters.wsfcDomainProfile.clusterOperatorAccount] + * Account name used for operating cluster i.e. will be part of administrators + * group on all the participating virtual machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.sqlServiceAccount] Account + * name under which SQL service will run on all participating SQL virtual + * machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.fileShareWitnessPath] Optional + * path for fileshare witness. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountUrl] Fully + * qualified ARM resource id of the witness storage account. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountPrimaryKey] + * Primary key of the witness storage account. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 SqlVirtualMachineGroup} 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 _createOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, 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.'); + } + + // Send request + this.beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['SqlVirtualMachineGroup']().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); + }); + }); +} + + +/** + * Deletes a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _deleteMethod(resourceGroupName, sqlVirtualMachineGroupName, 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.'); + } + + // Send request + this.beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + + return callback(null, result, httpRequest, response); + }); + }); +} + + +/** + * Updates SQL virtual machine group tags. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 SqlVirtualMachineGroup} 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 _update(resourceGroupName, sqlVirtualMachineGroupName, parameters, 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.'); + } + + // Send request + this.beginUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['SqlVirtualMachineGroup']().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); + }); + }); +} + +/** + * Gets all SQL virtual machine groups in a resource group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @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 SqlVirtualMachineGroupListResult} 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 _listByResourceGroup(resourceGroupName, 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 (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 (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 (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 (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.SqlVirtualMachine/sqlVirtualMachineGroups'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SqlVirtualMachineGroupListResult']().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); + }); +} + +/** + * Gets all SQL virtual machine groups in a subscription. + * + * @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 SqlVirtualMachineGroupListResult} 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 _list(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 (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 (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}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SqlVirtualMachineGroupListResult']().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); + }); +} + +/** + * Creates or updates a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {string} [parameters.sqlImageOffer] SQL image offer. Examples may + * include SQL2016-WS2016, SQL2017-WS2016. + * + * @param {string} [parameters.sqlImageSku] SQL image sku. Possible values + * include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * + * @param {object} [parameters.wsfcDomainProfile] Cluster Active Directory + * domain profile. + * + * @param {string} [parameters.wsfcDomainProfile.domainFqdn] Fully qualified + * name of the domain. + * + * @param {string} [parameters.wsfcDomainProfile.ouPath] Organizational Unit + * path in which the nodes and cluster will be present. + * + * @param {string} [parameters.wsfcDomainProfile.clusterBootstrapAccount] + * Account name used for creating cluster (at minimum needs permissions to + * 'Create Computer Objects' in domain). + * + * @param {string} [parameters.wsfcDomainProfile.clusterOperatorAccount] + * Account name used for operating cluster i.e. will be part of administrators + * group on all the participating virtual machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.sqlServiceAccount] Account + * name under which SQL service will run on all participating SQL virtual + * machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.fileShareWitnessPath] Optional + * path for fileshare witness. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountUrl] Fully + * qualified ARM resource id of the witness storage account. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountPrimaryKey] + * Primary key of the witness storage account. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 SqlVirtualMachineGroup} 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 _beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, 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 (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 (sqlVirtualMachineGroupName === null || sqlVirtualMachineGroupName === undefined || typeof sqlVirtualMachineGroupName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineGroupName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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 (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.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineGroupName}', encodeURIComponent(sqlVirtualMachineGroupName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'PUT'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['SqlVirtualMachineGroup']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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 && statusCode !== 201) { + 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['SqlVirtualMachineGroup']().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); + } + } + // Deserialize Response + if (statusCode === 201) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['SqlVirtualMachineGroup']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError1.request = msRest.stripRequest(httpRequest); + deserializationError1.response = msRest.stripResponse(response); + return callback(deserializationError1); + } + } + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Deletes a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, 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 (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 (sqlVirtualMachineGroupName === null || sqlVirtualMachineGroupName === undefined || typeof sqlVirtualMachineGroupName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineGroupName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineGroupName}', encodeURIComponent(sqlVirtualMachineGroupName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'DELETE'; + 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]; + } + } + } + httpRequest.body = null; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 200 && statusCode !== 202 && statusCode !== 204) { + 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; + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Updates SQL virtual machine group tags. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 SqlVirtualMachineGroup} 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 _beginUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, 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 (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 (sqlVirtualMachineGroupName === null || sqlVirtualMachineGroupName === undefined || typeof sqlVirtualMachineGroupName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineGroupName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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 (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.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineGroupName}', encodeURIComponent(sqlVirtualMachineGroupName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'PATCH'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['SqlVirtualMachineGroupUpdate']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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['SqlVirtualMachineGroup']().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); + }); +} + +/** + * Gets all SQL virtual machine groups in a resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 SqlVirtualMachineGroupListResult} 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 _listByResourceGroupNext(nextPageLink, 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 (nextPageLink === null || nextPageLink === undefined || typeof nextPageLink.valueOf() !== 'string') { + throw new Error('nextPageLink cannot be null or undefined and it must be of type string.'); + } + 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 requestUrl = '{nextLink}'; + requestUrl = requestUrl.replace('{nextLink}', nextPageLink); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SqlVirtualMachineGroupListResult']().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); + }); +} + +/** + * Gets all SQL virtual machine groups in a subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 SqlVirtualMachineGroupListResult} 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 _listNext(nextPageLink, 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 (nextPageLink === null || nextPageLink === undefined || typeof nextPageLink.valueOf() !== 'string') { + throw new Error('nextPageLink cannot be null or undefined and it must be of type string.'); + } + 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 requestUrl = '{nextLink}'; + requestUrl = requestUrl.replace('{nextLink}', nextPageLink); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SqlVirtualMachineGroupListResult']().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); + }); +} + +/** Class representing a SqlVirtualMachineGroups. */ +class SqlVirtualMachineGroups { + /** + * Create a SqlVirtualMachineGroups. + * @param {SqlVirtualMachineManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._get = _get; + this._createOrUpdate = _createOrUpdate; + this._deleteMethod = _deleteMethod; + this._update = _update; + this._listByResourceGroup = _listByResourceGroup; + this._list = _list; + this._beginCreateOrUpdate = _beginCreateOrUpdate; + this._beginDeleteMethod = _beginDeleteMethod; + this._beginUpdate = _beginUpdate; + this._listByResourceGroupNext = _listByResourceGroupNext; + this._listNext = _listNext; + } + + /** + * Gets a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._get(resourceGroupName, sqlVirtualMachineGroupName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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 {SqlVirtualMachineGroup} - 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 SqlVirtualMachineGroup} 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. + */ + get(resourceGroupName, sqlVirtualMachineGroupName, 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._get(resourceGroupName, sqlVirtualMachineGroupName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._get(resourceGroupName, sqlVirtualMachineGroupName, options, optionalCallback); + } + } + + /** + * Creates or updates a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {string} [parameters.sqlImageOffer] SQL image offer. Examples may + * include SQL2016-WS2016, SQL2017-WS2016. + * + * @param {string} [parameters.sqlImageSku] SQL image sku. Possible values + * include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * + * @param {object} [parameters.wsfcDomainProfile] Cluster Active Directory + * domain profile. + * + * @param {string} [parameters.wsfcDomainProfile.domainFqdn] Fully qualified + * name of the domain. + * + * @param {string} [parameters.wsfcDomainProfile.ouPath] Organizational Unit + * path in which the nodes and cluster will be present. + * + * @param {string} [parameters.wsfcDomainProfile.clusterBootstrapAccount] + * Account name used for creating cluster (at minimum needs permissions to + * 'Create Computer Objects' in domain). + * + * @param {string} [parameters.wsfcDomainProfile.clusterOperatorAccount] + * Account name used for operating cluster i.e. will be part of administrators + * group on all the participating virtual machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.sqlServiceAccount] Account + * name under which SQL service will run on all participating SQL virtual + * machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.fileShareWitnessPath] Optional + * path for fileshare witness. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountUrl] Fully + * qualified ARM resource id of the witness storage account. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountPrimaryKey] + * Primary key of the witness storage account. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._createOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Creates or updates a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {string} [parameters.sqlImageOffer] SQL image offer. Examples may + * include SQL2016-WS2016, SQL2017-WS2016. + * + * @param {string} [parameters.sqlImageSku] SQL image sku. Possible values + * include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * + * @param {object} [parameters.wsfcDomainProfile] Cluster Active Directory + * domain profile. + * + * @param {string} [parameters.wsfcDomainProfile.domainFqdn] Fully qualified + * name of the domain. + * + * @param {string} [parameters.wsfcDomainProfile.ouPath] Organizational Unit + * path in which the nodes and cluster will be present. + * + * @param {string} [parameters.wsfcDomainProfile.clusterBootstrapAccount] + * Account name used for creating cluster (at minimum needs permissions to + * 'Create Computer Objects' in domain). + * + * @param {string} [parameters.wsfcDomainProfile.clusterOperatorAccount] + * Account name used for operating cluster i.e. will be part of administrators + * group on all the participating virtual machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.sqlServiceAccount] Account + * name under which SQL service will run on all participating SQL virtual + * machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.fileShareWitnessPath] Optional + * path for fileshare witness. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountUrl] Fully + * qualified ARM resource id of the witness storage account. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountPrimaryKey] + * Primary key of the witness storage account. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachineGroup} - 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 SqlVirtualMachineGroup} 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. + */ + createOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, 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._createOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._createOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, optionalCallback); + } + } + + /** + * Deletes a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._deleteMethod(resourceGroupName, sqlVirtualMachineGroupName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Deletes a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + deleteMethod(resourceGroupName, sqlVirtualMachineGroupName, 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._deleteMethod(resourceGroupName, sqlVirtualMachineGroupName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._deleteMethod(resourceGroupName, sqlVirtualMachineGroupName, options, optionalCallback); + } + } + + /** + * Updates SQL virtual machine group tags. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._update(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Updates SQL virtual machine group tags. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachineGroup} - 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 SqlVirtualMachineGroup} 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. + */ + update(resourceGroupName, sqlVirtualMachineGroupName, parameters, 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._update(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._update(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, optionalCallback); + } + } + + /** + * Gets all SQL virtual machine groups in a resource group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @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. + */ + listByResourceGroupWithHttpOperationResponse(resourceGroupName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listByResourceGroup(resourceGroupName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets all SQL virtual machine groups in a resource group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @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 {SqlVirtualMachineGroupListResult} - 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 SqlVirtualMachineGroupListResult} 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. + */ + listByResourceGroup(resourceGroupName, 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._listByResourceGroup(resourceGroupName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listByResourceGroup(resourceGroupName, options, optionalCallback); + } + } + + /** + * Gets all SQL virtual machine groups in a subscription. + * + * @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. + */ + listWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets all SQL virtual machine groups in a subscription. + * + * @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 {SqlVirtualMachineGroupListResult} - 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 SqlVirtualMachineGroupListResult} 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. + */ + list(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._list(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(options, optionalCallback); + } + } + + /** + * Creates or updates a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {string} [parameters.sqlImageOffer] SQL image offer. Examples may + * include SQL2016-WS2016, SQL2017-WS2016. + * + * @param {string} [parameters.sqlImageSku] SQL image sku. Possible values + * include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * + * @param {object} [parameters.wsfcDomainProfile] Cluster Active Directory + * domain profile. + * + * @param {string} [parameters.wsfcDomainProfile.domainFqdn] Fully qualified + * name of the domain. + * + * @param {string} [parameters.wsfcDomainProfile.ouPath] Organizational Unit + * path in which the nodes and cluster will be present. + * + * @param {string} [parameters.wsfcDomainProfile.clusterBootstrapAccount] + * Account name used for creating cluster (at minimum needs permissions to + * 'Create Computer Objects' in domain). + * + * @param {string} [parameters.wsfcDomainProfile.clusterOperatorAccount] + * Account name used for operating cluster i.e. will be part of administrators + * group on all the participating virtual machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.sqlServiceAccount] Account + * name under which SQL service will run on all participating SQL virtual + * machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.fileShareWitnessPath] Optional + * path for fileshare witness. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountUrl] Fully + * qualified ARM resource id of the witness storage account. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountPrimaryKey] + * Primary key of the witness storage account. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Creates or updates a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {string} [parameters.sqlImageOffer] SQL image offer. Examples may + * include SQL2016-WS2016, SQL2017-WS2016. + * + * @param {string} [parameters.sqlImageSku] SQL image sku. Possible values + * include: 'Developer', 'Express', 'Standard', 'Enterprise', 'Web' + * + * @param {object} [parameters.wsfcDomainProfile] Cluster Active Directory + * domain profile. + * + * @param {string} [parameters.wsfcDomainProfile.domainFqdn] Fully qualified + * name of the domain. + * + * @param {string} [parameters.wsfcDomainProfile.ouPath] Organizational Unit + * path in which the nodes and cluster will be present. + * + * @param {string} [parameters.wsfcDomainProfile.clusterBootstrapAccount] + * Account name used for creating cluster (at minimum needs permissions to + * 'Create Computer Objects' in domain). + * + * @param {string} [parameters.wsfcDomainProfile.clusterOperatorAccount] + * Account name used for operating cluster i.e. will be part of administrators + * group on all the participating virtual machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.sqlServiceAccount] Account + * name under which SQL service will run on all participating SQL virtual + * machines in the cluster. + * + * @param {string} [parameters.wsfcDomainProfile.fileShareWitnessPath] Optional + * path for fileshare witness. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountUrl] Fully + * qualified ARM resource id of the witness storage account. + * + * @param {string} [parameters.wsfcDomainProfile.storageAccountPrimaryKey] + * Primary key of the witness storage account. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachineGroup} - 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 SqlVirtualMachineGroup} 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. + */ + beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, 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._beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, optionalCallback); + } + } + + /** + * Deletes a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Deletes a SQL virtual machine group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, 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._beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginDeleteMethod(resourceGroupName, sqlVirtualMachineGroupName, options, optionalCallback); + } + } + + /** + * Updates SQL virtual machine group tags. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + beginUpdateWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineGroupName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Updates SQL virtual machine group tags. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineGroupName Name of the SQL virtual machine + * group. + * + * @param {object} parameters The SQL virtual machine group. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachineGroup} - 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 SqlVirtualMachineGroup} 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. + */ + beginUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, 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._beginUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginUpdate(resourceGroupName, sqlVirtualMachineGroupName, parameters, options, optionalCallback); + } + } + + /** + * Gets all SQL virtual machine groups in a resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listByResourceGroupNextWithHttpOperationResponse(nextPageLink, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listByResourceGroupNext(nextPageLink, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets all SQL virtual machine groups in a resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {SqlVirtualMachineGroupListResult} - 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 SqlVirtualMachineGroupListResult} 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. + */ + listByResourceGroupNext(nextPageLink, 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._listByResourceGroupNext(nextPageLink, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listByResourceGroupNext(nextPageLink, options, optionalCallback); + } + } + + /** + * Gets all SQL virtual machine groups in a subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listNext(nextPageLink, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets all SQL virtual machine groups in a subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {SqlVirtualMachineGroupListResult} - 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 SqlVirtualMachineGroupListResult} 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. + */ + listNext(nextPageLink, 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._listNext(nextPageLink, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listNext(nextPageLink, options, optionalCallback); + } + } + +} + +module.exports = SqlVirtualMachineGroups; diff --git a/lib/services/sqlvirtualmachineManagement/lib/operations/sqlVirtualMachines.js b/lib/services/sqlvirtualmachineManagement/lib/operations/sqlVirtualMachines.js new file mode 100644 index 0000000000..c0fa19a9e3 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/operations/sqlVirtualMachines.js @@ -0,0 +1,3454 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const WebResource = msRest.WebResource; + +/** + * Gets a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} [options] Optional Parameters. + * + * @param {string} [options.expand] The child resources to include in the + * response. + * + * @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 SqlVirtualMachine} 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 _get(resourceGroupName, sqlVirtualMachineName, 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.'); + } + let expand = (options && options.expand !== undefined) ? options.expand : undefined; + // Validate + try { + 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 (sqlVirtualMachineName === null || sqlVirtualMachineName === undefined || typeof sqlVirtualMachineName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineName cannot be null or undefined and it must be of type string.'); + } + if (expand !== null && expand !== undefined && typeof expand.valueOf() !== 'string') { + throw new Error('expand must be of type string.'); + } + 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 (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 (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.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineName}', encodeURIComponent(sqlVirtualMachineName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + let queryParameters = []; + if (expand !== null && expand !== undefined) { + queryParameters.push('$expand=' + encodeURIComponent(expand)); + } + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SqlVirtualMachine']().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); + }); +} + + +/** + * Creates or updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.identity] Azure Active Directory identity of the + * server. + * + * @param {string} [parameters.identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure Active + * Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * + * @param {string} [parameters.virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * + * @param {string} [parameters.sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * + * @param {string} [parameters.sqlVirtualMachineGroupResourceId] ARM resource + * id of the SQL virtual machine group this SQL virtual machine is or will be + * part of. + * + * @param {object} [parameters.wsfcDomainCredentials] Domain credentials for + * setting up Windows Server Failover Cluster for SQL availability group. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterBootstrapAccountPassword] Cluster + * bootstrap account password. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterOperatorAccountPassword] Cluster + * operator account password. + * + * @param {string} [parameters.wsfcDomainCredentials.sqlServiceAccountPassword] + * SQL service account password. + * + * @param {object} [parameters.autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * + * @param {boolean} [parameters.autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * + * @param {string} [parameters.autoPatchingSettings.dayOfWeek] Day of week to + * apply the patch on. Possible values include: 'Monday', 'Tuesday', + * 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' + * + * @param {number} + * [parameters.autoPatchingSettings.maintenanceWindowStartingHour] Hour of the + * day when patching is initiated. Local VM time. + * + * @param {number} [parameters.autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * + * @param {object} [parameters.autoBackupSettings] Auto backup settings for SQL + * Server. + * + * @param {boolean} [parameters.autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * + * @param {boolean} [parameters.autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * + * @param {number} [parameters.autoBackupSettings.retentionPeriod] Retention + * period of backup: 1-30 days. + * + * @param {string} [parameters.autoBackupSettings.storageAccountUrl] Storage + * account url where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.storageAccessKey] Storage + * account key where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.password] Password for + * encryption on backup. + * + * @param {boolean} [parameters.autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * + * @param {string} [parameters.autoBackupSettings.backupScheduleType] Backup + * schedule type. Possible values include: 'Manual', 'Automated' + * + * @param {string} [parameters.autoBackupSettings.fullBackupFrequency] + * Frequency of full backups. In both cases, full backups begin during the next + * scheduled time window. Possible values include: 'Daily', 'Weekly' + * + * @param {number} [parameters.autoBackupSettings.fullBackupStartTime] Start + * time of a given day during which full backups can take place. 0-23 hours. + * + * @param {number} [parameters.autoBackupSettings.fullBackupWindowHours] + * Duration of the time window of a given day during which full backups can + * take place. 1-23 hours. + * + * @param {number} [parameters.autoBackupSettings.logBackupFrequency] Frequency + * of log backups. 5-60 minutes. + * + * @param {object} [parameters.keyVaultCredentialSettings] Key vault credential + * settings. + * + * @param {boolean} [parameters.keyVaultCredentialSettings.enable] Enable or + * disable key vault credential setting. + * + * @param {string} [parameters.keyVaultCredentialSettings.credentialName] + * Credential name. + * + * @param {string} [parameters.keyVaultCredentialSettings.azureKeyVaultUrl] + * Azure Key Vault url. + * + * @param {string} [parameters.keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * + * @param {string} + * [parameters.keyVaultCredentialSettings.servicePrincipalSecret] Service + * principal name secret to access key vault. + * + * @param {object} [parameters.serverConfigurationsManagementSettings] SQL + * Server configuration management settings. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] + * SQL connectivity type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] + * SQL workload type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings] + * SQL storage update settings. + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 SqlVirtualMachine} 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 _createOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, 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.'); + } + + // Send request + this.beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['SqlVirtualMachine']().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); + }); + }); +} + + +/** + * Deletes a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _deleteMethod(resourceGroupName, sqlVirtualMachineName, 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.'); + } + + // Send request + this.beginDeleteMethod(resourceGroupName, sqlVirtualMachineName, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + + return callback(null, result, httpRequest, response); + }); + }); +} + + +/** + * Updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 SqlVirtualMachine} 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 _update(resourceGroupName, sqlVirtualMachineName, parameters, 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.'); + } + + // Send request + this.beginUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, (err, parsedResult, httpRequest, response) => { + if (err) return callback(err); + + let initialResult = new msRest.HttpOperationResponse(); + initialResult.request = httpRequest; + initialResult.response = response; + initialResult.body = response.body; + client.getLongRunningOperationResult(initialResult, options, (err, pollingResult) => { + if (err) return callback(err); + + // Create Result + let result = null; + + httpRequest = pollingResult.request; + response = pollingResult.response; + let responseBody = pollingResult.body; + if (responseBody === '') responseBody = null; + + // Deserialize Response + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['SqlVirtualMachine']().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); + }); + }); +} + +/** + * Gets all SQL virtual machines in a resource group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @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 SqlVirtualMachineListResult} 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 _listByResourceGroup(resourceGroupName, 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 (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 (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 (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 (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.SqlVirtualMachine/sqlVirtualMachines'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SqlVirtualMachineListResult']().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); + }); +} + +/** + * Gets all SQL virtual machines in a subscription. + * + * @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 SqlVirtualMachineListResult} 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 _list(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 (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 (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}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines'; + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SqlVirtualMachineListResult']().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); + }); +} + +/** + * Creates or updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.identity] Azure Active Directory identity of the + * server. + * + * @param {string} [parameters.identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure Active + * Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * + * @param {string} [parameters.virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * + * @param {string} [parameters.sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * + * @param {string} [parameters.sqlVirtualMachineGroupResourceId] ARM resource + * id of the SQL virtual machine group this SQL virtual machine is or will be + * part of. + * + * @param {object} [parameters.wsfcDomainCredentials] Domain credentials for + * setting up Windows Server Failover Cluster for SQL availability group. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterBootstrapAccountPassword] Cluster + * bootstrap account password. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterOperatorAccountPassword] Cluster + * operator account password. + * + * @param {string} [parameters.wsfcDomainCredentials.sqlServiceAccountPassword] + * SQL service account password. + * + * @param {object} [parameters.autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * + * @param {boolean} [parameters.autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * + * @param {string} [parameters.autoPatchingSettings.dayOfWeek] Day of week to + * apply the patch on. Possible values include: 'Monday', 'Tuesday', + * 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' + * + * @param {number} + * [parameters.autoPatchingSettings.maintenanceWindowStartingHour] Hour of the + * day when patching is initiated. Local VM time. + * + * @param {number} [parameters.autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * + * @param {object} [parameters.autoBackupSettings] Auto backup settings for SQL + * Server. + * + * @param {boolean} [parameters.autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * + * @param {boolean} [parameters.autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * + * @param {number} [parameters.autoBackupSettings.retentionPeriod] Retention + * period of backup: 1-30 days. + * + * @param {string} [parameters.autoBackupSettings.storageAccountUrl] Storage + * account url where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.storageAccessKey] Storage + * account key where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.password] Password for + * encryption on backup. + * + * @param {boolean} [parameters.autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * + * @param {string} [parameters.autoBackupSettings.backupScheduleType] Backup + * schedule type. Possible values include: 'Manual', 'Automated' + * + * @param {string} [parameters.autoBackupSettings.fullBackupFrequency] + * Frequency of full backups. In both cases, full backups begin during the next + * scheduled time window. Possible values include: 'Daily', 'Weekly' + * + * @param {number} [parameters.autoBackupSettings.fullBackupStartTime] Start + * time of a given day during which full backups can take place. 0-23 hours. + * + * @param {number} [parameters.autoBackupSettings.fullBackupWindowHours] + * Duration of the time window of a given day during which full backups can + * take place. 1-23 hours. + * + * @param {number} [parameters.autoBackupSettings.logBackupFrequency] Frequency + * of log backups. 5-60 minutes. + * + * @param {object} [parameters.keyVaultCredentialSettings] Key vault credential + * settings. + * + * @param {boolean} [parameters.keyVaultCredentialSettings.enable] Enable or + * disable key vault credential setting. + * + * @param {string} [parameters.keyVaultCredentialSettings.credentialName] + * Credential name. + * + * @param {string} [parameters.keyVaultCredentialSettings.azureKeyVaultUrl] + * Azure Key Vault url. + * + * @param {string} [parameters.keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * + * @param {string} + * [parameters.keyVaultCredentialSettings.servicePrincipalSecret] Service + * principal name secret to access key vault. + * + * @param {object} [parameters.serverConfigurationsManagementSettings] SQL + * Server configuration management settings. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] + * SQL connectivity type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] + * SQL workload type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings] + * SQL storage update settings. + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 SqlVirtualMachine} 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 _beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, 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 (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 (sqlVirtualMachineName === null || sqlVirtualMachineName === undefined || typeof sqlVirtualMachineName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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 (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.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineName}', encodeURIComponent(sqlVirtualMachineName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'PUT'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['SqlVirtualMachine']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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 && statusCode !== 201) { + 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['SqlVirtualMachine']().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); + } + } + // Deserialize Response + if (statusCode === 201) { + let parsedResponse = null; + try { + parsedResponse = JSON.parse(responseBody); + result = JSON.parse(responseBody); + if (parsedResponse !== null && parsedResponse !== undefined) { + let resultMapper = new client.models['SqlVirtualMachine']().mapper(); + result = client.deserialize(resultMapper, parsedResponse, 'result'); + } + } catch (error) { + let deserializationError1 = new Error(`Error ${error} occurred in deserializing the responseBody - ${responseBody}`); + deserializationError1.request = msRest.stripRequest(httpRequest); + deserializationError1.response = msRest.stripResponse(response); + return callback(deserializationError1); + } + } + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Deletes a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {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 _beginDeleteMethod(resourceGroupName, sqlVirtualMachineName, 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 (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 (sqlVirtualMachineName === null || sqlVirtualMachineName === undefined || typeof sqlVirtualMachineName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineName cannot be null or undefined and it must be of type string.'); + } + 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 (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 (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.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineName}', encodeURIComponent(sqlVirtualMachineName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'DELETE'; + 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]; + } + } + } + httpRequest.body = null; + // Send Request + return client.pipeline(httpRequest, (err, response, responseBody) => { + if (err) { + return callback(err); + } + let statusCode = response.statusCode; + if (statusCode !== 200 && statusCode !== 202 && statusCode !== 204) { + 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; + + return callback(null, result, httpRequest, response); + }); +} + +/** + * Updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 SqlVirtualMachine} 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 _beginUpdate(resourceGroupName, sqlVirtualMachineName, parameters, 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 (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 (sqlVirtualMachineName === null || sqlVirtualMachineName === undefined || typeof sqlVirtualMachineName.valueOf() !== 'string') { + throw new Error('sqlVirtualMachineName cannot be null or undefined and it must be of type string.'); + } + if (parameters === null || parameters === undefined) { + throw new Error('parameters cannot be null or undefined.'); + } + 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 (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 (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.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}'; + requestUrl = requestUrl.replace('{resourceGroupName}', encodeURIComponent(resourceGroupName)); + requestUrl = requestUrl.replace('{sqlVirtualMachineName}', encodeURIComponent(sqlVirtualMachineName)); + requestUrl = requestUrl.replace('{subscriptionId}', encodeURIComponent(this.client.subscriptionId)); + 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 = 'PATCH'; + 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 (parameters !== null && parameters !== undefined) { + let requestModelMapper = new client.models['SqlVirtualMachineUpdate']().mapper(); + requestModel = client.serialize(requestModelMapper, parameters, 'parameters'); + requestContent = JSON.stringify(requestModel); + } + } catch (error) { + let serializationError = new Error(`Error "${error.message}" occurred in serializing the ` + + `payload - ${JSON.stringify(parameters, 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['SqlVirtualMachine']().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); + }); +} + +/** + * Gets all SQL virtual machines in a resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 SqlVirtualMachineListResult} 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 _listByResourceGroupNext(nextPageLink, 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 (nextPageLink === null || nextPageLink === undefined || typeof nextPageLink.valueOf() !== 'string') { + throw new Error('nextPageLink cannot be null or undefined and it must be of type string.'); + } + 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 requestUrl = '{nextLink}'; + requestUrl = requestUrl.replace('{nextLink}', nextPageLink); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SqlVirtualMachineListResult']().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); + }); +} + +/** + * Gets all SQL virtual machines in a subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 SqlVirtualMachineListResult} 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 _listNext(nextPageLink, 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 (nextPageLink === null || nextPageLink === undefined || typeof nextPageLink.valueOf() !== 'string') { + throw new Error('nextPageLink cannot be null or undefined and it must be of type string.'); + } + 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 requestUrl = '{nextLink}'; + requestUrl = requestUrl.replace('{nextLink}', nextPageLink); + + // Create HTTP transport objects + let httpRequest = new WebResource(); + httpRequest.method = 'GET'; + 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]; + } + } + } + httpRequest.body = null; + // 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['SqlVirtualMachineListResult']().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); + }); +} + +/** Class representing a SqlVirtualMachines. */ +class SqlVirtualMachines { + /** + * Create a SqlVirtualMachines. + * @param {SqlVirtualMachineManagementClient} client Reference to the service client. + */ + constructor(client) { + this.client = client; + this._get = _get; + this._createOrUpdate = _createOrUpdate; + this._deleteMethod = _deleteMethod; + this._update = _update; + this._listByResourceGroup = _listByResourceGroup; + this._list = _list; + this._beginCreateOrUpdate = _beginCreateOrUpdate; + this._beginDeleteMethod = _beginDeleteMethod; + this._beginUpdate = _beginUpdate; + this._listByResourceGroupNext = _listByResourceGroupNext; + this._listNext = _listNext; + } + + /** + * Gets a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} [options] Optional Parameters. + * + * @param {string} [options.expand] The child resources to include in the + * response. + * + * @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. + */ + getWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._get(resourceGroupName, sqlVirtualMachineName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} [options] Optional Parameters. + * + * @param {string} [options.expand] The child resources to include in the + * response. + * + * @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 {SqlVirtualMachine} - 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 SqlVirtualMachine} 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. + */ + get(resourceGroupName, sqlVirtualMachineName, 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._get(resourceGroupName, sqlVirtualMachineName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._get(resourceGroupName, sqlVirtualMachineName, options, optionalCallback); + } + } + + /** + * Creates or updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.identity] Azure Active Directory identity of the + * server. + * + * @param {string} [parameters.identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure Active + * Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * + * @param {string} [parameters.virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * + * @param {string} [parameters.sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * + * @param {string} [parameters.sqlVirtualMachineGroupResourceId] ARM resource + * id of the SQL virtual machine group this SQL virtual machine is or will be + * part of. + * + * @param {object} [parameters.wsfcDomainCredentials] Domain credentials for + * setting up Windows Server Failover Cluster for SQL availability group. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterBootstrapAccountPassword] Cluster + * bootstrap account password. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterOperatorAccountPassword] Cluster + * operator account password. + * + * @param {string} [parameters.wsfcDomainCredentials.sqlServiceAccountPassword] + * SQL service account password. + * + * @param {object} [parameters.autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * + * @param {boolean} [parameters.autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * + * @param {string} [parameters.autoPatchingSettings.dayOfWeek] Day of week to + * apply the patch on. Possible values include: 'Monday', 'Tuesday', + * 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' + * + * @param {number} + * [parameters.autoPatchingSettings.maintenanceWindowStartingHour] Hour of the + * day when patching is initiated. Local VM time. + * + * @param {number} [parameters.autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * + * @param {object} [parameters.autoBackupSettings] Auto backup settings for SQL + * Server. + * + * @param {boolean} [parameters.autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * + * @param {boolean} [parameters.autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * + * @param {number} [parameters.autoBackupSettings.retentionPeriod] Retention + * period of backup: 1-30 days. + * + * @param {string} [parameters.autoBackupSettings.storageAccountUrl] Storage + * account url where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.storageAccessKey] Storage + * account key where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.password] Password for + * encryption on backup. + * + * @param {boolean} [parameters.autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * + * @param {string} [parameters.autoBackupSettings.backupScheduleType] Backup + * schedule type. Possible values include: 'Manual', 'Automated' + * + * @param {string} [parameters.autoBackupSettings.fullBackupFrequency] + * Frequency of full backups. In both cases, full backups begin during the next + * scheduled time window. Possible values include: 'Daily', 'Weekly' + * + * @param {number} [parameters.autoBackupSettings.fullBackupStartTime] Start + * time of a given day during which full backups can take place. 0-23 hours. + * + * @param {number} [parameters.autoBackupSettings.fullBackupWindowHours] + * Duration of the time window of a given day during which full backups can + * take place. 1-23 hours. + * + * @param {number} [parameters.autoBackupSettings.logBackupFrequency] Frequency + * of log backups. 5-60 minutes. + * + * @param {object} [parameters.keyVaultCredentialSettings] Key vault credential + * settings. + * + * @param {boolean} [parameters.keyVaultCredentialSettings.enable] Enable or + * disable key vault credential setting. + * + * @param {string} [parameters.keyVaultCredentialSettings.credentialName] + * Credential name. + * + * @param {string} [parameters.keyVaultCredentialSettings.azureKeyVaultUrl] + * Azure Key Vault url. + * + * @param {string} [parameters.keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * + * @param {string} + * [parameters.keyVaultCredentialSettings.servicePrincipalSecret] Service + * principal name secret to access key vault. + * + * @param {object} [parameters.serverConfigurationsManagementSettings] SQL + * Server configuration management settings. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] + * SQL connectivity type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] + * SQL workload type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings] + * SQL storage update settings. + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + createOrUpdateWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._createOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Creates or updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.identity] Azure Active Directory identity of the + * server. + * + * @param {string} [parameters.identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure Active + * Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * + * @param {string} [parameters.virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * + * @param {string} [parameters.sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * + * @param {string} [parameters.sqlVirtualMachineGroupResourceId] ARM resource + * id of the SQL virtual machine group this SQL virtual machine is or will be + * part of. + * + * @param {object} [parameters.wsfcDomainCredentials] Domain credentials for + * setting up Windows Server Failover Cluster for SQL availability group. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterBootstrapAccountPassword] Cluster + * bootstrap account password. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterOperatorAccountPassword] Cluster + * operator account password. + * + * @param {string} [parameters.wsfcDomainCredentials.sqlServiceAccountPassword] + * SQL service account password. + * + * @param {object} [parameters.autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * + * @param {boolean} [parameters.autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * + * @param {string} [parameters.autoPatchingSettings.dayOfWeek] Day of week to + * apply the patch on. Possible values include: 'Monday', 'Tuesday', + * 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' + * + * @param {number} + * [parameters.autoPatchingSettings.maintenanceWindowStartingHour] Hour of the + * day when patching is initiated. Local VM time. + * + * @param {number} [parameters.autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * + * @param {object} [parameters.autoBackupSettings] Auto backup settings for SQL + * Server. + * + * @param {boolean} [parameters.autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * + * @param {boolean} [parameters.autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * + * @param {number} [parameters.autoBackupSettings.retentionPeriod] Retention + * period of backup: 1-30 days. + * + * @param {string} [parameters.autoBackupSettings.storageAccountUrl] Storage + * account url where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.storageAccessKey] Storage + * account key where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.password] Password for + * encryption on backup. + * + * @param {boolean} [parameters.autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * + * @param {string} [parameters.autoBackupSettings.backupScheduleType] Backup + * schedule type. Possible values include: 'Manual', 'Automated' + * + * @param {string} [parameters.autoBackupSettings.fullBackupFrequency] + * Frequency of full backups. In both cases, full backups begin during the next + * scheduled time window. Possible values include: 'Daily', 'Weekly' + * + * @param {number} [parameters.autoBackupSettings.fullBackupStartTime] Start + * time of a given day during which full backups can take place. 0-23 hours. + * + * @param {number} [parameters.autoBackupSettings.fullBackupWindowHours] + * Duration of the time window of a given day during which full backups can + * take place. 1-23 hours. + * + * @param {number} [parameters.autoBackupSettings.logBackupFrequency] Frequency + * of log backups. 5-60 minutes. + * + * @param {object} [parameters.keyVaultCredentialSettings] Key vault credential + * settings. + * + * @param {boolean} [parameters.keyVaultCredentialSettings.enable] Enable or + * disable key vault credential setting. + * + * @param {string} [parameters.keyVaultCredentialSettings.credentialName] + * Credential name. + * + * @param {string} [parameters.keyVaultCredentialSettings.azureKeyVaultUrl] + * Azure Key Vault url. + * + * @param {string} [parameters.keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * + * @param {string} + * [parameters.keyVaultCredentialSettings.servicePrincipalSecret] Service + * principal name secret to access key vault. + * + * @param {object} [parameters.serverConfigurationsManagementSettings] SQL + * Server configuration management settings. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] + * SQL connectivity type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] + * SQL workload type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings] + * SQL storage update settings. + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachine} - 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 SqlVirtualMachine} 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. + */ + createOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, 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._createOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._createOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, optionalCallback); + } + } + + /** + * Deletes a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @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. + */ + deleteMethodWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._deleteMethod(resourceGroupName, sqlVirtualMachineName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Deletes a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + deleteMethod(resourceGroupName, sqlVirtualMachineName, 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._deleteMethod(resourceGroupName, sqlVirtualMachineName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._deleteMethod(resourceGroupName, sqlVirtualMachineName, options, optionalCallback); + } + } + + /** + * Updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + updateWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._update(resourceGroupName, sqlVirtualMachineName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachine} - 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 SqlVirtualMachine} 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. + */ + update(resourceGroupName, sqlVirtualMachineName, parameters, 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._update(resourceGroupName, sqlVirtualMachineName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._update(resourceGroupName, sqlVirtualMachineName, parameters, options, optionalCallback); + } + } + + /** + * Gets all SQL virtual machines in a resource group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @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. + */ + listByResourceGroupWithHttpOperationResponse(resourceGroupName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listByResourceGroup(resourceGroupName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets all SQL virtual machines in a resource group. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @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 {SqlVirtualMachineListResult} - 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 SqlVirtualMachineListResult} 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. + */ + listByResourceGroup(resourceGroupName, 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._listByResourceGroup(resourceGroupName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listByResourceGroup(resourceGroupName, options, optionalCallback); + } + } + + /** + * Gets all SQL virtual machines in a subscription. + * + * @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. + */ + listWithHttpOperationResponse(options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._list(options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets all SQL virtual machines in a subscription. + * + * @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 {SqlVirtualMachineListResult} - 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 SqlVirtualMachineListResult} 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. + */ + list(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._list(options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._list(options, optionalCallback); + } + } + + /** + * Creates or updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.identity] Azure Active Directory identity of the + * server. + * + * @param {string} [parameters.identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure Active + * Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * + * @param {string} [parameters.virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * + * @param {string} [parameters.sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * + * @param {string} [parameters.sqlVirtualMachineGroupResourceId] ARM resource + * id of the SQL virtual machine group this SQL virtual machine is or will be + * part of. + * + * @param {object} [parameters.wsfcDomainCredentials] Domain credentials for + * setting up Windows Server Failover Cluster for SQL availability group. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterBootstrapAccountPassword] Cluster + * bootstrap account password. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterOperatorAccountPassword] Cluster + * operator account password. + * + * @param {string} [parameters.wsfcDomainCredentials.sqlServiceAccountPassword] + * SQL service account password. + * + * @param {object} [parameters.autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * + * @param {boolean} [parameters.autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * + * @param {string} [parameters.autoPatchingSettings.dayOfWeek] Day of week to + * apply the patch on. Possible values include: 'Monday', 'Tuesday', + * 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' + * + * @param {number} + * [parameters.autoPatchingSettings.maintenanceWindowStartingHour] Hour of the + * day when patching is initiated. Local VM time. + * + * @param {number} [parameters.autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * + * @param {object} [parameters.autoBackupSettings] Auto backup settings for SQL + * Server. + * + * @param {boolean} [parameters.autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * + * @param {boolean} [parameters.autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * + * @param {number} [parameters.autoBackupSettings.retentionPeriod] Retention + * period of backup: 1-30 days. + * + * @param {string} [parameters.autoBackupSettings.storageAccountUrl] Storage + * account url where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.storageAccessKey] Storage + * account key where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.password] Password for + * encryption on backup. + * + * @param {boolean} [parameters.autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * + * @param {string} [parameters.autoBackupSettings.backupScheduleType] Backup + * schedule type. Possible values include: 'Manual', 'Automated' + * + * @param {string} [parameters.autoBackupSettings.fullBackupFrequency] + * Frequency of full backups. In both cases, full backups begin during the next + * scheduled time window. Possible values include: 'Daily', 'Weekly' + * + * @param {number} [parameters.autoBackupSettings.fullBackupStartTime] Start + * time of a given day during which full backups can take place. 0-23 hours. + * + * @param {number} [parameters.autoBackupSettings.fullBackupWindowHours] + * Duration of the time window of a given day during which full backups can + * take place. 1-23 hours. + * + * @param {number} [parameters.autoBackupSettings.logBackupFrequency] Frequency + * of log backups. 5-60 minutes. + * + * @param {object} [parameters.keyVaultCredentialSettings] Key vault credential + * settings. + * + * @param {boolean} [parameters.keyVaultCredentialSettings.enable] Enable or + * disable key vault credential setting. + * + * @param {string} [parameters.keyVaultCredentialSettings.credentialName] + * Credential name. + * + * @param {string} [parameters.keyVaultCredentialSettings.azureKeyVaultUrl] + * Azure Key Vault url. + * + * @param {string} [parameters.keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * + * @param {string} + * [parameters.keyVaultCredentialSettings.servicePrincipalSecret] Service + * principal name secret to access key vault. + * + * @param {object} [parameters.serverConfigurationsManagementSettings] SQL + * Server configuration management settings. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] + * SQL connectivity type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] + * SQL workload type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings] + * SQL storage update settings. + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Creates or updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.identity] Azure Active Directory identity of the + * server. + * + * @param {string} [parameters.identity.type] The identity type. Set this to + * 'SystemAssigned' in order to automatically create and assign an Azure Active + * Directory principal for the resource. Possible values include: + * 'SystemAssigned' + * + * @param {string} [parameters.virtualMachineResourceId] ARM Resource id of + * underlying virtual machine created from SQL marketplace image. + * + * @param {string} [parameters.sqlServerLicenseType] SQL Server license type. + * Possible values include: 'PAYG', 'AHUB' + * + * @param {string} [parameters.sqlVirtualMachineGroupResourceId] ARM resource + * id of the SQL virtual machine group this SQL virtual machine is or will be + * part of. + * + * @param {object} [parameters.wsfcDomainCredentials] Domain credentials for + * setting up Windows Server Failover Cluster for SQL availability group. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterBootstrapAccountPassword] Cluster + * bootstrap account password. + * + * @param {string} + * [parameters.wsfcDomainCredentials.clusterOperatorAccountPassword] Cluster + * operator account password. + * + * @param {string} [parameters.wsfcDomainCredentials.sqlServiceAccountPassword] + * SQL service account password. + * + * @param {object} [parameters.autoPatchingSettings] Auto patching settings for + * applying critical security updates to SQL virtual machine. + * + * @param {boolean} [parameters.autoPatchingSettings.enable] Enable or disable + * autopatching on SQL virtual machine. + * + * @param {string} [parameters.autoPatchingSettings.dayOfWeek] Day of week to + * apply the patch on. Possible values include: 'Monday', 'Tuesday', + * 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' + * + * @param {number} + * [parameters.autoPatchingSettings.maintenanceWindowStartingHour] Hour of the + * day when patching is initiated. Local VM time. + * + * @param {number} [parameters.autoPatchingSettings.maintenanceWindowDuration] + * Duration of patching. + * + * @param {object} [parameters.autoBackupSettings] Auto backup settings for SQL + * Server. + * + * @param {boolean} [parameters.autoBackupSettings.enable] Enable or disable + * autobackup on SQL virtual machine. + * + * @param {boolean} [parameters.autoBackupSettings.enableEncryption] Enable or + * disable encryption for backup on SQL virtual machine. + * + * @param {number} [parameters.autoBackupSettings.retentionPeriod] Retention + * period of backup: 1-30 days. + * + * @param {string} [parameters.autoBackupSettings.storageAccountUrl] Storage + * account url where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.storageAccessKey] Storage + * account key where backup will be taken to. + * + * @param {string} [parameters.autoBackupSettings.password] Password for + * encryption on backup. + * + * @param {boolean} [parameters.autoBackupSettings.backupSystemDbs] Include or + * exclude system databases from auto backup. + * + * @param {string} [parameters.autoBackupSettings.backupScheduleType] Backup + * schedule type. Possible values include: 'Manual', 'Automated' + * + * @param {string} [parameters.autoBackupSettings.fullBackupFrequency] + * Frequency of full backups. In both cases, full backups begin during the next + * scheduled time window. Possible values include: 'Daily', 'Weekly' + * + * @param {number} [parameters.autoBackupSettings.fullBackupStartTime] Start + * time of a given day during which full backups can take place. 0-23 hours. + * + * @param {number} [parameters.autoBackupSettings.fullBackupWindowHours] + * Duration of the time window of a given day during which full backups can + * take place. 1-23 hours. + * + * @param {number} [parameters.autoBackupSettings.logBackupFrequency] Frequency + * of log backups. 5-60 minutes. + * + * @param {object} [parameters.keyVaultCredentialSettings] Key vault credential + * settings. + * + * @param {boolean} [parameters.keyVaultCredentialSettings.enable] Enable or + * disable key vault credential setting. + * + * @param {string} [parameters.keyVaultCredentialSettings.credentialName] + * Credential name. + * + * @param {string} [parameters.keyVaultCredentialSettings.azureKeyVaultUrl] + * Azure Key Vault url. + * + * @param {string} [parameters.keyVaultCredentialSettings.servicePrincipalName] + * Service principal name to access key vault. + * + * @param {string} + * [parameters.keyVaultCredentialSettings.servicePrincipalSecret] Service + * principal name secret to access key vault. + * + * @param {object} [parameters.serverConfigurationsManagementSettings] SQL + * Server configuration management settings. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings] + * SQL connectivity type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.connectivityType] + * SQL Server connectivity option. Possible values include: 'LOCAL', 'PRIVATE', + * 'PUBLIC' + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.port] + * SQL Server port. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdateUserName] + * SQL Server sysadmin login to create. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlConnectivityUpdateSettings.sqlAuthUpdatePassword] + * SQL Server sysadmin login password. + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings] + * SQL workload type settings. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlWorkloadTypeUpdateSettings.sqlWorkloadType] + * SQL Server workload type. Possible values include: 'GENERAL', 'OLTP', 'DW' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings] + * SQL storage update settings. + * + * @param {number} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskCount] + * Virtual machine disk count. + * + * @param {string} + * [parameters.serverConfigurationsManagementSettings.sqlStorageUpdateSettings.diskConfigurationType] + * Disk configuration to apply to SQL Server. Possible values include: 'NEW', + * 'EXTEND', 'ADD' + * + * @param {object} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations] + * Additional SQL feature settings. + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.isRServicesEnabled] + * Enable or disable R services (SQL 2016 onwards). + * + * @param {boolean} + * [parameters.serverConfigurationsManagementSettings.additionalFeaturesServerConfigurations.backupPermissionsForAzureBackupSvc] + * Enable or disable Azure Backup service. + * + * @param {string} parameters.location Resource location. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachine} - 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 SqlVirtualMachine} 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. + */ + beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, 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._beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginCreateOrUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, optionalCallback); + } + } + + /** + * Deletes a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @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. + */ + beginDeleteMethodWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineName, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginDeleteMethod(resourceGroupName, sqlVirtualMachineName, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Deletes a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @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 {null} - 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. + * + * {null} [result] - The deserialized result object if an error did not occur. + * + * {object} [request] - The HTTP Request object if an error did not occur. + * + * {stream} [response] - The HTTP Response stream if an error did not occur. + */ + beginDeleteMethod(resourceGroupName, sqlVirtualMachineName, 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._beginDeleteMethod(resourceGroupName, sqlVirtualMachineName, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginDeleteMethod(resourceGroupName, sqlVirtualMachineName, options, optionalCallback); + } + } + + /** + * Updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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. + */ + beginUpdateWithHttpOperationResponse(resourceGroupName, sqlVirtualMachineName, parameters, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._beginUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Updates a SQL virtual machine. + * + * @param {string} resourceGroupName Name of the resource group that contains + * the resource. You can obtain this value from the Azure Resource Manager API + * or the portal. + * + * @param {string} sqlVirtualMachineName Name of the SQL virtual machine. + * + * @param {object} parameters The SQL virtual machine. + * + * @param {object} [parameters.tags] Resource tags. + * + * @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 {SqlVirtualMachine} - 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 SqlVirtualMachine} 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. + */ + beginUpdate(resourceGroupName, sqlVirtualMachineName, parameters, 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._beginUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._beginUpdate(resourceGroupName, sqlVirtualMachineName, parameters, options, optionalCallback); + } + } + + /** + * Gets all SQL virtual machines in a resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listByResourceGroupNextWithHttpOperationResponse(nextPageLink, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listByResourceGroupNext(nextPageLink, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets all SQL virtual machines in a resource group. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {SqlVirtualMachineListResult} - 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 SqlVirtualMachineListResult} 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. + */ + listByResourceGroupNext(nextPageLink, 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._listByResourceGroupNext(nextPageLink, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listByResourceGroupNext(nextPageLink, options, optionalCallback); + } + } + + /** + * Gets all SQL virtual machines in a subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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. + */ + listNextWithHttpOperationResponse(nextPageLink, options) { + let client = this.client; + let self = this; + return new Promise((resolve, reject) => { + self._listNext(nextPageLink, options, (err, result, request, response) => { + let httpOperationResponse = new msRest.HttpOperationResponse(request, response); + httpOperationResponse.body = result; + if (err) { reject(err); } + else { resolve(httpOperationResponse); } + return; + }); + }); + } + + /** + * Gets all SQL virtual machines in a subscription. + * + * @param {string} nextPageLink The NextLink from the previous successful call + * to List operation. + * + * @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 {SqlVirtualMachineListResult} - 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 SqlVirtualMachineListResult} 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. + */ + listNext(nextPageLink, 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._listNext(nextPageLink, options, (err, result, request, response) => { + if (err) { reject(err); } + else { resolve(result); } + return; + }); + }); + } else { + return self._listNext(nextPageLink, options, optionalCallback); + } + } + +} + +module.exports = SqlVirtualMachines; diff --git a/lib/services/sqlvirtualmachineManagement/lib/sqlVirtualMachineManagementClient.d.ts b/lib/services/sqlvirtualmachineManagement/lib/sqlVirtualMachineManagementClient.d.ts new file mode 100644 index 0000000000..c64edb3179 --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/sqlVirtualMachineManagementClient.d.ts @@ -0,0 +1,65 @@ +/* + * 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. + */ + +import { ServiceClientCredentials } from 'ms-rest'; +import { AzureServiceClient, AzureServiceClientOptions } from 'ms-rest-azure'; +import * as models from "./models"; +import * as operations from "./operations"; + +export default class SqlVirtualMachineManagementClient extends AzureServiceClient { + /** + * Initializes a new instance of the SqlVirtualMachineManagementClient class. + * @constructor + * + * @class + * @param {credentials} credentials - Credentials needed for the client to connect to Azure. + * + * @param {string} subscriptionId - Subscription ID that identifies an Azure subscription. + * + * @param {string} [baseUri] - The base URI of the service. + * + * @param {object} [options] - The parameter options + * + * @param {Array} [options.filters] - Filters to be added to the request pipeline + * + * @param {object} [options.requestOptions] - Options for the underlying request object + * {@link https://github.com/request/request#requestoptions-callback Options doc} + * + * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy + * + * @param {string} [options.acceptLanguage] - The preferred language for the response. + * + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. + * + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * + */ + constructor(credentials: ServiceClientCredentials, subscriptionId: string, baseUri?: string, options?: AzureServiceClientOptions); + + credentials: ServiceClientCredentials; + + subscriptionId: string; + + apiVersion: string; + + acceptLanguage: string; + + longRunningOperationRetryTimeout: number; + + generateClientRequestId: boolean; + + // Operation groups + availabilityGroupListeners: operations.AvailabilityGroupListeners; + operations: operations.Operations; + sqlVirtualMachineGroups: operations.SqlVirtualMachineGroups; + sqlVirtualMachines: operations.SqlVirtualMachines; +} + +export { SqlVirtualMachineManagementClient, models as SqlVirtualMachineManagementModels }; diff --git a/lib/services/sqlvirtualmachineManagement/lib/sqlVirtualMachineManagementClient.js b/lib/services/sqlvirtualmachineManagement/lib/sqlVirtualMachineManagementClient.js new file mode 100644 index 0000000000..faf065647e --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/lib/sqlVirtualMachineManagementClient.js @@ -0,0 +1,88 @@ +/* + * 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. + */ + +/* jshint latedef:false */ +/* jshint forin:false */ +/* jshint noempty:false */ + +'use strict'; + +const msRest = require('ms-rest'); +const msRestAzure = require('ms-rest-azure'); +const ServiceClient = msRestAzure.AzureServiceClient; + +const models = require('./models'); +const operations = require('./operations'); + + +/** Class representing a SqlVirtualMachineManagementClient. */ +class SqlVirtualMachineManagementClient extends ServiceClient { + /** + * Create a SqlVirtualMachineManagementClient. + * @param {credentials} credentials - Credentials needed for the client to connect to Azure. + * @param {string} subscriptionId - Subscription ID that identifies an Azure subscription. + * @param {string} [baseUri] - The base URI of the service. + * @param {object} [options] - The parameter options + * @param {Array} [options.filters] - Filters to be added to the request pipeline + * @param {object} [options.requestOptions] - Options for the underlying request object + * {@link https://github.com/request/request#requestoptions-callback Options doc} + * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy + * @param {string} [options.acceptLanguage] - The preferred language for the response. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + */ + constructor(credentials, subscriptionId, baseUri, options) { + if (credentials === null || credentials === undefined) { + throw new Error('\'credentials\' cannot be null.'); + } + if (subscriptionId === null || subscriptionId === undefined) { + throw new Error('\'subscriptionId\' cannot be null.'); + } + + if (!options) options = {}; + + super(credentials, options); + + this.apiVersion = '2017-03-01-preview'; + this.acceptLanguage = 'en-US'; + this.longRunningOperationRetryTimeout = 30; + this.generateClientRequestId = true; + this.baseUri = baseUri; + if (!this.baseUri) { + this.baseUri = 'https://management.azure.com'; + } + this.credentials = credentials; + this.subscriptionId = subscriptionId; + + let packageInfo = this.getPackageJsonInfo(__dirname); + this.addUserAgentInfo(`${packageInfo.name}/${packageInfo.version}`); + if(options.acceptLanguage !== null && options.acceptLanguage !== undefined) { + this.acceptLanguage = options.acceptLanguage; + } + if(options.longRunningOperationRetryTimeout !== null && options.longRunningOperationRetryTimeout !== undefined) { + this.longRunningOperationRetryTimeout = options.longRunningOperationRetryTimeout; + } + if(options.generateClientRequestId !== null && options.generateClientRequestId !== undefined) { + this.generateClientRequestId = options.generateClientRequestId; + } + this.availabilityGroupListeners = new operations.AvailabilityGroupListeners(this); + this.operations = new operations.Operations(this); + this.sqlVirtualMachineGroups = new operations.SqlVirtualMachineGroups(this); + this.sqlVirtualMachines = new operations.SqlVirtualMachines(this); + this.models = models; + msRest.addSerializationMixin(this); + } + +} + +module.exports = SqlVirtualMachineManagementClient; +module.exports['default'] = SqlVirtualMachineManagementClient; +module.exports.SqlVirtualMachineManagementClient = SqlVirtualMachineManagementClient; +module.exports.SqlVirtualMachineManagementModels = models; diff --git a/lib/services/sqlvirtualmachineManagement/package.json b/lib/services/sqlvirtualmachineManagement/package.json new file mode 100644 index 0000000000..a2fb4e16bb --- /dev/null +++ b/lib/services/sqlvirtualmachineManagement/package.json @@ -0,0 +1,25 @@ +{ + "name": "azure-arm-sqlvirtualmachine", + "author": "Microsoft Corporation", + "description": "SqlVirtualMachineManagementClient Library with typescript type definitions for node", + "version": "1.0.0", + "dependencies": { + "ms-rest": "^2.3.3", + "ms-rest-azure": "^2.5.5" + }, + "keywords": [ + "node", + "azure" + ], + "license": "MIT", + "main": "./lib/sqlVirtualMachineManagementClient.js", + "types": "./lib/sqlVirtualMachineManagementClient.d.ts", + "homepage": "https://github.com/azure/azure-sdk-for-node/tree/master/lib/services/sqlvirtualmachineManagement", + "repository": { + "type": "git", + "url": "https://github.com/azure/azure-sdk-for-node.git" + }, + "bugs": { + "url": "https://github.com/azure/azure-sdk-for-node/issues" + } +} diff --git a/package.json b/package.json index 8bcfac7f8a..2d2d73b3b2 100644 --- a/package.json +++ b/package.json @@ -120,7 +120,7 @@ "azure-storage-legacy": "^0.10.3", "mime": "^1.6.0", "moment": "^2.22.2", - "ms-rest": "^2.3.0", + "ms-rest": "^2.3.8", "ms-rest-azure": "^2.5.0", "request": "^2.81.0", "underscore": "1.8.3", @@ -139,6 +139,7 @@ "json-stable-stringify": "^1.0.1", "minami": "devigned/minami#master", "mocha": "^5.2.0", + "mocha-junit-reporter": "^1.18.0", "nock": "0.16", "node-forge": "0.6.30", "nyc": "^11.2.1", @@ -168,6 +169,7 @@ "ci": "node scripts/unit.js testlist.txt", "runtime-install": "node scripts/runtime-install.js", "coverage": "node scripts/unit-coverage.js testlistarm.txt testlist.txt", - "debug": "node --inspect scripts/unit-arm.js testlistarm.txt" + "debug": "node --inspect scripts/unit-arm.js testlistarm.txt", + "mocha": "mocha" } } diff --git a/runtime/ms-rest/Changelog.md b/runtime/ms-rest/Changelog.md index 5664644f12..7636cb30fe 100644 --- a/runtime/ms-rest/Changelog.md +++ b/runtime/ms-rest/Changelog.md @@ -1,3 +1,6 @@ +### 2.3.8 (11/20/2018) +- Deserialization now allows for case-insensitive property name lookup. + ### 2.3.7 (9/26/2018) - update min. version of request to 2.88.0. This will keep ms-rest and ms-rest-azure in sync with request dependency. diff --git a/runtime/ms-rest/lib/serialization.js b/runtime/ms-rest/lib/serialization.js index 34dab015b1..663aa8d2df 100644 --- a/runtime/ms-rest/lib/serialization.js +++ b/runtime/ms-rest/lib/serialization.js @@ -484,6 +484,46 @@ function deserializeDictionaryType(mapper, responseBody, objectName) { return responseBody; } +/** + * Get the value of the property with the provided path. This function will first do a + * case-sensitive check for the property, and if that returns undefined then it will do a + * case-insensitive check. + * @param {object} value The value to get the property value from. + * @param {string[]} propertyPath The path to the property. + * @returns {any} The value of the property or undefined if it wasn't found. + */ +exports.getPropertyValue = function (value, propertyPath) { + let propertyValue; + + if (value != undefined && propertyPath != undefined) { + for (const propertyName of propertyPath) { + if (!propertyName) { + propertyValue = value; + } else { + propertyValue = value[propertyName]; + + if (propertyValue === undefined) { + const lowerCasePropertyName = propertyName.toLowerCase(); + for (const existingPropertyName of Object.keys(value)) { + if (lowerCasePropertyName === existingPropertyName.toLowerCase()) { + propertyValue = value[existingPropertyName]; + break; + } + } + } + + if (propertyValue == undefined) { + break; + } else { + value = propertyValue; + } + } + } + } + + return propertyValue; +}; + function deserializeCompositeType(mapper, responseBody, objectName) { /*jshint validthis: true */ //check for polymorphic discriminator @@ -517,21 +557,11 @@ function deserializeCompositeType(mapper, responseBody, objectName) { for (let key in modelProps) { if (modelProps.hasOwnProperty(key)) { - let jpath = ['responseBody']; - let paths = splitSerializeName(modelProps[key].serializedName); - paths.forEach((item) => { - jpath.push(`["${item}"]`); - }); + const paths = splitSerializeName(modelProps[key].serializedName); serializedpropertyNamesInMapper[modelProps[key].serializedName] = paths; //deserialize the property if it is present in the provided responseBody instance - let propertyInstance; - try { - /*jslint evil: true */ - propertyInstance = eval(jpath.join('')); - } catch (err) { - continue; - } + let propertyInstance = exports.getPropertyValue(responseBody, paths); let propertyMapper = modelProps[key]; //update discriminator property if missing diff --git a/runtime/ms-rest/package.json b/runtime/ms-rest/package.json index f7f6b73d18..49c870a743 100644 --- a/runtime/ms-rest/package.json +++ b/runtime/ms-rest/package.json @@ -5,7 +5,7 @@ "email": "azsdkteam@microsoft.com", "url": "https://github.com/Azure/azure-sdk-for-node" }, - "version": "2.3.7", + "version": "2.3.8", "description": "Client Runtime for Node.js client libraries generated using AutoRest", "tags": [ "node", @@ -55,4 +55,4 @@ "unit": "node test/unit.js testlist.txt", "jshint": "jshint lib --reporter=jslint" } -} \ No newline at end of file +} diff --git a/runtime/ms-rest/test/serializationTests.js b/runtime/ms-rest/test/serializationTests.js index 8f791a83a3..6c5372ea22 100644 --- a/runtime/ms-rest/test/serializationTests.js +++ b/runtime/ms-rest/test/serializationTests.js @@ -5,6 +5,7 @@ var assert = require('assert'); var should = require('should'); var moment = require('moment'); var msRest = require('../lib/msRest'); +var getPropertyValue = require('../lib/serialization').getPropertyValue; var testClient = require('./data/TestClient/lib/testClient'); var tokenCredentials = new msRest.TokenCredentials('dummy'); @@ -1215,5 +1216,55 @@ describe('msrest', function () { done(); }); }); + + describe('getPropertyValue', function () { + it('should return undefined when given an undefined value', function () { + assert.strictEqual(getPropertyValue(undefined, ["a"]), undefined); + }); + + it('should return undefined when given a null value', function () { + assert.strictEqual(getPropertyValue(null, ["a"]), undefined); + }); + + it('should return undefined when given undefined property path', function () { + assert.strictEqual(getPropertyValue("apples", undefined), undefined); + }); + + it('should return undefined when given null property path', function () { + assert.strictEqual(getPropertyValue("apples", null), undefined); + }); + + it('should return undefined when given empty property path', function () { + assert.strictEqual(getPropertyValue("apples", []), undefined); + }); + + it('should return undefined when given a property name that doesn\'t exist', function () { + assert.strictEqual(getPropertyValue("apples", ["spam"]), undefined); + }); + + it('should return property value when given a property name that exists', function () { + assert.strictEqual(getPropertyValue({ "a": 6 }, ["a"]), 6); + }); + + it('should return property value when given a property name that exists with the wrong case', function () { + assert.strictEqual(getPropertyValue({ "a": 6 }, ["A"]), 6); + }); + + it('should return original value when given an empty property name', function () { + assert.strictEqual(getPropertyValue("apples", [""]), "apples"); + }); + + it('should return undefined when part of the property path doesn\'t exist', function () { + assert.strictEqual(getPropertyValue({ "a": { "beta": { "c": 7 } } }, ["a", "b", "c"]), undefined); + }); + + it('should return property value when part of the property path is in the wrong case', function () { + assert.strictEqual(getPropertyValue({ "a": { "b": { "c": 7 } } }, ["A", "b", "C"]), 7); + }); + + it('should return null when the property value is null', function () { + assert.strictEqual(getPropertyValue({ "a": { "b": null } }, ["A", "b"]), null); + }); + }); }); diff --git a/swagger_to_sdk_config.json b/swagger_to_sdk_config.json index d67c013807..b6ca1a6455 100644 --- a/swagger_to_sdk_config.json +++ b/swagger_to_sdk_config.json @@ -5,7 +5,7 @@ "nodejs": "", "license-header": "MICROSOFT_MIT_NO_VERSION", "sdkrel:node-sdks-folder": ".", - "use": "@microsoft.azure/autorest.nodejs@2.1.116" + "use": "@microsoft.azure/autorest.nodejs@2.1.121" }, "advanced_options": { "clone_dir": "./azure-sdk-for-node" diff --git a/test/runtimeTests/rpRegistrationFilterTest.js b/test/runtimeTests/rpRegistrationFilterTest.js index fc82c53271..e24cdb069a 100644 --- a/test/runtimeTests/rpRegistrationFilterTest.js +++ b/test/runtimeTests/rpRegistrationFilterTest.js @@ -33,7 +33,7 @@ var requiredEnvironment = [{ ]; // the necessary clients -var DataLakeStoreAccountManagementClient = require('../../lib/services/dataLake.Store/lib/account/dataLakeStoreAccountManagementClient'); +var DataLakeStoreAccountManagementClient = require('../../lib/services/datalake.Store/lib/account/dataLakeStoreAccountManagementClient'); var ResourceManagementClient = require('../../lib/services/resourceManagement/lib/resource/resourceManagementClient'); var adlsClient; var adlsFileSystemClient; @@ -122,7 +122,7 @@ describe('Automatic RP Registration', function () { location: testLocation }; - adlsClient.account.create(testResourceGroup, accountName, accountToCreate, function (err, result) { + adlsClient.accounts.create(testResourceGroup, accountName, accountToCreate, function (err, result) { should.not.exist(err); should.exist(result); result.name.should.be.equal(accountName); diff --git a/test/services/dataLakeAnalyticsManagement/dataLakeAnalyticsManagementClient-tests.js b/test/services/dataLakeAnalyticsManagement/dataLakeAnalyticsManagementClient-tests.js index 35764f8769..886ab9047b 100644 --- a/test/services/dataLakeAnalyticsManagement/dataLakeAnalyticsManagementClient-tests.js +++ b/test/services/dataLakeAnalyticsManagement/dataLakeAnalyticsManagementClient-tests.js @@ -21,7 +21,7 @@ var SuiteBase = require('../../framework/suite-base'); var dump = util.inspect; var DataLakeAnalyticsAccountManagementClient = require('../../../lib/services/dataLake.Analytics/lib/account/dataLakeAnalyticsAccountManagementClient'); -var DataLakeStoreAccountManagementClient = require('../../../lib/services/dataLake.Store/lib/account/dataLakeStoreAccountManagementClient'); +var DataLakeStoreAccountManagementClient = require('../../../lib/services/datalake.Store/lib/account/dataLakeStoreAccountManagementClient'); var DataLakeAnalyticsJobManagementClient = require('../../../lib/services/dataLake.Analytics/lib/job/dataLakeAnalyticsJobManagementClient'); var DataLakeAnalyticsCatalogManagementClient = require('../../../lib/services/dataLake.Analytics/lib/catalog/dataLakeAnalyticsCatalogManagementClient'); var ResourceManagementClient = require('../../../lib/services/resourceManagement/lib/resource/resourceManagementClient'); @@ -150,9 +150,9 @@ describe('Data Lake Analytics Clients (Account, Job and Catalog)', function () { should.not.exist(err); resourceClient.resourceGroups.createOrUpdate(secondResourceGroup, {location: testLocation}, function (err) { should.not.exist(err); - adlsClient.account.create(testResourceGroup, storeAccountName, adlsAccount, function(err) { + adlsClient.accounts.create(testResourceGroup, storeAccountName, adlsAccount, function(err) { should.not.exist(err); - adlsClient.account.create(testResourceGroup, additionalStoreAccountName, secondAdlsAccount, function(err) { + adlsClient.accounts.create(testResourceGroup, additionalStoreAccountName, secondAdlsAccount, function(err) { should.not.exist(err); storageClient.storageAccounts.create(testResourceGroup, azureBlobAccountName, storageAccount, function (err) { should.not.exist(err); diff --git a/test/services/dataLakeStoreManagement/dataLakeStoreManagementClient-tests.js b/test/services/dataLakeStoreManagement/dataLakeStoreManagementClient-tests.js index 837694c9ff..fa491cdb56 100644 --- a/test/services/dataLakeStoreManagement/dataLakeStoreManagementClient-tests.js +++ b/test/services/dataLakeStoreManagement/dataLakeStoreManagementClient-tests.js @@ -34,8 +34,8 @@ var requiredEnvironment = [{ ]; // the necessary clients -var DataLakeStoreAccountManagementClient = require('../../../lib/services/dataLake.Store/lib/account/dataLakeStoreAccountManagementClient'); -var DataLakeStoreFileSystemManagementClient = require('../../../lib/services/dataLake.Store/lib/filesystem/dataLakeStoreFileSystemManagementClient'); +var DataLakeStoreAccountManagementClient = require('../../../lib/services/datalake.Store/lib/account/dataLakeStoreAccountManagementClient'); +var DataLakeStoreFileSystemManagementClient = require('../../../lib/services/datalake.Store/lib/filesystem/dataLakeStoreFileSystemManagementClient'); var ResourceManagementClient = require('../../../lib/services/resourceManagement/lib/resource/resourceManagementClient'); var adlsClient; var adlsFileSystemClient; @@ -110,7 +110,7 @@ describe('Data Lake Store Clients (Account and Filesystem)', function () { should.not.exist(err); resourceClient.resourceGroups.createOrUpdate(secondResourceGroup, { location: testLocation }, function (err) { should.not.exist(err); - adlsClient.account.create(testResourceGroup, filesystemAccountName, adlsAccount, function (err) { + adlsClient.accounts.create(testResourceGroup, filesystemAccountName, adlsAccount, function (err) { should.not.exist(err); done(); }); @@ -156,7 +156,7 @@ describe('Data Lake Store Clients (Account and Filesystem)', function () { location: testLocation }; - adlsClient.account.create(testResourceGroup, accountName, accountToCreate, function (err, result) { + adlsClient.accounts.create(testResourceGroup, accountName, accountToCreate, function (err, result) { should.not.exist(err); should.exist(result); result.name.should.be.equal(accountName); @@ -175,7 +175,7 @@ describe('Data Lake Store Clients (Account and Filesystem)', function () { location: testLocation }; - adlsClient.account.create(secondResourceGroup, accountName, accountToCreate, function (err, result, request, response) { + adlsClient.accounts.create(secondResourceGroup, accountName, accountToCreate, function (err, result, request, response) { should.exist(err); should.not.exist(result); err.statusCode.should.equalOneOf([409,400]); @@ -184,7 +184,7 @@ describe('Data Lake Store Clients (Account and Filesystem)', function () { }); it('get command should work', function (done) { - adlsClient.account.get(testResourceGroup, filesystemAccountName, function (err, result, request, response) { + adlsClient.accounts.get(testResourceGroup, filesystemAccountName, function (err, result, request, response) { should.not.exist(err); should.exist(result); response.statusCode.should.equal(200); @@ -194,13 +194,13 @@ describe('Data Lake Store Clients (Account and Filesystem)', function () { }); it('list commands should work', function (done) { - adlsClient.account.list(function (err, result, request, response) { + adlsClient.accounts.list(function (err, result, request, response) { should.not.exist(err); should.exist(result); response.statusCode.should.equal(200); result.length.should.be.above(0); // list within resource group as well. - adlsClient.account.listByResourceGroup(testResourceGroup, function (err, result, request, response) { + adlsClient.accounts.listByResourceGroup(testResourceGroup, function (err, result, request, response) { should.not.exist(err); should.exist(result); response.statusCode.should.equal(200); @@ -220,7 +220,7 @@ describe('Data Lake Store Clients (Account and Filesystem)', function () { } }; - adlsClient.account.update(testResourceGroup, filesystemAccountName, accountToUpdate, function (err, result, request, response) { + adlsClient.accounts.update(testResourceGroup, filesystemAccountName, accountToUpdate, function (err, result, request, response) { should.not.exist(err); should.exist(result); response.statusCode.should.equal(200); @@ -231,11 +231,11 @@ describe('Data Lake Store Clients (Account and Filesystem)', function () { }); it('Delete command should work', function (done) { - adlsClient.account.deleteMethod(testResourceGroup, accountName, function (err, result, request, response) { + adlsClient.accounts.deleteMethod(testResourceGroup, accountName, function (err, result, request, response) { should.not.exist(err); should.not.exist(result); response.statusCode.should.equalOneOf([200, 204]); - adlsClient.account.get(testResourceGroup, accountName, function (err, result, request, response) { + adlsClient.accounts.get(testResourceGroup, accountName, function (err, result, request, response) { should.exist(err); should.not.exist(result); err.statusCode.should.equal(404);