MeetingroommapClient

Classes

GetCustomLocationsByImageNameResponse dataclass

GetCustomLocationsByImageNameResponse(*, custom_location_collection: Optional[List[Dict[str, Any]]] = None, map_image: Optional[Dict[str, Any]] = None)

Response for Get locations by image

Attributes

custom_location_collection class-attribute instance-attribute

custom_location_collection: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'customLocationCollection'})

customLocationCollection

map_image class-attribute instance-attribute

map_image: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mapImage'})

mapImage

GetOfficeLocationsByImageResponse dataclass

GetOfficeLocationsByImageResponse(*, image: Optional[Dict[str, Any]] = None, attached_office_locations: Optional[List[Dict[str, Any]]] = None)

Response for Get office locations on image

Attributes

image class-attribute instance-attribute

image: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

image

attached_office_locations class-attribute instance-attribute

attached_office_locations: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'attachedOfficeLocations'})

attachedOfficeLocations

GetRoomWithPersonsDetailsResponse dataclass

GetRoomWithPersonsDetailsResponse(*, office_location_map: Optional[Dict[str, Any]] = None, map_image: Optional[Dict[str, Any]] = None)

Response for Get office location details

Attributes

office_location_map class-attribute instance-attribute

office_location_map: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'officeLocationMap'})

officeLocationMap

map_image class-attribute instance-attribute

map_image: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mapImage'})

mapImage

AADMeetingRoomCollection dataclass

AADMeetingRoomCollection(*, rooms: Optional[List[AADMeetingRoom | Mapping[str, Any]]] = None)

Response for Get all rooms

GetRoomsByImageNameResponse dataclass

GetRoomsByImageNameResponse(*, meeting_room_collection: Optional[Dict[str, Any]] = None, map_image: Optional[Dict[str, Any]] = None)

Response for Get all meeting rooms by image

Attributes

meeting_room_collection class-attribute instance-attribute

meeting_room_collection: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'meetingRoomCollection'})

meetingRoomCollection

map_image class-attribute instance-attribute

map_image: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mapImage'})

mapImage

GetCustomLocationsByCategoriesQuery dataclass

GetCustomLocationsByCategoriesQuery(*, categories: Optional[List[str]] = None)

Definition: GetCustomLocationsByCategoriesQuery

GetCustomLocationListByImageNameQuery dataclass

GetCustomLocationListByImageNameQuery(image_name: str, *, categories: Optional[List[str]] = None)

Definition: GetCustomLocationListByImageNameQuery

Attributes

image_name class-attribute instance-attribute

image_name: str = dataclass_field(metadata={'wire_name': 'imageName'})

The unique image name

AADMeetingRoom dataclass

AADMeetingRoom(*, name: Optional[str] = None, address: Optional[str] = None)

Definition: AADMeetingRoom

UserDetailsDTO dataclass

UserDetailsDTO(*, tenant_id: Optional[str] = None, email: Optional[str] = None)

Definition: UserDetailsDTO

MeetingroommapClient

