Skip to content

Office365groupsClient

Attributes

OnGroupMemberAddedOrRemovedResponse module-attribute 

OnGroupMemberAddedOrRemovedResponse = List[Dict[str, Any]]

OnNewEventResponse module-attribute 

OnNewEventResponse = List[Dict[str, Any]]

TRIGGER_OPERATIONS module-attribute 

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnGroupMembershipChange': {'operation_id': 'OnGroupMembershipChange', 'path': '/{connectionId}/trigger/v1.0/groups/delta', 'method': 'get', 'required_parameters': ['groupId'], 'callback_payload_type': 'OnGroupMemberAddedOrRemovedResponse'}, 'OnNewEvent': {'operation_id': 'OnNewEvent', 'path': '/{connectionId}/trigger/v1.0/groups/{groupId}/events', 'method': 'get', 'required_parameters': ['groupId'], 'callback_payload_type': 'OnNewEventResponse'}}

Classes

ListGroupMembersResponse dataclass 

ListGroupMembersResponse(*, context: Optional[str] = None, next_link: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List group members

Attributes

context class-attribute instance-attribute 
context: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.context'})

The OData context.

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

Only used in Power Apps Canvas to genereate the $skipToken for pagination. Power Automate and Logic Apps must use the pagination setting.

value class-attribute instance-attribute 
value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

value

ListGroupsResponse dataclass 

ListGroupsResponse(*, context: Optional[str] = None, next_link: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List groups

Attributes

context class-attribute instance-attribute 
context: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.context'})

The OData context.

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

Only used in Power Apps Canvas to genereate the $skipToken for pagination. Power Automate and Logic Apps must use the pagination setting.

value class-attribute instance-attribute 
value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

value

CreateCalendarEventResponse dataclass 

CreateCalendarEventResponse(*, id: Optional[str] = None, reminder_minutes_before_start: Optional[int] = None, is_reminder_on: Optional[bool] = None, subject: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, response_requested: Optional[bool] = None, show_as: Optional[str] = None, body: Optional[Dict[str, Any]] = None, start: Optional[Dict[str, Any]] = None, end: Optional[Dict[str, Any]] = None, location: Optional[Dict[str, Any]] = None)

Response for Update a group event

Attributes

id class-attribute instance-attribute 
id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique id of the event.

reminder_minutes_before_start class-attribute instance-attribute 
reminder_minutes_before_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderMinutesBeforeStart'})

Time in minutes before event starts to remind.

is_reminder_on class-attribute instance-attribute 
is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})

Set to true if the event has a reminder.

subject class-attribute instance-attribute 
subject: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of the event.

importance class-attribute instance-attribute 
importance: Optional[str] = dataclass_field(default=None, kw_only=True)

The importance of the event: Low, Normal, or High.

is_all_day class-attribute instance-attribute 
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isAllDay'})

True if the event is an all day event.

response_requested class-attribute instance-attribute 
response_requested: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseRequested'})

True if a response was requested for the event.

show_as class-attribute instance-attribute 
show_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'showAs'})

Status to show during the event.

body class-attribute instance-attribute 
body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

body

start class-attribute instance-attribute 
start: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

start

end class-attribute instance-attribute 
end: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

end

location class-attribute instance-attribute 
location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

location

ObjectWithoutType dataclass 

ObjectWithoutType(*, additional_properties: Dict[str, Any] = dict())

Response for Send an HTTP request

Attributes

additional_properties class-attribute instance-attribute 
additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ListOwnedGroupsResponse dataclass 

