Skip to content

Commit 232999b

Browse files
author
SDKAuto
committed
CodeGen from PR 29440 in Azure/azure-rest-api-specs
Merge 495ee87e131eed7c14f3033a79d38449b223307a into 7bf13ef1c776f6d973b9645906281d0ec4660fc8
1 parent e798d47 commit 232999b

20 files changed

Lines changed: 893 additions & 570 deletions

common/config/rush/pnpm-lock.yaml

Lines changed: 394 additions & 392 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sdk/devcenter/developer-devcenter-rest/.eslintrc.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
"rules": {
55
"@azure/azure-sdk/ts-modules-only-named": "warn",
66
"@azure/azure-sdk/ts-apiextractor-json-types": "warn",
7-
"tsdoc/syntax": "warn"
7+
"@azure/azure-sdk/ts-package-json-types": "warn",
8+
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
9+
"tsdoc/syntax": "warn",
10+
"@azure/azure-sdk/ts-package-json-module": "off",
11+
"@azure/azure-sdk/ts-package-json-files-required": "off",
12+
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off"
813
}
914
}

sdk/devcenter/developer-devcenter-rest/README.md

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
# Azure DevCenter REST client library for JavaScript
22

3-
4-
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-
6-
Use the package for Azure DevCenter to:
7-
> Create, access, manage, and delete Dev Box resources
8-
> Create, deploy, manage, and delete Environment resources
9-
103
DevCenter service
114

125
**Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
@@ -27,9 +20,7 @@ Key links:
2720
### Prerequisites
2821

2922
- 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
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-
23+
3324
### Install the `@azure-rest/developer-devcenter` package
3425

3526
Install the Azure DevCenter REST client REST client library for JavaScript with `npm`:
@@ -50,19 +41,8 @@ After setup, you can choose which type of [credential](https://github.com/Azure/
5041
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
5142
can be used to authenticate the client.
5243

53-
Set the value of dev center endpoint as environment variable:
54-
DEVCENTER_ENDPOINT
55-
56-
## Key Concepts
57-
58-
### REST Client
59-
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-
62-
### DevCenter Concepts
63-
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-
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.
44+
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
45+
AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
6646

6747
## Troubleshooting
6848

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,31 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
33
"mainEntryPointFilePath": "./dist/esm/index.d.ts",
4-
"docModel": { "enabled": true },
5-
"apiReport": { "enabled": true, "reportFolder": "./review" },
4+
"docModel": {
5+
"enabled": true
6+
},
7+
"apiReport": {
8+
"enabled": true,
9+
"reportFolder": "./review"
10+
},
611
"dtsRollup": {
712
"enabled": true,
813
"untrimmedFilePath": "",
914
"publicTrimmedFilePath": "./types/developer-devcenter.d.ts"
1015
},
1116
"messages": {
12-
"tsdocMessageReporting": { "default": { "logLevel": "none" } },
17+
"tsdocMessageReporting": {
18+
"default": {
19+
"logLevel": "none"
20+
}
21+
},
1322
"extractorMessageReporting": {
14-
"ae-missing-release-tag": { "logLevel": "none" },
15-
"ae-unresolved-link": { "logLevel": "none" }
23+
"ae-missing-release-tag": {
24+
"logLevel": "none"
25+
},
26+
"ae-unresolved-link": {
27+
"logLevel": "none"
28+
}
1629
}
1730
}
18-
}
31+
}

