Share via

az providerhub authorized-application

  • Reference

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

--application-id --name -n

The application ID.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

Optional Parameters

--data-authorizations

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.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--provider-authorization

The resource provider authorization. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--application-id --name -n

The application ID.

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

--provider-namespace

The name of the resource provider hosted within ProviderHub.

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

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.

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

--provider-namespace

The name of the resource provider hosted within ProviderHub.

Optional Parameters

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

--next-token

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

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

--application-id --name -n

The application ID.

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

--provider-namespace

The name of the resource provider hosted within ProviderHub.

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

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

--application-id --name -n

The application ID.

--data-authorizations

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.

--force-string

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

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.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--provider-authorization

The resource provider authorization. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

--remove

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

--set

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

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

--application-id --name -n

The application ID.

--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
--provider-namespace

The name of the resource provider hosted within ProviderHub.

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