@azure/arm-managementgroups 1.1.0 → 2.0.0-alpha.20211214.2

package/src/models/parameters.ts

@@ -0,0 +1,232 @@
+/*
+ * 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 {
+  OperationParameter,
+  OperationURLParameter,
+  OperationQueryParameter
+} from "@azure/core-client";
+import {
+  CreateManagementGroupRequest as CreateManagementGroupRequestMapper,
+  PatchManagementGroupRequest as PatchManagementGroupRequestMapper,
+  CreateOrUpdateSettingsRequest as CreateOrUpdateSettingsRequestMapper,
+  CheckNameAvailabilityRequest as CheckNameAvailabilityRequestMapper
+} from "../models/mappers";
+
+export const accept: OperationParameter = {
+  parameterPath: "accept",
+  mapper: {
+    defaultValue: "application/json",
+    isConstant: true,
+    serializedName: "Accept",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const $host: OperationURLParameter = {
+  parameterPath: "$host",
+  mapper: {
+    serializedName: "$host",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const apiVersion: OperationQueryParameter = {
+  parameterPath: "apiVersion",
+  mapper: {
+    defaultValue: "2021-04-01",
+    isConstant: true,
+    serializedName: "api-version",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const cacheControl: OperationParameter = {
+  parameterPath: ["options", "cacheControl"],
+  mapper: {
+    defaultValue: "no-cache",
+    serializedName: "Cache-Control",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const skiptoken: OperationQueryParameter = {
+  parameterPath: ["options", "skiptoken"],
+  mapper: {
+    serializedName: "$skiptoken",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const groupId: OperationURLParameter = {
+  parameterPath: "groupId",
+  mapper: {
+    serializedName: "groupId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const expand: OperationQueryParameter = {
+  parameterPath: ["options", "expand"],
+  mapper: {
+    serializedName: "$expand",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const recurse: OperationQueryParameter = {
+  parameterPath: ["options", "recurse"],
+  mapper: {
+    serializedName: "$recurse",
+    type: {
+      name: "Boolean"
+    }
+  }
+};
+
+export const filter: OperationQueryParameter = {
+  parameterPath: ["options", "filter"],
+  mapper: {
+    serializedName: "$filter",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const contentType: OperationParameter = {
+  parameterPath: ["options", "contentType"],
+  mapper: {
+    defaultValue: "application/json",
+    isConstant: true,
+    serializedName: "Content-Type",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const createManagementGroupRequest: OperationParameter = {
+  parameterPath: "createManagementGroupRequest",
+  mapper: CreateManagementGroupRequestMapper
+};
+
+export const patchGroupRequest: OperationParameter = {
+  parameterPath: "patchGroupRequest",
+  mapper: PatchManagementGroupRequestMapper
+};
+
+export const top: OperationQueryParameter = {
+  parameterPath: ["options", "top"],
+  mapper: {
+    serializedName: "$top",
+    type: {
+      name: "Number"
+    }
+  }
+};
+
+export const nextLink: OperationURLParameter = {
+  parameterPath: "nextLink",
+  mapper: {
+    serializedName: "nextLink",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const subscriptionId: OperationURLParameter = {
+  parameterPath: "subscriptionId",
+  mapper: {
+    serializedName: "subscriptionId",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const createTenantSettingsRequest: OperationParameter = {
+  parameterPath: "createTenantSettingsRequest",
+  mapper: CreateOrUpdateSettingsRequestMapper
+};
+
+export const checkNameAvailabilityRequest: OperationParameter = {
+  parameterPath: "checkNameAvailabilityRequest",
+  mapper: CheckNameAvailabilityRequestMapper
+};
+
+export const skip: OperationQueryParameter = {
+  parameterPath: ["options", "skip"],
+  mapper: {
+    serializedName: "$skip",
+    type: {
+      name: "Number"
+    }
+  }
+};
+
+export const select: OperationQueryParameter = {
+  parameterPath: ["options", "select"],
+  mapper: {
+    serializedName: "$select",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const search: OperationQueryParameter = {
+  parameterPath: ["options", "search"],
+  mapper: {
+    serializedName: "$search",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const view: OperationQueryParameter = {
+  parameterPath: ["options", "view"],
+  mapper: {
+    serializedName: "$view",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const groupName: OperationQueryParameter = {
+  parameterPath: ["options", "groupName"],
+  mapper: {
+    serializedName: "groupName",
+    type: {
+      name: "String"
+    }
+  }
+};

package/src/operations/entities.ts

@@ -0,0 +1,159 @@
+/*
+ * 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 { Entities } 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 {
+  EntityInfo,
+  EntitiesListNextOptionalParams,
+  EntitiesListOptionalParams,
+  EntitiesListResponse,
+  EntitiesListNextResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Class containing Entities operations. */
+export class EntitiesImpl implements Entities {
+  private readonly client: ManagementGroupsAPIContext;
+
+  /**
+   * Initialize a new instance of the class Entities class.
+   * @param client Reference to the service client
+   */
+  constructor(client: ManagementGroupsAPIContext) {
+    this.client = client;
+  }
+
+  /**
+   * List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.
+   *
+   * @param options The options parameters.
+   */
+  public list(
+    options?: EntitiesListOptionalParams
+  ): PagedAsyncIterableIterator<EntityInfo> {
+    const iter = this.listPagingAll(options);
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+      byPage: () => {
+        return this.listPagingPage(options);
+      }
+    };
+  }
+
+  private async *listPagingPage(
+    options?: EntitiesListOptionalParams
+  ): AsyncIterableIterator<EntityInfo[]> {
+    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?: EntitiesListOptionalParams
+  ): AsyncIterableIterator<EntityInfo> {
+    for await (const page of this.listPagingPage(options)) {
+      yield* page;
+    }
+  }
+
+  /**
+   * List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.
+   *
+   * @param options The options parameters.
+   */
+  private _list(
+    options?: EntitiesListOptionalParams
+  ): Promise<EntitiesListResponse> {
+    return this.client.sendOperationRequest({ options }, listOperationSpec);
+  }
+
+  /**
+   * ListNext
+   * @param nextLink The nextLink from the previous successful call to the List method.
+   * @param options The options parameters.
+   */
+  private _listNext(
+    nextLink: string,
+    options?: EntitiesListNextOptionalParams
+  ): Promise<EntitiesListNextResponse> {
+    return this.client.sendOperationRequest(
+      { nextLink, options },
+      listNextOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listOperationSpec: coreClient.OperationSpec = {
+  path: "/providers/Microsoft.Management/getEntities",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.EntityListResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.skiptoken,
+    Parameters.filter,
+    Parameters.top,
+    Parameters.skip,
+    Parameters.select,
+    Parameters.search,
+    Parameters.view,
+    Parameters.groupName
+  ],
+  urlParameters: [Parameters.$host],
+  headerParameters: [Parameters.accept, Parameters.cacheControl],
+  serializer
+};
+const listNextOperationSpec: coreClient.OperationSpec = {
+  path: "{nextLink}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.EntityListResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.skiptoken,
+    Parameters.filter,
+    Parameters.top,
+    Parameters.skip,
+    Parameters.select,
+    Parameters.search,
+    Parameters.view,
+    Parameters.groupName
+  ],
+  urlParameters: [Parameters.$host, Parameters.nextLink],
+  headerParameters: [Parameters.accept, Parameters.cacheControl],
+  serializer
+};

