Add workspace creation functionality #636
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Implemented workspace creation, assignment to capacity, and role assignment functions in `workspace_management.py`. - Added a YAML configuration example for bulk workspace creation in `workspace_config_example.yml`. - Developed unit tests for workspace management functions in `test_workspace_management.py`, covering various scenarios including invalid inputs and role assignments.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive workspace management functionality to enable programmatic workspace creation, capacity assignment, and role management - particularly designed for ISV scenarios requiring large-scale deployments (e.g., 500+ workspaces).
- Implements four main functions:
create_workspace,assign_workspace_to_capacity,add_workspace_role_assignment, andcreate_workspaces_from_config - Adds GUID validation utility and workspace-related constants
- Includes comprehensive test coverage with 499 lines of tests covering various scenarios
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/fabric_cicd/workspace_management.py | Core implementation of workspace management functions with API integration |
| tests/test_workspace_management.py | Comprehensive unit tests covering all functions and edge cases |
| src/fabric_cicd/constants.py | Adds workspace role and principal type constants |
| src/fabric_cicd/_common/_check_utils.py | Adds GUID validation utility function |
| src/fabric_cicd/init.py | Exports new workspace management functions |
| sample/workspace_config_example.yml | Provides example YAML configuration for bulk workspace creation |
| docs/how_to/workspace_management.md | Detailed documentation with usage examples and best practices |
docs/how_to/workspace_management.md
Outdated
Comment on lines
459
to
468
| For detailed API documentation, see the [Code Reference](../code_reference.md#workspace-management) section. | ||
|
|
||
| ### Related Functions | ||
|
|
||
| - [`create_workspace`](../code_reference.md#create_workspace): Create a single workspace | ||
| - [`create_workspaces_from_config`](../code_reference.md#create_workspaces_from_config): Create multiple workspaces from YAML config | ||
| - [`assign_workspace_to_capacity`](../code_reference.md#assign_workspace_to_capacity): Assign workspace to capacity | ||
| - [`add_workspace_role_assignment`](../code_reference.md#add_workspace_role_assignment): Add user/group/SP to workspace | ||
| - [`FabricWorkspace`](../code_reference.md#fabricworkspace): Initialize workspace for deployment | ||
| - [`publish_all_items`](../code_reference.md#publish_all_items): Deploy items to workspace |
There was a problem hiding this comment.
The documentation references a 'Code Reference' section with anchor links to the new functions (e.g., #workspace-management, #create_workspace), but these anchors likely don't exist yet in the code_reference.md file. Either remove these specific anchor references or ensure the corresponding API reference documentation is added to code_reference.md.
Suggested change
| For detailed API documentation, see the [Code Reference](../code_reference.md#workspace-management) section. | |
| ### Related Functions | |
| - [`create_workspace`](../code_reference.md#create_workspace): Create a single workspace | |
| - [`create_workspaces_from_config`](../code_reference.md#create_workspaces_from_config): Create multiple workspaces from YAML config | |
| - [`assign_workspace_to_capacity`](../code_reference.md#assign_workspace_to_capacity): Assign workspace to capacity | |
| - [`add_workspace_role_assignment`](../code_reference.md#add_workspace_role_assignment): Add user/group/SP to workspace | |
| - [`FabricWorkspace`](../code_reference.md#fabricworkspace): Initialize workspace for deployment | |
| - [`publish_all_items`](../code_reference.md#publish_all_items): Deploy items to workspace | |
| For detailed API documentation, see the [Code Reference](../code_reference.md) section. | |
| ### Related Functions | |
| - [`create_workspace`](../code_reference.md): Create a single workspace | |
| - [`create_workspaces_from_config`](../code_reference.md): Create multiple workspaces from YAML config | |
| - [`assign_workspace_to_capacity`](../code_reference.md): Assign workspace to capacity | |
| - [`add_workspace_role_assignment`](../code_reference.md): Add user/group/SP to workspace | |
| - [`FabricWorkspace`](../code_reference.md): Initialize workspace for deployment | |
| - [`publish_all_items`](../code_reference.md): Deploy items to workspace |
Author
|
@microsoft-github-policy-service agree |
Shailin
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
workspace_management.py.workspace_config_example.yml.test_workspace_management.py, covering various scenarios including invalid inputs and role assignments.Description
Briefly describe what this PR does and why.
Linked Issue (REQUIRED)
Fixes #635