Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
(Preview) Administer Copilot Studio agents: quarantine, reassign, delete, and evaluate.
Commands
| Command | Description |
|---|---|
| pac copilot-studio delete-copilot-agent | (Preview) Delete a bot. |
| pac copilot-studio download-agent-channel-manifest | (Preview) Downloads the channel manifest package for the specified agent and channel as a zip file. Currently only the "M365" channel is supported. |
| pac copilot-studio get-bot-quarantine-status | (Preview) Retrieve the quarantine status of a bot. |
| pac copilot-studio get-connector-consent-bypass | (Preview) Get the admin connector consent bypass setting for a bot. |
| pac copilot-studio get-maker-evaluation-test-run | (Preview) Get the status and results of a specific maker evaluation test run. |
| pac copilot-studio get-maker-evaluation-test-set | (Preview) Get a specific test set for maker evaluation of a bot. |
| pac copilot-studio list-maker-evaluation-test-runs | (Preview) List all maker evaluation test runs for a bot. |
| pac copilot-studio list-maker-evaluation-test-sets | (Preview) Retrieves the list of test sets for a bot in a specified environment. |
| pac copilot-studio reassign-copilot-agent | (Preview) Reassign the owner of the bot. |
| pac copilot-studio run-maker-evaluation-test-set | (Preview) Trigger a maker evaluation test run for a specific test set. |
| pac copilot-studio set-bot-as-quarantined | (Preview) Set the quarantine status of a bot to true. |
| pac copilot-studio set-bot-as-unquarantined | (Preview) Set the quarantine status of a bot to false. |
| pac copilot-studio set-connector-consent-bypass | (Preview) Set the admin connector consent bypass setting for a bot. |
pac copilot-studio delete-copilot-agent
(Preview) Delete a bot.
Required Parameters for copilot-studio delete-copilot-agent
--bot-id
The bot ID.
Optional Parameters for copilot-studio delete-copilot-agent
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
pac copilot-studio download-agent-channel-manifest
(Preview) Downloads the channel manifest package for the specified agent and channel as a zip file. Currently only the "M365" channel is supported.
Required Parameters for copilot-studio download-agent-channel-manifest
--agent-id
The bot ID.
--channel-name
The channel name. Currently only "M365" is supported.
--out-file
The local file path to write the downloaded content to.
Optional Parameters for copilot-studio download-agent-channel-manifest
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
--include-agent-schema
Whether to include the agent schema in the downloaded manifest package.
pac copilot-studio get-bot-quarantine-status
(Preview) Retrieve the quarantine status of a bot.
Required Parameters for copilot-studio get-bot-quarantine-status
--bot-id
The bot ID.
Optional Parameters for copilot-studio get-bot-quarantine-status
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
pac copilot-studio get-connector-consent-bypass
(Preview) Get the admin connector consent bypass setting for a bot.
Required Parameters for copilot-studio get-connector-consent-bypass
--bot-id
The bot ID.
Optional Parameters for copilot-studio get-connector-consent-bypass
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
pac copilot-studio get-maker-evaluation-test-run
(Preview) Get the status and results of a specific maker evaluation test run.
Required Parameters for copilot-studio get-maker-evaluation-test-run
--bot-id
The bot ID.
--test-run-id
The test run ID.
Optional Parameters for copilot-studio get-maker-evaluation-test-run
--columns
Comma-separated list of response properties to include in table output. Use --json for the complete response.
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
pac copilot-studio get-maker-evaluation-test-set
(Preview) Get a specific test set for maker evaluation of a bot.
Required Parameters for copilot-studio get-maker-evaluation-test-set
--bot-id
The bot ID.
--test-set-id
The test set ID.
Optional Parameters for copilot-studio get-maker-evaluation-test-set
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
pac copilot-studio list-maker-evaluation-test-runs
(Preview) List all maker evaluation test runs for a bot.
Required Parameters for copilot-studio list-maker-evaluation-test-runs
--bot-id
The bot ID.
Optional Parameters for copilot-studio list-maker-evaluation-test-runs
--columns
Comma-separated list of response properties to include in table output. Use --json for the complete response.
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
pac copilot-studio list-maker-evaluation-test-sets
(Preview) Retrieves the list of test sets for a bot in a specified environment.
Required Parameters for copilot-studio list-maker-evaluation-test-sets
--bot-id
The bot ID.
Optional Parameters for copilot-studio list-maker-evaluation-test-sets
--columns
Comma-separated list of response properties to include in table output. Use --json for the complete response.
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
pac copilot-studio reassign-copilot-agent
(Preview) Reassign the owner of the bot.
Required Parameters for copilot-studio reassign-copilot-agent
--bot-id
The bot ID.
--new-owner-aad-user-id
The new owner Entra ID.
Optional Parameters for copilot-studio reassign-copilot-agent
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
pac copilot-studio run-maker-evaluation-test-set
(Preview) Trigger a maker evaluation test run for a specific test set.
Required Parameters for copilot-studio run-maker-evaluation-test-set
--bot-id
The bot ID.
--test-set-id
The test set ID.
Optional Parameters for copilot-studio run-maker-evaluation-test-set
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
--evaluation-run-name
The name of the evaluation run.
--mcs-connection-id
The connection ID for the MCS connector that is used to execute the evaluation run, or leave empty for an anonymous run.
--run-on-published-bot
Indicates whether the operation should run on a published bot instance. If set to false, the operation will run on a draft bot instance.
--tools-connections
The tools connections that will be used to execute the evaluation run. This is a list of tools along with the corresponding user connections that should be used for each tool. Provide the value as a JSON array.
pac copilot-studio set-bot-as-quarantined
(Preview) Set the quarantine status of a bot to true.
Required Parameters for copilot-studio set-bot-as-quarantined
--bot-id
The bot ID.
Optional Parameters for copilot-studio set-bot-as-quarantined
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
pac copilot-studio set-bot-as-unquarantined
(Preview) Set the quarantine status of a bot to false.
Required Parameters for copilot-studio set-bot-as-unquarantined
--bot-id
The bot ID.
Optional Parameters for copilot-studio set-bot-as-unquarantined
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
pac copilot-studio set-connector-consent-bypass
(Preview) Set the admin connector consent bypass setting for a bot.
Required Parameters for copilot-studio set-connector-consent-bypass
--admin-consent-bypass
Indicates whether to enable admin connector consent bypass for the bot.
--bot-id
The bot ID.
Optional Parameters for copilot-studio set-connector-consent-bypass
--environment -env
Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.
See also
Microsoft Power Platform CLI Command Groups
Microsoft Power Platform CLI overview