az containerapp add-on kafka

Note

This reference is part of the containerapp extension for the Azure CLI (version 2.62.0 or higher). The extension will automatically install the first time you run an az containerapp add-on kafka command. Learn more about extensions.

Command group 'containerapp add-on' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage the kafka add-on for the Container Apps environment.

Commands

Name	Description	Type	Status
az containerapp add-on kafka create	Command to create the kafka add-on.	Extension	Preview
az containerapp add-on kafka delete	Command to delete the kafka add-on.	Extension	Preview

az containerapp add-on kafka create

Preview

Command group 'containerapp add-on' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to create the kafka add-on.

az containerapp add-on kafka create --environment
                                    --name
                                    --resource-group
                                    [--no-wait]

Required Parameters

--environment

The environment name.

--name -n

The service name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az containerapp add-on kafka delete

Preview

Command group 'containerapp add-on' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command to delete the kafka add-on.

az containerapp add-on kafka delete --name
                                    --resource-group
                                    [--no-wait]
                                    [--yes]

Required Parameters

--name -n

The service name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False