@azure-rest/developer-devcenter 1.0.1-alpha.20241213.1 → 1.0.1-alpha.20241218.1
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 +6 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# Azure DevCenter REST client library for JavaScript
|
|
2
2
|
|
|
3
|
-
|
|
4
3
|
The Azure DevCenter library provides access to manage resources for Microsoft Dev Box and Azure Deployment Environments. This package enables managing developer machines and environments in Azure.
|
|
5
4
|
|
|
6
5
|
Use the package for Azure DevCenter to:
|
|
6
|
+
|
|
7
7
|
> Create, access, manage, and delete Dev Box resources
|
|
8
8
|
> Create, deploy, manage, and delete Environment resources
|
|
9
9
|
|
|
@@ -15,7 +15,7 @@ Key links:
|
|
|
15
15
|
|
|
16
16
|
- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/devcenter/developer-devcenter-rest)
|
|
17
17
|
- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/developer-devcenter)
|
|
18
|
-
- [API reference documentation](https://
|
|
18
|
+
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/developer-devcenter)
|
|
19
19
|
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/devcenter/developer-devcenter-rest/samples)
|
|
20
20
|
|
|
21
21
|
## Getting started
|
|
@@ -27,9 +27,9 @@ Key links:
|
|
|
27
27
|
### Prerequisites
|
|
28
28
|
|
|
29
29
|
- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
|
|
30
|
-
- You must have [configured](https://learn.microsoft.com/azure/dev-box/quickstart-configure-dev-box-service) a DevCenter, Project, Network Connection, Dev Box Definition, and Pool before you can create Dev Boxes
|
|
30
|
+
- You must have [configured](https://learn.microsoft.com/azure/dev-box/quickstart-configure-dev-box-service) a DevCenter, Project, Network Connection, Dev Box Definition, and Pool before you can create Dev Boxes
|
|
31
31
|
- You must have [configured](https://learn.microsoft.com/azure/deployment-environments/) a DevCenter, Project, Catalog, and Environment Type before you can create Environments
|
|
32
|
-
|
|
32
|
+
|
|
33
33
|
### Install the `@azure-rest/developer-devcenter` package
|
|
34
34
|
|
|
35
35
|
Install the Azure DevCenter REST client REST client library for JavaScript with `npm`:
|
|
@@ -44,7 +44,7 @@ To use an [Azure Active Directory (AAD) token credential](https://github.com/Azu
|
|
|
44
44
|
provide an instance of the desired credential type obtained from the
|
|
45
45
|
[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
|
|
46
46
|
|
|
47
|
-
To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)
|
|
47
|
+
To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)
|
|
48
48
|
|
|
49
49
|
After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
|
|
50
50
|
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
|
|
@@ -60,6 +60,7 @@ DEVCENTER_ENDPOINT
|
|
|
60
60
|
This client is one of our REST clients. We highly recommend you read how to use a REST client [here](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md).
|
|
61
61
|
|
|
62
62
|
### DevCenter Concepts
|
|
63
|
+
|
|
63
64
|
Dev Boxes refer to managed developer machines running in Azure. Dev Boxes are provisioned in Pools, which define the network and image used for a Dev Box.
|
|
64
65
|
|
|
65
66
|
Environments refer to templated developer environments, which combine a template (Catalog Item) and parameters, as well as an Environment Type which defines permissions and where the resources are deployed.
|
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.20241218.1",
|
|
4
4
|
"description": "Azure Developer DevCenter Client",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18.0.0"
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
"dotenv": "^16.0.0",
|
|
79
79
|
"eslint": "^9.9.0",
|
|
80
80
|
"playwright": "^1.41.2",
|
|
81
|
-
"typescript": "~5.
|
|
81
|
+
"typescript": "~5.7.2",
|
|
82
82
|
"vitest": "^2.0.5"
|
|
83
83
|
},
|
|
84
84
|
"scripts": {
|