Microsoft365PublishDefaults interface

Package:
@azure/ai-projects

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

Properties

agentDisplayName

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

The agent name.
appPublishScope

The publish scope.
appRegistrationClientId

The app-registration client id associated with the agent.
appVersion

The most recently published app version.
botServiceArmId

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

Display name of the developer / publisher.
developerWebsiteUrl

Developer / publisher website URL.
fullDescription

Full description shown on the Teams app details page.
privacyUrl

Privacy policy URL.
recommendedNextAppVersion

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

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

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

Terms-of-use URL.
titleId

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

Property Details

agentDisplayName

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

agentDisplayName?: string

Property Value

string

agentName

The agent name.

agentName?: string

Property Value

string

appPublishScope

The publish scope.

appPublishScope?: Microsoft365PublishScope

Property Value

Microsoft365PublishScope

appRegistrationClientId

The app-registration client id associated with the agent.

appRegistrationClientId?: string

Property Value

string

appVersion

The most recently published app version.

appVersion?: string

Property Value

string

botServiceArmId

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

botServiceArmId?: string

Property Value

string

developerName

Display name of the developer / publisher.

developerName?: string

Property Value

string

developerWebsiteUrl

Developer / publisher website URL.

developerWebsiteUrl?: string

Property Value

string

fullDescription

Full description shown on the Teams app details page.

fullDescription?: string

Property Value

string

privacyUrl

Privacy policy URL.

privacyUrl?: string

Property Value

string

recommendedNextAppVersion

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

recommendedNextAppVersion?: string

Property Value

string

shortDescription

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

shortDescription?: string

Property Value

string

teamsAppId

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

teamsAppId?: string

Property Value

string

termsOfUseUrl

Terms-of-use URL.

termsOfUseUrl?: string

Property Value

string

titleId

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

titleId?: string

Property Value

string