Share via

EntityInfo Class

The entity.

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

Constructor

EntityInfo(*, tenant_id: str | None = None, display_name: str | None = None, parent: EntityParentGroupInfo | None = None, permissions: str | Permissions | None = None, inherited_permissions: str | Permissions | None = None, number_of_descendants: int | None = None, number_of_children: int | None = None, number_of_child_groups: int | None = None, parent_display_name_chain: List[str] | None = None, parent_name_chain: List[str] | None = None, **kwargs)

Parameters

Name Description
tenant_id
Required
str

The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000.
display_name
Required
str

The friendly name of the management group.
parent
Required
EntityParentGroupInfo

(Optional) The ID of the parent management group.
permissions
Required
str or Permissions

The users specific permissions to this item. Possible values include: "noaccess", "view", "edit", "delete".
inherited_permissions
Required
str or Permissions

The users specific permissions to this item. Possible values include: "noaccess", "view", "edit", "delete".
number_of_descendants
Required
int

Number of Descendants.
number_of_children
Required
int

Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.
number_of_child_groups
Required
int

Number of children is the number of Groups that are exactly one level underneath the current Group.
parent_display_name_chain
Required
list[str]

The parent display name chain from the root group to the immediate parent.
parent_name_chain
Required
list[str]

The parent name chain from the root group to the immediate parent.

Keyword-Only Parameters

Name Description
tenant_id
Default value: None
display_name
Default value: None
parent
Default value: None
permissions
Default value: None
inherited_permissions
Default value: None
number_of_descendants
Default value: None
number_of_children
Default value: None
number_of_child_groups
Default value: None
parent_display_name_chain
Default value: None
parent_name_chain
Default value: None

Variables

Name Description
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.