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

package/src/models/index.ts

@@ -0,0 +1,1082 @@
+/*
+ * 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 * as coreClient from "@azure/core-client";
+
+/** Describes the result of the request to list management groups. */
+export interface ManagementGroupListResult {
+  /** The list of management groups. */
+  value?: ManagementGroupInfo[];
+  /**
+   * The URL to use for getting the next set of results.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly nextLink?: string;
+}
+
+/** The management group resource. */
+export interface ManagementGroupInfo {
+  /**
+   * The fully qualified ID for the management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource. For example, Microsoft.Management/managementGroups
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The name of the management group. For example, 00000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /** The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 */
+  tenantId?: string;
+  /** The friendly name of the management group. */
+  displayName?: string;
+}
+
+/** The error object. */
+export interface ErrorResponse {
+  /** The details of the error. */
+  error?: ErrorDetails;
+}
+
+/** The details of the error. */
+export interface ErrorDetails {
+  /** One of a server-defined set of error codes. */
+  code?: string;
+  /** A human-readable representation of the error. */
+  message?: string;
+  /** A human-readable representation of the error's details. */
+  details?: string;
+}
+
+/** The management group details. */
+export interface ManagementGroup {
+  /**
+   * The fully qualified ID for the management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource.  For example, Microsoft.Management/managementGroups
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The name of the management group. For example, 00000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /** The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 */
+  tenantId?: string;
+  /** The friendly name of the management group. */
+  displayName?: string;
+  /** The details of a management group. */
+  details?: ManagementGroupDetails;
+  /** The list of children. */
+  children?: ManagementGroupChildInfo[];
+}
+
+/** The details of a management group. */
+export interface ManagementGroupDetails {
+  /** The version number of the object. */
+  version?: number;
+  /** The date and time when this object was last updated. */
+  updatedTime?: Date;
+  /** The identity of the principal or process that updated the object. */
+  updatedBy?: string;
+  /** (Optional) The ID of the parent management group. */
+  parent?: ParentGroupInfo;
+  /** The path from the root to the current group. */
+  path?: ManagementGroupPathElement[];
+  /** The ancestors of the management group. */
+  managementGroupAncestors?: string[];
+  /** The ancestors of the management group displayed in reversed order, from immediate parent to the root. */
+  managementGroupAncestorsChain?: ManagementGroupPathElement[];
+}
+
+/** (Optional) The ID of the parent management group. */
+export interface ParentGroupInfo {
+  /** The fully qualified ID for the parent management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */
+  id?: string;
+  /** The name of the parent management group */
+  name?: string;
+  /** The friendly name of the parent management group. */
+  displayName?: string;
+}
+
+/** A path element of a management group ancestors. */
+export interface ManagementGroupPathElement {
+  /** The name of the group. */
+  name?: string;
+  /** The friendly name of the group. */
+  displayName?: string;
+}
+
+/** The child information of a management group. */
+export interface ManagementGroupChildInfo {
+  /** The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups) */
+  type?: ManagementGroupChildType;
+  /** The fully qualified ID for the child resource (management group or subscription).  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */
+  id?: string;
+  /** The name of the child entity. */
+  name?: string;
+  /** The friendly name of the child resource. */
+  displayName?: string;
+  /** The list of children. */
+  children?: ManagementGroupChildInfo[];
+}
+
+/** Management group creation parameters. */
+export interface CreateManagementGroupRequest {
+  /**
+   * The fully qualified ID for the management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource.  For example, Microsoft.Management/managementGroups
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /** The name of the management group. For example, 00000000-0000-0000-0000-000000000000 */
+  name?: string;
+  /**
+   * The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly tenantId?: string;
+  /** The friendly name of the management group. If no value is passed then this  field will be set to the groupId. */
+  displayName?: string;
+  /** The details of a management group used during creation. */
+  details?: CreateManagementGroupDetails;
+  /**
+   * The list of children.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly children?: CreateManagementGroupChildInfo[];
+}
+
+/** The details of a management group used during creation. */
+export interface CreateManagementGroupDetails {
+  /**
+   * The version number of the object.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly version?: number;
+  /**
+   * The date and time when this object was last updated.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly updatedTime?: Date;
+  /**
+   * The identity of the principal or process that updated the object.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly updatedBy?: string;
+  /** (Optional) The ID of the parent management group used during creation. */
+  parent?: CreateParentGroupInfo;
+}
+
+/** (Optional) The ID of the parent management group used during creation. */
+export interface CreateParentGroupInfo {
+  /** The fully qualified ID for the parent management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */
+  id?: string;
+  /**
+   * The name of the parent management group
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /**
+   * The friendly name of the parent management group.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly displayName?: string;
+}
+
+/** The child information of a management group used during creation. */
+export interface CreateManagementGroupChildInfo {
+  /**
+   * The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups)
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: ManagementGroupChildType;
+  /**
+   * The fully qualified ID for the child resource (management group or subscription).  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The name of the child entity.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /**
+   * The friendly name of the child resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly displayName?: string;
+  /**
+   * The list of children.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly children?: CreateManagementGroupChildInfo[];
+}
+
+/** The results of Azure-AsyncOperation. */
+export interface AzureAsyncOperationResults {
+  /**
+   * The fully qualified ID for the management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource.  For example, Microsoft.Management/managementGroups
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The name of the management group. For example, 00000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /**
+   * The current status of the asynchronous operation performed . For example, Running, Succeeded, Failed
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly status?: string;
+  /** The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 */
+  tenantId?: string;
+  /** The friendly name of the management group. */
+  displayName?: string;
+}
+
+/** Management group patch parameters. */
+export interface PatchManagementGroupRequest {
+  /** The friendly name of the management group. */
+  displayName?: string;
+  /** (Optional) The fully qualified ID for the parent management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */
+  parentGroupId?: string;
+}
+
+/** Describes the result of the request to view descendants. */
+export interface DescendantListResult {
+  /** The list of descendants. */
+  value?: DescendantInfo[];
+  /**
+   * The URL to use for getting the next set of results.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly nextLink?: string;
+}
+
+/** The descendant. */
+export interface DescendantInfo {
+  /**
+   * The fully qualified ID for the descendant.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 or /subscriptions/0000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource. For example, Microsoft.Management/managementGroups or /subscriptions
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The name of the descendant. For example, 00000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /** The friendly name of the management group. */
+  displayName?: string;
+  /** The ID of the parent management group. */
+  parent?: DescendantParentGroupInfo;
+}
+
+/** The ID of the parent management group. */
+export interface DescendantParentGroupInfo {
+  /** The fully qualified ID for the parent management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */
+  id?: string;
+}
+
+/** The details of subscription under management group. */
+export interface SubscriptionUnderManagementGroup {
+  /**
+   * The fully qualified ID for the subscription.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/subscriptions/0000000-0000-0000-0000-000000000001
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource.  For example, Microsoft.Management/managementGroups/subscriptions
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The stringified id of the subscription. For example, 00000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /** The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000 */
+  tenant?: string;
+  /** The friendly name of the subscription. */
+  displayName?: string;
+  /** The ID of the parent management group. */
+  parent?: DescendantParentGroupInfo;
+  /** The state of the subscription. */
+  state?: string;
+}
+
+/** The details of all subscriptions under management group. */
+export interface ListSubscriptionUnderManagementGroup {
+  /** The list of subscriptions. */
+  value?: SubscriptionUnderManagementGroup[];
+  /**
+   * The URL to use for getting the next set of results.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly nextLink?: string;
+}
+
+/** Lists all hierarchy settings. */
+export interface HierarchySettingsList {
+  /** The list of hierarchy settings. */
+  value?: HierarchySettingsInfo[];
+  /**
+   * The URL to use for getting the next set of results.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly nextLink?: string;
+}
+
+/** The hierarchy settings resource. */
+export interface HierarchySettingsInfo {
+  /**
+   * The fully qualified ID for the settings object.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource.  For example, Microsoft.Management/managementGroups/settings.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The name of the object. In this case, default.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /** The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 */
+  tenantId?: string;
+  /** Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. */
+  requireAuthorizationForGroupCreation?: boolean;
+  /** Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup */
+  defaultManagementGroup?: string;
+}
+
+/** Settings defined at the Management Group scope. */
+export interface HierarchySettings {
+  /**
+   * The fully qualified ID for the settings object.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource.  For example, Microsoft.Management/managementGroups/settings.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The name of the object. In this case, default.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /** The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 */
+  tenantId?: string;
+  /** Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. */
+  requireAuthorizationForGroupCreation?: boolean;
+  /** Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup */
+  defaultManagementGroup?: string;
+}
+
+/** Parameters for creating or updating Management Group settings */
+export interface CreateOrUpdateSettingsRequest {
+  /** Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. */
+  requireAuthorizationForGroupCreation?: boolean;
+  /** Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup */
+  defaultManagementGroup?: string;
+}
+
+/** Describes the result of the request to list Microsoft.Management operations. */
+export interface OperationListResult {
+  /**
+   * List of operations supported by the Microsoft.Management resource provider.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly value?: Operation[];
+  /**
+   * URL to get the next set of operation list results if there are any.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly nextLink?: string;
+}
+
+/** Operation supported by the Microsoft.Management resource provider. */
+export interface Operation {
+  /**
+   * Operation name: {provider}/{resource}/{operation}.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /** The object that represents the operation. */
+  display?: OperationDisplayProperties;
+}
+
+/** The object that represents the operation. */
+export interface OperationDisplayProperties {
+  /**
+   * The name of the provider.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly provider?: string;
+  /**
+   * The resource on which the operation is performed.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly resource?: string;
+  /**
+   * The operation that can be performed.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly operation?: string;
+  /**
+   * Operation description.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly description?: string;
+}
+
+/** Management group name availability check parameters. */
+export interface CheckNameAvailabilityRequest {
+  /** the name to check for availability */
+  name?: string;
+  /** fully qualified resource type which includes provider namespace */
+  type?: "Microsoft.Management/managementGroups";
+}
+
+/** Describes the result of the request to check management group name availability. */
+export interface CheckNameAvailabilityResult {
+  /**
+   * Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly nameAvailable?: boolean;
+  /**
+   * Required if nameAvailable == false. Invalid indicates the name provided does not match the resource provider's naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly reason?: Reason;
+  /**
+   * Required if nameAvailable == false. Localized. If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly message?: string;
+}
+
+/** Describes the result of the request to view entities. */
+export interface EntityListResult {
+  /** The list of entities. */
+  value?: EntityInfo[];
+  /**
+   * Total count of records that match the filter
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly count?: number;
+  /**
+   * The URL to use for getting the next set of results.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly nextLink?: string;
+}
+
+/** The entity. */
+export interface EntityInfo {
+  /**
+   * The fully qualified ID for the entity.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource. For example, Microsoft.Management/managementGroups
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The name of the entity. For example, 00000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /** The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000 */
+  tenantId?: string;
+  /** The friendly name of the management group. */
+  displayName?: string;
+  /** (Optional) The ID of the parent management group. */
+  parent?: EntityParentGroupInfo;
+  /** The users specific permissions to this item. */
+  permissions?: Permissions;
+  /** The users specific permissions to this item. */
+  inheritedPermissions?: Permissions;
+  /** Number of Descendants */
+  numberOfDescendants?: number;
+  /** Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group. */
+  numberOfChildren?: number;
+  /** Number of children is the number of Groups that are exactly one level underneath the current Group. */
+  numberOfChildGroups?: number;
+  /** The parent display name chain from the root group to the immediate parent */
+  parentDisplayNameChain?: string[];
+  /** The parent name chain from the root group to the immediate parent */
+  parentNameChain?: string[];
+}
+
+/** (Optional) The ID of the parent management group. */
+export interface EntityParentGroupInfo {
+  /** The fully qualified ID for the parent management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */
+  id?: string;
+}
+
+/** The tenant backfill status */
+export interface TenantBackfillStatusResult {
+  /**
+   * The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly tenantId?: string;
+  /**
+   * The status of the Tenant Backfill
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly status?: Status;
+}
+
+/** The results of an asynchronous operation. */
+export interface OperationResults {
+  /**
+   * The fully qualified ID for the management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource.  For example, Microsoft.Management/managementGroups
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The name of the management group. For example, 00000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /** The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 */
+  tenantId?: string;
+  /** The friendly name of the management group. */
+  displayName?: string;
+}
+
+/** The management group details for the hierarchy view. */
+export interface EntityHierarchyItem {
+  /**
+   * The fully qualified ID for the management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The type of the resource.  For example, Microsoft.Management/managementGroups
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The name of the management group. For example, 00000000-0000-0000-0000-000000000000
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /** The friendly name of the management group. */
+  displayName?: string;
+  /** The users specific permissions to this item. */
+  permissions?: Permissions;
+  /** The list of children. */
+  children?: EntityHierarchyItem[];
+}
+
+/** Defines headers for ManagementGroups_createOrUpdate operation. */
+export interface ManagementGroupsCreateOrUpdateHeaders {
+  /**
+   * URL for determining when an operation has completed. Send a GET request to the URL in Location header.
+   * The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.
+   *
+   * For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers
+   */
+  location?: string;
+  /**
+   * URL for checking the ongoing status of the operation.
+   * To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.
+   *
+   * For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations
+   */
+  azureAsyncOperation?: string;
+}
+
+/** Defines headers for ManagementGroups_delete operation. */
+export interface ManagementGroupsDeleteHeaders {
+  /**
+   * URL for determining when an operation has completed. Send a GET request to the URL in Location header.
+   * The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.
+   *
+   * For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers
+   */
+  location?: string;
+  /**
+   * URL for checking the ongoing status of the operation.
+   * To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.
+   *
+   * For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations
+   */
+  azureAsyncOperation?: string;
+}
+
+/** Known values of {@link Enum0} that the service accepts. */
+export enum KnownEnum0 {
+  Children = "children",
+  Path = "path",
+  Ancestors = "ancestors"
+}
+
+/**
+ * Defines values for Enum0. \
+ * {@link KnownEnum0} can be used interchangeably with Enum0,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **children** \
+ * **path** \
+ * **ancestors**
+ */
+export type Enum0 = string;
+
+/** Known values of {@link ManagementGroupChildType} that the service accepts. */
+export enum KnownManagementGroupChildType {
+  MicrosoftManagementManagementGroups = "Microsoft.Management/managementGroups",
+  Subscriptions = "/subscriptions"
+}
+
+/**
+ * Defines values for ManagementGroupChildType. \
+ * {@link KnownManagementGroupChildType} can be used interchangeably with ManagementGroupChildType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Microsoft.Management\/managementGroups** \
+ * **\/subscriptions**
+ */
+export type ManagementGroupChildType = string;
+
+/** Known values of {@link Enum2} that the service accepts. */
+export enum KnownEnum2 {
+  AllowedParents = "AllowedParents",
+  AllowedChildren = "AllowedChildren",
+  ParentAndFirstLevelChildren = "ParentAndFirstLevelChildren",
+  ParentOnly = "ParentOnly",
+  ChildrenOnly = "ChildrenOnly"
+}
+
+/**
+ * Defines values for Enum2. \
+ * {@link KnownEnum2} can be used interchangeably with Enum2,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **AllowedParents** \
+ * **AllowedChildren** \
+ * **ParentAndFirstLevelChildren** \
+ * **ParentOnly** \
+ * **ChildrenOnly**
+ */
+export type Enum2 = string;
+
+/** Known values of {@link Enum3} that the service accepts. */
+export enum KnownEnum3 {
+  FullHierarchy = "FullHierarchy",
+  GroupsOnly = "GroupsOnly",
+  SubscriptionsOnly = "SubscriptionsOnly",
+  Audit = "Audit"
+}
+
+/**
+ * Defines values for Enum3. \
+ * {@link KnownEnum3} can be used interchangeably with Enum3,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **FullHierarchy** \
+ * **GroupsOnly** \
+ * **SubscriptionsOnly** \
+ * **Audit**
+ */
+export type Enum3 = string;
+
+/** Known values of {@link Permissions} that the service accepts. */
+export enum KnownPermissions {
+  Noaccess = "noaccess",
+  View = "view",
+  Edit = "edit",
+  Delete = "delete"
+}
+
+/**
+ * Defines values for Permissions. \
+ * {@link KnownPermissions} can be used interchangeably with Permissions,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **noaccess** \
+ * **view** \
+ * **edit** \
+ * **delete**
+ */
+export type Permissions = string;
+/** Defines values for Reason. */
+export type Reason = "Invalid" | "AlreadyExists";
+/** Defines values for Status. */
+export type Status =
+  | "NotStarted"
+  | "NotStartedButGroupsExist"
+  | "Started"
+  | "Failed"
+  | "Cancelled"
+  | "Completed";
+
+/** Optional parameters. */
+export interface ManagementGroupsListOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+  /**
+   * Page continuation token is only used if a previous operation returned a partial result.
+   * If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.
+   *
+   */
+  skiptoken?: string;
+}
+
+/** Contains response data for the list operation. */
+export type ManagementGroupsListResponse = ManagementGroupListResult;
+
+/** Optional parameters. */
+export interface ManagementGroupsGetOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+  /** The $expand=children query string parameter allows clients to request inclusion of children in the response payload.  $expand=path includes the path from the root group to the current group.  $expand=ancestors includes the ancestor Ids of the current group. */
+  expand?: Enum0;
+  /** The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that  $expand=children must be passed up if $recurse is set to true. */
+  recurse?: boolean;
+  /** A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription') */
+  filter?: string;
+}
+
+/** Contains response data for the get operation. */
+export type ManagementGroupsGetResponse = ManagementGroup;
+
+/** Optional parameters. */
+export interface ManagementGroupsCreateOrUpdateOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+  /** Delay to wait until next poll, in milliseconds. */
+  updateIntervalInMs?: number;
+  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+  resumeFrom?: string;
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export type ManagementGroupsCreateOrUpdateResponse = ManagementGroup;
+
+/** Optional parameters. */
+export interface ManagementGroupsUpdateOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+}
+
+/** Contains response data for the update operation. */
+export type ManagementGroupsUpdateResponse = ManagementGroup;
+
+/** Optional parameters. */
+export interface ManagementGroupsDeleteOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+  /** Delay to wait until next poll, in milliseconds. */
+  updateIntervalInMs?: number;
+  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+  resumeFrom?: string;
+}
+
+/** Contains response data for the delete operation. */
+export type ManagementGroupsDeleteResponse = ManagementGroupsDeleteHeaders &
+  AzureAsyncOperationResults;
+
+/** Optional parameters. */
+export interface ManagementGroupsGetDescendantsOptionalParams
+  extends coreClient.OperationOptions {
+  /**
+   * Page continuation token is only used if a previous operation returned a partial result.
+   * If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.
+   *
+   */
+  skiptoken?: string;
+  /** Number of elements to return when retrieving results. Passing this in will override $skipToken. */
+  top?: number;
+}
+
+/** Contains response data for the getDescendants operation. */
+export type ManagementGroupsGetDescendantsResponse = DescendantListResult;
+
+/** Optional parameters. */
+export interface ManagementGroupsListNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+  /**
+   * Page continuation token is only used if a previous operation returned a partial result.
+   * If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.
+   *
+   */
+  skiptoken?: string;
+}
+
+/** Contains response data for the listNext operation. */
+export type ManagementGroupsListNextResponse = ManagementGroupListResult;
+
+/** Optional parameters. */
+export interface ManagementGroupsGetDescendantsNextOptionalParams
+  extends coreClient.OperationOptions {
+  /**
+   * Page continuation token is only used if a previous operation returned a partial result.
+   * If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.
+   *
+   */
+  skiptoken?: string;
+  /** Number of elements to return when retrieving results. Passing this in will override $skipToken. */
+  top?: number;
+}
+
+/** Contains response data for the getDescendantsNext operation. */
+export type ManagementGroupsGetDescendantsNextResponse = DescendantListResult;
+
+/** Optional parameters. */
+export interface ManagementGroupSubscriptionsCreateOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+}
+
+/** Contains response data for the create operation. */
+export type ManagementGroupSubscriptionsCreateResponse = SubscriptionUnderManagementGroup;
+
+/** Optional parameters. */
+export interface ManagementGroupSubscriptionsDeleteOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+}
+
+/** Optional parameters. */
+export interface ManagementGroupSubscriptionsGetSubscriptionOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+}
+
+/** Contains response data for the getSubscription operation. */
+export type ManagementGroupSubscriptionsGetSubscriptionResponse = SubscriptionUnderManagementGroup;
+
+/** Optional parameters. */
+export interface ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams
+  extends coreClient.OperationOptions {
+  /**
+   * Page continuation token is only used if a previous operation returned a partial result.
+   * If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.
+   *
+   */
+  skiptoken?: string;
+}
+
+/** Contains response data for the getSubscriptionsUnderManagementGroup operation. */
+export type ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupResponse = ListSubscriptionUnderManagementGroup;
+
+/** Optional parameters. */
+export interface ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupNextOptionalParams
+  extends coreClient.OperationOptions {
+  /**
+   * Page continuation token is only used if a previous operation returned a partial result.
+   * If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.
+   *
+   */
+  skiptoken?: string;
+}
+
+/** Contains response data for the getSubscriptionsUnderManagementGroupNext operation. */
+export type ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupNextResponse = ListSubscriptionUnderManagementGroup;
+
+/** Optional parameters. */
+export interface HierarchySettingsListOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the list operation. */
+export type HierarchySettingsListResponse = HierarchySettingsList;
+
+/** Optional parameters. */
+export interface HierarchySettingsGetOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the get operation. */
+export type HierarchySettingsGetResponse = HierarchySettings;
+
+/** Optional parameters. */
+export interface HierarchySettingsCreateOrUpdateOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the createOrUpdate operation. */
+export type HierarchySettingsCreateOrUpdateResponse = HierarchySettings;
+
+/** Optional parameters. */
+export interface HierarchySettingsUpdateOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the update operation. */
+export type HierarchySettingsUpdateResponse = HierarchySettings;
+
+/** Optional parameters. */
+export interface HierarchySettingsDeleteOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Optional parameters. */
+export interface OperationsListOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the list operation. */
+export type OperationsListResponse = OperationListResult;
+
+/** Optional parameters. */
+export interface OperationsListNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listNext operation. */
+export type OperationsListNextResponse = OperationListResult;
+
+/** Optional parameters. */
+export interface CheckNameAvailabilityOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the checkNameAvailability operation. */
+export type CheckNameAvailabilityResponse = CheckNameAvailabilityResult;
+
+/** Optional parameters. */
+export interface StartTenantBackfillOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the startTenantBackfill operation. */
+export type StartTenantBackfillResponse = TenantBackfillStatusResult;
+
+/** Optional parameters. */
+export interface TenantBackfillStatusOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the tenantBackfillStatus operation. */
+export type TenantBackfillStatusResponse = TenantBackfillStatusResult;
+
+/** Optional parameters. */
+export interface EntitiesListOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+  /**
+   * Page continuation token is only used if a previous operation returned a partial result.
+   * If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.
+   *
+   */
+  skiptoken?: string;
+  /** The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}')  and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively. */
+  filter?: string;
+  /** Number of elements to return when retrieving results. Passing this in will override $skipToken. */
+  top?: number;
+  /** Number of entities to skip over when retrieving results. Passing this in will override $skipToken. */
+  skip?: number;
+  /** This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken. */
+  select?: string;
+  /**
+   * The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in.
+   * With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions.
+   * With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity.
+   * With $search=ParentAndFirstLevelChildren the API will return the parent and  first level of children that the user has either direct access to or indirect access via one of their descendants.
+   * With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group.
+   * With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter.  The user must have direct access to the children entities or one of it's descendants for it to show up in the results.
+   */
+  search?: Enum2;
+  /** The view parameter allows clients to filter the type of data that is returned by the getEntities call. */
+  view?: Enum3;
+  /** A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'") */
+  groupName?: string;
+}
+
+/** Contains response data for the list operation. */
+export type EntitiesListResponse = EntityListResult;
+
+/** Optional parameters. */
+export interface EntitiesListNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. */
+  cacheControl?: string;
+  /**
+   * Page continuation token is only used if a previous operation returned a partial result.
+   * If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.
+   *
+   */
+  skiptoken?: string;
+  /** The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}')  and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively. */
+  filter?: string;
+  /** Number of elements to return when retrieving results. Passing this in will override $skipToken. */
+  top?: number;
+  /** Number of entities to skip over when retrieving results. Passing this in will override $skipToken. */
+  skip?: number;
+  /** This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken. */
+  select?: string;
+  /**
+   * The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in.
+   * With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions.
+   * With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity.
+   * With $search=ParentAndFirstLevelChildren the API will return the parent and  first level of children that the user has either direct access to or indirect access via one of their descendants.
+   * With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group.
+   * With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter.  The user must have direct access to the children entities or one of it's descendants for it to show up in the results.
+   */
+  search?: Enum2;
+  /** The view parameter allows clients to filter the type of data that is returned by the getEntities call. */
+  view?: Enum3;
+  /** A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'") */
+  groupName?: string;
+}
+
+/** Contains response data for the listNext operation. */
+export type EntitiesListNextResponse = EntityListResult;
+
+/** Optional parameters. */
+export interface ManagementGroupsAPIOptionalParams
+  extends coreClient.ServiceClientOptions {
+  /** server parameter */
+  $host?: string;
+  /** Api Version */
+  apiVersion?: string;
+  /** Overrides client endpoint. */
+  endpoint?: string;
+}