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

package/review/arm-managementgroups.api.md

@@ -0,0 +1,667 @@
+## API Report File for "@azure/arm-managementgroups"
+
+> 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 interface AzureAsyncOperationResults {
+    displayName?: string;
+    readonly id?: string;
+    readonly name?: string;
+    readonly status?: string;
+    tenantId?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface CheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface CheckNameAvailabilityRequest {
+    name?: string;
+    type?: "Microsoft.Management/managementGroups";
+}
+
+// @public
+export type CheckNameAvailabilityResponse = CheckNameAvailabilityResult;
+
+// @public
+export interface CheckNameAvailabilityResult {
+    readonly message?: string;
+    readonly nameAvailable?: boolean;
+    readonly reason?: Reason;
+}
+
+// @public
+export interface CreateManagementGroupChildInfo {
+    readonly children?: CreateManagementGroupChildInfo[];
+    readonly displayName?: string;
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: ManagementGroupChildType;
+}
+
+// @public
+export interface CreateManagementGroupDetails {
+    parent?: CreateParentGroupInfo;
+    readonly updatedBy?: string;
+    readonly updatedTime?: Date;
+    readonly version?: number;
+}
+
+// @public
+export interface CreateManagementGroupRequest {
+    readonly children?: CreateManagementGroupChildInfo[];
+    details?: CreateManagementGroupDetails;
+    displayName?: string;
+    readonly id?: string;
+    name?: string;
+    readonly tenantId?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface CreateOrUpdateSettingsRequest {
+    defaultManagementGroup?: string;
+    requireAuthorizationForGroupCreation?: boolean;
+}
+
+// @public
+export interface CreateParentGroupInfo {
+    readonly displayName?: string;
+    id?: string;
+    readonly name?: string;
+}
+
+// @public
+export interface DescendantInfo {
+    displayName?: string;
+    readonly id?: string;
+    readonly name?: string;
+    parent?: DescendantParentGroupInfo;
+    readonly type?: string;
+}
+
+// @public
+export interface DescendantListResult {
+    readonly nextLink?: string;
+    value?: DescendantInfo[];
+}
+
+// @public
+export interface DescendantParentGroupInfo {
+    id?: string;
+}
+
+// @public
+export interface Entities {
+    list(options?: EntitiesListOptionalParams): PagedAsyncIterableIterator<EntityInfo>;
+}
+
+// @public
+export interface EntitiesListNextOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+    filter?: string;
+    groupName?: string;
+    search?: Enum2;
+    select?: string;
+    skip?: number;
+    skiptoken?: string;
+    top?: number;
+    view?: Enum3;
+}
+
+// @public
+export type EntitiesListNextResponse = EntityListResult;
+
+// @public
+export interface EntitiesListOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+    filter?: string;
+    groupName?: string;
+    search?: Enum2;
+    select?: string;
+    skip?: number;
+    skiptoken?: string;
+    top?: number;
+    view?: Enum3;
+}
+
+// @public
+export type EntitiesListResponse = EntityListResult;
+
+// @public
+export interface EntityHierarchyItem {
+    children?: EntityHierarchyItem[];
+    displayName?: string;
+    readonly id?: string;
+    readonly name?: string;
+    permissions?: Permissions_2;
+    readonly type?: string;
+}
+
+// @public
+export interface EntityInfo {
+    displayName?: string;
+    readonly id?: string;
+    inheritedPermissions?: Permissions_2;
+    readonly name?: string;
+    numberOfChildGroups?: number;
+    numberOfChildren?: number;
+    numberOfDescendants?: number;
+    parent?: EntityParentGroupInfo;
+    parentDisplayNameChain?: string[];
+    parentNameChain?: string[];
+    permissions?: Permissions_2;
+    tenantId?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface EntityListResult {
+    readonly count?: number;
+    readonly nextLink?: string;
+    value?: EntityInfo[];
+}
+
+// @public
+export interface EntityParentGroupInfo {
+    id?: string;
+}
+
+// @public
+export type Enum0 = string;
+
+// @public
+export type Enum2 = string;
+
+// @public
+export type Enum3 = string;
+
+// @public
+export interface ErrorDetails {
+    code?: string;
+    details?: string;
+    message?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetails;
+}
+
+// @public
+export interface HierarchySettings {
+    defaultManagementGroup?: string;
+    readonly id?: string;
+    readonly name?: string;
+    requireAuthorizationForGroupCreation?: boolean;
+    tenantId?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface HierarchySettingsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HierarchySettingsCreateOrUpdateResponse = HierarchySettings;
+
+// @public
+export interface HierarchySettingsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface HierarchySettingsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HierarchySettingsGetResponse = HierarchySettings;
+
+// @public
+export interface HierarchySettingsInfo {
+    defaultManagementGroup?: string;
+    readonly id?: string;
+    readonly name?: string;
+    requireAuthorizationForGroupCreation?: boolean;
+    tenantId?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface HierarchySettingsList {
+    readonly nextLink?: string;
+    value?: HierarchySettingsInfo[];
+}
+
+// @public
+export interface HierarchySettingsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HierarchySettingsListResponse = HierarchySettingsList;
+
+// @public
+export interface HierarchySettingsOperations {
+    createOrUpdate(groupId: string, createTenantSettingsRequest: CreateOrUpdateSettingsRequest, options?: HierarchySettingsCreateOrUpdateOptionalParams): Promise<HierarchySettingsCreateOrUpdateResponse>;
+    delete(groupId: string, options?: HierarchySettingsDeleteOptionalParams): Promise<void>;
+    get(groupId: string, options?: HierarchySettingsGetOptionalParams): Promise<HierarchySettingsGetResponse>;
+    list(groupId: string, options?: HierarchySettingsListOptionalParams): Promise<HierarchySettingsListResponse>;
+    update(groupId: string, createTenantSettingsRequest: CreateOrUpdateSettingsRequest, options?: HierarchySettingsUpdateOptionalParams): Promise<HierarchySettingsUpdateResponse>;
+}
+
+// @public
+export interface HierarchySettingsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HierarchySettingsUpdateResponse = HierarchySettings;
+
+// @public
+export enum KnownEnum0 {
+    // (undocumented)
+    Ancestors = "ancestors",
+    // (undocumented)
+    Children = "children",
+    // (undocumented)
+    Path = "path"
+}
+
+// @public
+export enum KnownEnum2 {
+    // (undocumented)
+    AllowedChildren = "AllowedChildren",
+    // (undocumented)
+    AllowedParents = "AllowedParents",
+    // (undocumented)
+    ChildrenOnly = "ChildrenOnly",
+    // (undocumented)
+    ParentAndFirstLevelChildren = "ParentAndFirstLevelChildren",
+    // (undocumented)
+    ParentOnly = "ParentOnly"
+}
+
+// @public
+export enum KnownEnum3 {
+    // (undocumented)
+    Audit = "Audit",
+    // (undocumented)
+    FullHierarchy = "FullHierarchy",
+    // (undocumented)
+    GroupsOnly = "GroupsOnly",
+    // (undocumented)
+    SubscriptionsOnly = "SubscriptionsOnly"
+}
+
+// @public
+export enum KnownManagementGroupChildType {
+    // (undocumented)
+    MicrosoftManagementManagementGroups = "Microsoft.Management/managementGroups",
+    // (undocumented)
+    Subscriptions = "/subscriptions"
+}
+
+// @public
+export enum KnownPermissions {
+    // (undocumented)
+    Delete = "delete",
+    // (undocumented)
+    Edit = "edit",
+    // (undocumented)
+    Noaccess = "noaccess",
+    // (undocumented)
+    View = "view"
+}
+
+// @public
+export interface ListSubscriptionUnderManagementGroup {
+    readonly nextLink?: string;
+    value?: SubscriptionUnderManagementGroup[];
+}
+
+// @public
+export interface ManagementGroup {
+    children?: ManagementGroupChildInfo[];
+    details?: ManagementGroupDetails;
+    displayName?: string;
+    readonly id?: string;
+    readonly name?: string;
+    tenantId?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface ManagementGroupChildInfo {
+    children?: ManagementGroupChildInfo[];
+    displayName?: string;
+    id?: string;
+    name?: string;
+    type?: ManagementGroupChildType;
+}
+
+// @public
+export type ManagementGroupChildType = string;
+
+// @public
+export interface ManagementGroupDetails {
+    managementGroupAncestors?: string[];
+    managementGroupAncestorsChain?: ManagementGroupPathElement[];
+    parent?: ParentGroupInfo;
+    path?: ManagementGroupPathElement[];
+    updatedBy?: string;
+    updatedTime?: Date;
+    version?: number;
+}
+
+// @public
+export interface ManagementGroupInfo {
+    displayName?: string;
+    readonly id?: string;
+    readonly name?: string;
+    tenantId?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface ManagementGroupListResult {
+    readonly nextLink?: string;
+    value?: ManagementGroupInfo[];
+}
+
+// @public
+export interface ManagementGroupPathElement {
+    displayName?: string;
+    name?: string;
+}
+
+// @public
+export interface ManagementGroups {
+    beginCreateOrUpdate(groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: ManagementGroupsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ManagementGroupsCreateOrUpdateResponse>, ManagementGroupsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: ManagementGroupsCreateOrUpdateOptionalParams): Promise<ManagementGroupsCreateOrUpdateResponse>;
+    beginDelete(groupId: string, options?: ManagementGroupsDeleteOptionalParams): Promise<PollerLike<PollOperationState<ManagementGroupsDeleteResponse>, ManagementGroupsDeleteResponse>>;
+    beginDeleteAndWait(groupId: string, options?: ManagementGroupsDeleteOptionalParams): Promise<ManagementGroupsDeleteResponse>;
+    get(groupId: string, options?: ManagementGroupsGetOptionalParams): Promise<ManagementGroupsGetResponse>;
+    list(options?: ManagementGroupsListOptionalParams): PagedAsyncIterableIterator<ManagementGroupInfo>;
+    listDescendants(groupId: string, options?: ManagementGroupsGetDescendantsOptionalParams): PagedAsyncIterableIterator<DescendantInfo>;
+    update(groupId: string, patchGroupRequest: PatchManagementGroupRequest, options?: ManagementGroupsUpdateOptionalParams): Promise<ManagementGroupsUpdateResponse>;
+}
+
+// @public (undocumented)
+export class ManagementGroupsAPI extends ManagementGroupsAPIContext {
+    constructor(credentials: coreAuth.TokenCredential, options?: ManagementGroupsAPIOptionalParams);
+    checkNameAvailability(checkNameAvailabilityRequest: CheckNameAvailabilityRequest, options?: CheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResponse>;
+    // (undocumented)
+    entities: Entities;
+    // (undocumented)
+    hierarchySettingsOperations: HierarchySettingsOperations;
+    // (undocumented)
+    managementGroups: ManagementGroups;
+    // (undocumented)
+    managementGroupSubscriptions: ManagementGroupSubscriptions;
+    // (undocumented)
+    operations: Operations;
+    startTenantBackfill(options?: StartTenantBackfillOptionalParams): Promise<StartTenantBackfillResponse>;
+    tenantBackfillStatus(options?: TenantBackfillStatusOptionalParams): Promise<TenantBackfillStatusResponse>;
+}
+
+// @public (undocumented)
+export class ManagementGroupsAPIContext extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, options?: ManagementGroupsAPIOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+}
+
+// @public
+export interface ManagementGroupsAPIOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface ManagementGroupsCreateOrUpdateHeaders {
+    azureAsyncOperation?: string;
+    location?: string;
+}
+
+// @public
+export interface ManagementGroupsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ManagementGroupsCreateOrUpdateResponse = ManagementGroup;
+
+// @public
+export interface ManagementGroupsDeleteHeaders {
+    azureAsyncOperation?: string;
+    location?: string;
+}
+
+// @public
+export interface ManagementGroupsDeleteOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ManagementGroupsDeleteResponse = ManagementGroupsDeleteHeaders & AzureAsyncOperationResults;
+
+// @public
+export interface ManagementGroupsGetDescendantsNextOptionalParams extends coreClient.OperationOptions {
+    skiptoken?: string;
+    top?: number;
+}
+
+// @public
+export type ManagementGroupsGetDescendantsNextResponse = DescendantListResult;
+
+// @public
+export interface ManagementGroupsGetDescendantsOptionalParams extends coreClient.OperationOptions {
+    skiptoken?: string;
+    top?: number;
+}
+
+// @public
+export type ManagementGroupsGetDescendantsResponse = DescendantListResult;
+
+// @public
+export interface ManagementGroupsGetOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+    expand?: Enum0;
+    filter?: string;
+    recurse?: boolean;
+}
+
+// @public
+export type ManagementGroupsGetResponse = ManagementGroup;
+
+// @public
+export interface ManagementGroupsListNextOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+    skiptoken?: string;
+}
+
+// @public
+export type ManagementGroupsListNextResponse = ManagementGroupListResult;
+
+// @public
+export interface ManagementGroupsListOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+    skiptoken?: string;
+}
+
+// @public
+export type ManagementGroupsListResponse = ManagementGroupListResult;
+
+// @public
+export interface ManagementGroupSubscriptions {
+    create(groupId: string, subscriptionId: string, options?: ManagementGroupSubscriptionsCreateOptionalParams): Promise<ManagementGroupSubscriptionsCreateResponse>;
+    delete(groupId: string, subscriptionId: string, options?: ManagementGroupSubscriptionsDeleteOptionalParams): Promise<void>;
+    getSubscription(groupId: string, subscriptionId: string, options?: ManagementGroupSubscriptionsGetSubscriptionOptionalParams): Promise<ManagementGroupSubscriptionsGetSubscriptionResponse>;
+    listSubscriptionsUnderManagementGroup(groupId: string, options?: ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams): PagedAsyncIterableIterator<SubscriptionUnderManagementGroup>;
+}
+
+// @public
+export interface ManagementGroupSubscriptionsCreateOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+}
+
+// @public
+export type ManagementGroupSubscriptionsCreateResponse = SubscriptionUnderManagementGroup;
+
+// @public
+export interface ManagementGroupSubscriptionsDeleteOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+}
+
+// @public
+export interface ManagementGroupSubscriptionsGetSubscriptionOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+}
+
+// @public
+export type ManagementGroupSubscriptionsGetSubscriptionResponse = SubscriptionUnderManagementGroup;
+
+// @public
+export interface ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupNextOptionalParams extends coreClient.OperationOptions {
+    skiptoken?: string;
+}
+
+// @public
+export type ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupNextResponse = ListSubscriptionUnderManagementGroup;
+
+// @public
+export interface ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams extends coreClient.OperationOptions {
+    skiptoken?: string;
+}
+
+// @public
+export type ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupResponse = ListSubscriptionUnderManagementGroup;
+
+// @public
+export interface ManagementGroupsUpdateOptionalParams extends coreClient.OperationOptions {
+    cacheControl?: string;
+}
+
+// @public
+export type ManagementGroupsUpdateResponse = ManagementGroup;
+
+// @public
+export interface Operation {
+    display?: OperationDisplayProperties;
+    readonly name?: string;
+}
+
+// @public
+export interface OperationDisplayProperties {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    readonly nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface OperationResults {
+    displayName?: string;
+    readonly id?: string;
+    readonly name?: string;
+    tenantId?: string;
+    readonly type?: string;
+}
+
+// @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 interface ParentGroupInfo {
+    displayName?: string;
+    id?: string;
+    name?: string;
+}
+
+// @public
+export interface PatchManagementGroupRequest {
+    displayName?: string;
+    parentGroupId?: string;
+}
+
+// @public
+type Permissions_2 = string;
+export { Permissions_2 as Permissions }
+
+// @public
+export type Reason = "Invalid" | "AlreadyExists";
+
+// @public
+export interface StartTenantBackfillOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StartTenantBackfillResponse = TenantBackfillStatusResult;
+
+// @public
+export type Status = "NotStarted" | "NotStartedButGroupsExist" | "Started" | "Failed" | "Cancelled" | "Completed";
+
+// @public
+export interface SubscriptionUnderManagementGroup {
+    displayName?: string;
+    readonly id?: string;
+    readonly name?: string;
+    parent?: DescendantParentGroupInfo;
+    state?: string;
+    tenant?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface TenantBackfillStatusOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TenantBackfillStatusResponse = TenantBackfillStatusResult;
+
+// @public
+export interface TenantBackfillStatusResult {
+    readonly status?: Status;
+    readonly tenantId?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```