Add command param in debug command #9186

shivamkm07 · 2025-09-19T11:01:46Z

This PR adds command param in debug command.

This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
My extension version conforms to the Extension version schema

For new extensions:

My extension description/summary conforms to the Extension Summary Guidelines.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

…ntainerapp functions

[Containerapp] `az containerapp function`: Add function key management commands

[Container App] az containerapp function: Add list and show commands for container app functions

azure-client-tools-bot-prd · 2025-09-19T11:01:49Z

Validation for Breaking Change Starting...

Thanks for your contribution!

azure-client-tools-bot-prd · 2025-09-19T11:01:52Z

Hi @shivamkm07,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

yonzhan · 2025-09-19T11:01:56Z

Thank you for your contribution! We will review the pull request and get back to you soon.

github-actions · 2025-09-19T11:01:57Z

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

github-actions · 2025-09-19T11:02:48Z

CodeGen Tools Feedback Collection

Thank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey

Copilot

Pull Request Overview

This PR adds a command parameter to the debug command and introduces a comprehensive set of Azure Function management commands for Azure Container Apps. The primary purpose is to enhance debugging capabilities by allowing custom commands to be passed when establishing debug connections, while also adding new function-related operations for container apps.

Adds a command parameter to the containerapp debug command for custom debug commands
Introduces new command group containerapp function with list and show operations
Adds function key management commands for listing and updating function and host keys

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`custom.py`	Updates debug function signature to accept command parameter and adds new function management commands
`_ssh_utils.py`	Modifies debug WebSocket connection to handle URL encoding and append command parameter to debug URL
`_params.py`	Adds parameter definitions for all new function-related commands
`commands.py`	Registers new containerapp function command group and subcommands
`_help.py`	Adds comprehensive help documentation for all new function commands
`_clients.py`	Implements API client methods for function operations and key management
`containerapp_functions_decorator.py`	New decorator classes for function list and show operations
`containerapp_function_keys_decorator.py`	New decorator classes for function key management operations
`HISTORY.rst`	Documents the new features in release history

Copilot · 2025-09-19T11:03:01Z

src/containerapp/azext_containerapp/_clients.py

+    class ContainerAppFunctionsPreviewClient:
+    api_version = PREVIEW_API_VERSION
+
+    @classmethod
+    def list_function_keys(cls, cmd, resource_group_name, name, function_name):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/containerapps/{}/functions/{}/listkeys?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            function_name,
+            cls.api_version)
+
+        r = send_raw_request(cmd.cli_ctx, "POST", request_url)
+        return r.json()
+
+    @classmethod
+    def update_function_keys(cls, cmd, resource_group_name, name, function_name, key_name, key_value=None):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/containerapps/{}/functions/{}/keys/{}?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            function_name,
+            key_name,
+            cls.api_version)
+
+        body = {}
+        if key_value:
+            body["value"] = key_value
+
+        r = send_raw_request(cmd.cli_ctx, "PUT", request_url, body=json.dumps(body))
+        return r.json()
+
+    @classmethod
+    def list_host_keys(cls, cmd, resource_group_name, name):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/containerapps/{}/host/default/listkeys?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            cls.api_version)
+
+        r = send_raw_request(cmd.cli_ctx, "POST", request_url)
+        return r.json()
+
+    @classmethod
+    def update_host_keys(cls, cmd, resource_group_name, name, key_type, key_name, key_value=None):
+        management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager
+        sub_id = get_subscription_id(cmd.cli_ctx)
+        url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/containerapps/{}/host/default/{}/{}?api-version={}"
+        request_url = url_fmt.format(
+            management_hostname.strip('/'),
+            sub_id,
+            resource_group_name,
+            name,
+            key_type,
+            key_name,
+            cls.api_version)
+
+        body = {}
+        if key_value:
+            body["value"] = key_value
+
+        r = send_raw_request(cmd.cli_ctx, "PUT", request_url, body=json.dumps(body))
+        return r.json()


Duplicate class definition. There's already a ContainerAppFunctionsPreviewClient class defined at line 306. This creates a naming conflict and the second definition will override the first one.

Suggested change

class ContainerAppFunctionsPreviewClient:

api_version = PREVIEW_API_VERSION

@classmethod

def list_function_keys(cls, cmd, resource_group_name, name, function_name):

management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager

sub_id = get_subscription_id(cmd.cli_ctx)

url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/containerapps/{}/functions/{}/listkeys?api-version={}"

request_url = url_fmt.format(

management_hostname.strip('/'),

sub_id,

resource_group_name,

name,

function_name,

cls.api_version)

r = send_raw_request(cmd.cli_ctx, "POST", request_url)

return r.json()

@classmethod

def update_function_keys(cls, cmd, resource_group_name, name, function_name, key_name, key_value=None):

management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager

sub_id = get_subscription_id(cmd.cli_ctx)

