Skip to content

Commit e8109d6

Browse files
authored
[mgmt] quantum release (#28880)
Azure/sdk-release-request#4998
1 parent d738efb commit e8109d6

File tree

57 files changed

+1804
-1161
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+1804
-1161
lines changed

common/config/rush/pnpm-lock.yaml

Lines changed: 382 additions & 381 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,33 @@
11
# Release History
2+
3+
## 1.0.0-beta.2 (2024-03-12)
4+
5+
**Features**
26

3-
## 1.0.0-beta.2 (Unreleased)
7+
- Added operation Workspace.listKeys
8+
- Added operation Workspace.regenerateKeys
9+
- Added Interface ApiKey
10+
- Added Interface APIKeys
11+
- Added Interface ListKeysResult
12+
- Added Interface WorkspaceListKeysOptionalParams
13+
- Added Interface WorkspaceRegenerateKeysOptionalParams
14+
- Added Interface WorkspaceResourceProperties
15+
- Added Type Alias KeyType_2
16+
- Added Type Alias WorkspaceListKeysResponse
17+
- Interface QuantumWorkspace has a new optional parameter properties
18+
- Interface Resource has a new optional parameter systemData
19+
- Added Enum KnownKeyType
420

5-
### Features Added
6-
7-
### Breaking Changes
8-
9-
### Bugs Fixed
10-
11-
### Other Changes
21+
**Breaking Changes**
1222

23+
- Interface QuantumWorkspace no longer has parameter endpointUri
24+
- Interface QuantumWorkspace no longer has parameter providers
25+
- Interface QuantumWorkspace no longer has parameter provisioningState
26+
- Interface QuantumWorkspace no longer has parameter storageAccount
27+
- Interface QuantumWorkspace no longer has parameter systemData
28+
- Interface QuantumWorkspace no longer has parameter usable
29+
30+
1331
## 1.0.0-beta.1 (2023-07-10)
1432

1533
The package of @azure/arm-quantum is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart ).

sdk/quantum/arm-quantum/LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2023 Microsoft
3+
Copyright (c) 2024 Microsoft
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

sdk/quantum/arm-quantum/_meta.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"commit": "0f39a2d56070d2bc4251494525cb8af88583a938",
2+
"commit": "c45a7f47c1901149828eb8a33c74898c554659c0",
33
"readme": "specification/quantum/resource-manager/readme.md",
4-
"autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\quantum\\resource-manager\\readme.md --use=@autorest/[email protected].5 --generate-sample=true",
4+
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\quantum\\resource-manager\\readme.md --use=@autorest/[email protected].17 --generate-sample=true",
55
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
6-
"release_tool": "@azure-tools/[email protected].0",
7-
"use": "@autorest/[email protected].5"
6+
"release_tool": "@azure-tools/[email protected].4",
7+
"use": "@autorest/[email protected].17"
88
}

sdk/quantum/arm-quantum/assets.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"AssetsRepo": "Azure/azure-sdk-assets",
33
"AssetsRepoPrefixPath": "js",
44
"TagPrefix": "js/quantum/arm-quantum",
5-
"Tag": "js/quantum/arm-quantum_7d980c2b33"
5+
"Tag": "js/quantum/arm-quantum_722240f12d"
66
}

sdk/quantum/arm-quantum/package.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
"node": ">=18.0.0"
99
},
1010
"dependencies": {
11-
"@azure/core-lro": "^2.5.3",
11+
"@azure/core-lro": "^2.5.4",
1212
"@azure/abort-controller": "^1.0.0",
1313
"@azure/core-paging": "^1.2.0",
1414
"@azure/core-client": "^1.7.0",
15-
"@azure/core-auth": "^1.3.0",
16-
"@azure/core-rest-pipeline": "^1.8.0",
15+
"@azure/core-auth": "^1.6.0",
16+
"@azure/core-rest-pipeline": "^1.14.0",
1717
"tslib": "^2.2.0"
1818
},
1919
"keywords": [
@@ -32,19 +32,20 @@
3232
"mkdirp": "^2.1.2",
3333
"typescript": "~5.3.3",
3434
"uglify-js": "^3.4.9",
35-
"rimraf": "^5.0.5",
35+
"rimraf": "^5.0.0",
3636
"dotenv": "^16.0.0",
37+
"@azure/dev-tool": "^1.0.0",
3738
"@azure/identity": "^4.0.1",
3839
"@azure-tools/test-recorder": "^3.0.0",
3940
"@azure-tools/test-credential": "^1.0.0",
4041
"mocha": "^10.0.0",
42+
"@types/mocha": "^10.0.0",
43+
"esm": "^3.2.18",
4144
"@types/chai": "^4.2.8",
4245
"chai": "^4.2.0",
4346
"cross-env": "^7.0.2",
4447
"@types/node": "^18.0.0",
45-
"@azure/dev-tool": "^1.0.0",
46-
"ts-node": "^10.0.0",
47-
"@types/mocha": "^10.0.0"
48+
"ts-node": "^10.0.0"
4849
},
4950
"repository": {
5051
"type": "git",
@@ -77,7 +78,6 @@
7778
"pack": "npm pack 2>&1",
7879
"extract-api": "api-extractor run --local",
7980
"lint": "echo skipped",
80-
"audit": "echo skipped",
8181
"clean": "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
8282
"build:node": "echo skipped",
8383
"build:browser": "echo skipped",
@@ -115,4 +115,4 @@
115115
"disableDocsMs": true,
116116
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-quantum?view=azure-node-preview"
117117
}
118-
}
118+
}

