@azure/arm-managementgroups 1.2.0 → 2.0.0-alpha.20211215.1

package/src/operations/operations.ts

@@ -1,26 +1,33 @@
 /*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for
- * license information.
+ * 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.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import * as msRest from "@azure/ms-rest-js";
-import * as Models from "../models";
-import * as Mappers from "../models/operationsMappers";
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { Operations } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
 import { ManagementGroupsAPIContext } from "../managementGroupsAPIContext";
+import {
+  Operation,
+  OperationsListNextOptionalParams,
+  OperationsListOptionalParams,
+  OperationsListResponse,
+  OperationsListNextResponse
+} from "../models";
 
-/** Class representing a Operations. */
-export class Operations {
+/// <reference lib="esnext.asynciterable" />
+/** Class containing Operations operations. */
+export class OperationsImpl implements Operations {
   private readonly client: ManagementGroupsAPIContext;
 
   /**
-   * Create a Operations.
-   * @param {ManagementGroupsAPIContext} client Reference to the service client.
+   * Initialize a new instance of the class Operations class.
+   * @param client Reference to the service client
    */
   constructor(client: ManagementGroupsAPIContext) {
     this.client = client;
@@ -28,68 +35,77 @@ export class Operations {
 
   /**
    * Lists all of the available Management REST API operations.
-   * @param [options] The optional parameters
-   * @returns Promise<Models.OperationsListResponse>
+   * @param options The options parameters.
    */
-  list(options?: msRest.RequestOptionsBase): Promise<Models.OperationsListResponse>;
-  /**
-   * @param callback The callback
-   */
-  list(callback: msRest.ServiceCallback<Models.OperationListResult>): void;
-  /**
-   * @param options The optional parameters
-   * @param callback The callback
-   */
-  list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Models.OperationListResult>): void;
-  list(options?: msRest.RequestOptionsBase | msRest.ServiceCallback<Models.OperationListResult>, callback?: msRest.ServiceCallback<Models.OperationListResult>): Promise<Models.OperationsListResponse> {
-    return this.client.sendOperationRequest(
-      {
-        options
+  public list(
+    options?: OperationsListOptionalParams
+  ): PagedAsyncIterableIterator<Operation> {
+    const iter = this.listPagingAll(options);
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
       },
-      listOperationSpec,
-      callback) as Promise<Models.OperationsListResponse>;
+      byPage: () => {
+        return this.listPagingPage(options);
+      }
+    };
+  }
+
+  private async *listPagingPage(
+    options?: OperationsListOptionalParams
+  ): AsyncIterableIterator<Operation[]> {
+    let result = await this._list(options);
+    yield result.value || [];
+    let continuationToken = result.nextLink;
+    while (continuationToken) {
+      result = await this._listNext(continuationToken, options);
+      continuationToken = result.nextLink;
+      yield result.value || [];
+    }
+  }
+
+  private async *listPagingAll(
+    options?: OperationsListOptionalParams
+  ): AsyncIterableIterator<Operation> {
+    for await (const page of this.listPagingPage(options)) {
+      yield* page;
+    }
   }
 
   /**
    * Lists all of the available Management REST API operations.
-   * @param nextPageLink The NextLink from the previous successful call to List operation.
-   * @param [options] The optional parameters
-   * @returns Promise<Models.OperationsListNextResponse>
-   */
-  listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.OperationsListNextResponse>;
-  /**
-   * @param nextPageLink The NextLink from the previous successful call to List operation.
-   * @param callback The callback
+   * @param options The options parameters.
    */
-  listNext(nextPageLink: string, callback: msRest.ServiceCallback<Models.OperationListResult>): void;
+  private _list(
+    options?: OperationsListOptionalParams
+  ): Promise<OperationsListResponse> {
+    return this.client.sendOperationRequest({ options }, listOperationSpec);
+  }
+
   /**
-   * @param nextPageLink The NextLink from the previous successful call to List operation.
-   * @param options The optional parameters
-   * @param callback The callback
+   * ListNext
+   * @param nextLink The nextLink from the previous successful call to the List method.
+   * @param options The options parameters.
    */
-  listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Models.OperationListResult>): void;
-  listNext(nextPageLink: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback<Models.OperationListResult>, callback?: msRest.ServiceCallback<Models.OperationListResult>): Promise<Models.OperationsListNextResponse> {
+  private _listNext(
+    nextLink: string,
+    options?: OperationsListNextOptionalParams
+  ): Promise<OperationsListNextResponse> {
     return this.client.sendOperationRequest(
-      {
-        nextPageLink,
-        options
-      },
-      listNextOperationSpec,
-      callback) as Promise<Models.OperationsListNextResponse>;
+      { nextLink, options },
+      listNextOperationSpec
+    );
   }
 }
-
 // Operation Specifications
-const serializer = new msRest.Serializer(Mappers);
-const listOperationSpec: msRest.OperationSpec = {
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listOperationSpec: coreClient.OperationSpec = {
+  path: "/providers/Microsoft.Management/operations",
   httpMethod: "GET",
-  path: "providers/Microsoft.Management/operations",
-  queryParameters: [
-    Parameters.apiVersion
-  ],
-  headerParameters: [
-    Parameters.acceptLanguage
-  ],
   responses: {
     200: {
       bodyMapper: Mappers.OperationListResult
@@ -98,19 +114,14 @@ const listOperationSpec: msRest.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host],
+  headerParameters: [Parameters.accept],
   serializer
 };
-
-const listNextOperationSpec: msRest.OperationSpec = {
-  httpMethod: "GET",
-  baseUrl: "https://management.azure.com",
+const listNextOperationSpec: coreClient.OperationSpec = {
   path: "{nextLink}",
-  urlParameters: [
-    Parameters.nextPageLink
-  ],
-  headerParameters: [
-    Parameters.acceptLanguage
-  ],
+  httpMethod: "GET",
   responses: {
     200: {
       bodyMapper: Mappers.OperationListResult
@@ -119,5 +130,8 @@ const listNextOperationSpec: msRest.OperationSpec = {
       bodyMapper: Mappers.ErrorResponse
     }
   },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.nextLink],
+  headerParameters: [Parameters.accept],
   serializer
 };

package/src/operationsInterfaces/entities.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { EntityInfo, EntitiesListOptionalParams } from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Entities. */
+export interface Entities {
+  /**
+   * List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.
+   *
+   * @param options The options parameters.
+   */
+  list(
+    options?: EntitiesListOptionalParams
+  ): PagedAsyncIterableIterator<EntityInfo>;
+}

package/src/operationsInterfaces/hierarchySettingsOperations.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 {
+  HierarchySettingsListOptionalParams,
+  HierarchySettingsListResponse,
+  HierarchySettingsGetOptionalParams,
+  HierarchySettingsGetResponse,
+  CreateOrUpdateSettingsRequest,
+  HierarchySettingsCreateOrUpdateOptionalParams,
+  HierarchySettingsCreateOrUpdateResponse,
+  HierarchySettingsUpdateOptionalParams,
+  HierarchySettingsUpdateResponse,
+  HierarchySettingsDeleteOptionalParams
+} from "../models";
+
+/** Interface representing a HierarchySettingsOperations. */
+export interface HierarchySettingsOperations {
+  /**
+   * Gets all the hierarchy settings defined at the Management Group level. Settings can only be set on
+   * the root Management Group of the hierarchy.
+   *
+   * @param groupId Management Group ID.
+   * @param options The options parameters.
+   */
+  list(
+    groupId: string,
+    options?: HierarchySettingsListOptionalParams
+  ): Promise<HierarchySettingsListResponse>;
+  /**
+   * Gets the hierarchy settings defined at the Management Group level. Settings can only be set on the
+   * root Management Group of the hierarchy.
+   *
+   * @param groupId Management Group ID.
+   * @param options The options parameters.
+   */
+  get(
+    groupId: string,
+    options?: HierarchySettingsGetOptionalParams
+  ): Promise<HierarchySettingsGetResponse>;
+  /**
+   * Creates or updates the hierarchy settings defined at the Management Group level.
+   *
+   * @param groupId Management Group ID.
+   * @param createTenantSettingsRequest Tenant level settings request parameter.
+   * @param options The options parameters.
+   */
+  createOrUpdate(
+    groupId: string,
+    createTenantSettingsRequest: CreateOrUpdateSettingsRequest,
+    options?: HierarchySettingsCreateOrUpdateOptionalParams
+  ): Promise<HierarchySettingsCreateOrUpdateResponse>;
+  /**
+   * Updates the hierarchy settings defined at the Management Group level.
+   *
+   * @param groupId Management Group ID.
+   * @param createTenantSettingsRequest Tenant level settings request parameter.
+   * @param options The options parameters.
+   */
+  update(
+    groupId: string,
+    createTenantSettingsRequest: CreateOrUpdateSettingsRequest,
+    options?: HierarchySettingsUpdateOptionalParams
+  ): Promise<HierarchySettingsUpdateResponse>;
+  /**
+   * Deletes the hierarchy settings defined at the Management Group level.
+   *
+   * @param groupId Management Group ID.
+   * @param options The options parameters.
+   */
+  delete(
+    groupId: string,
+    options?: HierarchySettingsDeleteOptionalParams
+  ): Promise<void>;
+}

package/src/operationsInterfaces/index.ts

@@ -0,0 +1,13 @@
+/*
+ * 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.
+ */
+
+export * from "./managementGroups";
+export * from "./managementGroupSubscriptions";
+export * from "./hierarchySettingsOperations";
+export * from "./operations";
+export * from "./entities";

package/src/operationsInterfaces/managementGroupSubscriptions.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 { PagedAsyncIterableIterator } from "@azure/core-paging";
+import {
+  SubscriptionUnderManagementGroup,
+  ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams,
+  ManagementGroupSubscriptionsCreateOptionalParams,
+  ManagementGroupSubscriptionsCreateResponse,
+  ManagementGroupSubscriptionsDeleteOptionalParams,
+  ManagementGroupSubscriptionsGetSubscriptionOptionalParams,
+  ManagementGroupSubscriptionsGetSubscriptionResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a ManagementGroupSubscriptions. */
+export interface ManagementGroupSubscriptions {
+  /**
+   * Retrieves details about all subscriptions which are associated with the management group.
+   *
+   * @param groupId Management Group ID.
+   * @param options The options parameters.
+   */
+  listSubscriptionsUnderManagementGroup(
+    groupId: string,
+    options?: ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams
+  ): PagedAsyncIterableIterator<SubscriptionUnderManagementGroup>;
+  /**
+   * Associates existing subscription with the management group.
+   *
+   * @param groupId Management Group ID.
+   * @param subscriptionId Subscription ID.
+   * @param options The options parameters.
+   */
+  create(
+    groupId: string,
+    subscriptionId: string,
+    options?: ManagementGroupSubscriptionsCreateOptionalParams
+  ): Promise<ManagementGroupSubscriptionsCreateResponse>;
+  /**
+   * De-associates subscription from the management group.
+   *
+   * @param groupId Management Group ID.
+   * @param subscriptionId Subscription ID.
+   * @param options The options parameters.
+   */
+  delete(
+    groupId: string,
+    subscriptionId: string,
+    options?: ManagementGroupSubscriptionsDeleteOptionalParams
+  ): Promise<void>;
+  /**
+   * Retrieves details about given subscription which is associated with the management group.
+   *
+   * @param groupId Management Group ID.
+   * @param subscriptionId Subscription ID.
+   * @param options The options parameters.
+   */
+  getSubscription(
+    groupId: string,
+    subscriptionId: string,
+    options?: ManagementGroupSubscriptionsGetSubscriptionOptionalParams
+  ): Promise<ManagementGroupSubscriptionsGetSubscriptionResponse>;
+}

package/src/operationsInterfaces/managementGroups.ts

@@ -0,0 +1,131 @@
+/*
+ * 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 { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PollerLike, PollOperationState } from "@azure/core-lro";
+import {
+  ManagementGroupInfo,
+  ManagementGroupsListOptionalParams,
+  DescendantInfo,
+  ManagementGroupsGetDescendantsOptionalParams,
+  ManagementGroupsGetOptionalParams,
+  ManagementGroupsGetResponse,
+  CreateManagementGroupRequest,
+  ManagementGroupsCreateOrUpdateOptionalParams,
+  ManagementGroupsCreateOrUpdateResponse,
+  PatchManagementGroupRequest,
+  ManagementGroupsUpdateOptionalParams,
+  ManagementGroupsUpdateResponse,
+  ManagementGroupsDeleteOptionalParams,
+  ManagementGroupsDeleteResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a ManagementGroups. */
+export interface ManagementGroups {
+  /**
+   * List management groups for the authenticated user.
+   *
+   * @param options The options parameters.
+   */
+  list(
+    options?: ManagementGroupsListOptionalParams
+  ): PagedAsyncIterableIterator<ManagementGroupInfo>;
+  /**
+   * List all entities that descend from a management group.
+   *
+   * @param groupId Management Group ID.
+   * @param options The options parameters.
+   */
+  listDescendants(
+    groupId: string,
+    options?: ManagementGroupsGetDescendantsOptionalParams
+  ): PagedAsyncIterableIterator<DescendantInfo>;
+  /**
+   * Get the details of the management group.
+   *
+   * @param groupId Management Group ID.
+   * @param options The options parameters.
+   */
+  get(
+    groupId: string,
+    options?: ManagementGroupsGetOptionalParams
+  ): Promise<ManagementGroupsGetResponse>;
+  /**
+   * Create or update a management group.
+   * If a management group is already created and a subsequent create request is issued with different
+   * properties, the management group properties will be updated.
+   *
+   * @param groupId Management Group ID.
+   * @param createManagementGroupRequest Management group creation parameters.
+   * @param options The options parameters.
+   */
+  beginCreateOrUpdate(
+    groupId: string,
+    createManagementGroupRequest: CreateManagementGroupRequest,
+    options?: ManagementGroupsCreateOrUpdateOptionalParams
+  ): Promise<
+    PollerLike<
+      PollOperationState<ManagementGroupsCreateOrUpdateResponse>,
+      ManagementGroupsCreateOrUpdateResponse
+    >
+  >;
+  /**
+   * Create or update a management group.
+   * If a management group is already created and a subsequent create request is issued with different
+   * properties, the management group properties will be updated.
+   *
+   * @param groupId Management Group ID.
+   * @param createManagementGroupRequest Management group creation parameters.
+   * @param options The options parameters.
+   */
+  beginCreateOrUpdateAndWait(
+    groupId: string,
+    createManagementGroupRequest: CreateManagementGroupRequest,
+    options?: ManagementGroupsCreateOrUpdateOptionalParams
+  ): Promise<ManagementGroupsCreateOrUpdateResponse>;
+  /**
+   * Update a management group.
+   *
+   * @param groupId Management Group ID.
+   * @param patchGroupRequest Management group patch parameters.
+   * @param options The options parameters.
+   */
+  update(
+    groupId: string,
+    patchGroupRequest: PatchManagementGroupRequest,
+    options?: ManagementGroupsUpdateOptionalParams
+  ): Promise<ManagementGroupsUpdateResponse>;
+  /**
+   * Delete management group.
+   * If a management group contains child resources, the request will fail.
+   *
+   * @param groupId Management Group ID.
+   * @param options The options parameters.
+   */
+  beginDelete(
+    groupId: string,
+    options?: ManagementGroupsDeleteOptionalParams
+  ): Promise<
+    PollerLike<
+      PollOperationState<ManagementGroupsDeleteResponse>,
+      ManagementGroupsDeleteResponse
+    >
+  >;
+  /**
+   * Delete management group.
+   * If a management group contains child resources, the request will fail.
+   *
+   * @param groupId Management Group ID.
+   * @param options The options parameters.
+   */
+  beginDeleteAndWait(
+    groupId: string,
+    options?: ManagementGroupsDeleteOptionalParams
+  ): Promise<ManagementGroupsDeleteResponse>;
+}

package/src/operationsInterfaces/operations.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { Operation, OperationsListOptionalParams } from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Operations. */
+export interface Operations {
+  /**
+   * Lists all of the available Management REST API operations.
+   * @param options The options parameters.
+   */
+  list(
+    options?: OperationsListOptionalParams
+  ): PagedAsyncIterableIterator<Operation>;
+}

package/tsconfig.json

@@ -3,17 +3,17 @@
     "module": "es6",
     "moduleResolution": "node",
     "strict": true,
-    "target": "es5",
+    "target": "es6",
     "sourceMap": true,
     "declarationMap": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "forceConsistentCasingInFileNames": true,
-    "lib": ["es6"],
+    "lib": ["es6", "dom"],
     "declaration": true,
-    "outDir": "./esm",
+    "outDir": "./dist-esm",
     "importHelpers": true
   },
-  "include": ["./src/**/*.ts"],
+  "include": ["./src/**/*.ts", "./test/**/*.ts"],
   "exclude": ["node_modules"]
 }