url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/containerapps/{}/functions/{}/keys/{}?api-version={}"

request_url = url_fmt.format(

management_hostname.strip('/'),

sub_id,

resource_group_name,

name,

function_name,

key_name,

cls.api_version)

body = {}

if key_value:

body["value"] = key_value

r = send_raw_request(cmd.cli_ctx, "PUT", request_url, body=json.dumps(body))

return r.json()

@classmethod

def list_host_keys(cls, cmd, resource_group_name, name):

management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager

sub_id = get_subscription_id(cmd.cli_ctx)

url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/containerapps/{}/host/default/listkeys?api-version={}"

request_url = url_fmt.format(

management_hostname.strip('/'),

sub_id,

resource_group_name,

name,

cls.api_version)

r = send_raw_request(cmd.cli_ctx, "POST", request_url)

return r.json()

@classmethod

def update_host_keys(cls, cmd, resource_group_name, name, key_type, key_name, key_value=None):

management_hostname = cmd.cli_ctx.cloud.endpoints.resource_manager

sub_id = get_subscription_id(cmd.cli_ctx)

url_fmt = "{}/subscriptions/{}/resourceGroups/{}/providers/Microsoft.App/containerapps/{}/host/default/{}/{}?api-version={}"

request_url = url_fmt.format(

management_hostname.strip('/'),

sub_id,

resource_group_name,

name,

key_type,

key_name,

cls.api_version)

body = {}

if key_value:

body["value"] = key_value

r = send_raw_request(cmd.cli_ctx, "PUT", request_url, body=json.dumps(body))

return r.json()

# Duplicate definition of ContainerAppFunctionsPreviewClient removed to resolve naming conflict.

Copilot · 2025-09-19T11:03:02Z

src/containerapp/azext_containerapp/_clients.py

                poll_results(cmd, operation_url)
+
+    class ContainerAppFunctionsPreviewClient:
+    api_version = PREVIEW_API_VERSION


Missing indentation. This line should be indented to be part of the class definition.

Suggested change

api_version = PREVIEW_API_VERSION

api_version = PREVIEW_API_VERSION

Copilot · 2025-09-19T11:03:02Z

src/containerapp/azext_containerapp/commands.py

+    with self.command_group('containerapp function') as g:
+        g.custom_command('list-keys', 'list_containerapp_function_keys')
+        g.custom_command('update-keys', 'update_containerapp_function_keys')
+        g.custom_command('list-hostkeys', 'list_containerapp_function_hostkeys')
+        g.custom_command('update-hostkeys', 'update_containerapp_function_hostkeys')


Duplicate command group definition. The 'containerapp function' command group is already defined at lines 35-37. This will cause conflicts between the two command group definitions.

khushishah513 and others added 12 commits September 11, 2025 10:51

adding az containerapp functions commands

4dc363f

modification to help descriptions

a9393d8

correcting params.py file

94cf376

addressing comments

95e3345

modifying help description

e42a0f6

adding az containerapp function keys commands

88ab1f6

modifying the command to be az containerapp function instead of az co…

0986024

…ntainerapp functions

updating function keys decorator

b9c8a4b

Merge pull request #1 from khushishah513/functionaca-keys

0cf0be6

[Containerapp] `az containerapp function`: Add function key management commands

Merge branch 'function-changes' into functionaca-getlist

771087c

Merge pull request #2 from khushishah513/functionaca-getlist

a34da44

[Container App] az containerapp function: Add list and show commands for container app functions

Adding command param in debug command

d9bd529

Copilot AI review requested due to automatic review settings September 19, 2025 11:01

shivamkm07 requested review from Juliehzl and howang-ms as code owners September 19, 2025 11:01

azure-client-tools-bot-prd bot added this to the October 2025 (2025-10-07) milestone Sep 19, 2025

shivamkm07 closed this Sep 19, 2025

Copilot AI reviewed Sep 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add command param in debug command #9186

Add command param in debug command #9186

Uh oh!

shivamkm07 commented Sep 19, 2025

Uh oh!

azure-client-tools-bot-prd bot commented Sep 19, 2025

Uh oh!

azure-client-tools-bot-prd bot commented Sep 19, 2025

Uh oh!

yonzhan commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 19, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 19, 2025

Uh oh!

Copilot AI Sep 19, 2025

Uh oh!

Copilot AI Sep 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	api_version = PREVIEW_API_VERSION
	api_version = PREVIEW_API_VERSION

Add command param in debug command #9186

Add command param in debug command #9186

Uh oh!

Conversation

shivamkm07 commented Sep 19, 2025

Related command

General Guidelines

About Extension Publish

Uh oh!

azure-client-tools-bot-prd bot commented Sep 19, 2025

Uh oh!

azure-client-tools-bot-prd bot commented Sep 19, 2025

Uh oh!

yonzhan commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 19, 2025

CodeGen Tools Feedback Collection

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants