azure.mgmt.managementgroups.models module

class azure.mgmt.managementgroups.models.AzureAsyncOperationResults(*, tenant_id: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The results of Azure-AsyncOperation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups.

  • name (str) – The name of the management group. For example, 00000000-0000-0000-0000-000000000000.

  • status (str) – The current status of the asynchronous operation performed . For example, Running, Succeeded, Failed.

  • tenant_id (str) – The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

Keyword Arguments

  • tenant_id (str) – The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

class azure.mgmt.managementgroups.models.CheckNameAvailabilityRequest(*, name: Optional[str] = None, type: Optional[Literal[Microsoft.Management / managementGroups]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Management group name availability check parameters.

Variables

  • name (str) – the name to check for availability.

  • type (str) – fully qualified resource type which includes provider namespace. Default value is “Microsoft.Management/managementGroups”.

Keyword Arguments

  • name (str) – the name to check for availability.

  • type (str) – fully qualified resource type which includes provider namespace. Default value is “Microsoft.Management/managementGroups”.

class azure.mgmt.managementgroups.models.CheckNameAvailabilityResult(**kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Describes the result of the request to check management group name availability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name_available (bool) – Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.

  • reason (str or 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. Known values are: “Invalid” and “AlreadyExists”.

  • message (str) – 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.

class azure.mgmt.managementgroups.models.CreateManagementGroupChildInfo(**kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The child information of a management group used during creation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • type (str or ManagementGroupChildType) – The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups). Known values are: “Microsoft.Management/managementGroups” and “/subscriptions”.

  • id (str) – The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • name (str) – The name of the child entity.

  • display_name (str) – The friendly name of the child resource.

  • children (list[CreateManagementGroupChildInfo]) – The list of children.

class azure.mgmt.managementgroups.models.CreateManagementGroupDetails(*, parent: Optional[_models.CreateParentGroupInfo] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The details of a management group used during creation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • version (int) – The version number of the object.

  • updated_time (datetime) – The date and time when this object was last updated.

  • updated_by (str) – The identity of the principal or process that updated the object.

  • parent (CreateParentGroupInfo) – (Optional) The ID of the parent management group used during creation.

Keyword Arguments

parent (CreateParentGroupInfo) – (Optional) The ID of the parent management group used during creation.

class azure.mgmt.managementgroups.models.CreateManagementGroupRequest(*, name: Optional[str] = None, display_name: Optional[str] = None, details: Optional[_models.CreateManagementGroupDetails] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Management group creation parameters.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups.

  • name (str) – The name of the management group. For example, 00000000-0000-0000-0000-000000000000.

  • tenant_id (str) – The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group. If no value is passed then this field will be set to the groupId.

  • details (CreateManagementGroupDetails) – The details of a management group used during creation.

  • children (list[CreateManagementGroupChildInfo]) – The list of children.

Keyword Arguments

  • name (str) – The name of the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group. If no value is passed then this field will be set to the groupId.

  • details (CreateManagementGroupDetails) – The details of a management group used during creation.

class azure.mgmt.managementgroups.models.CreateOrUpdateSettingsRequest(*, require_authorization_for_group_creation: Optional[bool] = None, default_management_group: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Parameters for creating or updating Management Group settings.

Variables

  • require_authorization_for_group_creation (bool) – 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.

  • default_management_group (str) – Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup.

Keyword Arguments

  • require_authorization_for_group_creation (bool) – 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.

  • default_management_group (str) – Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup.

class azure.mgmt.managementgroups.models.CreateParentGroupInfo(*, id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

(Optional) The ID of the parent management group used during creation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • name (str) – The name of the parent management group.

  • display_name (str) – The friendly name of the parent management group.

Keyword Arguments

id (str) – The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

class azure.mgmt.managementgroups.models.DescendantInfo(*, display_name: Optional[str] = None, parent: Optional[_models.DescendantParentGroupInfo] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The descendant.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – 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.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups or /subscriptions.

  • name (str) – The name of the descendant. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

  • parent (DescendantParentGroupInfo) – The ID of the parent management group.

Keyword Arguments

  • display_name (str) – The friendly name of the management group.

  • parent (DescendantParentGroupInfo) – The ID of the parent management group.

class azure.mgmt.managementgroups.models.DescendantListResult(*, value: Optional[List[_models.DescendantInfo]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Describes the result of the request to view descendants.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • value (list[DescendantInfo]) – The list of descendants.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments

value (list[DescendantInfo]) – The list of descendants.

class azure.mgmt.managementgroups.models.DescendantParentGroupInfo(*, id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The ID of the parent management group.

Variables

id (str) – The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

Keyword Arguments

id (str) – The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

class azure.mgmt.managementgroups.models.EntityHierarchyItem(*, display_name: Optional[str] = None, permissions: Optional[Union[str, _models.Permissions]] = None, children: Optional[List[_models.EntityHierarchyItem]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The management group details for the hierarchy view.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups.

  • name (str) – The name of the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

  • permissions (str or Permissions) – The users specific permissions to this item. Known values are: “noaccess”, “view”, “edit”, and “delete”.

  • children (list[EntityHierarchyItem]) – The list of children.

Keyword Arguments

  • display_name (str) – The friendly name of the management group.

  • permissions (str or Permissions) – The users specific permissions to this item. Known values are: “noaccess”, “view”, “edit”, and “delete”.

  • children (list[EntityHierarchyItem]) – The list of children.

class azure.mgmt.managementgroups.models.EntityInfo(*, tenant_id: Optional[str] = None, display_name: Optional[str] = None, parent: Optional[_models.EntityParentGroupInfo] = None, permissions: Optional[Union[str, _models.Permissions]] = None, inherited_permissions: Optional[Union[str, _models.Permissions]] = None, number_of_descendants: Optional[int] = None, number_of_children: Optional[int] = None, number_of_child_groups: Optional[int] = None, parent_display_name_chain: Optional[List[str]] = None, parent_name_chain: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The entity.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups.

  • name (str) – The name of the entity. For example, 00000000-0000-0000-0000-000000000000.

  • tenant_id (str) – The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

  • parent (EntityParentGroupInfo) – (Optional) The ID of the parent management group.

  • permissions (str or Permissions) – The users specific permissions to this item. Known values are: “noaccess”, “view”, “edit”, and “delete”.

  • inherited_permissions (str or Permissions) – The users specific permissions to this item. Known values are: “noaccess”, “view”, “edit”, and “delete”.

  • number_of_descendants (int) – Number of Descendants.

  • number_of_children (int) – Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.

  • number_of_child_groups (int) – Number of children is the number of Groups that are exactly one level underneath the current Group.

  • parent_display_name_chain (list[str]) – The parent display name chain from the root group to the immediate parent.

  • parent_name_chain (list[str]) – The parent name chain from the root group to the immediate parent.

Keyword Arguments

  • tenant_id (str) – The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

  • parent (EntityParentGroupInfo) – (Optional) The ID of the parent management group.

  • permissions (str or Permissions) – The users specific permissions to this item. Known values are: “noaccess”, “view”, “edit”, and “delete”.

  • inherited_permissions (str or Permissions) – The users specific permissions to this item. Known values are: “noaccess”, “view”, “edit”, and “delete”.

  • number_of_descendants (int) – Number of Descendants.

  • number_of_children (int) – Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.

  • number_of_child_groups (int) – Number of children is the number of Groups that are exactly one level underneath the current Group.

  • parent_display_name_chain (list[str]) – The parent display name chain from the root group to the immediate parent.

  • parent_name_chain (list[str]) – The parent name chain from the root group to the immediate parent.

class azure.mgmt.managementgroups.models.EntityListResult(*, value: Optional[List[_models.EntityInfo]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Describes the result of the request to view entities.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • value (list[EntityInfo]) – The list of entities.

  • count (int) – Total count of records that match the filter.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments

value (list[EntityInfo]) – The list of entities.

class azure.mgmt.managementgroups.models.EntityParentGroupInfo(*, id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

(Optional) The ID of the parent management group.

Variables

id (str) – The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

Keyword Arguments

id (str) – The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

class azure.mgmt.managementgroups.models.EntitySearchType(value)[source]

Bases: str, enum.Enum

EntitySearchType.

ALLOWED_CHILDREN = 'AllowedChildren'
ALLOWED_PARENTS = 'AllowedParents'
CHILDREN_ONLY = 'ChildrenOnly'
PARENT_AND_FIRST_LEVEL_CHILDREN = 'ParentAndFirstLevelChildren'
PARENT_ONLY = 'ParentOnly'
class azure.mgmt.managementgroups.models.EntityViewParameterType(value)[source]

Bases: str, enum.Enum

EntityViewParameterType.

AUDIT = 'Audit'
FULL_HIERARCHY = 'FullHierarchy'
GROUPS_ONLY = 'GroupsOnly'
SUBSCRIPTIONS_ONLY = 'SubscriptionsOnly'
class azure.mgmt.managementgroups.models.ErrorDetails(*, code: Optional[str] = None, message: Optional[str] = None, details: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The details of the error.

Variables

  • code (str) – One of a server-defined set of error codes.

  • message (str) – A human-readable representation of the error.

  • details (str) – A human-readable representation of the error’s details.

Keyword Arguments

  • code (str) – One of a server-defined set of error codes.

  • message (str) – A human-readable representation of the error.

  • details (str) – A human-readable representation of the error’s details.

class azure.mgmt.managementgroups.models.ErrorResponse(*, error: Optional[_models.ErrorDetails] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The error object.

Variables

error (ErrorDetails) – The details of the error.

Keyword Arguments

error (ErrorDetails) – The details of the error.

class azure.mgmt.managementgroups.models.HierarchySettings(*, tenant_id: Optional[str] = None, require_authorization_for_group_creation: Optional[bool] = None, default_management_group: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Settings defined at the Management Group scope.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups/settings.

  • name (str) – The name of the object. In this case, default.

  • tenant_id (str) – The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000.

  • require_authorization_for_group_creation (bool) – 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.

  • default_management_group (str) – Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup.

Keyword Arguments

  • tenant_id (str) – The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000.

  • require_authorization_for_group_creation (bool) – 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.

  • default_management_group (str) – Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup.

class azure.mgmt.managementgroups.models.HierarchySettingsInfo(*, tenant_id: Optional[str] = None, require_authorization_for_group_creation: Optional[bool] = None, default_management_group: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The hierarchy settings resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups/settings.

  • name (str) – The name of the object. In this case, default.

  • tenant_id (str) – The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000.

  • require_authorization_for_group_creation (bool) – 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.

  • default_management_group (str) – Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup.

Keyword Arguments

  • tenant_id (str) – The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000.

  • require_authorization_for_group_creation (bool) – 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.

  • default_management_group (str) – Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup.

class azure.mgmt.managementgroups.models.HierarchySettingsList(*, value: Optional[List[_models.HierarchySettingsInfo]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Lists all hierarchy settings.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • value (list[HierarchySettingsInfo]) – The list of hierarchy settings.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments

value (list[HierarchySettingsInfo]) – The list of hierarchy settings.

class azure.mgmt.managementgroups.models.ListSubscriptionUnderManagementGroup(*, value: Optional[List[_models.SubscriptionUnderManagementGroup]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The details of all subscriptions under management group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
Keyword Arguments

value (list[SubscriptionUnderManagementGroup]) – The list of subscriptions.

class azure.mgmt.managementgroups.models.ManagementGroup(*, tenant_id: Optional[str] = None, display_name: Optional[str] = None, details: Optional[_models.ManagementGroupDetails] = None, children: Optional[List[_models.ManagementGroupChildInfo]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The management group details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups.

  • name (str) – The name of the management group. For example, 00000000-0000-0000-0000-000000000000.

  • tenant_id (str) – The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

  • details (ManagementGroupDetails) – The details of a management group.

  • children (list[ManagementGroupChildInfo]) – The list of children.

Keyword Arguments

  • tenant_id (str) – The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

  • details (ManagementGroupDetails) – The details of a management group.

  • children (list[ManagementGroupChildInfo]) – The list of children.

class azure.mgmt.managementgroups.models.ManagementGroupChildInfo(*, type: Optional[Union[str, _models.ManagementGroupChildType]] = None, id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, children: Optional[List[_models.ManagementGroupChildInfo]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The child information of a management group.

Variables

  • type (str or ManagementGroupChildType) – The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups). Known values are: “Microsoft.Management/managementGroups” and “/subscriptions”.

  • id (str) – The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • name (str) – The name of the child entity.

  • display_name (str) – The friendly name of the child resource.

  • children (list[ManagementGroupChildInfo]) – The list of children.

Keyword Arguments

  • type (str or ManagementGroupChildType) – The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups). Known values are: “Microsoft.Management/managementGroups” and “/subscriptions”.

  • id (str) – The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • name (str) – The name of the child entity.

  • display_name (str) – The friendly name of the child resource.

  • children (list[ManagementGroupChildInfo]) – The list of children.

class azure.mgmt.managementgroups.models.ManagementGroupChildType(value)[source]

Bases: str, enum.Enum

The type of child resource.

MICROSOFT_MANAGEMENT_MANAGEMENT_GROUPS = 'Microsoft.Management/managementGroups'
class azure.mgmt.managementgroups.models.ManagementGroupDetails(*, version: Optional[int] = None, updated_time: Optional[datetime.datetime] = None, updated_by: Optional[str] = None, parent: Optional[_models.ParentGroupInfo] = None, path: Optional[List[_models.ManagementGroupPathElement]] = None, management_group_ancestors: Optional[List[str]] = None, management_group_ancestors_chain: Optional[List[_models.ManagementGroupPathElement]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The details of a management group.

Variables

  • version (int) – The version number of the object.

  • updated_time (datetime) – The date and time when this object was last updated.

  • updated_by (str) – The identity of the principal or process that updated the object.

  • parent (ParentGroupInfo) – (Optional) The ID of the parent management group.

  • path (list[ManagementGroupPathElement]) – The path from the root to the current group.

  • management_group_ancestors (list[str]) – The ancestors of the management group.

  • management_group_ancestors_chain (list[ManagementGroupPathElement]) – The ancestors of the management group displayed in reversed order, from immediate parent to the root.

Keyword Arguments

  • version (int) – The version number of the object.

  • updated_time (datetime) – The date and time when this object was last updated.

  • updated_by (str) – The identity of the principal or process that updated the object.

  • parent (ParentGroupInfo) – (Optional) The ID of the parent management group.

  • path (list[ManagementGroupPathElement]) – The path from the root to the current group.

  • management_group_ancestors (list[str]) – The ancestors of the management group.

  • management_group_ancestors_chain (list[ManagementGroupPathElement]) – The ancestors of the management group displayed in reversed order, from immediate parent to the root.

class azure.mgmt.managementgroups.models.ManagementGroupExpandType(value)[source]

Bases: str, enum.Enum

ManagementGroupExpandType.

ANCESTORS = 'ancestors'
CHILDREN = 'children'
PATH = 'path'
class azure.mgmt.managementgroups.models.ManagementGroupInfo(*, tenant_id: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The management group resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups.

  • name (str) – The name of the management group. For example, 00000000-0000-0000-0000-000000000000.

  • tenant_id (str) – The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

Keyword Arguments

  • tenant_id (str) – The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

class azure.mgmt.managementgroups.models.ManagementGroupListResult(*, value: Optional[List[_models.ManagementGroupInfo]] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Describes the result of the request to list management groups.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • value (list[ManagementGroupInfo]) – The list of management groups.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments

value (list[ManagementGroupInfo]) – The list of management groups.

class azure.mgmt.managementgroups.models.ManagementGroupPathElement(*, name: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

A path element of a management group ancestors.

Variables

  • name (str) – The name of the group.

  • display_name (str) – The friendly name of the group.

Keyword Arguments

  • name (str) – The name of the group.

  • display_name (str) – The friendly name of the group.

class azure.mgmt.managementgroups.models.Operation(*, display: Optional[_models.OperationDisplayProperties] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Operation supported by the Microsoft.Management resource provider.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – Operation name: {provider}/{resource}/{operation}.

  • display (OperationDisplayProperties) – The object that represents the operation.

Keyword Arguments

display (OperationDisplayProperties) – The object that represents the operation.

class azure.mgmt.managementgroups.models.OperationDisplayProperties(**kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The object that represents the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • provider (str) – The name of the provider.

  • resource (str) – The resource on which the operation is performed.

  • operation (str) – The operation that can be performed.

  • description (str) – Operation description.

class azure.mgmt.managementgroups.models.OperationListResult(**kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Describes the result of the request to list Microsoft.Management operations.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • value (list[Operation]) – List of operations supported by the Microsoft.Management resource provider.

  • next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.managementgroups.models.OperationResults(*, tenant_id: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The results of an asynchronous operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups.

  • name (str) – The name of the management group. For example, 00000000-0000-0000-0000-000000000000.

  • tenant_id (str) – The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

Keyword Arguments

  • tenant_id (str) – The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the management group.

class azure.mgmt.managementgroups.models.ParentGroupBagInfo(*, id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The ID, name and displayName of the parent management group.

Variables

  • id (str) – The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • name (str) – The name of the parent management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the parent management group.

Keyword Arguments

  • id (str) – The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • name (str) – The name of the parent management group. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the parent management group.

class azure.mgmt.managementgroups.models.ParentGroupInfo(*, id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

(Optional) The ID of the parent management group.

Variables

  • id (str) – The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • name (str) – The name of the parent management group.

  • display_name (str) – The friendly name of the parent management group.

Keyword Arguments

  • id (str) – The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

  • name (str) – The name of the parent management group.

  • display_name (str) – The friendly name of the parent management group.

class azure.mgmt.managementgroups.models.PatchManagementGroupRequest(*, display_name: Optional[str] = None, parent_group_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

Management group patch parameters.

Variables

  • display_name (str) – The friendly name of the management group.

  • parent_group_id (str) – (Optional) The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

Keyword Arguments

  • display_name (str) – The friendly name of the management group.

  • parent_group_id (str) – (Optional) The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.

class azure.mgmt.managementgroups.models.Permissions(value)[source]

Bases: str, enum.Enum

The users specific permissions to this item.

DELETE = 'delete'
EDIT = 'edit'
NOACCESS = 'noaccess'
VIEW = 'view'
class azure.mgmt.managementgroups.models.Reason(value)[source]

Bases: str, enum.Enum

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.

ALREADY_EXISTS = 'AlreadyExists'
INVALID = 'Invalid'
class azure.mgmt.managementgroups.models.Status(value)[source]

Bases: str, enum.Enum

The status of the Tenant Backfill.

CANCELLED = 'Cancelled'
COMPLETED = 'Completed'
FAILED = 'Failed'
NOT_STARTED = 'NotStarted'
NOT_STARTED_BUT_GROUPS_EXIST = 'NotStartedButGroupsExist'
STARTED = 'Started'
class azure.mgmt.managementgroups.models.SubscriptionUnderManagementGroup(*, tenant: Optional[str] = None, display_name: Optional[str] = None, parent: Optional[_models.ParentGroupBagInfo] = None, state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The details of subscription under management group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The fully qualified ID for the subscription. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/subscriptions/0000000-0000-0000-0000-000000000001.

  • type (str) – The type of the resource. For example, Microsoft.Management/managementGroups/subscriptions.

  • name (str) – The stringified id of the subscription. For example, 00000000-0000-0000-0000-000000000000.

  • tenant (str) – The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the subscription.

  • parent (ParentGroupBagInfo) – The ID, name and displayName of the parent management group.

  • state (str) – The state of the subscription.

Keyword Arguments

  • tenant (str) – The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000.

  • display_name (str) – The friendly name of the subscription.

  • parent (ParentGroupBagInfo) – The ID, name and displayName of the parent management group.

  • state (str) – The state of the subscription.

class azure.mgmt.managementgroups.models.TenantBackfillStatusResult(**kwargs)[source]

Bases: azure.mgmt.managementgroups._serialization.Model

The tenant backfill status.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • tenant_id (str) – The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000.

  • status (str or Status) – The status of the Tenant Backfill. Known values are: “NotStarted”, “NotStartedButGroupsExist”, “Started”, “Failed”, “Cancelled”, and “Completed”.