Share via


az confluent organization

Note

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

Perform administrative operations on Confluent organization entities via Azure.

Commands

Name Description Type Status
az confluent organization access

Manage Access for List Cluster, Environment, Invitation, Role Binding Names with in the Confluent organization.

Extension GA
az confluent organization access default

Manage Default.

Extension GA
az confluent organization access default list-cluster

List all Confluent cluster within an environment in an organization.

Extension GA
az confluent organization access default list-environment

List all Confluent environment in an organization.

Extension GA
az confluent organization access default list-invitation

List all Confluent invitation in an organization.

Extension GA
az confluent organization access default list-role-binding-name-list

List all Confluent role bindings names in an organization.

Extension GA
az confluent organization api-key

Manage API keys for Kafka or Schema Registry clusters in Confluent.

Extension GA
az confluent organization api-key delete

Remove an API key from a Kafka or Schema Registry cluster in Confluent.

Extension GA
az confluent organization api-key show

Show a API key from a Kafka or Schema Registry cluster in Confluent.

Extension GA
az confluent organization create

Create Organization resource.

Extension GA
az confluent organization create-role-binding

Assign roles to users or groups within a Confluent organization.

Extension GA
az confluent organization create-user

Invite a new user to join the Confluent organization.

Extension GA
az confluent organization delete

Delete Organization resource.

Extension GA
az confluent organization environment

Commands to get the confluent environments in the organization.

Extension GA
az confluent organization environment cluster

Command to get the confluent cluster details in a environment.

Extension GA
az confluent organization environment cluster create-api-key

Create API keys for Schema Registry or Kafka clusters within an environment.

Extension GA
az confluent organization environment cluster list

List all clusters within a specific Confluent environment.

Extension GA
az confluent organization environment cluster show

Retrieve details of a specific Confluent cluster by its ID.

Extension GA
az confluent organization environment list

List all Confluent environments within a specific organization.

Extension GA
az confluent organization environment schema-registry-cluster

Retrieve details of Schema Registry clusters within a Confluent environment.

Extension GA
az confluent organization environment schema-registry-cluster list

List all Schema Registry clusters within a Confluent environment.

Extension GA
az confluent organization environment schema-registry-cluster show

Retrieve details of a specific Schema Registry cluster by its ID.

Extension GA
az confluent organization environment show

Display details of a specific Confluent environment within an organization.

Extension GA
az confluent organization list

List all Organizations under the specified resource group. And List all organizations under the specified subscription.

Extension GA
az confluent organization list-region

List all the supported regions within a Confluent organization.

Extension GA
az confluent organization list-role-binding

List all the role bindings within a Confluent organization.

Extension GA
az confluent organization list-service-accounts

List all the details of service accounts within a Confluent organization.

Extension GA
az confluent organization list-users

List all the details of users within a Confluent organization.

Extension GA
az confluent organization role-binding

Manage role bindings within a Confluent organization.

Extension GA
az confluent organization role-binding delete

Delete role bindings within a Confluent organization.

Extension GA
az confluent organization show

Get the properties of a specific Organization resource.

Extension GA
az confluent organization update

Update Organization resource.

Extension GA
az confluent organization wait

Place the CLI in a waiting state until a condition of the confluent organization is met.

Extension GA

az confluent organization create

Create Organization resource.

az confluent organization create --name --organization-name
                                 --plan-id
                                 --plan-name
                                 --resource-group
                                 --term-unit
                                 [--location]
                                 [--no-wait]
                                 [--offer-id]
                                 [--publisher-id]
                                 [--tags]

Examples

Create organization

az confluent organization create --location "West US" --tags Environment="Dev" --name "myOrganization" --resource-group "myResourceGroup" --offer-id "confluent-cloud-azure-prod" --plan-id "confluent-cloud-azure-payg-prod" --plan-name "Confluent Cloud - Pay as you Go" --publisher-id "confluentinc" --term-unit "P1M"

Required Parameters

--name --organization-name -n

Organization resource name.

--plan-id

Offer Plan Id.

Property Value
Parameter group: Offer Detail Arguments
--plan-name

Offer Plan Name.

Property Value
Parameter group: Offer Detail Arguments
--resource-group -g

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

--term-unit

Offer Plan Term unit.

Property Value
Parameter group: Offer Detail Arguments

Optional Parameters

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Property Value
Default value: False
--offer-id

Offer Id.

Property Value
Parameter group: Offer Detail Arguments
Default value: confluent-cloud-azure-prod
--publisher-id

Publisher Id.

