[Containerapp] `az containerapp function` : list, show, keys list/show/set, invocations summary/traces commands #9185

khushishah513 · 2025-09-19T09:51:50Z

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

…ntainerapp functions

azure-client-tools-bot-prd · 2025-09-19T09:51:53Z

Hi @khushishah513,
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.

azure-client-tools-bot-prd · 2025-09-19T09:51:56Z

⚠️Azure CLI Extensions Breaking Change Test

⚠️containerapp

rule cmd_name rule_message suggest_message

⚠️ 1006 - ParaAdd containerapp debug cmd containerapp debug added parameter debug_command

⚠️ 1011 - SubgroupAdd containerapp function sub group containerapp function added

yonzhan · 2025-09-19T09:52:00Z

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

github-actions · 2025-09-19T09:52:03Z

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-23T06:16:38Z

Hi @khushishah513

Release Suggestions

Module: containerapp

Update VERSION to 1.2.0b4 in src/containerapp/setup.py

Notes

For more info about extension versioning, please refer to Extension version schema

src/containerapp/azext_containerapp/_clients.py

krishnajaju · 2025-09-23T06:21:27Z

src/containerapp/azext_containerapp/_clients.py

+        invocation_summary_query = (
+            f"requests | extend functionNameFromCustomDimension = tostring(customDimensions['faas.name']) "
+            f"| where timestamp >= ago({timespan}) "
+            f"| where cloud_RoleName =~ '{container_app_name}' "
+            f"| where operation_Name =~ '{function_name}' or functionNameFromCustomDimension =~ '{function_name}' "
+            f"| summarize count=count() by success"
+        )


something for future - this will work fine in single-revision mode, but for multi-revision mode, we will need to pass revisionName as well.

src/containerapp/azext_containerapp/_clients.py

src/containerapp/azext_containerapp/_help.py

krishnajaju · 2025-09-23T06:28:11Z

src/containerapp/azext_containerapp/_help.py

+    - name: Set/Update a master key for a container app
+      text: |
+          az containerapp function keys set -n my-containerapp -g MyResourceGroup --key-type masterKey --key-name MyKeyName --key-value MyKeyValue
+    - name: Set/Update a system key for a container app


Please check with Shivam, if we want to add an example to rotate keys as well. Backend already supports it I think.

src/containerapp/azext_containerapp/_help.py

Signed-off-by: Shivam Kumar <[email protected]>

…ations traces

adding support for output formats and adding limit parameter to invocation traces

Copilot

Pull Request Overview

This PR introduces comprehensive support for Azure Functions on Azure Container Apps through new CLI commands. It adds functionality to manage functions, function keys, debug commands, and retrieve invocation data from Application Insights.

Key changes:

Added new command groups for container app functions and function keys management
Enhanced debug functionality with command execution capability
Integrated Application Insights querying for function invocation monitoring

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
custom.py	Added function management commands and enhanced debug functionality with command execution
containerapp_functions_decorator.py	New decorator classes for function listing, showing, and invocation operations
containerapp_function_keys_decorator.py	New decorator classes for function key management operations
containerapp_debug_command_decorator.py	New decorator for executing commands in debug containers
commands.py	Added command group definitions and transformers for function operations
_validators.py	Added validation functions for function apps and revision management
_utils.py	Added utility function for replica selection
_transformers.py	Added transformation functions for function data display and debug output
_ssh_utils.py	Minor refactoring of debug URL generation
_params.py	Added parameter definitions for all new function-related commands
_help.py	Added comprehensive help documentation for new commands
_clients.py	Added ContainerAppFunctionsPreviewClient with function and key management methods
HISTORY.rst	Updated with new feature descriptions

src/containerapp/azext_containerapp/_validators.py

Copilot · 2025-09-26T06:45:03Z

src/containerapp/azext_containerapp/_utils.py

+        raise ValidationError(f"No replicas found for revision '{revision_name}' of container app '{container_app_name}'.")
+
+    # Select a random replica
+    replica = random.choice(replicas)


Using random selection for replica choice may lead to unpredictable behavior in production environments. Consider implementing a more deterministic selection strategy, such as choosing the first available replica or the one with the lowest load.

src/containerapp/azext_containerapp/_clients.py

Copilot · 2025-09-26T06:45:04Z

src/containerapp/azext_containerapp/_transformers.py

+                # If not valid JSON, treat as plain text and decode escape sequences
+                decoded_output = output_str.encode().decode('unicode_escape')
+                return decoded_output


