Share via

az providerhub operation

  • 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 operation command. Learn more about extensions.

Manage operation with providerhub.

Commands

Name Description Type Status
az providerhub operation create

Create the operation supported by the given provider.

 Extension GA
az providerhub operation delete

Delete an operation.

 Extension GA
az providerhub operation list

List the operations supported by the given provider.

 Extension GA
az providerhub operation update

Update the operation supported by the given provider.

 Extension GA

az providerhub operation create

Create the operation supported by the given provider.

az providerhub operation create --provider-namespace
                                [--contents]

Examples

operation create

az providerhub operation create --contents "[{{\"name\":\"Private.VPTest/Employees/Read\",\"display\":{{\"default\":{{\"description\":\"Read employees\",\"operation\":\"Gets/List employee resources\",\"provider\":\"Private.VPTest\",\"resource\":\"Employees\"}}}}}}]" --provider-namespace "{providerNamespace}"

Required Parameters

--provider-namespace

The name of the resource provider hosted within ProviderHub.

Optional Parameters

--contents

Operations content. 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 operation delete

Delete an operation.

az providerhub operation delete [--ids]
                                [--provider-namespace]
                                [--subscription]
                                [--yes]

Examples

operation delete

az providerhub operation delete -y --provider-namespace "{providerNamespace}"

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.

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

List the operations supported by the given provider.

az providerhub operation list --provider-namespace

Examples

operation list

az providerhub operation list --provider-namespace "{providerNamespace}"

Required Parameters

--provider-namespace

The name of the resource provider hosted within ProviderHub.

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

Update the operation supported by the given provider.

az providerhub operation update [--add]
                                [--contents]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--provider-namespace]
                                [--remove]
                                [--set]
                                [--subscription]

Examples

operation update

az providerhub operation update --contents "[{{\"name\":\"Private.VPTest/Employees/Read\",\"display\":{{\"default\":{{\"description\":\"Read employees\",\"operation\":\"Gets/List employee resources\",\"provider\":\"Private.VPTest\",\"resource\":\"Employees\"}}}}}}]" --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>.

--contents

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

--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 OR --remove propertyToRemove.

--set

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

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