az confluent organization

Note

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

Commands to perform actions on a confluent organization.

Commands

Name	Description	Type	Status
az confluent organization api-key	Manage cluster api key.	Extension	GA
az confluent organization api-key delete	Delete API key of a kafka or schema registry cluster.	Extension	GA
az confluent organization create	Create Organization resource.	Extension	GA
az confluent organization create-role-binding	Organization role bindings.	Extension	GA
az confluent organization create-user	Invite user to the 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	Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment.	Extension	GA
az confluent organization environment cluster list	List of all the clusters in a environment.	Extension	GA
az confluent organization environment cluster show	Get cluster by Id.	Extension	GA
az confluent organization environment list	List of all the environments in a organization.	Extension	GA
az confluent organization environment schema-registry-cluster	Commands to get the schema registry cluster details in a environment.	Extension	GA
az confluent organization environment schema-registry-cluster list	List schema registry clusters.	Extension	GA
az confluent organization environment schema-registry-cluster show	Get schema registry cluster by Id.	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-role-binding	Organization role bindings.	Extension	GA
az confluent organization list-service-accounts	Organization service accounts details.	Extension	GA
az confluent organization list-users	Organization users details.	Extension	GA
az confluent organization role-binding	Manage Role binding.	Extension	GA
az confluent organization role-binding delete	Delete role bindings.	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
                                 --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.

--plan-name

Offer Plan Name.

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

Optional Parameters

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

Default value: False

--offer-id

Offer Id.

Default value: confluent-cloud-azure-prod

--publisher-id

Publisher Id.

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az confluent organization create-role-binding

Organization role bindings.

az confluent organization create-role-binding [--crn-pattern]
                                              [--ids]
                                              [--organization-name]
                                              [--principal]
                                              [--resource-group]
                                              [--role-name]
                                              [--subscription]

Optional Parameters

--crn-pattern

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

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

--organization-name

Organization resource name.

--principal

The principal User or Group to bind the role to.

--resource-group

Resource group name.

--role-name

The name of the role to bind to the principal.

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az confluent organization create-user

Invite user to the organization.

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

Optional Parameters

--auth-type

Auth type of the user.

--email

Email of the logged in user.

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

--invited-email

UPN/Email of the user who is being invited.

--organization-id

Id of the organization.

--organization-name

Organization resource name.

--resource-group -g

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

--subscription

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

--upn

Upn of the logged in user.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az confluent organization delete

Delete Organization resource.

az confluent organization delete [--ids]
                                 [--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

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

--name --organization-name -n

Organization resource name.

--no-wait

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

Default value: False

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

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

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az confluent organization list-role-binding

Organization role bindings.

az confluent organization list-role-binding [--ids]
                                            [--organization-name]
                                            [--resource-group]
                                            [--search-filters]
                                            [--subscription]

Optional Parameters

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

--organization-name

Organization resource name.

--resource-group

Resource group name.

--search-filters

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az confluent organization list-service-accounts

Organization service accounts details.

az confluent organization list-service-accounts [--ids]
                                                [--organization-name]
                                                [--resource-group]
                                                [--search-filters]
                                                [--subscription]

Optional Parameters

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

--organization-name

Organization resource name.

--resource-group

Resource group name.

--search-filters

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az confluent organization list-users

Organization users details.

az confluent organization list-users [--ids]
                                     [--organization-name]
                                     [--resource-group]
                                     [--search-filters]
                                     [--subscription]

Optional Parameters

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

--organization-name

Organization resource name.

--resource-group

Resource group name.

--search-filters

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az confluent organization show

Get the properties of a specific Organization resource.

az confluent organization show [--ids]
                               [--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

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

--name --organization-name -n

Organization resource name.

--resource-group -g

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az confluent organization update

Update Organization resource.

az confluent organization update [--ids]
                                 [--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

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

--name --organization-name -n

Organization resource name.

--resource-group -g

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

--subscription

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

--tags

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

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]
                               [--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

--created

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

Default value: False

--custom

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

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30

--name --organization-name -n

Organization resource name.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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