Using decode('unicode_escape') on untrusted input can be a security risk as it can execute escape sequences. Consider using a safer string processing approach or validate the input before decoding.

Suggested change

# If not valid JSON, treat as plain text and decode escape sequences

decoded_output = output_str.encode().decode('unicode_escape')

return decoded_output

# If not valid JSON, treat as plain text and return as-is (do not decode escape sequences)

return output_str

Adding transformers for ouput formatting and check for kind

Several minor code improvements without functionality changes

src/containerapp/HISTORY.rst

src/containerapp/azext_containerapp/_clients.py

src/containerapp/azext_containerapp/_help.py

BlackRider97 · 2025-09-29T07:22:52Z

src/containerapp/azext_containerapp/_utils.py

+        raise CLIError(f"No replicas found for revision '{revision_name}' of container app '{container_app_name}'.")
+
+    # Select a random replica
+    replica = random.choice(replicas)


if we have state of a replica then consider selecting latest created & healthy replica instead of random

src/containerapp/azext_containerapp/_validators.py

addressing comments

khushishah513 and others added 21 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 az containerapp functions commands

dd11032

modification to help descriptions

103347c

correcting params.py file

a6f740c

addressing comments

5e514c8

modifying help description

c1e4db7

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

0107fda

…ntainerapp functions

adding tests

852994d

Add functionapp invocations summary and traces commands

d5af977

updated command name

677df78

Rebasing changes over top of exiting changes

7c168ff

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

microsoft-github-policy-service bot requested review from yonzhan, wangzelin007, yanzhudd and zhoxing-ms September 19, 2025 09:52

Passing container to the debug api

c417b1e

krishnajaju reviewed Sep 23, 2025

View reviewed changes

khushishah513 and others added 11 commits September 23, 2025 07:20

a minor fix

6f92a80

modifications to help.py

30e4b09

nit changes to help.py

457afd3

fixes for invocations

35bf04a

adding support for output formatting

a720b41

Adding debug command changes

681deeb

Signed-off-by: Shivam Kumar <[email protected]>

adding support for output formats and adding limit parameter to invoc…

1168a8e

…ations traces

Merge pull request #8 from khushishah513/functionaca-cli

bb913c0

adding support for output formats and adding limit parameter to invocation traces

temp

9aa8d4b

Fixes for function keys commands

581641a

fix debug command parsing issue

41bc7ef

khushishah513 marked this pull request as ready for review September 26, 2025 06:43

Copilot AI review requested due to automatic review settings September 26, 2025 06:43

Copilot AI reviewed Sep 26, 2025

View reviewed changes

khushishah513 force-pushed the function-changes branch 3 times, most recently from 0bc26da to 41bc7ef Compare September 26, 2025 06:56

khushishah513 added 4 commits September 26, 2025 06:57

adding transformers for ouput formatting and adding check for kind

e23a6e0

Merge pull request #9 from khushishah513/functionaca-cli

911a093

Adding transformers for ouput formatting and check for kind

several minor code improvements without functionality changes

d3d2a40

Merge pull request #10 from khushishah513/functionaca-cli

36b39c3

Several minor code improvements without functionality changes

khushishah513 changed the title ~~[Containerapp] az containerapp function~~ [Containerapp] az containerapp function : list, show, keys list/show/set, invocations summary/traces commands Sep 26, 2025

BlackRider97 reviewed Sep 29, 2025

View reviewed changes

src/containerapp/HISTORY.rst Outdated Show resolved Hide resolved

src/containerapp/HISTORY.rst Outdated Show resolved Hide resolved

BlackRider97 reviewed Sep 29, 2025

View reviewed changes

khushishah513 and others added 3 commits October 1, 2025 00:43

addressing comments

5ddb8de

Merge pull request #11 from khushishah513/shahkhushi/functionaca-cli

cd21d64

addressing comments

Review comments

30093f6

[Containerapp] az containerapp function : list, show, keys list/show/set, invocations summary/traces commands #9185

Are you sure you want to change the base?

[Containerapp] az containerapp function : list, show, keys list/show/set, invocations summary/traces commands #9185

Uh oh!

Conversation

khushishah513 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 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yonzhan commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 23, 2025

Release Suggestions

Module: containerapp

Notes

Uh oh!

Uh oh!

krishnajaju Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

krishnajaju Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

shivamkm07 Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BlackRider97 Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

shivamkm07 Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[Containerapp] `az containerapp function` : list, show, keys list/show/set, invocations summary/traces commands #9185

[Containerapp] `az containerapp function` : list, show, keys list/show/set, invocations summary/traces commands #9185

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

edited

Loading