sdk/quantum/arm-quantum/review/arm-quantum.api.md

Lines changed: 55 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@ import { OperationState } from '@azure/core-lro';
1010
import { PagedAsyncIterableIterator } from '@azure/core-paging';
1111
import { SimplePollerLike } from '@azure/core-lro';
1212

13+
// @public
14+
export interface ApiKey {
15+
createdAt?: Date;
16+
readonly key?: string;
17+
}
18+
19+
// @public
20+
export interface APIKeys {
21+
keys?: KeyType_2[];
22+
}
23+
1324
// @public (undocumented)
1425
export class AzureQuantumManagementClient extends coreClient.ServiceClient {
1526
// (undocumented)
@@ -75,6 +86,10 @@ export interface ErrorResponse {
7586
// @public
7687
export function getContinuationToken(page: unknown): string | undefined;
7788

89+
// @public
90+
type KeyType_2 = string;
91+
export { KeyType_2 as KeyType }
92+
7893
// @public
7994
export enum KnownCreatedByType {
8095
Application = "Application",
@@ -83,6 +98,12 @@ export enum KnownCreatedByType {
8398
User = "User"
8499
}
85100

101+
// @public
102+
export enum KnownKeyType {
103+
Primary = "Primary",
104+
Secondary = "Secondary"
105+
}
106+
86107
// @public
87108
export enum KnownProvisioningStatus {
88109
Failed = "Failed",
@@ -116,6 +137,15 @@ export enum KnownUsableStatus {
116137
Yes = "Yes"
117138
}
118139

140+
// @public
141+
export interface ListKeysResult {
142+
apiKeyEnabled?: boolean;
143+
readonly primaryConnectionString?: string;
144+
primaryKey?: ApiKey;
145+
readonly secondaryConnectionString?: string;
146+
secondaryKey?: ApiKey;
147+
}
148+
119149
// @public
120150
export interface Offerings {
121151
list(locationName: string, options?: OfferingsListOptionalParams): PagedAsyncIterableIterator<ProviderDescription>;
@@ -241,13 +271,8 @@ export type ProvisioningStatus = string;
241271

242272
// @public
243273
export interface QuantumWorkspace extends TrackedResource {
244-
readonly endpointUri?: string;
245274
identity?: QuantumWorkspaceIdentity;
246-
providers?: Provider[];
247-
readonly provisioningState?: ProvisioningStatus;
248-
storageAccount?: string;
249-
readonly systemData?: SystemData;
250-
readonly usable?: UsableStatus;
275+
properties?: WorkspaceResourceProperties;
251276
}
252277

253278
// @public
@@ -273,6 +298,7 @@ export interface QuotaDimension {
273298
export interface Resource {
274299
readonly id?: string;
275300
readonly name?: string;
301+
readonly systemData?: SystemData;
276302
readonly type?: string;
277303
}
278304

@@ -335,6 +361,8 @@ export type UsableStatus = string;
335361
// @public
336362
export interface Workspace {
337363
checkNameAvailability(locationName: string, checkNameAvailabilityParameters: CheckNameAvailabilityParameters, options?: WorkspaceCheckNameAvailabilityOptionalParams): Promise<WorkspaceCheckNameAvailabilityResponse>;
364+
listKeys(resourceGroupName: string, workspaceName: string, options?: WorkspaceListKeysOptionalParams): Promise<WorkspaceListKeysResponse>;
365+
regenerateKeys(resourceGroupName: string, workspaceName: string, keySpecification: APIKeys, options?: WorkspaceRegenerateKeysOptionalParams): Promise<void>;
338366
}
339367

340368
// @public
@@ -344,12 +372,33 @@ export interface WorkspaceCheckNameAvailabilityOptionalParams extends coreClient
344372
// @public
345373
export type WorkspaceCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
346374

375+
// @public
376+
export interface WorkspaceListKeysOptionalParams extends coreClient.OperationOptions {
377+
}
378+
379+
// @public
380+
export type WorkspaceListKeysResponse = ListKeysResult;
381+
347382
// @public
348383
export interface WorkspaceListResult {
349384
nextLink?: string;
350385
value?: QuantumWorkspace[];
351386
}
352387

388+
// @public
389+
export interface WorkspaceRegenerateKeysOptionalParams extends coreClient.OperationOptions {
390+
}
391+
392+
// @public
393+
export interface WorkspaceResourceProperties {
394+
apiKeyEnabled?: boolean;
395+
readonly endpointUri?: string;
396+
providers?: Provider[];
397+
readonly provisioningState?: ProvisioningStatus;
398+
storageAccount?: string;
399+
readonly usable?: UsableStatus;
400+
}
401+
353402
// @public
354403
export interface Workspaces {
355404
beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, quantumWorkspace: QuantumWorkspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspacesCreateOrUpdateResponse>, WorkspacesCreateOrUpdateResponse>>;

sdk/quantum/arm-quantum/samples-dev/offeringsListSample.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ dotenv.config();
1818
* This sample demonstrates how to Returns the list of all provider offerings available for the given location.
1919
*
2020
* @summary Returns the list of all provider offerings available for the given location.
21-
* x-ms-original-file: specification/quantum/resource-manager/Microsoft.Quantum/preview/2022-01-10-preview/examples/offeringsList.json
21+
* x-ms-original-file: specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/offeringsList.json
2222
*/
2323
async function offeringsList() {
2424
const subscriptionId =

sdk/quantum/arm-quantum/samples-dev/operationsListSample.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ dotenv.config();
1818
* This sample demonstrates how to Returns list of operations.
1919
*
2020
* @summary Returns list of operations.
21-
* x-ms-original-file: specification/quantum/resource-manager/Microsoft.Quantum/preview/2022-01-10-preview/examples/operations.json
21+
* x-ms-original-file: specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/operations.json
2222
*/
2323
async function operations() {
2424
const subscriptionId =

sdk/quantum/arm-quantum/samples-dev/workspaceCheckNameAvailabilitySample.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
// Licensed under the MIT License.
1111
import {
1212
CheckNameAvailabilityParameters,
13-
AzureQuantumManagementClient
13+
AzureQuantumManagementClient,
1414
} from "@azure/arm-quantum";
1515
import { DefaultAzureCredential } from "@azure/identity";
1616
import * as dotenv from "dotenv";
@@ -21,7 +21,7 @@ dotenv.config();
2121
* This sample demonstrates how to Check the availability of the resource name.
2222
*
2323
* @summary Check the availability of the resource name.
24-
* x-ms-original-file: specification/quantum/resource-manager/Microsoft.Quantum/preview/2022-01-10-preview/examples/quantumWorkspacesCheckNameAvailability.json
24+
* x-ms-original-file: specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesCheckNameAvailability.json
2525
*/
2626
async function quantumWorkspacesCheckNameAvailability() {
2727
const subscriptionId =
@@ -30,13 +30,13 @@ async function quantumWorkspacesCheckNameAvailability() {
3030
const locationName = "westus2";
3131
const checkNameAvailabilityParameters: CheckNameAvailabilityParameters = {
3232
name: "sample-workspace-name",
33-
type: "Microsoft.Quantum/Workspaces"
33+
type: "Microsoft.Quantum/Workspaces",
3434
};
3535
const credential = new DefaultAzureCredential();
3636
const client = new AzureQuantumManagementClient(credential, subscriptionId);
3737
const result = await client.workspace.checkNameAvailability(
3838
locationName,
39-
checkNameAvailabilityParameters
39+
checkNameAvailabilityParameters,
4040
);
4141
console.log(result);
4242
}

0 commit comments

Comments
 (0)