Microsoft365PublishDefaults Class

Default and previously-published values used to pre-populate a Microsoft 365 publish request for a Foundry agent.

Constructor

Microsoft365PublishDefaults(*args: Any, **kwargs: Any)

Variables

Name	Description
app_publish_scope	str or Microsoft365PublishScope The publish scope. Known values are: "Personal", "Shared", and "Tenant".
agent_name	str The agent name.
agent_display_name	str The user-facing display name for the agent. Defaults to the agent name if not previously overridden.
app_registration_client_id	str The app-registration client id associated with the agent.
bot_service_arm_id	str ARM resource id of the Azure Bot Service associated with the previously-published app, if any.
app_version	str The most recently published app version.
recommended_next_app_version	str The recommended next app version (the most recent app version, incremented).
title_id	str The Microsoft 365 title id of the previously-published app, if any.
teams_app_id	str The Microsoft Teams app id of the previously-published app, if any.
short_description	str Short, one-line description shown in the Teams app listing.
full_description	str Full description shown on the Teams app details page.
developer_name	str Display name of the developer / publisher.
developer_website_url	str Developer / publisher website URL.
privacy_url	str Privacy policy URL.
terms_of_use_url	str Terms-of-use URL.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from the dictionary.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.
setdefault	Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
update	Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on the mapping's values

Attributes

agent_display_name

The user-facing display name for the agent. Defaults to the agent name if not previously overridden.

agent_display_name: str | None

agent_name

The agent name.

agent_name: str | None

app_publish_scope

"Personal", "Shared", and "Tenant".

app_publish_scope: str | _models.Microsoft365PublishScope | None

app_registration_client_id

The app-registration client id associated with the agent.

app_registration_client_id: str | None

app_version

The most recently published app version.

app_version: str | None

bot_service_arm_id

ARM resource id of the Azure Bot Service associated with the previously-published app, if any.

bot_service_arm_id: str | None

developer_name

Display name of the developer / publisher.

developer_name: str | None

developer_website_url

Developer / publisher website URL.

developer_website_url: str | None

full_description

Full description shown on the Teams app details page.

full_description: str | None

privacy_url

privacy_url: str | None

recommended_next_app_version

The recommended next app version (the most recent app version, incremented).

recommended_next_app_version: str | None

short_description

Short, one-line description shown in the Teams app listing.

short_description: str | None

teams_app_id

The Microsoft Teams app id of the previously-published app, if any.

teams_app_id: str | None

terms_of_use_url

Terms-of-use URL.

terms_of_use_url: str | None

title_id

The Microsoft 365 title id of the previously-published app, if any.

title_id: str | None

Opinia

Czy ta strona była pomocna?