@azure/arm-managementgroups package

Classes

Interfaces

CheckNameAvailabilityOptionalParams	Optional parameters.
CheckNameAvailabilityRequest	Management group name availability check parameters.
CheckNameAvailabilityResult	Describes the result of the request to check management group name availability.
CreateManagementGroupChildInfo	The child information of a management group used during creation.
CreateManagementGroupDetails	The details of a management group used during creation.
CreateManagementGroupProperties	The generic properties of a management group used during creation.
CreateManagementGroupRequest	Management group creation parameters.
CreateOrUpdateSettingsProperties	The properties of the request to create or update Management Group settings
CreateOrUpdateSettingsRequest	Parameters for creating or updating Management Group settings
CreateParentGroupInfo	(Optional) The ID of the parent management group used during creation.
DescendantInfo	The descendant.
DescendantInfoProperties	The generic properties of an descendant.
DescendantParentGroupInfo	The ID of the parent management group.
EntitiesListOptionalParams	Optional parameters.
EntitiesOperations	Interface representing a Entities operations.
EntityInfo	The entity.
EntityInfoProperties	The generic properties of an entity.
EntityParentGroupInfo	(Optional) The ID of the parent management group.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
HierarchySettings	Settings defined at the Management Group scope.
HierarchySettingsCreateOrUpdateOptionalParams	Optional parameters.
HierarchySettingsDeleteOptionalParams	Optional parameters.
HierarchySettingsGetOptionalParams	Optional parameters.
HierarchySettingsInfo	The hierarchy settings resource.
HierarchySettingsList	Lists all hierarchy settings.
HierarchySettingsListOptionalParams	Optional parameters.
HierarchySettingsOperations	Interface representing a HierarchySettings operations.
HierarchySettingsProperties	The generic properties of hierarchy settings.
HierarchySettingsUpdateOptionalParams	Optional parameters.
ManagementGroup	The management group details.
ManagementGroupChildInfo	The child information of a management group.
ManagementGroupDetails	The details of a management group.
ManagementGroupInfo	The management group resource.
ManagementGroupInfoProperties	The generic properties of a management group.
ManagementGroupPathElement	A path element of a management group ancestors.
ManagementGroupProperties	The generic properties of a management group.
ManagementGroupSubscriptionsCreateOptionalParams	Optional parameters.
ManagementGroupSubscriptionsDeleteOptionalParams	Optional parameters.
ManagementGroupSubscriptionsGetSubscriptionOptionalParams	Optional parameters.
ManagementGroupSubscriptionsListSubscriptionsUnderManagementGroupOptionalParams	Optional parameters.
ManagementGroupSubscriptionsOperations	Interface representing a ManagementGroupSubscriptions operations.
ManagementGroupsAPIOptionalParams	Optional parameters for the client.
ManagementGroupsCreateOrUpdateOptionalParams	Optional parameters.
ManagementGroupsDeleteOptionalParams	Optional parameters.
ManagementGroupsGetOptionalParams	Optional parameters.
ManagementGroupsListDescendantsOptionalParams	Optional parameters.
ManagementGroupsListOptionalParams	Optional parameters.
ManagementGroupsOperations	Interface representing a ManagementGroups operations.
ManagementGroupsUpdateOptionalParams	Optional parameters.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ParentGroupInfo	(Optional) The ID of the parent management group.
PatchManagementGroupRequest	Management group patch parameters.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SimplePollerLike	A simple poller that can be used to poll a long running operation.
StartTenantBackfillOptionalParams	Optional parameters.
SubscriptionUnderManagementGroup	The details of subscription under management group.
SubscriptionUnderManagementGroupProperties	The generic properties of subscription under a management group.
SystemData	Metadata pertaining to creation and last modification of the resource.
TenantBackfillStatusOptionalParams	Optional parameters.
TenantBackfillStatusResult	The tenant backfill status

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
EntitySearchType	Type of EntitySearchType
EntityViewParameterType	Type of EntityViewParameterType
ManagementGroupChildType	The type of child resource.
ManagementGroupExpandType	Type of ManagementGroupExpandType
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
Permissions	The users specific permissions to this item.
Reason	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.
Status	The status of the Tenant Backfill

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCreatedByType	The kind of entity that created the resource.
KnownEntitySearchType	Known values of EntitySearchType that the service accepts.
KnownEntityViewParameterType	Known values of EntityViewParameterType that the service accepts.
KnownManagementGroupExpandType	Known values of ManagementGroupExpandType that the service accepts.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(ManagementGroupsAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(ManagementGroupsAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ManagementGroupsAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: ManagementGroupsAPI

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-managementgroups package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(ManagementGroupsAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type

Feedback