sdk/devcenter/developer-devcenter-rest/package.json

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@
6060
"@azure/core-rest-pipeline": "^1.5.0",
6161
"@azure/logger": "^1.0.0",
6262
"tslib": "^2.6.2",
63-
"@azure/core-lro": "^2.5.4",
64-
"@azure/abort-controller": "^1.0.0",
63+
"@azure/core-lro": "3.0.0-beta.1",
64+
"@azure/abort-controller": "^2.0.0",
6565
"@azure/core-paging": "^1.5.0"
6666
},
6767
"devDependencies": {
@@ -75,9 +75,9 @@
7575
"typescript": "~5.4.5",
7676
"tshy": "^1.11.1",
7777
"@azure/core-util": "^1.0.0",
78-
"@azure-tools/test-credential": "^2.0.0",
78+
"@azure-tools/test-credential": "^1.1.0",
7979
"@azure/identity": "^4.0.1",
80-
"@azure-tools/test-recorder": "^4.0.0",
80+
"@azure-tools/test-recorder": "^3.0.0",
8181
"@vitest/browser": "^1.3.1",
8282
"@vitest/coverage-istanbul": "^1.3.1",
8383
"playwright": "^1.41.2",
@@ -92,8 +92,8 @@
9292
"lint": "eslint package.json api-extractor.json src test --ext .ts --ext .cts --ext .mts",
9393
"lint:fix": "eslint package.json api-extractor.json src test --ext .ts --ext .cts --ext .mts --fix --fix-type [problem,suggestion]",
9494
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
95-
"unit-test:browser": "echo skipped",
96-
"unit-test:node": "dev-tool run test:vitest -- -c vitest.config.ts",
95+
"unit-test:browser": "npm run build:test && dev-tool run test:vitest --no-test-proxy --browser",
96+
"unit-test:node": "dev-tool run test:vitest --no-test-proxy",
9797
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
9898
"integration-test:browser": "echo skipped",
9999
"integration-test:node": "echo skipped",
@@ -114,30 +114,27 @@
114114
"./package.json": "./package.json",
115115
".": {
116116
"browser": {
117+
"source": "./src/index.ts",
117118
"types": "./dist/browser/index.d.ts",
118119
"default": "./dist/browser/index.js"
119120
},
120121
"react-native": {
122+
"source": "./src/index.ts",
121123
"types": "./dist/react-native/index.d.ts",
122124
"default": "./dist/react-native/index.js"
123125
},
124126
"import": {
127+
"source": "./src/index.ts",
125128
"types": "./dist/esm/index.d.ts",
126129
"default": "./dist/esm/index.js"
127130
},
128131
"require": {
132+
"source": "./src/index.ts",
129133
"types": "./dist/commonjs/index.d.ts",
130134
"default": "./dist/commonjs/index.js"
131135
}
132136
}
133137
},
134138
"main": "./dist/commonjs/index.js",
135-
"types": "./dist/commonjs/index.d.ts",
136-
"//sampleConfiguration": {
137-
"productName": "Azure DevCenter",
138-
"productSlugs": [
139-
"azure"
140-
],
141-
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure-rest/developer-devcenter"
142-
}
143-
}
139+
"types": "./dist/commonjs/index.d.ts"
140+
}

sdk/devcenter/developer-devcenter-rest/review/developer-devcenter.api.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
55
```ts
66

7+
import { AbortSignalLike } from '@azure/abort-controller';
8+
import { CancelOnProgress } from '@azure/core-lro';
79
import { Client } from '@azure-rest/core-client';
810
import { ClientOptions } from '@azure-rest/core-client';
911
import { CreateHttpPollerOptions } from '@azure/core-lro';
@@ -16,7 +18,6 @@ import { PagedAsyncIterableIterator } from '@azure/core-paging';
1618
import { PathUncheckedResponse } from '@azure-rest/core-client';
1719
import { RawHttpHeaders } from '@azure/core-rest-pipeline';
1820
import { RequestParameters } from '@azure-rest/core-client';
19-
import { SimplePollerLike } from '@azure/core-lro';
2021
import { StreamableMethod } from '@azure-rest/core-client';
2122
import { TokenCredential } from '@azure/core-auth';
2223

@@ -439,7 +440,7 @@ export type EnvironmentTypeEnableStatusOutput = "Enabled" | "Disabled" | string;
439440
// @public
440441
export interface EnvironmentTypeOutput {
441442
deploymentTargetId: string;
442-
name: string;
443+
readonly name: string;
443444
status: EnvironmentTypeEnableStatusOutput;
444445
}
445446

@@ -1534,6 +1535,27 @@ export interface ScheduleOutput {
15341535
type: ScheduledTypeOutput;
15351536
}
15361537

1538+
// @public
1539+
export interface SimplePollerLike<TState extends OperationState<TResult>, TResult> {
1540+
getOperationState(): TState;
1541+
getResult(): TResult | undefined;
1542+
isDone(): boolean;
1543+
isStopped(): boolean;
1544+
onProgress(callback: (state: TState) => void): CancelOnProgress;
1545+
poll(options?: {
1546+
abortSignal?: AbortSignalLike;
1547+
}): Promise<TState>;
1548+
pollUntilDone(pollOptions?: {
1549+
abortSignal?: AbortSignalLike;
1550+
}): Promise<TResult>;
1551+
serialize(): Promise<string>;
1552+
// @deprecated
1553+
stopPolling(): void;
1554+
submitted(): Promise<void>;
1555+
// @deprecated
1556+
toString(): string;
1557+
}
1558+
15371559
// @public (undocumented)
15381560
export interface SkipAction {
15391561
post(options?: SkipActionParameters): StreamableMethod<SkipAction204Response | SkipActionDefaultResponse>;

sdk/devcenter/developer-devcenter-rest/src/azureDeveloperDevCenter.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,17 @@ export default function createClient(
3333
logger: options.loggingOptions?.logger ?? logger.info,
3434
},
3535
credentials: {
36-
scopes: options.credentials?.scopes ?? ["https://devcenter.azure.com/.default"],
36+
scopes: options.credentials?.scopes ?? [
37+
"https://devcenter.azure.com/.default",
38+
],
3739
},
3840
};
3941

40-
const client = getClient(endpointUrl, credentials, options) as AzureDeveloperDevCenterClient;
42+
const client = getClient(
43+
endpointUrl,
44+
credentials,
45+
options,
46+
) as AzureDeveloperDevCenterClient;
4147

4248
return client;
4349
}

0 commit comments

Comments
 (0)