package/src/operations/hierarchySettingsOperations.ts

@@ -0,0 +1,214 @@
+/*
+ * 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 { HierarchySettingsOperations } 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 {
+  HierarchySettingsListOptionalParams,
+  HierarchySettingsListResponse,
+  HierarchySettingsGetOptionalParams,
+  HierarchySettingsGetResponse,
+  CreateOrUpdateSettingsRequest,
+  HierarchySettingsCreateOrUpdateOptionalParams,
+  HierarchySettingsCreateOrUpdateResponse,
+  HierarchySettingsUpdateOptionalParams,
+  HierarchySettingsUpdateResponse,
+  HierarchySettingsDeleteOptionalParams
+} from "../models";
+
+/** Class containing HierarchySettingsOperations operations. */
+export class HierarchySettingsOperationsImpl
+  implements HierarchySettingsOperations {
+  private readonly client: ManagementGroupsAPIContext;
+
+  /**
+   * Initialize a new instance of the class HierarchySettingsOperations class.
+   * @param client Reference to the service client
+   */
+  constructor(client: ManagementGroupsAPIContext) {
+    this.client = client;
+  }
+
+  /**
+   * 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> {
+    return this.client.sendOperationRequest(
+      { groupId, options },
+      listOperationSpec
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.sendOperationRequest(
+      { groupId, options },
+      getOperationSpec
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.sendOperationRequest(
+      { groupId, createTenantSettingsRequest, options },
+      createOrUpdateOperationSpec
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.sendOperationRequest(
+      { groupId, createTenantSettingsRequest, options },
+      updateOperationSpec
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.sendOperationRequest(
+      { groupId, options },
+      deleteOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listOperationSpec: coreClient.OperationSpec = {
+  path: "/providers/Microsoft.Management/managementGroups/{groupId}/settings",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.HierarchySettingsList
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.groupId],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const getOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/providers/Microsoft.Management/managementGroups/{groupId}/settings/default",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.HierarchySettings
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.groupId],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const createOrUpdateOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/providers/Microsoft.Management/managementGroups/{groupId}/settings/default",
+  httpMethod: "PUT",
+  responses: {
+    200: {
+      bodyMapper: Mappers.HierarchySettings
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.createTenantSettingsRequest,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.groupId],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
+const updateOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/providers/Microsoft.Management/managementGroups/{groupId}/settings/default",
+  httpMethod: "PATCH",
+  responses: {
+    200: {
+      bodyMapper: Mappers.HierarchySettings
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.createTenantSettingsRequest,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.groupId],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
+const deleteOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/providers/Microsoft.Management/managementGroups/{groupId}/settings/default",
+  httpMethod: "DELETE",
+  responses: {
+    200: {},
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.groupId],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/{lib → src}/operations/index.ts

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