diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index b52e8ad158be..f14cf0d126b3 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -16705,7 +16705,7 @@ packages: dev: false file:projects/arm-subscriptions.tgz: - resolution: {integrity: sha512-Eo6Okn9MfBzDiO911iU5Jgj7YZOYO1FTeYR5adc6qAIZqRiFy3gr9G1MP+oGafOPt2NMYOVeng44dMzG/G7TKg==, tarball: file:projects/arm-subscriptions.tgz} + resolution: {integrity: sha512-uNNeEoIAKUIaRA7WBBlsMhFdQxP+Y20LPKWKatGAopOIQao6xiUk98ELwQn8DPJp2F+y+pg/Et59j4YC9udliA==, tarball: file:projects/arm-subscriptions.tgz} name: '@rush-temp/arm-subscriptions' version: 0.0.0 dependencies: @@ -16719,7 +16719,8 @@ packages: '@types/node': 14.18.51 chai: 4.3.7 cross-env: 7.0.3 - mkdirp: 1.0.4 + dotenv: 16.3.1 + mkdirp: 2.1.6 mocha: 7.2.0 rimraf: 3.0.2 rollup: 2.79.1 diff --git a/sdk/subscription/arm-subscriptions/CHANGELOG.md b/sdk/subscription/arm-subscriptions/CHANGELOG.md index d5254d285bc1..3efe756ae86a 100644 --- a/sdk/subscription/arm-subscriptions/CHANGELOG.md +++ b/sdk/subscription/arm-subscriptions/CHANGELOG.md @@ -1,15 +1,19 @@ # Release History + +## 5.2.0 (2023-06-20) + +**Features** -## 5.1.1 (Unreleased) - -### Features Added - -### Breaking Changes - -### Bugs Fixed - -### Other Changes - + - Added operation group SubscriptionOperation + - Added Interface ErrorAdditionalInfo + - Added Interface ErrorDetail + - Added Interface ErrorResponseAutoGenerated + - Added Interface SubscriptionCreationResult + - Added Interface SubscriptionOperationGetHeaders + - Added Interface SubscriptionOperationGetOptionalParams + - Added Type Alias SubscriptionOperationGetResponse + + ## 5.1.0 (2022-11-11) **Features** diff --git a/sdk/subscription/arm-subscriptions/LICENSE b/sdk/subscription/arm-subscriptions/LICENSE index 5d1d36e0af80..3a1d9b6f24f7 100644 --- a/sdk/subscription/arm-subscriptions/LICENSE +++ b/sdk/subscription/arm-subscriptions/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2022 Microsoft +Copyright (c) 2023 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 diff --git a/sdk/subscription/arm-subscriptions/_meta.json b/sdk/subscription/arm-subscriptions/_meta.json index 20c925dd32b1..9c3f7b04381e 100644 --- a/sdk/subscription/arm-subscriptions/_meta.json +++ b/sdk/subscription/arm-subscriptions/_meta.json @@ -1,8 +1,8 @@ { - "commit": "52a770004c3019a067e9dcdbb2e95b4992d42728", + "commit": "c75298342bd1b7b651606d90fd5fbc7f8b3515bd", "readme": "specification/subscription/resource-manager/readme.md", - "autorest_command": "autorest --version=3.8.4 --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\\subscription\\resource-manager\\readme.md --use=@autorest/typescript@6.0.0-rc.3.20221108.1 --generate-sample=true", + "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=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/subscription/resource-manager/readme.md --use=@autorest/typescript@^6.0.4", "repository_url": "https://github.com/Azure/azure-rest-api-specs.git", - "release_tool": "@azure-tools/js-sdk-release-tools@2.4.2", - "use": "@autorest/typescript@6.0.0-rc.3.20221108.1" + "release_tool": "@azure-tools/js-sdk-release-tools@2.7.1", + "use": "@autorest/typescript@^6.0.4" } \ No newline at end of file diff --git a/sdk/subscription/arm-subscriptions/package.json b/sdk/subscription/arm-subscriptions/package.json index f6ff8d91f977..c6908237c5ee 100644 --- a/sdk/subscription/arm-subscriptions/package.json +++ b/sdk/subscription/arm-subscriptions/package.json @@ -3,15 +3,15 @@ "sdk-type": "mgmt", "author": "Microsoft Corporation", "description": "A generated SDK for SubscriptionClient.", - "version": "5.1.1", + "version": "5.2.0", "engines": { "node": ">=14.0.0" }, "dependencies": { - "@azure/core-lro": "^2.2.0", + "@azure/core-lro": "^2.5.3", "@azure/abort-controller": "^1.0.0", "@azure/core-paging": "^1.2.0", - "@azure/core-client": "^1.6.1", + "@azure/core-client": "^1.7.0", "@azure/core-auth": "^1.3.0", "@azure/core-rest-pipeline": "^1.8.0", "tslib": "^2.2.0" @@ -33,12 +33,13 @@ "@rollup/plugin-json": "^6.0.0", "@rollup/plugin-multi-entry": "^6.0.0", "@rollup/plugin-node-resolve": "^13.1.3", - "mkdirp": "^1.0.4", + "mkdirp": "^2.1.2", "rollup": "^2.66.1", "rollup-plugin-sourcemaps": "^0.6.3", "typescript": "~5.0.0", "uglify-js": "^3.4.9", "rimraf": "^3.0.0", + "dotenv": "^16.0.0", "@azure/identity": "^2.0.1", "@azure-tools/test-recorder": "^3.0.0", "@azure-tools/test-credential": "^1.0.0", @@ -49,7 +50,6 @@ "@types/node": "^14.0.0", "@azure/dev-tool": "^1.0.0" }, - "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/subscription/arm-subscriptions", "repository": { "type": "git", "url": "https://github.com/Azure/azure-sdk-for-js.git" @@ -111,12 +111,5 @@ ] }, "autoPublish": true, - "//sampleConfiguration": { - "productName": "", - "productSlugs": [ - "azure" - ], - "disableDocsMs": true, - "apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-subscriptions?view=azure-node-preview" - } -} + "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/subscription/arm-subscriptions" +} \ No newline at end of file diff --git a/sdk/subscription/arm-subscriptions/review/arm-subscriptions.api.md b/sdk/subscription/arm-subscriptions/review/arm-subscriptions.api.md index b58f5417f295..8eefb2da01d5 100644 --- a/sdk/subscription/arm-subscriptions/review/arm-subscriptions.api.md +++ b/sdk/subscription/arm-subscriptions/review/arm-subscriptions.api.md @@ -6,9 +6,9 @@ import * as coreAuth from '@azure/core-auth'; import * as coreClient from '@azure/core-client'; +import { OperationState } from '@azure/core-lro'; import { PagedAsyncIterableIterator } from '@azure/core-paging'; -import { PollerLike } from '@azure/core-lro'; -import { PollOperationState } from '@azure/core-lro'; +import { SimplePollerLike } from '@azure/core-lro'; // @public export type AcceptOwnership = string; @@ -42,7 +42,7 @@ export interface AcceptOwnershipStatusResponse { // @public export interface Alias { - beginCreate(aliasName: string, body: PutAliasRequest, options?: AliasCreateOptionalParams): Promise, AliasCreateResponse>>; + beginCreate(aliasName: string, body: PutAliasRequest, options?: AliasCreateOptionalParams): Promise, AliasCreateResponse>>; beginCreateAndWait(aliasName: string, body: PutAliasRequest, options?: AliasCreateOptionalParams): Promise; delete(aliasName: string, options?: AliasDeleteOptionalParams): Promise; get(aliasName: string, options?: AliasGetOptionalParams): Promise; @@ -116,12 +116,32 @@ export interface EnabledSubscriptionId { readonly subscriptionId?: string; } +// @public +export interface ErrorAdditionalInfo { + readonly info?: Record; + readonly type?: string; +} + +// @public +export interface ErrorDetail { + readonly additionalInfo?: ErrorAdditionalInfo[]; + readonly code?: string; + readonly details?: ErrorDetail[]; + readonly message?: string; + readonly target?: string; +} + // @public export interface ErrorResponse { code?: string; message?: string; } +// @public +export interface ErrorResponseAutoGenerated { + error?: ErrorDetail; +} + // @public export interface ErrorResponseBody { code?: string; @@ -378,6 +398,8 @@ export class SubscriptionClient extends coreClient.ServiceClient { // (undocumented) operations: Operations; // (undocumented) + subscriptionOperation: SubscriptionOperation; + // (undocumented) subscriptionOperations: SubscriptionOperations; // (undocumented) subscriptionPolicy: SubscriptionPolicy; @@ -393,6 +415,11 @@ export interface SubscriptionClientOptionalParams extends coreClient.ServiceClie endpoint?: string; } +// @public +export interface SubscriptionCreationResult { + subscriptionLink?: string; +} + // @public export interface SubscriptionEnableOptionalParams extends coreClient.OperationOptions { } @@ -411,10 +438,28 @@ export interface SubscriptionName { subscriptionName?: string; } +// @public +export interface SubscriptionOperation { + get(operationId: string, options?: SubscriptionOperationGetOptionalParams): Promise; +} + +// @public +export interface SubscriptionOperationGetHeaders { + location?: string; + retryAfter?: number; +} + +// @public +export interface SubscriptionOperationGetOptionalParams extends coreClient.OperationOptions { +} + +// @public +export type SubscriptionOperationGetResponse = SubscriptionCreationResult; + // @public export interface SubscriptionOperations { acceptOwnershipStatus(subscriptionId: string, options?: SubscriptionAcceptOwnershipStatusOptionalParams): Promise; - beginAcceptOwnership(subscriptionId: string, body: AcceptOwnershipRequest, options?: SubscriptionAcceptOwnershipOptionalParams): Promise, SubscriptionAcceptOwnershipResponse>>; + beginAcceptOwnership(subscriptionId: string, body: AcceptOwnershipRequest, options?: SubscriptionAcceptOwnershipOptionalParams): Promise, SubscriptionAcceptOwnershipResponse>>; beginAcceptOwnershipAndWait(subscriptionId: string, body: AcceptOwnershipRequest, options?: SubscriptionAcceptOwnershipOptionalParams): Promise; cancel(subscriptionId: string, options?: SubscriptionCancelOptionalParams): Promise; enable(subscriptionId: string, options?: SubscriptionEnableOptionalParams): Promise; diff --git a/sdk/subscription/arm-subscriptions/src/lroImpl.ts b/sdk/subscription/arm-subscriptions/src/lroImpl.ts index 518d5f053b4e..dd803cd5e28c 100644 --- a/sdk/subscription/arm-subscriptions/src/lroImpl.ts +++ b/sdk/subscription/arm-subscriptions/src/lroImpl.ts @@ -6,29 +6,37 @@ * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + +import { AbortSignalLike } from "@azure/abort-controller"; import { LongRunningOperation, LroResponse } from "@azure/core-lro"; -export class LroImpl implements LongRunningOperation { - constructor( - private sendOperationFn: (args: any, spec: any) => Promise>, - private args: Record, - private spec: { - readonly requestBody?: unknown; - readonly path?: string; - readonly httpMethod: string; - } & Record, - public requestPath: string = spec.path!, - public requestMethod: string = spec.httpMethod - ) {} - public async sendInitialRequest(): Promise> { - return this.sendOperationFn(this.args, this.spec); - } - public async sendPollRequest(path: string): Promise> { - const { requestBody, ...restSpec } = this.spec; - return this.sendOperationFn(this.args, { - ...restSpec, - path, - httpMethod: "GET" - }); - } +export function createLroSpec(inputs: { + sendOperationFn: (args: any, spec: any) => Promise>; + args: Record; + spec: { + readonly requestBody?: unknown; + readonly path?: string; + readonly httpMethod: string; + } & Record; +}): LongRunningOperation { + const { args, spec, sendOperationFn } = inputs; + return { + requestMethod: spec.httpMethod, + requestPath: spec.path!, + sendInitialRequest: () => sendOperationFn(args, spec), + sendPollRequest: ( + path: string, + options?: { abortSignal?: AbortSignalLike } + ) => { + const { requestBody, ...restSpec } = spec; + return sendOperationFn(args, { + ...restSpec, + httpMethod: "GET", + path, + abortSignal: options?.abortSignal + }); + } + }; } diff --git a/sdk/subscription/arm-subscriptions/src/models/index.ts b/sdk/subscription/arm-subscriptions/src/models/index.ts index 888357c0e806..a24ce651c152 100644 --- a/sdk/subscription/arm-subscriptions/src/models/index.ts +++ b/sdk/subscription/arm-subscriptions/src/models/index.ts @@ -218,6 +218,61 @@ export interface EnabledSubscriptionId { readonly subscriptionId?: string; } +/** The created subscription object. */ +export interface SubscriptionCreationResult { + /** The link to the new subscription. Use this link to check the status of subscription creation operation. */ + subscriptionLink?: string; +} + +/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */ +export interface ErrorResponseAutoGenerated { + /** The error object. */ + error?: ErrorDetail; +} + +/** The error detail. */ +export interface ErrorDetail { + /** + * The error code. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly code?: string; + /** + * The error message. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly message?: string; + /** + * The error target. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly target?: string; + /** + * The error details. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly details?: ErrorDetail[]; + /** + * The error additional info. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly additionalInfo?: ErrorAdditionalInfo[]; +} + +/** The resource management error additional info. */ +export interface ErrorAdditionalInfo { + /** + * The additional info type. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly type?: string; + /** + * The additional info. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly info?: Record; +} + /** Result of the request to list operations. It contains a list of operations and a URL link to get the next set of results. */ export interface OperationListResult { /** List of operations. */ @@ -546,6 +601,14 @@ export interface SubscriptionAcceptOwnershipHeaders { retryAfter?: number; } +/** Defines headers for SubscriptionOperation_get operation. */ +export interface SubscriptionOperationGetHeaders { + /** The URL where the status of the asynchronous operation can be checked. */ + location?: string; + /** The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. */ + retryAfter?: number; +} + /** Known values of {@link Workload} that the service accepts. */ export enum KnownWorkload { /** Production */ @@ -742,6 +805,13 @@ export interface SubscriptionAcceptOwnershipStatusOptionalParams /** Contains response data for the acceptOwnershipStatus operation. */ export type SubscriptionAcceptOwnershipStatusResponse = AcceptOwnershipStatusResponse; +/** Optional parameters. */ +export interface SubscriptionOperationGetOptionalParams + extends coreClient.OperationOptions {} + +/** Contains response data for the get operation. */ +export type SubscriptionOperationGetResponse = SubscriptionCreationResult; + /** Optional parameters. */ export interface OperationsListOptionalParams extends coreClient.OperationOptions {} diff --git a/sdk/subscription/arm-subscriptions/src/models/mappers.ts b/sdk/subscription/arm-subscriptions/src/models/mappers.ts index 62629d0d25d0..503aee66812a 100644 --- a/sdk/subscription/arm-subscriptions/src/models/mappers.ts +++ b/sdk/subscription/arm-subscriptions/src/models/mappers.ts @@ -415,6 +415,117 @@ export const EnabledSubscriptionId: coreClient.CompositeMapper = { } }; +export const SubscriptionCreationResult: coreClient.CompositeMapper = { + type: { + name: "Composite", + className: "SubscriptionCreationResult", + modelProperties: { + subscriptionLink: { + serializedName: "subscriptionLink", + type: { + name: "String" + } + } + } + } +}; + +export const ErrorResponseAutoGenerated: coreClient.CompositeMapper = { + type: { + name: "Composite", + className: "ErrorResponseAutoGenerated", + modelProperties: { + error: { + serializedName: "error", + type: { + name: "Composite", + className: "ErrorDetail" + } + } + } + } +}; + +export const ErrorDetail: coreClient.CompositeMapper = { + type: { + name: "Composite", + className: "ErrorDetail", + modelProperties: { + code: { + serializedName: "code", + readOnly: true, + type: { + name: "String" + } + }, + message: { + serializedName: "message", + readOnly: true, + type: { + name: "String" + } + }, + target: { + serializedName: "target", + readOnly: true, + type: { + name: "String" + } + }, + details: { + serializedName: "details", + readOnly: true, + type: { + name: "Sequence", + element: { + type: { + name: "Composite", + className: "ErrorDetail" + } + } + } + }, + additionalInfo: { + serializedName: "additionalInfo", + readOnly: true, + type: { + name: "Sequence", + element: { + type: { + name: "Composite", + className: "ErrorAdditionalInfo" + } + } + } + } + } + } +}; + +export const ErrorAdditionalInfo: coreClient.CompositeMapper = { + type: { + name: "Composite", + className: "ErrorAdditionalInfo", + modelProperties: { + type: { + serializedName: "type", + readOnly: true, + type: { + name: "String" + } + }, + info: { + serializedName: "info", + readOnly: true, + type: { + name: "Dictionary", + value: { type: { name: "any" } } + } + } + } + } +}; + export const OperationListResult: coreClient.CompositeMapper = { type: { name: "Composite", @@ -1159,3 +1270,24 @@ export const SubscriptionAcceptOwnershipHeaders: coreClient.CompositeMapper = { } } }; + +export const SubscriptionOperationGetHeaders: coreClient.CompositeMapper = { + type: { + name: "Composite", + className: "SubscriptionOperationGetHeaders", + modelProperties: { + location: { + serializedName: "location", + type: { + name: "String" + } + }, + retryAfter: { + serializedName: "retry-after", + type: { + name: "Number" + } + } + } + } +}; diff --git a/sdk/subscription/arm-subscriptions/src/models/parameters.ts b/sdk/subscription/arm-subscriptions/src/models/parameters.ts index 9e3494646de8..068912c5f177 100644 --- a/sdk/subscription/arm-subscriptions/src/models/parameters.ts +++ b/sdk/subscription/arm-subscriptions/src/models/parameters.ts @@ -111,6 +111,17 @@ export const body1: OperationParameter = { mapper: AcceptOwnershipRequestMapper }; +export const operationId: OperationURLParameter = { + parameterPath: "operationId", + mapper: { + serializedName: "operationId", + required: true, + type: { + name: "String" + } + } +}; + export const body2: OperationParameter = { parameterPath: "body", mapper: PutAliasRequestMapper diff --git a/sdk/subscription/arm-subscriptions/src/operations/alias.ts b/sdk/subscription/arm-subscriptions/src/operations/alias.ts index fbb5e1e0ff14..d8c468501d55 100644 --- a/sdk/subscription/arm-subscriptions/src/operations/alias.ts +++ b/sdk/subscription/arm-subscriptions/src/operations/alias.ts @@ -11,8 +11,12 @@ import * as coreClient from "@azure/core-client"; import * as Mappers from "../models/mappers"; import * as Parameters from "../models/parameters"; import { SubscriptionClient } from "../subscriptionClient"; -import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro"; -import { LroImpl } from "../lroImpl"; +import { + SimplePollerLike, + OperationState, + createHttpPoller +} from "@azure/core-lro"; +import { createLroSpec } from "../lroImpl"; import { PutAliasRequest, AliasCreateOptionalParams, @@ -49,7 +53,7 @@ export class AliasImpl implements Alias { body: PutAliasRequest, options?: AliasCreateOptionalParams ): Promise< - PollerLike, AliasCreateResponse> + SimplePollerLike, AliasCreateResponse> > { const directSendOperation = async ( args: coreClient.OperationArguments, @@ -57,7 +61,7 @@ export class AliasImpl implements Alias { ): Promise => { return this.client.sendOperationRequest(args, spec); }; - const sendOperation = async ( + const sendOperationFn = async ( args: coreClient.OperationArguments, spec: coreClient.OperationSpec ) => { @@ -90,13 +94,16 @@ export class AliasImpl implements Alias { }; }; - const lro = new LroImpl( - sendOperation, - { aliasName, body, options }, - createOperationSpec - ); - const poller = new LroEngine(lro, { - resumeFrom: options?.resumeFrom, + const lro = createLroSpec({ + sendOperationFn, + args: { aliasName, body, options }, + spec: createOperationSpec + }); + const poller = await createHttpPoller< + AliasCreateResponse, + OperationState + >(lro, { + restoreFrom: options?.resumeFrom, intervalInMs: options?.updateIntervalInMs }); await poller.poll(); diff --git a/sdk/subscription/arm-subscriptions/src/operations/index.ts b/sdk/subscription/arm-subscriptions/src/operations/index.ts index 2a569a3b44dc..8548b1ba8228 100644 --- a/sdk/subscription/arm-subscriptions/src/operations/index.ts +++ b/sdk/subscription/arm-subscriptions/src/operations/index.ts @@ -9,6 +9,7 @@ export * from "./subscriptions"; export * from "./tenants"; export * from "./subscriptionOperations"; +export * from "./subscriptionOperation"; export * from "./operations"; export * from "./alias"; export * from "./subscriptionPolicy"; diff --git a/sdk/subscription/arm-subscriptions/src/operations/operations.ts b/sdk/subscription/arm-subscriptions/src/operations/operations.ts index cc3e4bd2bf6d..11ec373079ad 100644 --- a/sdk/subscription/arm-subscriptions/src/operations/operations.ts +++ b/sdk/subscription/arm-subscriptions/src/operations/operations.ts @@ -143,7 +143,6 @@ const listNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ErrorResponseBody } }, - queryParameters: [Parameters.apiVersion1], urlParameters: [Parameters.$host, Parameters.nextLink], headerParameters: [Parameters.accept], serializer diff --git a/sdk/subscription/arm-subscriptions/src/operations/subscriptionOperation.ts b/sdk/subscription/arm-subscriptions/src/operations/subscriptionOperation.ts new file mode 100644 index 000000000000..859f96c5c2bc --- /dev/null +++ b/sdk/subscription/arm-subscriptions/src/operations/subscriptionOperation.ts @@ -0,0 +1,69 @@ +/* + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. + */ + +import { SubscriptionOperation } from "../operationsInterfaces"; +import * as coreClient from "@azure/core-client"; +import * as Mappers from "../models/mappers"; +import * as Parameters from "../models/parameters"; +import { SubscriptionClient } from "../subscriptionClient"; +import { + SubscriptionOperationGetOptionalParams, + SubscriptionOperationGetResponse +} from "../models"; + +/** Class containing SubscriptionOperation operations. */ +export class SubscriptionOperationImpl implements SubscriptionOperation { + private readonly client: SubscriptionClient; + + /** + * Initialize a new instance of the class SubscriptionOperation class. + * @param client Reference to the service client + */ + constructor(client: SubscriptionClient) { + this.client = client; + } + + /** + * Get the status of the pending Microsoft.Subscription API operations. + * @param operationId The operation ID, which can be found from the Location field in the generate + * recommendation response header. + * @param options The options parameters. + */ + get( + operationId: string, + options?: SubscriptionOperationGetOptionalParams + ): Promise { + return this.client.sendOperationRequest( + { operationId, options }, + getOperationSpec + ); + } +} +// Operation Specifications +const serializer = coreClient.createSerializer(Mappers, /* isXml */ false); + +const getOperationSpec: coreClient.OperationSpec = { + path: + "/providers/Microsoft.Subscription/subscriptionOperations/{operationId}", + httpMethod: "GET", + responses: { + 200: { + bodyMapper: Mappers.SubscriptionCreationResult + }, + 202: { + headersMapper: Mappers.SubscriptionOperationGetHeaders + }, + default: { + bodyMapper: Mappers.ErrorResponseAutoGenerated + } + }, + queryParameters: [Parameters.apiVersion1], + urlParameters: [Parameters.$host, Parameters.operationId], + headerParameters: [Parameters.accept], + serializer +}; diff --git a/sdk/subscription/arm-subscriptions/src/operations/subscriptionOperations.ts b/sdk/subscription/arm-subscriptions/src/operations/subscriptionOperations.ts index a9800838cf2f..a5665b852540 100644 --- a/sdk/subscription/arm-subscriptions/src/operations/subscriptionOperations.ts +++ b/sdk/subscription/arm-subscriptions/src/operations/subscriptionOperations.ts @@ -11,8 +11,12 @@ import * as coreClient from "@azure/core-client"; import * as Mappers from "../models/mappers"; import * as Parameters from "../models/parameters"; import { SubscriptionClient } from "../subscriptionClient"; -import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro"; -import { LroImpl } from "../lroImpl"; +import { + SimplePollerLike, + OperationState, + createHttpPoller +} from "@azure/core-lro"; +import { createLroSpec } from "../lroImpl"; import { SubscriptionCancelOptionalParams, SubscriptionCancelResponse, @@ -98,8 +102,8 @@ export class SubscriptionOperationsImpl implements SubscriptionOperations { body: AcceptOwnershipRequest, options?: SubscriptionAcceptOwnershipOptionalParams ): Promise< - PollerLike< - PollOperationState, + SimplePollerLike< + OperationState, SubscriptionAcceptOwnershipResponse > > { @@ -109,7 +113,7 @@ export class SubscriptionOperationsImpl implements SubscriptionOperations { ): Promise => { return this.client.sendOperationRequest(args, spec); }; - const sendOperation = async ( + const sendOperationFn = async ( args: coreClient.OperationArguments, spec: coreClient.OperationSpec ) => { @@ -142,13 +146,16 @@ export class SubscriptionOperationsImpl implements SubscriptionOperations { }; }; - const lro = new LroImpl( - sendOperation, - { subscriptionId, body, options }, - acceptOwnershipOperationSpec - ); - const poller = new LroEngine(lro, { - resumeFrom: options?.resumeFrom, + const lro = createLroSpec({ + sendOperationFn, + args: { subscriptionId, body, options }, + spec: acceptOwnershipOperationSpec + }); + const poller = await createHttpPoller< + SubscriptionAcceptOwnershipResponse, + OperationState + >(lro, { + restoreFrom: options?.resumeFrom, intervalInMs: options?.updateIntervalInMs }); await poller.poll(); diff --git a/sdk/subscription/arm-subscriptions/src/operations/subscriptionPolicy.ts b/sdk/subscription/arm-subscriptions/src/operations/subscriptionPolicy.ts index 4bcd43d6516c..783b9f259172 100644 --- a/sdk/subscription/arm-subscriptions/src/operations/subscriptionPolicy.ts +++ b/sdk/subscription/arm-subscriptions/src/operations/subscriptionPolicy.ts @@ -213,7 +213,6 @@ const listPolicyForTenantNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ErrorResponseBody } }, - queryParameters: [Parameters.apiVersion1], urlParameters: [Parameters.$host, Parameters.nextLink], headerParameters: [Parameters.accept], serializer diff --git a/sdk/subscription/arm-subscriptions/src/operations/subscriptions.ts b/sdk/subscription/arm-subscriptions/src/operations/subscriptions.ts index d612b33bb9e4..b1006d43ae26 100644 --- a/sdk/subscription/arm-subscriptions/src/operations/subscriptions.ts +++ b/sdk/subscription/arm-subscriptions/src/operations/subscriptions.ts @@ -248,7 +248,6 @@ const listNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.SubscriptionListResult } }, - queryParameters: [Parameters.apiVersion], urlParameters: [Parameters.$host, Parameters.nextLink], headerParameters: [Parameters.accept], serializer diff --git a/sdk/subscription/arm-subscriptions/src/operations/tenants.ts b/sdk/subscription/arm-subscriptions/src/operations/tenants.ts index 053198e4ed02..58a0293f575d 100644 --- a/sdk/subscription/arm-subscriptions/src/operations/tenants.ts +++ b/sdk/subscription/arm-subscriptions/src/operations/tenants.ts @@ -137,7 +137,6 @@ const listNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.TenantListResult } }, - queryParameters: [Parameters.apiVersion], urlParameters: [Parameters.$host, Parameters.nextLink], headerParameters: [Parameters.accept], serializer diff --git a/sdk/subscription/arm-subscriptions/src/operationsInterfaces/alias.ts b/sdk/subscription/arm-subscriptions/src/operationsInterfaces/alias.ts index 6cc57ed29fa6..4011d89fd140 100644 --- a/sdk/subscription/arm-subscriptions/src/operationsInterfaces/alias.ts +++ b/sdk/subscription/arm-subscriptions/src/operationsInterfaces/alias.ts @@ -6,7 +6,7 @@ * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { PollerLike, PollOperationState } from "@azure/core-lro"; +import { SimplePollerLike, OperationState } from "@azure/core-lro"; import { PutAliasRequest, AliasCreateOptionalParams, @@ -33,7 +33,7 @@ export interface Alias { body: PutAliasRequest, options?: AliasCreateOptionalParams ): Promise< - PollerLike, AliasCreateResponse> + SimplePollerLike, AliasCreateResponse> >; /** * Create Alias Subscription. diff --git a/sdk/subscription/arm-subscriptions/src/operationsInterfaces/index.ts b/sdk/subscription/arm-subscriptions/src/operationsInterfaces/index.ts index 2a569a3b44dc..8548b1ba8228 100644 --- a/sdk/subscription/arm-subscriptions/src/operationsInterfaces/index.ts +++ b/sdk/subscription/arm-subscriptions/src/operationsInterfaces/index.ts @@ -9,6 +9,7 @@ export * from "./subscriptions"; export * from "./tenants"; export * from "./subscriptionOperations"; +export * from "./subscriptionOperation"; export * from "./operations"; export * from "./alias"; export * from "./subscriptionPolicy"; diff --git a/sdk/subscription/arm-subscriptions/src/operationsInterfaces/subscriptionOperation.ts b/sdk/subscription/arm-subscriptions/src/operationsInterfaces/subscriptionOperation.ts new file mode 100644 index 000000000000..296553804dfe --- /dev/null +++ b/sdk/subscription/arm-subscriptions/src/operationsInterfaces/subscriptionOperation.ts @@ -0,0 +1,26 @@ +/* + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. + */ + +import { + SubscriptionOperationGetOptionalParams, + SubscriptionOperationGetResponse +} from "../models"; + +/** Interface representing a SubscriptionOperation. */ +export interface SubscriptionOperation { + /** + * Get the status of the pending Microsoft.Subscription API operations. + * @param operationId The operation ID, which can be found from the Location field in the generate + * recommendation response header. + * @param options The options parameters. + */ + get( + operationId: string, + options?: SubscriptionOperationGetOptionalParams + ): Promise; +} diff --git a/sdk/subscription/arm-subscriptions/src/operationsInterfaces/subscriptionOperations.ts b/sdk/subscription/arm-subscriptions/src/operationsInterfaces/subscriptionOperations.ts index ee66d9822d36..12a1612f91e7 100644 --- a/sdk/subscription/arm-subscriptions/src/operationsInterfaces/subscriptionOperations.ts +++ b/sdk/subscription/arm-subscriptions/src/operationsInterfaces/subscriptionOperations.ts @@ -6,7 +6,7 @@ * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { PollerLike, PollOperationState } from "@azure/core-lro"; +import { SimplePollerLike, OperationState } from "@azure/core-lro"; import { SubscriptionCancelOptionalParams, SubscriptionCancelResponse, @@ -64,8 +64,8 @@ export interface SubscriptionOperations { body: AcceptOwnershipRequest, options?: SubscriptionAcceptOwnershipOptionalParams ): Promise< - PollerLike< - PollOperationState, + SimplePollerLike< + OperationState, SubscriptionAcceptOwnershipResponse > >; diff --git a/sdk/subscription/arm-subscriptions/src/pagingHelper.ts b/sdk/subscription/arm-subscriptions/src/pagingHelper.ts index d85fc13bce1e..269a2b9814b5 100644 --- a/sdk/subscription/arm-subscriptions/src/pagingHelper.ts +++ b/sdk/subscription/arm-subscriptions/src/pagingHelper.ts @@ -13,11 +13,11 @@ export interface PageInfo { const pageMap = new WeakMap(); /** - * Given a result page from a pageable operation, returns a - * continuation token that can be used to begin paging from + * Given the last `.value` produced by the `byPage` iterator, + * returns a continuation token that can be used to begin paging from * that point later. - * @param page A result object from calling .byPage() on a paged operation. - * @returns The continuation token that can be passed into byPage(). + * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator. + * @returns The continuation token that can be passed into byPage() during future calls. */ export function getContinuationToken(page: unknown): string | undefined { if (typeof page !== "object" || page === null) { diff --git a/sdk/subscription/arm-subscriptions/src/subscriptionClient.ts b/sdk/subscription/arm-subscriptions/src/subscriptionClient.ts index f470618e0313..db0776924913 100644 --- a/sdk/subscription/arm-subscriptions/src/subscriptionClient.ts +++ b/sdk/subscription/arm-subscriptions/src/subscriptionClient.ts @@ -13,6 +13,7 @@ import { SubscriptionsImpl, TenantsImpl, SubscriptionOperationsImpl, + SubscriptionOperationImpl, OperationsImpl, AliasImpl, SubscriptionPolicyImpl, @@ -22,6 +23,7 @@ import { Subscriptions, Tenants, SubscriptionOperations, + SubscriptionOperation, Operations, Alias, SubscriptionPolicy, @@ -54,7 +56,7 @@ export class SubscriptionClient extends coreClient.ServiceClient { credential: credentials }; - const packageDetails = `azsdk-js-arm-subscriptions/5.1.1`; + const packageDetails = `azsdk-js-arm-subscriptions/5.2.0`; const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}` @@ -108,6 +110,7 @@ export class SubscriptionClient extends coreClient.ServiceClient { this.subscriptions = new SubscriptionsImpl(this); this.tenants = new TenantsImpl(this); this.subscriptionOperations = new SubscriptionOperationsImpl(this); + this.subscriptionOperation = new SubscriptionOperationImpl(this); this.operations = new OperationsImpl(this); this.alias = new AliasImpl(this); this.subscriptionPolicy = new SubscriptionPolicyImpl(this); @@ -117,6 +120,7 @@ export class SubscriptionClient extends coreClient.ServiceClient { subscriptions: Subscriptions; tenants: Tenants; subscriptionOperations: SubscriptionOperations; + subscriptionOperation: SubscriptionOperation; operations: Operations; alias: Alias; subscriptionPolicy: SubscriptionPolicy; diff --git a/sdk/subscription/arm-subscriptions/tsconfig.json b/sdk/subscription/arm-subscriptions/tsconfig.json index 9889c4c576e3..3e6ae96443f3 100644 --- a/sdk/subscription/arm-subscriptions/tsconfig.json +++ b/sdk/subscription/arm-subscriptions/tsconfig.json @@ -15,17 +15,11 @@ ], "declaration": true, "outDir": "./dist-esm", - "importHelpers": true, - "paths": { - "@azure/arm-subscriptions": [ - "./src/index" - ] - } + "importHelpers": true }, "include": [ "./src/**/*.ts", - "./test/**/*.ts", - "samples-dev/**/*.ts" + "./test/**/*.ts" ], "exclude": [ "node_modules"