MeetingroommapClient(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 meetingroommap connector.

Initialize a MeetingroommapClient.

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:

get_custom_locations async

get_custom_locations(input: GetCustomLocationsByCategoriesQuery | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Get all custom locations

Get all custom locations

Swagger operation ID: GetCustomLocations.

Parameters:

Name	Type	Description	Default
input	GetCustomLocationsByCategoriesQuery | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	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.

get_custom_locations_by_image_name async

get_custom_locations_by_image_name(input: GetCustomLocationListByImageNameQuery | Mapping[str, Any], *, 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

Get locations by image

Get all custom locations for a given image

Swagger operation ID: GetCustomLocationsByImageName.

Parameters:

Name	Type	Description	Default
input	GetCustomLocationListByImageNameQuery | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	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_categories

list_categories(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[str]

GetCategories

Get custom categories

Returns a single-page Azure Core async collection.

Swagger operation ID: GetCategories.

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[str]	AsyncItemPaged[str]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

location_details async

location_details(location_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Get location by id

Get location details including image url by the location id

Swagger operation ID: LocationDetails.

Parameters:

Name	Type	Description	Default
location_id	str	Location identifier.	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_search_locations

list_search_locations(location_name: str, *, category: 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]]

Search location by name

Search custom locations by name

Returns a single-page Azure Core async collection.

Swagger operation ID: SearchLocations.

Parameters:

Name	Type	Description	Default
location_name	str	Search string for location.	required
category	Optional[str]	Optional category filter.	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.

get_custom_location_image async

get_custom_location_image(location_id: str, *, large: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get image for location

Get image for specific custom location

Swagger operation ID: GetCustomLocationImage.

Parameters:

Name	Type	Description	Default
location_id	str	Unique identifier for location.	required
large	Optional[bool]	Large image returned.	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:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_images

list_images(*, 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]]

Get all images

Get list of all floorplans/images

Returns a single-page Azure Core async collection.

Swagger operation ID: Images.

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.

get_meeting_room_image async

get_meeting_room_image(room_name: str, *, large: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get image for meeting room

Get image for a specific meeting room

Swagger operation ID: GetMeetingRoomImage.

Parameters:

Name	Type	Description	Default
room_name	str	The name of the room to get image for.	required
large	Optional[bool]	Large image.	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:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

next_meetings async

next_meetings(meeting_count: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Get next meetings

Get the next meetings for the current user

Swagger operation ID: NextMeetings.

Parameters:

Name	Type	Description	Default
meeting_count	int	Count of meetings.	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.

get_meeting_room_details async

get_meeting_room_details(room_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Get meetingroom details

Get meetingroom details

Swagger operation ID: GetMeetingRoomDetails.

Parameters:

Name	Type	Description	Default
room_name	str	The room name to get details for.	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.

get_office_locations async

get_office_locations(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Get all office locations

Get all office locations

Swagger operation ID: GetOfficeLocations.

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:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_search_coworkers

list_search_coworkers(person_search: str, *, 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]]

Search coworker

Search coworker by name/email

Returns a single-page Azure Core async collection.

Swagger operation ID: SearchCoworkers.

Parameters:

Name	Type	Description	Default
person_search	str	Search string.	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
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.

get_office_locations_by_image async

get_office_locations_by_image(image_name: 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

Get office locations on image

Get all office locations mapped to a specific image

Swagger operation ID: GetOfficeLocationsByImage.

Parameters:

Name	Type	Description	Default
image_name	str	The image identifier.	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.

get_room_with_persons_details async

get_room_with_persons_details(office_location_name: str, *, inlude_user_info: Optional[bool] = None, 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

Get office location details

Get office location details including list of people for that office location

Swagger operation ID: GetRoomWithPersonsDetails.

Parameters:

Name	Type	Description	Default
office_location_name	str	The office location name.	required
inlude_user_info	Optional[bool]	Flag to indicate if user info should be included.	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
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_office_location_image async

get_office_location_image(office_location_name: str, *, large: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get image of office location

Get image of specific office location

Swagger operation ID: GetOfficeLocationImage.

Parameters:

Name	Type	Description	Default
office_location_name	str	Office location identifier.	required
large	Optional[bool]	Image size.	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:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_rooms

list_rooms(*, 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]]

Get all rooms

Get all rooms (defined in Azure AD as meeting rooms)

Returns a single-page Azure Core async collection.

Swagger operation ID: GetRooms.

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.

list_search_meeting_rooms

list_search_meeting_rooms(name: str, *, 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]]

Search for meeting room

Get rooms by name search (from Azure AD meeting rooms)

Returns a single-page Azure Core async collection.

Swagger operation ID: SearchMeetingRooms.

Parameters:

Name	Type	Description	Default
name	str	Search string.	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
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.

list_room_lists

list_room_lists(*, 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]]

Get meeting rooms lists

Get meeting rooms lists as defined in Azure AD

Returns a single-page Azure Core async collection.

Swagger operation ID: RoomLists.

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.

list_rooms_by_list_address

list_rooms_by_list_address(meeting_room_list_address: str, *, 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]]

Get meeting rooms by list

Get all meeting rooms from specific list name

Returns a single-page Azure Core async collection.

Swagger operation ID: RoomsByListAddress.

Parameters:

Name	Type	Description	Default
meeting_room_list_address	str	Name of list.	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
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.

get_rooms_by_image_name async

get_rooms_by_image_name(image_name: 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

Get all meeting rooms by image

Get all meeting rooms mapped to a specific image

Swagger operation ID: GetRoomsByImageName.

Parameters:

Name	Type	Description	Default
image_name	str	The unique image name.	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.