ListOwnedGroupsResponse(*, context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List groups that I own and belong to

Attributes

context class-attribute instance-attribute 
context: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.context'})

The OData context.

value class-attribute instance-attribute 
value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

value

SensitivityLabelMetadata dataclass 

SensitivityLabelMetadata(*, sensitivity_label_id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, tooltip: Optional[str] = None, priority: Optional[int] = None, color: Optional[str] = None, is_encrypted: Optional[bool] = None, is_enabled: Optional[bool] = None, is_parent: Optional[bool] = None, parent_sensitivity_label_id: Optional[str] = None)

Definition: SensitivityLabelMetadata

Attributes

sensitivity_label_id class-attribute instance-attribute 
sensitivity_label_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sensitivityLabelId'})

SensitivityLabel Id.

name class-attribute instance-attribute 
name: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel name.

display_name class-attribute instance-attribute 
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

SensitivityLabel displayName info

tooltip class-attribute instance-attribute 
tooltip: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel details on tooltip.

priority class-attribute instance-attribute 
priority: Optional[int] = dataclass_field(default=None, kw_only=True)

SensitivityLabel priority.

color class-attribute instance-attribute 
color: Optional[str] = dataclass_field(default=None, kw_only=True)

SensitivityLabel color.

is_encrypted class-attribute instance-attribute 
is_encrypted: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEncrypted'})

is SensitivityLabel Encrypted.

is_enabled class-attribute instance-attribute 
is_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEnabled'})

Whether SensitivityLabel is Enabled.

is_parent class-attribute instance-attribute 
is_parent: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isParent'})

Whether SensitivityLabel is Parent.

parent_sensitivity_label_id class-attribute instance-attribute 
parent_sensitivity_label_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentSensitivityLabelId'})

Parent SensitivityLabel Id.

UpdateCalendarEventRequest dataclass 

UpdateCalendarEventRequest(subject: str, start: Dict[str, Any], end: Dict[str, Any], *, body: Optional[Dict[str, Any]] = None, location: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, is_reminder_on: Optional[bool] = None, reminder_minutes_before_start: Optional[int] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None)

Definition: UpdateCalendarEvent_Request

Attributes

subject instance-attribute 
subject: str

Title of the event.

importance class-attribute instance-attribute 
importance: Optional[str] = dataclass_field(default=None, kw_only=True)

The importance of the event: Low, Normal, or High.

is_all_day class-attribute instance-attribute 
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isAllDay'})

Set to true if the event lasts all day.

is_reminder_on class-attribute instance-attribute 
is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})

Set to true if the event has a reminder.

reminder_minutes_before_start class-attribute instance-attribute 
reminder_minutes_before_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderMinutesBeforeStart'})

Time in minutes before event start to remind.

show_as class-attribute instance-attribute 
show_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'showAs'})

Status to show during the event.

response_requested class-attribute instance-attribute 
response_requested: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseRequested'})

Set to true if the sender would like a response when the event is accepted or declined.

UpdateCalendarEventHTMLRequest dataclass 

UpdateCalendarEventHTMLRequest(subject: str, start: Dict[str, Any], end: Dict[str, Any], *, body: Optional[Dict[str, Any]] = None, location: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, is_reminder_on: Optional[bool] = None, reminder_minutes_before_start: Optional[int] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None)

Definition: UpdateCalendarEvent_HTMLRequest

Attributes

subject instance-attribute 
subject: str

Title of the event.

importance class-attribute instance-attribute 
importance: Optional[str] = dataclass_field(default=None, kw_only=True)

The importance of the event: Low, Normal, or High.

is_all_day class-attribute instance-attribute 
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isAllDay'})

Set to true if the event lasts all day.

is_reminder_on class-attribute instance-attribute 
is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})

Set to true if the event has a reminder.

reminder_minutes_before_start class-attribute instance-attribute 
reminder_minutes_before_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderMinutesBeforeStart'})

Time in minutes before event start to remind.

show_as class-attribute instance-attribute 
show_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'showAs'})

Status to show during the event.

response_requested class-attribute instance-attribute 
response_requested: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseRequested'})

Set to true if the sender would like a response when the event is accepted or declined.

Office365groupsClient 

Office365groupsClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for office365groups connector.

Initialize a Office365groupsClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

 required
credential AsyncTokenCredential | AzureKeyCredential

Caller-owned Azure Core credential.

 required
max_retry_attempts int

The maximum number of request attempts.

 3
timeout float

The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.

 30.0
use_exponential_backoff bool

Whether retries use exponential backoff.

 True
initial_retry_delay_seconds float

The initial retry delay in seconds.

 0.5
maximum_retry_delay_seconds float

The maximum retry delay in seconds.

 120.0
retry_jitter_factor float

The jitter fraction applied to retry delays.

 0.1
retry_unsafe_http_methods bool

Whether unsafe HTTP methods may be retried.

 False
transport Optional[AsyncHttpTransport]

Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.

 None
**kwargs Any

Optional Azure Core pipeline policy settings.

 {}

Methods:

