CodeGen from PR 18390 in Azure/azure-rest-api-specs

update readme (Azure#18390) * update readme * update readme * Update readme.python.md * Update readme.python.md * Update readme.python.md * Update readme.python.md
AzureSDKAutomation · Mar 25, 2022 · e08a058 · e08a058
1 parent d7fe99a
commit e08a058
Show file tree

Hide file tree

Showing 30 changed files with 3,890 additions and 9 deletions.
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/rush.json b/rush.json
@@ -1,7 +1,7 @@
 /**
  * This is the main configuration file for Rush.
  * For full documentation, please see https://rushjs.io
- */ {
+ */{
   "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush.schema.json",
   /**
    * (Required) This specifies the version of the Rush engine to be used in this repo.
@@ -1670,6 +1670,11 @@
       "packageName": "@azure/arm-app",
       "projectFolder": "sdk/app/arm-app",
       "versionPolicyName": "management"
+    },
+    {
+      "packageName": "vi",
+      "projectFolder": "sdk/vi/arm-vi",
+      "versionPolicyName": "management"
     }
   ]
-}
+}
diff --git a/sdk/vi/arm-vi/CHANGELOG.md b/sdk/vi/arm-vi/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Release History
+
+## 2.0.0-beta.1 (2022-03-25)
+
+The package of vi is using our next generation design principles since version 2.0.0-beta.1, which contains breaking changes.
+
+To understand the detail of the change, please refer to [Changelog](https://aka.ms/js-track2-changelog).
+
+To migrate the existing applications to the latest version, please refer to [Migration Guide](https://aka.ms/js-track2-migration-guide).
+
+To learn more, please refer to our documentation [Quick Start](https://aka.ms/js-track2-quickstart).
diff --git a/sdk/vi/arm-vi/LICENSE b/sdk/vi/arm-vi/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 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/sdk/vi/arm-vi/README.md b/sdk/vi/arm-vi/README.md
@@ -0,0 +1,36 @@
+# ViManagement client library for JavaScript
+
+This package contains an isomorphic SDK (runs both in Node.js and in browsers) for ViManagement client.
+
+Microsoft Azure Video Analyzer for Media
+
+[Package (NPM)](https://www.npmjs.com/package/vi) |
+[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
+
+## Getting started
+
+### Currently supported environments
+
+- [LTS versions of Node.js](https://nodejs.org/about/releases/)
+- Latest versions of Safari, Chrome, Edge and Firefox.
+
+
+### Install the `vi` package
+
+Install the ViManagement client library for JavaScript with `npm`:
+
+```bash
+npm install vi
+```
+
+
+
+### JavaScript Bundle
+To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
+
+## Key concepts
+
+### ViManagementClient
+
+`ViManagementClient` is the primary interface for developers using the ViManagement client library. Explore the methods on this client object to understand the different features of the ViManagement service that you can access.
+
diff --git a/sdk/vi/arm-vi/_meta.json b/sdk/vi/arm-vi/_meta.json
@@ -0,0 +1,8 @@
+{
+  "commit": "3be6fd5261360d01202066fd46031af4f4d8f198",
+  "readme": "specification/vi/resource-manager/readme.md",
+  "autorest_command": "autorest --version=3.7.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/vi/resource-manager/readme.md --use=@autorest/[email protected]",
+  "repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
+  "release_tool": "@azure-tools/[email protected]",
+  "use": "@autorest/[email protected]"
+}
diff --git a/sdk/vi/arm-vi/api-extractor.json b/sdk/vi/arm-vi/api-extractor.json
@@ -0,0 +1,31 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
+  "docModel": {
+    "enabled": true
+  },
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "./review"
+  },
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "",
+    "publicTrimmedFilePath": "./types/vi.d.ts"
+  },
+  "messages": {
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "none"
+      }
+    },
+    "extractorMessageReporting": {
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      },
+      "ae-unresolved-link": {
+        "logLevel": "none"
+      }
+    }
+  }
+}
diff --git a/sdk/vi/arm-vi/package.json b/sdk/vi/arm-vi/package.json
@@ -0,0 +1,100 @@
+{
+  "name": "vi",
+  "sdk-type": "mgmt",
+  "author": "Microsoft Corporation",
+  "description": "A generated SDK for ViManagementClient.",
+  "version": "2.0.0-beta.1",
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "dependencies": {
+    "@azure/core-paging": "^1.2.0",
+    "@azure/core-client": "^1.0.0",
+    "@azure/core-auth": "^1.3.0",
+    "@azure/core-rest-pipeline": "^1.1.0",
+    "tslib": "^2.2.0"
+  },
+  "keywords": [
+    "node",
+    "azure",
+    "typescript",
+    "browser",
+    "isomorphic"
+  ],
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist-esm/src/index.js",
+  "types": "./types/vi.d.ts",
+  "devDependencies": {
+    "@microsoft/api-extractor": "^7.18.11",
+    "@rollup/plugin-commonjs": "11.0.2",
+    "@rollup/plugin-json": "^4.0.0",
+    "@rollup/plugin-multi-entry": "^3.0.0",
+    "@rollup/plugin-node-resolve": "^8.0.0",
+    "mkdirp": "^1.0.4",
+    "rollup": "^1.16.3",
+    "rollup-plugin-sourcemaps": "^0.4.2",
+    "typescript": "~4.2.0",
+    "uglify-js": "^3.4.9",
+    "rimraf": "^3.0.0",
+    "@azure/identity": "^2.0.1",
+    "@azure-tools/test-recorder": "^1.0.0",
+    "mocha": "^7.1.1",
+    "cross-env": "^7.0.2"
+  },
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/vi/arm-vi",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Azure/azure-sdk-for-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map",
+    "dist-esm/**/*.js",
+    "dist-esm/**/*.js.map",
+    "dist-esm/**/*.d.ts",
+    "dist-esm/**/*.d.ts.map",
+    "src/**/*.ts",
+    "README.md",
+    "LICENSE",
+    "rollup.config.js",
+    "tsconfig.json",
+    "review/*",
+    "CHANGELOG.md",
+    "types/*"
+  ],
+  "scripts": {
+    "build": "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
+    "minify": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
+    "prepack": "npm run build",
+    "pack": "npm pack 2>&1",
+    "extract-api": "api-extractor run --local",
+    "lint": "echo skipped",
+    "audit": "echo skipped",
+    "clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log",
+    "build:node": "echo skipped",
+    "build:browser": "echo skipped",
+    "build:test": "echo skipped",
+    "build:samples": "echo skipped.",
+    "check-format": "echo skipped",
+    "execute:samples": "echo skipped",
+    "format": "echo skipped",
+    "test": "npm run integration-test",
+    "test:node": "echo skipped",
+    "test:browser": "echo skipped",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
+    "unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
+    "unit-test:browser": "echo skipped",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js",
+    "integration-test:browser": "echo skipped",
+    "docs": "echo skipped"
+  },
+  "sideEffects": false,
+  "autoPublish": true
+}