Property Value
Parameter group: Offer Detail Arguments
Default value: confluentinc
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 create-role-binding

Assign roles to users or groups within a Confluent organization.

az confluent organization create-role-binding [--crn-pattern]
                                              [--ids]
                                              [--organization-name]
                                              [--principal]
                                              [--resource-group]
                                              [--role-name]
                                              [--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.

--crn-pattern

A CRN that specifies the scope and resource patterns necessary for the role to bind.

Property Value
Parameter group: Body 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
--principal

The principal User or Group to bind the role to.

Property Value
Parameter group: Body 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
--role-name

The name of the role to bind to the principal.

Property Value
Parameter group: Body 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 create-user

Invite a new user to join the Confluent organization.

az confluent organization create-user [--auth-type]
                                      [--email]
                                      [--ids]
                                      [--invited-email]
                                      [--organization-id]
                                      [--organization-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--upn]

Optional Parameters

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

--auth-type

Auth type of the user.

Property Value
Parameter group: InvitedUserDetails Arguments
--email

Email of the logged in user.

Property Value
Parameter group: Body 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
--invited-email

UPN/Email of the user who is being invited.

Property Value
Parameter group: InvitedUserDetails Arguments
--organization-id

Id of the organization.

Property Value
Parameter group: Body 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
--upn

Upn of the logged in user.

Property Value
Parameter group: Body 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 delete

Delete Organization resource.

az confluent organization delete [--ids]
                                 [--name --organization-name]
                                 [--no-wait]
                                 [--resource-group]
                                 [--subscription]
                                 [--yes]

Examples

Delete organization

az confluent organization delete --name "myOrganization" --resource-group "myResourceGroup"

Delete organization using IDs

az confluent organization delete --ids "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Confluent/organizations/{myOrganization}"

Optional Parameters

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

--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
--name --organization-name -n

Organization resource name.

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

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

Property Value
Default value: False
--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.

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 list

List all Organizations under the specified resource group. And List all organizations under the specified subscription.

az confluent organization list [--resource-group]

Examples

Organization_ListByResourceGroup

az confluent organization list --resource-group "myResourceGroup"

Organization_ListBySubscription

az confluent organization list

Optional Parameters

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

--resource-group -g

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

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 list-region

List all the supported regions within a Confluent organization.

az confluent organization list-region [--ids]
                                      [--organization-name]
                                      [--resource-group]
                                      [--search-filters]
                                      [--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.

--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
--search-filters

Search filters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body 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 list-role-binding

List all the role bindings within a Confluent organization.

az confluent organization list-role-binding [--ids]
                                            [--organization-name]
                                            [--resource-group]
                                            [--search-filters]
                                            [--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.

--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
--search-filters

Search filters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body 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 list-service-accounts

List all the details of service accounts within a Confluent organization.

az confluent organization list-service-accounts [--ids]
                                                [--organization-name]
                                                [--resource-group]
                                                [--search-filters]
                                                [--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.

--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
--search-filters

Search filters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body 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 list-users

List all the details of users within a Confluent organization.

az confluent organization list-users [--ids]
                                     [--organization-name]
                                     [--resource-group]
                                     [--search-filters]
                                     [--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.

--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
--search-filters

Search filters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body 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 show

Get the properties of a specific Organization resource.

az confluent organization show [--ids]
                               [--name --organization-name]
                               [--resource-group]
                               [--subscription]

Examples

Show organization

az confluent organization show --name "myOrganization" --resource-group "myResourceGroup"

Show organization using IDs

az confluent organization show --ids "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Confluent/organizations/{myOrganization}"

Optional Parameters

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

--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
--name --organization-name -n

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 update

Update Organization resource.

az confluent organization update [--ids]
                                 [--name --organization-name]
                                 [--resource-group]
                                 [--subscription]
                                 [--tags]

Examples

Confluent_Update

az confluent organization update --tags client="dev-client" env="dev" --name "myOrganization" --resource-group "myResourceGroup"

Optional Parameters

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

--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
--name --organization-name -n

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
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 wait

Place the CLI in a waiting state until a condition of the confluent organization is met.

az confluent organization wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name --organization-name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]

Examples

Pause executing next line of CLI script until the confluent organization is successfully created.

az confluent organization wait --name "myOrganization" --resource-group "myResourceGroup" --created

Pause executing next line of CLI script until the confluent organization is successfully deleted.

az confluent organization wait --name "myOrganization" --resource-group "myResourceGroup" --deleted

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--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
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --organization-name -n

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
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
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