PublishToMicrosoft365OptionalParams interface

Package:
@azure/ai-projects

Optional parameters.

Extends
OperationOptions

Properties

accessBoundaries

Activity-protocol access boundaries to apply to the agent when publishing as an autopilot agent. An empty list clears the existing boundaries. When omitted, the existing boundaries are left unchanged.
agentDisplayName

Display name used as the published Teams app name. When omitted, the agent name from the route is used.
appVersion

App version (for example 1.2.3) written into the Teams manifest. May contain only digits and periods, must not start with 0, and must end with a digit. When omitted, a platform default is used.
botServiceArmId

ARM resource id of the Azure Bot Service that fronts this agent in Microsoft Teams. Required for workspaces on the default bot-based Teams backend; optional for workspaces on the API-based backend. Must not be supplied when publishAsAutopilot is true.
canRespondWithoutMention

Controls how the published agent responds to Teams messages: when true it responds to all messages on its surfaces, when false only when it is at-mentioned. When omitted, the agent's existing Teams message-notification setting is left unchanged.
colorIconBase64

Optional base64-encoded PNG used as the color (full-bleed) icon in the Teams app package. Must be a 192x192 PNG (perfect square, no border or rounded corners). Max 1 MB after decode. When omitted, the platform default color icon is used.
developerName

Display name of the developer / publisher shown in the Teams app listing.
developerWebsiteUrl

Developer / publisher website URL shown in the Teams app listing. Must be an https URL.
fullDescription

Full description shown on the Teams app details page.
optionalPermissionScopes

Exact selection of delegated permission scopes to grant to the autopilot blueprint. May only be supplied when publishAsAutopilot is true. When omitted or empty, the platform's default permission set is used. Mandatory platform permissions are always granted and are not affected by this value.
outlineIconBase64

Optional base64-encoded PNG used as the outline icon in the Teams app package. Must be a 32x32 PNG. Max 1 MB after decode. When omitted, the platform default outline icon is used.
privacyUrl

Privacy policy URL shown in the Teams app listing. Must be an http or https URL.
publishAsAutopilot

When true, the agent is published as an autopilot (digital worker) agent: the bot id is taken from the agent's blueprint identity and the generated Teams manifest is marked as a digital worker.
shortDescription

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

Terms-of-use URL shown in the Teams app listing.

Inherited Properties

abortSignal

The signal which can be used to abort requests.
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
tracingOptions

Options used when tracing is enabled.

Property Details

accessBoundaries

Activity-protocol access boundaries to apply to the agent when publishing as an autopilot agent. An empty list clears the existing boundaries. When omitted, the existing boundaries are left unchanged.

accessBoundaries?: ActivityProtocolAccessBoundary[]

Property Value

ActivityProtocolAccessBoundary[]

agentDisplayName

Display name used as the published Teams app name. When omitted, the agent name from the route is used.

agentDisplayName?: string

Property Value

string

appVersion

App version (for example 1.2.3) written into the Teams manifest. May contain only digits and periods, must not start with 0, and must end with a digit. When omitted, a platform default is used.

appVersion?: string

Property Value

string

botServiceArmId

ARM resource id of the Azure Bot Service that fronts this agent in Microsoft Teams. Required for workspaces on the default bot-based Teams backend; optional for workspaces on the API-based backend. Must not be supplied when publishAsAutopilot is true.

botServiceArmId?: string

Property Value

string

canRespondWithoutMention

Controls how the published agent responds to Teams messages: when true it responds to all messages on its surfaces, when false only when it is at-mentioned. When omitted, the agent's existing Teams message-notification setting is left unchanged.

canRespondWithoutMention?: boolean

Property Value

boolean

colorIconBase64

Optional base64-encoded PNG used as the color (full-bleed) icon in the Teams app package. Must be a 192x192 PNG (perfect square, no border or rounded corners). Max 1 MB after decode. When omitted, the platform default color icon is used.

colorIconBase64?: string

Property Value

string

developerName

Display name of the developer / publisher shown in the Teams app listing.

developerName?: string

Property Value

string

developerWebsiteUrl

Developer / publisher website URL shown in the Teams app listing. Must be an https URL.

developerWebsiteUrl?: string

Property Value

string

fullDescription

Full description shown on the Teams app details page.

fullDescription?: string

Property Value

string

optionalPermissionScopes

Exact selection of delegated permission scopes to grant to the autopilot blueprint. May only be supplied when publishAsAutopilot is true. When omitted or empty, the platform's default permission set is used. Mandatory platform permissions are always granted and are not affected by this value.

optionalPermissionScopes?: Microsoft365PermissionScopes[]

Property Value

Microsoft365PermissionScopes[]

outlineIconBase64

Optional base64-encoded PNG used as the outline icon in the Teams app package. Must be a 32x32 PNG. Max 1 MB after decode. When omitted, the platform default outline icon is used.

outlineIconBase64?: string

Property Value

string

privacyUrl

Privacy policy URL shown in the Teams app listing. Must be an http or https URL.

privacyUrl?: string

Property Value

string

publishAsAutopilot

When true, the agent is published as an autopilot (digital worker) agent: the bot id is taken from the agent's blueprint identity and the generated Teams manifest is marked as a digital worker.

publishAsAutopilot?: boolean

Property Value

boolean

shortDescription

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

shortDescription?: string

Property Value

string

termsOfUseUrl

Terms-of-use URL shown in the Teams app listing.

termsOfUseUrl?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions