@azure-rest/developer-devcenter 1.0.1-alpha.20250127.1 → 1.0.1-alpha.20250129.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -3
- package/package.json +41 -40
- package/CHANGELOG.md +0 -83
- package/review/developer-devcenter.api.md +0 -1764
package/README.md
CHANGED
|
@@ -51,7 +51,15 @@ As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-j
|
|
|
51
51
|
can be used to authenticate the client.
|
|
52
52
|
|
|
53
53
|
Set the value of dev center endpoint as environment variable:
|
|
54
|
-
DEVCENTER_ENDPOINT
|
|
54
|
+
`DEVCENTER_ENDPOINT`
|
|
55
|
+
|
|
56
|
+
```ts snippet:ReadmeSampleCreateClient_Node
|
|
57
|
+
import AzureDeveloperDevCenter from "@azure-rest/developer-devcenter";
|
|
58
|
+
import { DefaultAzureCredential } from "@azure/identity";
|
|
59
|
+
|
|
60
|
+
const endpoint = process.env["DEVCENTER_ENDPOINT"] || "<endpoint>";
|
|
61
|
+
const client = AzureDeveloperDevCenter(endpoint, new DefaultAzureCredential());
|
|
62
|
+
```
|
|
55
63
|
|
|
56
64
|
## Key Concepts
|
|
57
65
|
|
|
@@ -71,8 +79,8 @@ Environments refer to templated developer environments, which combine a template
|
|
|
71
79
|
|
|
72
80
|
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
|
|
73
81
|
|
|
74
|
-
```
|
|
75
|
-
|
|
82
|
+
```ts snippet:SetLogLevel
|
|
83
|
+
import { setLogLevel } from "@azure/logger";
|
|
76
84
|
|
|
77
85
|
setLogLevel("info");
|
|
78
86
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@azure-rest/developer-devcenter",
|
|
3
|
-
"version": "1.0.1-alpha.
|
|
3
|
+
"version": "1.0.1-alpha.20250129.2",
|
|
4
4
|
"description": "Azure Developer DevCenter Client",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18.0.0"
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
"sideEffects": false,
|
|
9
9
|
"autoPublish": false,
|
|
10
10
|
"tshy": {
|
|
11
|
+
"project": "./tsconfig.src.json",
|
|
11
12
|
"exports": {
|
|
12
13
|
"./package.json": "./package.json",
|
|
13
14
|
".": "./src/index.ts"
|
|
@@ -20,8 +21,7 @@
|
|
|
20
21
|
"browser",
|
|
21
22
|
"react-native"
|
|
22
23
|
],
|
|
23
|
-
"selfLink": false
|
|
24
|
-
"project": "./tsconfig.src.json"
|
|
24
|
+
"selfLink": false
|
|
25
25
|
},
|
|
26
26
|
"type": "module",
|
|
27
27
|
"keywords": [
|
|
@@ -35,11 +35,9 @@
|
|
|
35
35
|
"author": "Microsoft Corporation",
|
|
36
36
|
"license": "MIT",
|
|
37
37
|
"files": [
|
|
38
|
-
"dist",
|
|
38
|
+
"dist/",
|
|
39
39
|
"README.md",
|
|
40
|
-
"LICENSE"
|
|
41
|
-
"review/*",
|
|
42
|
-
"CHANGELOG.md"
|
|
40
|
+
"LICENSE"
|
|
43
41
|
],
|
|
44
42
|
"sdk-type": "client",
|
|
45
43
|
"repository": "github:Azure/azure-sdk-for-js",
|
|
@@ -58,53 +56,54 @@
|
|
|
58
56
|
},
|
|
59
57
|
"dependencies": {
|
|
60
58
|
"@azure-rest/core-client": "^2.3.1",
|
|
61
|
-
"@azure/
|
|
62
|
-
"@azure/core-
|
|
63
|
-
"@azure/logger": "^1.0.0",
|
|
64
|
-
"tslib": "^2.6.2",
|
|
59
|
+
"@azure/abort-controller": "^2.1.2",
|
|
60
|
+
"@azure/core-auth": "^1.9.0",
|
|
65
61
|
"@azure/core-lro": "^3.1.0",
|
|
66
|
-
"@azure/
|
|
62
|
+
"@azure/core-rest-pipeline": "^1.18.2",
|
|
63
|
+
"@azure/logger": "^1.1.4",
|
|
64
|
+
"tslib": "^2.8.1"
|
|
67
65
|
},
|
|
68
66
|
"devDependencies": {
|
|
69
|
-
"
|
|
67
|
+
"@azure-tools/test-credential": "^2.0.0",
|
|
68
|
+
"@azure-tools/test-recorder": ">=4.1.0-alpha <4.1.0-alphb",
|
|
69
|
+
"@azure-tools/test-utils-vitest": ">=1.0.0-alpha <1.0.0-alphb",
|
|
70
|
+
"@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
|
|
71
|
+
"@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
|
|
72
|
+
"@azure/identity": "^4.6.0",
|
|
73
|
+
"@azure/logger": "^1.1.4",
|
|
70
74
|
"@types/node": "^18.0.0",
|
|
71
|
-
"eslint": "^8.55.0",
|
|
72
|
-
"typescript": "~5.7.2",
|
|
73
|
-
"tshy": "^2.0.0",
|
|
74
|
-
"@azure/identity": "^4.2.1",
|
|
75
75
|
"@vitest/browser": "^3.0.3",
|
|
76
76
|
"@vitest/coverage-istanbul": "^3.0.3",
|
|
77
|
-
"
|
|
78
|
-
"
|
|
79
|
-
"
|
|
80
|
-
"
|
|
81
|
-
"
|
|
82
|
-
"@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb"
|
|
77
|
+
"dotenv": "^16.0.0",
|
|
78
|
+
"eslint": "^9.9.0",
|
|
79
|
+
"playwright": "^1.50.0",
|
|
80
|
+
"typescript": "~5.7.2",
|
|
81
|
+
"vitest": "^3.0.3"
|
|
83
82
|
},
|
|
84
83
|
"scripts": {
|
|
85
|
-
"
|
|
86
|
-
"extract-api": "dev-tool run vendored rimraf review && dev-tool run extract-api",
|
|
87
|
-
"pack": "npm pack 2>&1",
|
|
88
|
-
"lint": "eslint package.json api-extractor.json src test",
|
|
89
|
-
"lint:fix": "eslint package.json api-extractor.json src test --fix --fix-type [problem,suggestion]",
|
|
90
|
-
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
|
|
91
|
-
"unit-test:browser": "echo skipped",
|
|
92
|
-
"unit-test:node": "dev-tool run test:vitest",
|
|
93
|
-
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
|
|
94
|
-
"integration-test:browser": "echo skipped",
|
|
95
|
-
"integration-test:node": "echo skipped",
|
|
84
|
+
"build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
|
|
96
85
|
"build:samples": "echo skipped",
|
|
86
|
+
"build:test": "npm run clean && dev-tool run build-package && dev-tool run build-test",
|
|
97
87
|
"check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ",
|
|
88
|
+
"clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
|
|
98
89
|
"execute:samples": "echo skipped",
|
|
90
|
+
"extract-api": "dev-tool run vendored rimraf review && dev-tool run extract-api",
|
|
99
91
|
"format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ",
|
|
100
92
|
"generate:client": "echo skipped",
|
|
101
|
-
"test
|
|
93
|
+
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
|
|
94
|
+
"integration-test:browser": "echo skipped",
|
|
95
|
+
"integration-test:node": "echo skipped",
|
|
96
|
+
"lint": "eslint package.json api-extractor.json src test",
|
|
97
|
+
"lint:fix": "eslint package.json api-extractor.json src test --fix --fix-type [problem,suggestion]",
|
|
102
98
|
"minify": "dev-tool run vendored uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
|
|
103
|
-
"
|
|
104
|
-
"build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
|
|
105
|
-
"test:node": "npm run clean && dev-tool run build-package && npm run unit-test:node && npm run integration-test:node",
|
|
99
|
+
"pack": "npm pack 2>&1",
|
|
106
100
|
"test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test",
|
|
107
|
-
"
|
|
101
|
+
"test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
|
|
102
|
+
"test:node": "npm run clean && dev-tool run build-package && npm run unit-test:node && npm run integration-test:node",
|
|
103
|
+
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
|
|
104
|
+
"unit-test:browser": "echo skipped",
|
|
105
|
+
"unit-test:node": "dev-tool run test:vitest",
|
|
106
|
+
"update-snippets": "dev-tool run update-snippets"
|
|
108
107
|
},
|
|
109
108
|
"exports": {
|
|
110
109
|
"./package.json": "./package.json",
|
|
@@ -129,5 +128,7 @@
|
|
|
129
128
|
},
|
|
130
129
|
"main": "./dist/commonjs/index.js",
|
|
131
130
|
"types": "./dist/commonjs/index.d.ts",
|
|
132
|
-
"module": "./dist/esm/index.js"
|
|
131
|
+
"module": "./dist/esm/index.js",
|
|
132
|
+
"browser": "./dist/browser/index.js",
|
|
133
|
+
"react-native": "./dist/react-native/index.js"
|
|
133
134
|
}
|
package/CHANGELOG.md
DELETED
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
# Release History
|
|
2
|
-
|
|
3
|
-
## 1.0.1 (2024-12-16)
|
|
4
|
-
|
|
5
|
-
### Features Added
|
|
6
|
-
|
|
7
|
-
- refresh @azure-rest/developer-devcenter sdk
|
|
8
|
-
|
|
9
|
-
## 1.0.0 (2024-07-08)
|
|
10
|
-
|
|
11
|
-
This release targets Azure Dev Center 2023-04-01 General Available API, which is the same version as the previous 1.0.0-beta.3 release.
|
|
12
|
-
|
|
13
|
-
### Features Added
|
|
14
|
-
|
|
15
|
-
- Added output types:
|
|
16
|
-
- DevBoxActionDelayResultStatusOutput
|
|
17
|
-
- DevBoxActionTypeOutput
|
|
18
|
-
- DevBoxProvisioningStateOutput
|
|
19
|
-
- EnvironmentProvisioningStateOutput
|
|
20
|
-
- EnvironmentTypeEnableStatusOutput
|
|
21
|
-
- HibernateSupportOutput
|
|
22
|
-
- LocalAdminStatusOutput
|
|
23
|
-
- OperationStateOutput
|
|
24
|
-
- OsTypeOutput
|
|
25
|
-
- ParameterTypeOutput
|
|
26
|
-
- PoolHealthStatusOutput
|
|
27
|
-
- PowerStateOutput
|
|
28
|
-
- ScheduledFrequencyOutput
|
|
29
|
-
- ScheduledTypeOutput
|
|
30
|
-
- SkuNameOutput
|
|
31
|
-
- StopOnDisconnectEnableStatusOutput
|
|
32
|
-
|
|
33
|
-
### Breaking Changes
|
|
34
|
-
|
|
35
|
-
- Rename interfaces to match operation names in Dev Center API documentation
|
|
36
|
-
- ListSchedules was renamed to ListSchedulesByPool
|
|
37
|
-
- GetSchedule was renamed to GetScheduleByPool
|
|
38
|
-
- ListDevBoxes was renamed to ListDevBoxesByUser
|
|
39
|
-
- GetDevBox was renamed to GetDevBoxByUser
|
|
40
|
-
- ListDevBoxActions was renamed to ListActions
|
|
41
|
-
- GetDevBoxAction was renamed to GetAction
|
|
42
|
-
- DelayAllActions was renamed to DelayActions
|
|
43
|
-
- ListAllEnvironments was renamed to ListEnvironments
|
|
44
|
-
- ListEnvironments was renamed to ListEnvironmentsByUser
|
|
45
|
-
- GetEnvironment was renamed to GetEnvironmentByUser
|
|
46
|
-
- CreateOrUpdateEnvironment was renamed to CreateOrReplaceEnvironment
|
|
47
|
-
- ListCatalogs was renamed to ListCatalogsByProject
|
|
48
|
-
- ListEnvironmentDefinitions was renamed to listEnvironmentDefinitionsByProject
|
|
49
|
-
|
|
50
|
-
## 1.0.0-beta.3 (2023-11-20)
|
|
51
|
-
This release updates the Azure DevCenter library to use the 2023-04-01 GA API.
|
|
52
|
-
|
|
53
|
-
### Breaking Changes
|
|
54
|
-
|
|
55
|
-
- Environments client now works with "environment definitions" instead of "catalog items"
|
|
56
|
-
- Creating a new environment requires passing `environmentDefinitionName` instead of `catalogItemName`
|
|
57
|
-
- Creating a new environment requires passing an additional parameter `catalogName`
|
|
58
|
-
|
|
59
|
-
## 1.0.0-beta.2 (2023-02-07)
|
|
60
|
-
|
|
61
|
-
This release updates the Azure DevCenter library to use the 2022-11-11-preview API.
|
|
62
|
-
|
|
63
|
-
### Breaking Changes
|
|
64
|
-
|
|
65
|
-
- `createClient` now accepts an endpoint URI on construction rather than tenant ID + dev center name.
|
|
66
|
-
|
|
67
|
-
### Features Added
|
|
68
|
-
|
|
69
|
-
- Added upcoming actions APIs to dev boxes.
|
|
70
|
-
- `/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions`
|
|
71
|
-
- `/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}`
|
|
72
|
-
- `/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}:skip`
|
|
73
|
-
- `/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}:delay`
|
|
74
|
-
|
|
75
|
-
### Bugs Fixed
|
|
76
|
-
- Invalid response types removed from `DeleteDevBox`, `StartDevBox`, and `StopDevBox` APIs.
|
|
77
|
-
- Invalid `DeleteEnvironmentAction` API removed from `EnvironmentsClient`.
|
|
78
|
-
- Unimplemented artifacts APIs removed from `EnvironmentsClient`.
|
|
79
|
-
|
|
80
|
-
## 1.0.0-beta.1 (2022-11-11)
|
|
81
|
-
|
|
82
|
-
### Features Added
|
|
83
|
-
Initial release of the Azure DevCenter package
|