-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Planetary Computer CLI extension #9737
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
Open
thisisdevanshu
wants to merge
5
commits into
Azure:main
Choose a base branch
from
thisisdevanshu:add-planetarycomputer-extension
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ad26d3e
Add planetarycomputer extension for GeoCatalog management
thisisdevanshu-ms f30b5f3
Sanitize test catalog names in recordings and test constants
thisisdevanshu-ms d248fb4
Restore inline examples in AAZ command docstrings
thisisdevanshu-ms 5d72465
Address PR review comments: fix naming consistency and help text
thisisdevanshu-ms 52fe738
Remove --system-assigned flag, fix docstrings, add identity remove help
thisisdevanshu-ms File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| .. :changelog: | ||
|
|
||
| Release History | ||
| =============== | ||
|
|
||
| 1.0.0b1 | ||
| ++++++ | ||
| * Initial release. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Azure CLI Planetary Computer Extension # | ||
| This is an extension to Azure CLI to manage Planetary Computer GeoCatalog resources. | ||
|
|
||
| ## How to use ## | ||
|
|
||
| ### Install the extension ### | ||
| ```bash | ||
| az extension add --name planetarycomputer | ||
| ``` | ||
|
|
||
| ### Commands ### | ||
|
|
||
| #### GeoCatalog Management #### | ||
| ```bash | ||
| # Create a GeoCatalog | ||
| az planetarycomputer geocatalog create -g MyResourceGroup -n MyCatalog -l eastus | ||
|
|
||
| # Show a GeoCatalog | ||
| az planetarycomputer geocatalog show -g MyResourceGroup -n MyCatalog | ||
|
|
||
| # List GeoCatalogs in a resource group | ||
| az planetarycomputer geocatalog list -g MyResourceGroup | ||
|
|
||
| # List all GeoCatalogs in a subscription | ||
| az planetarycomputer geocatalog list | ||
|
|
||
| # Update tags on a GeoCatalog | ||
| az planetarycomputer geocatalog update -g MyResourceGroup -n MyCatalog --tags env=prod | ||
|
|
||
| # Delete a GeoCatalog | ||
| az planetarycomputer geocatalog delete -g MyResourceGroup -n MyCatalog | ||
|
|
||
| # Wait for a GeoCatalog to reach a desired state | ||
| az planetarycomputer geocatalog wait -g MyResourceGroup -n MyCatalog --created | ||
| ``` | ||
|
|
||
| #### GeoCatalog Identity Management #### | ||
| ```bash | ||
| # Assign a user-assigned managed identity | ||
| az planetarycomputer geocatalog identity assign -g MyResourceGroup -n MyCatalog --user-assigned /subscriptions/<subscription-id>/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyIdentity | ||
|
|
||
| # Show identity information | ||
| az planetarycomputer geocatalog identity show -g MyResourceGroup -n MyCatalog | ||
|
|
||
| # Remove a user-assigned managed identity | ||
| az planetarycomputer geocatalog identity remove -g MyResourceGroup -n MyCatalog --user-assigned /subscriptions/<subscription-id>/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyIdentity | ||
| ``` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # | ||
| # Code generated by aaz-dev-tools | ||
| # -------------------------------------------------------------------------------------------- | ||
|
|
||
| from azure.cli.core import AzCommandsLoader | ||
| from azext_planetarycomputer._help import helps # pylint: disable=unused-import | ||
|
|
||
|
|
||
| class PlanetarycomputerCommandsLoader(AzCommandsLoader): | ||
|
|
||
| def __init__(self, cli_ctx=None): | ||
| from azure.cli.core.commands import CliCommandType | ||
| custom_command_type = CliCommandType( | ||
| operations_tmpl='azext_planetarycomputer.custom#{}') | ||
| super().__init__(cli_ctx=cli_ctx, | ||
| custom_command_type=custom_command_type) | ||
|
|
||
| def load_command_table(self, args): | ||
| from azext_planetarycomputer.commands import load_command_table | ||
| from azure.cli.core.aaz import load_aaz_command_table | ||
| try: | ||
| from . import aaz | ||
| except ImportError: | ||
| aaz = None | ||
| if aaz: | ||
| load_aaz_command_table( | ||
| loader=self, | ||
| aaz_pkg_name=aaz.__name__, | ||
| args=args | ||
| ) | ||
| load_command_table(self, args) | ||
| return self.command_table | ||
|
|
||
| def load_arguments(self, command): | ||
| from azext_planetarycomputer._params import load_arguments | ||
| load_arguments(self, command) | ||
|
|
||
|
|
||
| COMMAND_LOADER_CLS = PlanetarycomputerCommandsLoader |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # | ||
| # Code generated by aaz-dev-tools | ||
| # -------------------------------------------------------------------------------------------- | ||
|
|
||
| # pylint: disable=line-too-long | ||
| # pylint: disable=too-many-lines | ||
|
|
||
| from knack.help_files import helps # pylint: disable=unused-import | ||
|
|
||
| helps['planetarycomputer'] = """ | ||
| type: group | ||
| short-summary: Manage Planetary Computer resources. | ||
| """ | ||
|
|
||
| helps['planetarycomputer geocatalog'] = """ | ||
| type: group | ||
| short-summary: Manage Planetary Computer GeoCatalog resources. | ||
| """ | ||
|
|
||
| helps['planetarycomputer geocatalog create'] = """ | ||
| type: command | ||
| short-summary: Create a GeoCatalog. | ||
| examples: | ||
| - name: Create a GeoCatalog with default settings | ||
| text: |- | ||
| az planetarycomputer geocatalog create -g MyResourceGroup -n MyCatalog -l eastus | ||
| - name: Create a GeoCatalog with a user-assigned identity | ||
| text: |- | ||
| az planetarycomputer geocatalog create -g MyResourceGroup -n MyCatalog -l eastus \\ | ||
| --user-assigned "/subscriptions/{sub}/resourcegroups/{rg}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{name}" | ||
| """ | ||
|
|
||
| helps['planetarycomputer geocatalog update'] = """ | ||
| type: command | ||
| short-summary: Update a GeoCatalog. | ||
| examples: | ||
| - name: Update tags on a GeoCatalog | ||
| text: |- | ||
| az planetarycomputer geocatalog update -g MyResourceGroup -n MyCatalog --tags env=prod team=platform | ||
| """ | ||
|
|
||
| helps['planetarycomputer geocatalog identity'] = """ | ||
| type: group | ||
| short-summary: Manage identities for a Planetary Computer GeoCatalog. | ||
| """ | ||
|
|
||
| helps['planetarycomputer geocatalog identity assign'] = """ | ||
| type: command | ||
| short-summary: Assign an identity to a GeoCatalog. | ||
| examples: | ||
| - name: Assign a user-assigned managed identity | ||
| text: |- | ||
| az planetarycomputer geocatalog identity assign -g MyResourceGroup -n MyCatalog \\ | ||
| --user-assigned "/subscriptions/{sub}/resourcegroups/{rg}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{name}" | ||
| """ | ||
|
Comment on lines
+53
to
+58
|
||
|
|
||
| helps['planetarycomputer geocatalog identity remove'] = """ | ||
| type: command | ||
| short-summary: Remove an identity from a GeoCatalog. | ||
| examples: | ||
| - name: Remove a user-assigned managed identity | ||
| text: |- | ||
| az planetarycomputer geocatalog identity remove -g MyResourceGroup -n MyCatalog \\ | ||
| --user-assigned "/subscriptions/{sub}/resourcegroups/{rg}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{name}" | ||
| """ | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # | ||
| # Code generated by aaz-dev-tools | ||
| # -------------------------------------------------------------------------------------------- | ||
|
|
||
| # pylint: disable=too-many-lines | ||
| # pylint: disable=too-many-statements | ||
|
|
||
|
|
||
| def load_arguments(self, _): # pylint: disable=unused-argument | ||
| pass |
6 changes: 6 additions & 0 deletions
6
src/planetarycomputer/azext_planetarycomputer/aaz/__init__.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # | ||
| # Code generated by aaz-dev-tools | ||
| # -------------------------------------------------------------------------------------------- |
10 changes: 10 additions & 0 deletions
10
src/planetarycomputer/azext_planetarycomputer/aaz/latest/__init__.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # | ||
| # Code generated by aaz-dev-tools | ||
| # -------------------------------------------------------------------------------------------- | ||
|
|
||
| # pylint: skip-file | ||
| # flake8: noqa | ||
|
|
23 changes: 23 additions & 0 deletions
23
src/planetarycomputer/azext_planetarycomputer/aaz/latest/spatio/__cmd_group.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # | ||
| # Code generated by aaz-dev-tools | ||
| # -------------------------------------------------------------------------------------------- | ||
|
|
||
| # pylint: skip-file | ||
| # flake8: noqa | ||
|
|
||
| from azure.cli.core.aaz import * | ||
|
|
||
|
|
||
| @register_command_group( | ||
| "planetarycomputer", | ||
| ) | ||
| class __CMDGroup(AAZCommandGroup): | ||
| """Manage Planetary Computer resources. | ||
| """ | ||
| pass | ||
|
|
||
|
|
||
| __all__ = ["__CMDGroup"] |
11 changes: 11 additions & 0 deletions
11
src/planetarycomputer/azext_planetarycomputer/aaz/latest/spatio/__init__.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # | ||
| # Code generated by aaz-dev-tools | ||
| # -------------------------------------------------------------------------------------------- | ||
|
|
||
| # pylint: skip-file | ||
| # flake8: noqa | ||
|
|
||
| from .__cmd_group import * |
23 changes: 23 additions & 0 deletions
23
src/planetarycomputer/azext_planetarycomputer/aaz/latest/spatio/geo_catalog/__cmd_group.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # | ||
| # Code generated by aaz-dev-tools | ||
| # -------------------------------------------------------------------------------------------- | ||
|
|
||
| # pylint: skip-file | ||
| # flake8: noqa | ||
|
|
||
| from azure.cli.core.aaz import * | ||
|
|
||
|
|
||
| @register_command_group( | ||
| "planetarycomputer geocatalog", | ||
| ) | ||
| class __CMDGroup(AAZCommandGroup): | ||
| """Manage GeoCatalog | ||
| """ | ||
| pass | ||
|
|
||
|
|
||
| __all__ = ["__CMDGroup"] |
17 changes: 17 additions & 0 deletions
17
src/planetarycomputer/azext_planetarycomputer/aaz/latest/spatio/geo_catalog/__init__.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # -------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See License.txt in the project root for license information. | ||
| # | ||
| # Code generated by aaz-dev-tools | ||
| # -------------------------------------------------------------------------------------------- | ||
|
|
||
| # pylint: skip-file | ||
| # flake8: noqa | ||
|
|
||
| from .__cmd_group import * | ||
| from ._create import * | ||
| from ._delete import * | ||
| from ._list import * | ||
| from ._show import * | ||
| from ._update import * | ||
| from ._wait import * |
Oops, something went wrong.
Oops, something went wrong.
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.
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 help examples use four backslashes at line breaks (e.g.,
\\\\in the source), which will render as two backslashes in the CLI help output. Other extensions use a single rendered continuation (\), so this should be reduced to\\in the Python string to display one backslash to users.