Share via

az confluent organization environment cluster connector

Note

This reference is part of the confluent extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az confluent organization environment cluster connector command. Learn more about extensions.

Manage Connector.

Commands

Name Description Type Status
az confluent organization environment cluster connector create

Create confluent connector by Name.

 Extension GA
az confluent organization environment cluster connector delete

Delete confluent connector by name.

 Extension GA
az confluent organization environment cluster connector list

List all the connectors in a cluster.

 Extension GA
az confluent organization environment cluster connector show

Get confluent connector by Name.

 Extension GA
az confluent organization environment cluster connector update

Update confluent connector by Name.

 Extension GA

az confluent organization environment cluster connector create

Create confluent connector by Name.

az confluent organization environment cluster connector create --cluster-id
                                                               --connector-name --name
                                                               --environment-id
                                                               --organization-name
                                                               --resource-group
                                                               [--acquire-policy-token]
                                                               [--change-reference]
                                                               [--connector-basic-info]
                                                               [--connector-service-type-info]
                                                               [--partner-connector-info]

Required Parameters

--cluster-id

Confluent kafka or schema registry cluster id.

--connector-name --name -n

Confluent connector name.

--environment-id

Confluent environment id.

--organization-name

Organization resource 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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--connector-basic-info

Connector Info Base Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--connector-service-type-info

Connector Service type info base properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--partner-connector-info

The connection information consumed by applications. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
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 confluent organization environment cluster connector delete

Delete confluent connector by name.

az confluent organization environment cluster connector delete [--acquire-policy-token]
                                                               [--change-reference]
                                                               [--cluster-id]
                                                               [--connector-name --name]
                                                               [--environment-id]
                                                               [--ids]
                                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                               [--organization-name]
                                                               [--resource-group]
                                                               [--subscription]
                                                               [--yes]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-id

Confluent kafka or schema registry cluster id.

Property Value
Parameter group: Resource Id Arguments
--connector-name --name -n

Confluent connector name.

Property Value
Parameter group: Resource Id Arguments
--environment-id

Confluent environment id.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--organization-name

Organization resource name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--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.

--verbose

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

Property Value
Default value: False

az confluent organization environment cluster connector list

List all the connectors in a cluster.

az confluent organization environment cluster connector list --cluster-id
                                                             --environment-id
                                                             --organization-name
                                                             --resource-group
                                                             [--max-items]
                                                             [--next-token]
                                                             [--page-size]
                                                             [--page-token]

Required Parameters

--cluster-id

Confluent kafka or schema registry cluster id.

--environment-id

Confluent environment id.

--organization-name

Organization resource 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.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--page-size

Pagination size.

--page-token

An opaque pagination token to fetch the next set of records.

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 confluent organization environment cluster connector show

Get confluent connector by Name.

az confluent organization environment cluster connector show [--cluster-id]
                                                             [--connector-name --name]
                                                             [--environment-id]
                                                             [--ids]
                                                             [--organization-name]
                                                             [--resource-group]
                                                             [--subscription]

Optional Parameters

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

--cluster-id

Confluent kafka or schema registry cluster id.

Property Value
Parameter group: Resource Id Arguments
--connector-name --name -n

Confluent connector name.

Property Value
Parameter group: Resource Id Arguments
--environment-id

Confluent environment id.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--organization-name

Organization resource name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

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

Property Value
Default value: False

az confluent organization environment cluster connector update

Update confluent connector by Name.

az confluent organization environment cluster connector update [--acquire-policy-token]
                                                               [--add]
                                                               [--change-reference]
                                                               [--cluster-id]
                                                               [--connector-basic-info]
                                                               [--connector-name --name]
                                                               [--connector-service-type-info]
                                                               [--environment-id]
                                                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                               [--ids]
                                                               [--organization-name]
                                                               [--partner-connector-info]
                                                               [--remove]
                                                               [--resource-group]
                                                               [--set]
                                                               [--subscription]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-id

Confluent kafka or schema registry cluster id.

Property Value
Parameter group: Resource Id Arguments
--connector-basic-info

Connector Info Base Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--connector-name --name -n

Confluent connector name.

Property Value
Parameter group: Resource Id Arguments
--connector-service-type-info

Connector Service type info base properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--environment-id

Confluent environment id.

Property Value
Parameter group: Resource Id Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--organization-name

Organization resource name.

Property Value
Parameter group: Resource Id Arguments
--partner-connector-info

The connection information consumed by applications. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

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

Property Value
Default value: False