@azure/arm-subscriptions 3.1.2 → 4.0.0

package/review/arm-subscriptions.api.md

@@ -0,0 +1,446 @@
+## API Report File for "@azure/arm-subscriptions"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export type AcceptOwnership = string;
+
+// @public
+export interface AcceptOwnershipRequest {
+    properties?: AcceptOwnershipRequestProperties;
+}
+
+// @public
+export interface AcceptOwnershipRequestProperties {
+    displayName: string;
+    managementGroupId?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface AcceptOwnershipStatusResponse {
+    readonly acceptOwnershipState?: AcceptOwnership;
+    readonly billingOwner?: string;
+    displayName?: string;
+    readonly subscriptionId?: string;
+    subscriptionTenantId?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface Alias {
+    beginCreate(aliasName: string, body: PutAliasRequest, options?: AliasCreateOptionalParams): Promise<PollerLike<PollOperationState<AliasCreateResponse>, AliasCreateResponse>>;
+    beginCreateAndWait(aliasName: string, body: PutAliasRequest, options?: AliasCreateOptionalParams): Promise<AliasCreateResponse>;
+    delete(aliasName: string, options?: AliasDeleteOptionalParams): Promise<void>;
+    get(aliasName: string, options?: AliasGetOptionalParams): Promise<AliasGetResponse>;
+    list(options?: AliasListOptionalParams): Promise<AliasListResponse>;
+}
+
+// @public
+export interface AliasCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type AliasCreateResponse = SubscriptionAliasResponse;
+
+// @public
+export interface AliasDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface AliasGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AliasGetResponse = SubscriptionAliasResponse;
+
+// @public
+export interface AliasListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AliasListResponse = SubscriptionAliasListResult;
+
+// @public
+export interface BillingAccount {
+    getPolicy(billingAccountId: string, options?: BillingAccountGetPolicyOptionalParams): Promise<BillingAccountGetPolicyResponse>;
+}
+
+// @public
+export interface BillingAccountGetPolicyOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type BillingAccountGetPolicyResponse = BillingAccountPoliciesResponse;
+
+// @public
+export interface BillingAccountPoliciesResponse {
+    readonly id?: string;
+    readonly name?: string;
+    properties?: BillingAccountPoliciesResponseProperties;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface BillingAccountPoliciesResponseProperties {
+    allowTransfers?: boolean;
+    serviceTenants?: ServiceTenantResponse[];
+}
+
+// @public
+export interface CanceledSubscriptionId {
+    readonly value?: string;
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface EnabledSubscriptionId {
+    readonly value?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    code?: string;
+    message?: string;
+}
+
+// @public
+export interface ErrorResponseBody {
+    code?: string;
+    error?: ErrorResponse;
+    message?: string;
+}
+
+// @public
+export interface GetTenantPolicyListResponse {
+    readonly nextLink?: string;
+    readonly value?: GetTenantPolicyResponse[];
+}
+
+// @public
+export interface GetTenantPolicyResponse {
+    readonly id?: string;
+    readonly name?: string;
+    properties?: TenantPolicy;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export enum KnownAcceptOwnership {
+    // (undocumented)
+    Completed = "Completed",
+    // (undocumented)
+    Expired = "Expired",
+    // (undocumented)
+    Pending = "Pending"
+}
+
+// @public
+export enum KnownCreatedByType {
+    // (undocumented)
+    Application = "Application",
+    // (undocumented)
+    Key = "Key",
+    // (undocumented)
+    ManagedIdentity = "ManagedIdentity",
+    // (undocumented)
+    User = "User"
+}
+
+// @public
+export enum KnownProvisioningState {
+    // (undocumented)
+    Accepted = "Accepted",
+    // (undocumented)
+    Failed = "Failed",
+    // (undocumented)
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownWorkload {
+    // (undocumented)
+    DevTest = "DevTest",
+    // (undocumented)
+    Production = "Production"
+}
+
+// @public
+export interface Operation {
+    display?: OperationDisplay;
+    isDataAction?: boolean;
+    name?: string;
+}
+
+// @public
+export interface OperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    nextLink?: string;
+    value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface PutAliasRequest {
+    properties?: PutAliasRequestProperties;
+}
+
+// @public
+export interface PutAliasRequestAdditionalProperties {
+    managementGroupId?: string;
+    subscriptionOwnerId?: string;
+    subscriptionTenantId?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface PutAliasRequestProperties {
+    additionalProperties?: PutAliasRequestAdditionalProperties;
+    billingScope?: string;
+    displayName?: string;
+    resellerId?: string;
+    subscriptionId?: string;
+    workload?: Workload;
+}
+
+// @public
+export interface PutTenantPolicyRequestProperties {
+    blockSubscriptionsIntoTenant?: boolean;
+    blockSubscriptionsLeavingTenant?: boolean;
+    exemptedPrincipals?: string[];
+}
+
+// @public
+export interface RenamedSubscriptionId {
+    readonly value?: string;
+}
+
+// @public
+export interface ServiceTenantResponse {
+    tenantId?: string;
+    tenantName?: string;
+}
+
+// @public
+export interface Subscription {
+    acceptOwnershipStatus(subscriptionId: string, options?: SubscriptionAcceptOwnershipStatusOptionalParams): Promise<SubscriptionAcceptOwnershipStatusResponse>;
+    beginAcceptOwnership(subscriptionId: string, body: AcceptOwnershipRequest, options?: SubscriptionAcceptOwnershipOptionalParams): Promise<PollerLike<PollOperationState<SubscriptionAcceptOwnershipResponse>, SubscriptionAcceptOwnershipResponse>>;
+    beginAcceptOwnershipAndWait(subscriptionId: string, body: AcceptOwnershipRequest, options?: SubscriptionAcceptOwnershipOptionalParams): Promise<SubscriptionAcceptOwnershipResponse>;
+    cancel(subscriptionId: string, options?: SubscriptionCancelOptionalParams): Promise<SubscriptionCancelResponse>;
+    enable(subscriptionId: string, options?: SubscriptionEnableOptionalParams): Promise<SubscriptionEnableResponse>;
+    rename(subscriptionId: string, body: SubscriptionName, options?: SubscriptionRenameOptionalParams): Promise<SubscriptionRenameResponse>;
+}
+
+// @public
+export interface SubscriptionAcceptOwnershipHeaders {
+    location?: string;
+    retryAfter?: number;
+}
+
+// @public
+export interface SubscriptionAcceptOwnershipOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type SubscriptionAcceptOwnershipResponse = SubscriptionAcceptOwnershipHeaders;
+
+// @public
+export interface SubscriptionAcceptOwnershipStatusOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SubscriptionAcceptOwnershipStatusResponse = AcceptOwnershipStatusResponse;
+
+// @public
+export interface SubscriptionAliasListResult {
+    readonly nextLink?: string;
+    readonly value?: SubscriptionAliasResponse[];
+}
+
+// @public
+export interface SubscriptionAliasResponse {
+    readonly id?: string;
+    readonly name?: string;
+    properties?: SubscriptionAliasResponseProperties;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface SubscriptionAliasResponseProperties {
+    readonly acceptOwnershipState?: AcceptOwnership;
+    readonly acceptOwnershipUrl?: string;
+    billingScope?: string;
+    displayName?: string;
+    managementGroupId?: string;
+    provisioningState?: ProvisioningState;
+    resellerId?: string;
+    readonly subscriptionId?: string;
+    subscriptionOwnerId?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    workload?: Workload;
+}
+
+// @public
+export interface SubscriptionCancelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SubscriptionCancelResponse = CanceledSubscriptionId;
+
+// @public (undocumented)
+export class SubscriptionClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, options?: SubscriptionClientOptionalParams);
+    // (undocumented)
+    alias: Alias;
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    billingAccount: BillingAccount;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscription: Subscription;
+    // (undocumented)
+    subscriptionPolicy: SubscriptionPolicy;
+}
+
+// @public
+export interface SubscriptionClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface SubscriptionEnableOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SubscriptionEnableResponse = EnabledSubscriptionId;
+
+// @public
+export interface SubscriptionName {
+    subscriptionName?: string;
+}
+
+// @public
+export interface SubscriptionPolicy {
+    addUpdatePolicyForTenant(body: PutTenantPolicyRequestProperties, options?: SubscriptionPolicyAddUpdatePolicyForTenantOptionalParams): Promise<SubscriptionPolicyAddUpdatePolicyForTenantResponse>;
+    getPolicyForTenant(options?: SubscriptionPolicyGetPolicyForTenantOptionalParams): Promise<SubscriptionPolicyGetPolicyForTenantResponse>;
+    listPolicyForTenant(options?: SubscriptionPolicyListPolicyForTenantOptionalParams): PagedAsyncIterableIterator<GetTenantPolicyResponse>;
+}
+
+// @public
+export interface SubscriptionPolicyAddUpdatePolicyForTenantOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SubscriptionPolicyAddUpdatePolicyForTenantResponse = GetTenantPolicyResponse;
+
+// @public
+export interface SubscriptionPolicyGetPolicyForTenantOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SubscriptionPolicyGetPolicyForTenantResponse = GetTenantPolicyResponse;
+
+// @public
+export interface SubscriptionPolicyListPolicyForTenantNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SubscriptionPolicyListPolicyForTenantNextResponse = GetTenantPolicyListResponse;
+
+// @public
+export interface SubscriptionPolicyListPolicyForTenantOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SubscriptionPolicyListPolicyForTenantResponse = GetTenantPolicyListResponse;
+
+// @public
+export interface SubscriptionRenameOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SubscriptionRenameResponse = RenamedSubscriptionId;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TenantPolicy {
+    blockSubscriptionsIntoTenant?: boolean;
+    blockSubscriptionsLeavingTenant?: boolean;
+    exemptedPrincipals?: string[];
+    readonly policyId?: string;
+}
+
+// @public
+export type Workload = string;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -1,37 +1,188 @@
-import rollup from "rollup";
-import nodeResolve from "rollup-plugin-node-resolve";
+/*
+ * 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 nodeResolve from "@rollup/plugin-node-resolve";
+import cjs from "@rollup/plugin-commonjs";
 import sourcemaps from "rollup-plugin-sourcemaps";
+import multiEntry from "@rollup/plugin-multi-entry";
+import json from "@rollup/plugin-json";
+
+import nodeBuiltins from "builtin-modules";
+
+/**
+ * Gets the proper configuration needed for rollup's commonJS plugin for @opentelemetry/api.
+ *
+ * NOTE: this manual configuration is only needed because OpenTelemetry uses an
+ * __exportStar downleveled helper function to declare its exports which confuses
+ * rollup's automatic discovery mechanism.
+ *
+ * @returns an object reference that can be `...`'d into your cjs() configuration.
+ */
+export function openTelemetryCommonJs() {
+  const namedExports = {};
+
+  for (const key of [
+    "@opentelemetry/api",
+    "@azure/core-tracing/node_modules/@opentelemetry/api"
+  ]) {
+    namedExports[key] = [
+      "SpanKind",
+      "TraceFlags",
+      "getSpan",
+      "setSpan",
+      "SpanStatusCode",
+      "getSpanContext",
+      "setSpanContext"
+    ];
+  }
+
+  const releasedOpenTelemetryVersions = ["0.10.2", "1.0.0-rc.0"];
+
+  for (const version of releasedOpenTelemetryVersions) {
+    namedExports[
+      // working around a limitation in the rollup common.js plugin - it's not able to resolve these modules so the named exports listed above will not get applied. We have to drill down to the actual path.
+      `../../../common/temp/node_modules/.pnpm/@opentelemetry/api@${version}/node_modules/@opentelemetry/api/build/src/index.js`
+    ] = [
+      "SpanKind",
+      "TraceFlags",
+      "getSpan",
+      "setSpan",
+      "StatusCode",
+      "CanonicalCode",
+      "getSpanContext",
+      "setSpanContext"
+    ];
+  }
+
+  return namedExports;
+}
+
+// #region Warning Handler
 
 /**
- * @type {rollup.RollupFileOptions}
+ * A function that can determine whether a rollupwarning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
  */
-const config = {
-  input: "./esm/subscriptionClient.js",
-  external: [
-    "@azure/ms-rest-js",
-    "@azure/ms-rest-azure-js"
-  ],
-  output: {
-    file: "./dist/arm-subscriptions.js",
-    format: "umd",
-    name: "Azure.ArmSubscriptions",
-    sourcemap: true,
-    globals: {
-      "@azure/ms-rest-js": "msRest",
-      "@azure/ms-rest-azure-js": "msRestAzure"
+
+function ignoreNiseSinonEvalWarnings(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+      (warning.id.includes("node_modules/nise") ||
+        warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependencyWarnings(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer && warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [
+  ignoreChaiCircularDependencyWarnings,
+  ignoreNiseSinonEvalWarnings
+];
+
+/**
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
+ */
+function makeOnWarnForTesting() {
+  return (warning, warn) => {
+    // If every inhibitor returns false (i.e. no inhibitors), then show the warning
+    if (warningInhibitors.every((inhib) => !inhib(warning))) {
+      warn(warning);
+    }
+  };
+}
+
+// #endregion
+
+function makeBrowserTestConfig() {
+  const config = {
+    input: {
+      include: ["dist-esm/test/**/*.spec.js"],
+      exclude: ["dist-esm/test/**/node/**"]
     },
-    banner: `/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */`
-  },
-  plugins: [
-    nodeResolve({ mainFields: ['module', 'main'] }),
-    sourcemaps()
-  ]
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      nodeResolve({
+        mainFields: ["module", "browser"]
+      }),
+      cjs({
+        namedExports: {
+          // Chai's strange internal architecture makes it impossible to statically
+          // analyze its exports.
+          chai: [
+            "version",
+            "use",
+            "util",
+            "config",
+            "expect",
+            "should",
+            "assert"
+          ],
+          ...openTelemetryCommonJs()
+        }
+      }),
+      json(),
+      sourcemaps()
+      //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
+    ],
+    onwarn: makeOnWarnForTesting(),
+    // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
+    // rollup started respecting the "sideEffects" field in package.json.  Since
+    // our package.json sets "sideEffects=false", this also applies to test
+    // code, which causes all tests to be removed by tree-shaking.
+    treeshake: false
+  };
+
+  return config;
+}
+
+const defaultConfigurationOptions = {
+  disableBrowserBundle: false
 };
 
-export default config;
+export function makeConfig(pkg, options) {
+  options = {
+    ...defaultConfigurationOptions,
+    ...(options || {})
+  };
+
+  const baseConfig = {
+    // Use the package's module field if it has one
+    input: pkg["module"] || "dist-esm/src/index.js",
+    external: [
+      ...nodeBuiltins,
+      ...Object.keys(pkg.dependencies),
+      ...Object.keys(pkg.devDependencies)
+    ],
+    output: { file: "dist/index.js", format: "cjs", sourcemap: true },
+    preserveSymlinks: false,
+    plugins: [sourcemaps(), nodeResolve(), cjs()]
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));

package/src/index.ts

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+/// <reference lib="esnext.asynciterable" />
+export * from "./models";
+export { SubscriptionClient } from "./subscriptionClient";
+export * from "./operationsInterfaces";

package/src/lroImpl.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { LongRunningOperation, LroResponse } from "@azure/core-lro";
+
+export class LroImpl<T> implements LongRunningOperation<T> {
+  constructor(
+    private sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>,
+    private args: Record<string, unknown>,
+    private spec: {
+      readonly requestBody?: unknown;
+      readonly path?: string;
+      readonly httpMethod: string;
+    } & Record<string, any>,
+    public requestPath: string = spec.path!,
+    public requestMethod: string = spec.httpMethod
+  ) {}
+  public async sendInitialRequest(): Promise<LroResponse<T>> {
+    return this.sendOperationFn(this.args, this.spec);
+  }
+  public async sendPollRequest(path: string): Promise<LroResponse<T>> {
+    const { requestBody, ...restSpec } = this.spec;
+    return this.sendOperationFn(this.args, {
+      ...restSpec,
+      path,
+      httpMethod: "GET"
+    });
+  }
+}