-
Notifications
You must be signed in to change notification settings - Fork 393
Add capability host creation instructions and update agent version #624
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Added instructions for creating an account-level capability host and updated the hosted agent version section to reflect changes in replica parameters.
|
@tinaem : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit 7ea9050: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Hi @tinaem - This pull request was opened in the public repo. PMs should work in the private repo, per the Microsoft Docs contributor guide. We can keep this PR open for review and merge, but would you make future content updates in the private repo? Thank you! @aahill - Can you review the proposed changes? Important: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds documentation for creating an account-level capability host and updates the parameter requirements for the az cognitiveservices agent start command. The changes clarify that min/max replicas are now optional parameters when starting an agent deployment.
- Adds new section documenting capability host creation with public hosting environment enabled
- Updates replica parameters from required to optional in the agent start command documentation
|
|
||
| ```bash | ||
| curl --request PUT \ | ||
| --url 'https://management.azure.com/subscriptions/96aede12-2f73-41cb-b983-6d11a904839b/resourceGroups/arthfa-ncus/providers/Microsoft.CognitiveServices/accounts/arthfa-ncus/capabilityHosts/accountcaphost?api-version=2025-10-01-preview' \ |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This cURL example contains hardcoded subscription ID, resource group name, and account name that appear to be specific to a test environment ("arthfa-ncus"). These should be replaced with placeholders or generic example values to prevent confusion and potential security issues.
Consider using placeholders like:
{subscription-id}oryour-subscription-id{resource-group-name}oryour-resource-group{account-name}oryour-foundry-account
| --url 'https://management.azure.com/subscriptions/96aede12-2f73-41cb-b983-6d11a904839b/resourceGroups/arthfa-ncus/providers/Microsoft.CognitiveServices/accounts/arthfa-ncus/capabilityHosts/accountcaphost?api-version=2025-10-01-preview' \ | |
| --url 'https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.CognitiveServices/accounts/{account-name}/capabilityHosts/accountcaphost?api-version=2025-10-01-preview' \ |
| 1. Grant pull permissions by assigning the Container Registry Repository Reader role to your project's managed identity on the container registry. For detailed steps, see [Azure Container Registry roles and permissions](/azure/container-registry/container-registry-roles). | ||
|
|
||
| ### Create account-level Capability Host |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heading uses sentence case ("Capability Host") instead of the expected lowercase style for multi-word terms. According to Microsoft Writing Style Guide, headings should be in sentence case. This should be "Create account-level capability host" (with "capability host" in lowercase).
| ### Create account-level Capability Host | |
| ### Create account-level capability host |
| ### Create account-level Capability Host | ||
|
|
||
| Updating capability hosts is not supported. If you have existing capability host for your Foundry account, you must delete the existing one and recreate it with the property "enablePublicHostingEnvironment" set to true. | ||
|
|
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The cURL command lacks introductory text explaining what the command does or when to use it. Consider adding a brief introduction before the code block, such as "To create the account-level capability host with public hosting enabled, use the following Azure REST API call:" This follows the pattern used elsewhere in the document (see lines 237-240, 293).
| To create the account-level capability host with public hosting enabled, use the following Azure REST API call: |
|
|
||
| ### Create account-level Capability Host | ||
|
|
||
| Updating capability hosts is not supported. If you have existing capability host for your Foundry account, you must delete the existing one and recreate it with the property "enablePublicHostingEnvironment" set to true. |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra space detected between "you" and "must" - should be a single space instead of two spaces.
| Updating capability hosts is not supported. If you have existing capability host for your Foundry account, you must delete the existing one and recreate it with the property "enablePublicHostingEnvironment" set to true. | |
| Updating capability hosts is not supported. If you have existing capability host for your Foundry account, you must delete the existing one and recreate it with the property "enablePublicHostingEnvironment" set to true. |
|
|
||
| ### Create account-level Capability Host | ||
|
|
||
| Updating capability hosts is not supported. If you have existing capability host for your Foundry account, you must delete the existing one and recreate it with the property "enablePublicHostingEnvironment" set to true. |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing article "an" before "existing capability host". The sentence should read "If you have an existing capability host for your Foundry account..."
| Updating capability hosts is not supported. If you have existing capability host for your Foundry account, you must delete the existing one and recreate it with the property "enablePublicHostingEnvironment" set to true. | |
| Updating capability hosts is not supported. If you have an existing capability host for your Foundry account, you must delete the existing one and recreate it with the property "enablePublicHostingEnvironment" set to true. |
|
Could you clarify what the enablePublicHostingEnvironment parameter is intended to do? The API docs don’t make its behaviour very clear |
Added instructions for creating an account-level capability host and updated the hosted agent version section to reflect changes in replica parameters.