list_group_members 
list_group_members(group_id: str, *, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List group members

This operation returns a list of all members in the given group and their details such as name, title, email, etc. You can query up to 1000 items using Top parameter. In case you need to retrieve more than 1000 values please turn on Settings->Pagination feature and provide Threshold limit.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListGroupMembers.

Parameters:

Name Type Description Default
group_id str

Pick a group from the drop down or enter group id.

 required
top Optional[int]

Number of group members to retrieve (from 1 to 999, default is 100).

 None
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
add_member_to_group async 
add_member_to_group(group_id: str, user_upn: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Add member to group

This operation is used to add a member to an O365 group, using a UPN.

Swagger operation ID: AddMemberToGroup.

Parameters:

Name Type Description Default
group_id str

Pick a group from the drop down or enter group id.

 required
user_upn str

The user principal name (UPN) of the user.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Name Type Description
None None

The operation completes without a response body.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_groups 
list_groups(*, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, filter: Optional[str] = None, top: Optional[int] = None, skiptoken: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List groups

This operation returns a list of all groups in the organization.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListGroups.

Parameters:

Name Type Description Default
extract_sensitivity_label Optional[bool]

A boolean whether to extract sensitivity label Id for associated artefact.

 None
fetch_sensitivity_label_metadata Optional[bool]

A boolean whether to fetch sensitivity label Metadata for associated LabelId.

 None
filter Optional[str]

Enter an OData style filter expression to limit which rows are listed.

 None
top Optional[int]

Sets the page size of results.

 None
skiptoken Optional[str]

Token that references the next page of results and is returned in the @odata.nextLink property in the response.

 None
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
update_calendar_event async 
update_calendar_event(input: UpdateCalendarEventHTMLRequest | Mapping[str, Any], group_id: str, event: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a group event

This operation is used to update a new event in a group calendar.

Swagger operation ID: UpdateCalendarEvent.

Parameters:

Name Type Description Default
input UpdateCalendarEventHTMLRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

 required
group_id str

Pick a group from the drop down or enter group id.

 required
event str

Select an event.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
remove_member_from_group async 
remove_member_from_group(group_id: str, user_upn: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Remove member from group

This operation is used to remove a member from an O365 group, using a UPN.

Swagger operation ID: RemoveMemberFromGroup.

Parameters:

Name Type Description Default
group_id str

Pick a group from the drop down or enter group id.

 required
user_upn str

The user principal name (UPN) of the user.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Name Type Description
None None

The operation completes without a response body.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_deleted_groups 
list_deleted_groups(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List deleted groups

Lists deleted groups that can be restored.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListDeletedGroups.

Parameters:

Name Type Description Default
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
restore_deleted_group async 
restore_deleted_group(group_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Restore a deleted group

Restore a recently deleted group

Swagger operation ID: RestoreDeletedGroup.

Parameters:

Name Type Description Default
group_id str

Pick a group from the drop down or enter group id.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Name Type Description
None None

The operation completes without a response body.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_deleted_groups_by_owner 
list_deleted_groups_by_owner(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List deleted groups by owner

List deleted groups that can be restored by owner

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListDeletedGroupsByOwner.

Parameters:

Name Type Description Default
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
calendar_delete_item async 
calendar_delete_item(group_id: str, event: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete event

This operation deletes an event in a calendar.

Swagger operation ID: CalendarDeleteItem_V2.

Parameters:

Name Type Description Default
group_id str

Pick a group from the drop down or enter group id.

 required
event str

Select an event.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Name Type Description
None None

The operation completes without a response body.

Raises:

Type Description
ConnectorException

If the connector request fails.
create_calendar_event async 
create_calendar_event(input: UpdateCalendarEventHTMLRequest | Mapping[str, Any], group_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a group event

This operation is used to create a new event in a group calendar.

Swagger operation ID: CreateCalendarEventV2.

Parameters:

Name Type Description Default
input UpdateCalendarEventHTMLRequest | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

 required
group_id str

Pick a group from the drop down or enter group id.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
http_request async 
http_request(input: bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Send an HTTP request

Construct a Microsoft Graph REST API request to invoke. There is one segment that is supported: /groups. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api.

Swagger operation ID: HttpRequestV2.

Parameters:

Name Type Description Default
input bytes

The binary request body.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_owned_groups 
list_owned_groups(*, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List groups that I own and belong to

This operation returns a list of all groups that you own and belong to.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListOwnedGroups_V3.

Parameters:

Name Type Description Default
extract_sensitivity_label Optional[bool]

A boolean whether to extract sensitivity label Id for associated artefact.

 None
fetch_sensitivity_label_metadata Optional[bool]

A boolean whether to fetch sensitivity label Metadata for associated LabelId.

 None
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.