az providerhub authorized-application
Note
This reference is part of the providerhub extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az providerhub authorized-application command. Learn more about extensions.
Manage authorized application with providerhub.
Commands
Name | Description | Type | Status |
---|---|---|---|
az providerhub authorized-application create |
Create the authorized application. |
Extension | GA |
az providerhub authorized-application delete |
Delete an authorized application. |
Extension | GA |
az providerhub authorized-application list |
List the list of the authorized applications in the provider namespace. |
Extension | GA |
az providerhub authorized-application show |
Get the authorized application details. |
Extension | GA |
az providerhub authorized-application update |
Update the authorized application. |
Extension | GA |
az providerhub authorized-application wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az providerhub authorized-application create
Create the authorized application.
az providerhub authorized-application create --application-id
--provider-namespace
[--data-authorizations]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--provider-authorization]
Examples
authorized-application create
az providerhub authorized-application create -n "8b51e6a7-7814-42bd-aa17-3fb1837b3b7a" --data-authorizations "[{{role:ServiceOwner}}]" --provider-namespace "{providerNamespace}"
Required Parameters
The application ID.
The name of the resource provider hosted within ProviderHub.
Optional Parameters
The authorizations that determine the level of data access permissions on the specified resource types. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
The resource provider authorization. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
az providerhub authorized-application delete
Delete an authorized application.
az providerhub authorized-application delete [--application-id]
[--ids]
[--provider-namespace]
[--subscription]
[--yes]
Examples
authorized-application delete
az providerhub authorized-application delete -y -n "8b51e6a7-7814-42bd-aa17-3fb1837b3b7a" --provider-namespace "{providerNamespace}"
Optional Parameters
The application ID.
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.
The name of the resource provider hosted within ProviderHub.
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.
az providerhub authorized-application list
List the list of the authorized applications in the provider namespace.
az providerhub authorized-application list --provider-namespace
[--max-items]
[--next-token]
Examples
authorized-application list
az providerhub authorized-application list --provider-namespace "{providerNamespace}"
Required Parameters
The name of the resource provider hosted within ProviderHub.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
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.
az providerhub authorized-application show
Get the authorized application details.
az providerhub authorized-application show [--application-id]
[--ids]
[--provider-namespace]
[--subscription]
Examples
authorized-application show
az providerhub authorized-application show -n "8b51e6a7-7814-42bd-aa17-3fb1837b3b7a" --provider-namespace "{providerNamespace}"
Optional Parameters
The application ID.
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.
The name of the resource provider hosted within ProviderHub.
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.
az providerhub authorized-application update
Update the authorized application.
az providerhub authorized-application update [--add]
[--application-id]
[--data-authorizations]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--provider-authorization]
[--provider-namespace]
[--remove]
[--set]
[--subscription]
Examples
authorized-application update
az providerhub authorized-application update -n "8b51e6a7-7814-42bd-aa17-3fb1837b3b7a" --data-authorizations "[{{role:ServiceOwner}}]" --provider-namespace "{providerNamespace}"
Optional Parameters
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>
.
The application ID.
The authorizations that determine the level of data access permissions on the specified resource types. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Do not wait for the long-running operation to finish.
The resource provider authorization. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the resource provider hosted within ProviderHub.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
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.
az providerhub authorized-application wait
Place the CLI in a waiting state until a condition is met.
az providerhub authorized-application wait [--application-id]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--provider-namespace]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The application ID.
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.
The name of the resource provider hosted within ProviderHub.
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.