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.
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 |
Create Organization resource.
az confluent organization create --name
--plan-id
--plan-name
--resource-group
--term-unit
[--location]
[--no-wait]
[--offer-id]
[--publisher-id]
[--tags]
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"
Organization resource name.
Offer Plan Id.
Offer Plan Name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Offer Plan Term unit.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the long-running operation to finish.
Offer Id.
Publisher Id.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Organization role bindings.
az confluent organization create-role-binding [--crn-pattern]
[--ids]
[--organization-name]
[--principal]
[--resource-group]
[--role-name]
[--subscription]
A CRN that specifies the scope and resource patterns necessary for the role to bind.
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 resource name.
The principal User or Group to bind the role to.
Resource group name.
The name of the role to bind to the principal.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Invite user to the organization.
az confluent organization create-user [--auth-type]
[--email]
[--ids]
[--invited-email]
[--organization-id]
[--organization-name]
[--resource-group]
[--subscription]
[--upn]
Auth type of the user.
Email of the logged in user.
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.
UPN/Email of the user who is being invited.
Id of the organization.
Organization resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Upn of the logged in user.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Delete Organization resource.
az confluent organization delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--yes]
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}"
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 resource name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List all Organizations under the specified resource group. And List all organizations under the specified subscription.
az confluent organization list [--resource-group]
Organization_ListByResourceGroup
az confluent organization list --resource-group "myResourceGroup"
Organization_ListBySubscription
az confluent organization list
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Organization role bindings.
az confluent organization list-role-binding [--ids]
[--organization-name]
[--resource-group]
[--search-filters]
[--subscription]
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 resource name.
Resource group name.
Search filters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Organization service accounts details.
az confluent organization list-service-accounts [--ids]
[--organization-name]
[--resource-group]
[--search-filters]
[--subscription]
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 resource name.
Resource group name.
Search filters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Organization users details.
az confluent organization list-users [--ids]
[--organization-name]
[--resource-group]
[--search-filters]
[--subscription]
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 resource name.
Resource group name.
Search filters for the request Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Get the properties of a specific Organization resource.
az confluent organization show [--ids]
[--name]
[--resource-group]
[--subscription]
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}"
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 resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Update Organization resource.
az confluent organization update [--ids]
[--name]
[--resource-group]
[--subscription]
[--tags]
Confluent_Update
az confluent organization update --tags client="dev-client" env="dev" --name "myOrganization" --resource-group "myResourceGroup"
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 resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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]
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
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Organization resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: