Dijeli putem

az custom-providers resource-provider

  • Experimental
  • Reference

Note

This reference is part of the custom-providers extension for the Azure CLI (version 2.3.1 or higher). The extension will automatically install the first time you run an az custom-providers resource-provider command. Learn more about extensions.

This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage custom resource provider.

Commands

Name Description Type Status
az custom-providers resource-provider create

Create or update the custom resource provider.

 Extension Experimental
az custom-providers resource-provider delete

Delete the custom resource provider.

 Extension Experimental
az custom-providers resource-provider list

Get all the custom resource providers within a resource group or in the current subscription.

 Extension Experimental
az custom-providers resource-provider show

Get the properties for the custom resource provider.

 Extension Experimental
az custom-providers resource-provider update

Update the custom resource provider. Only tags can be updated.

 Extension Experimental

az custom-providers resource-provider create

Experimental

Command group 'custom-providers resource-provider' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create or update the custom resource provider.

az custom-providers resource-provider create --name
                                             --resource-group
                                             [--action]
                                             [--location]
                                             [--no-wait]
                                             [--resource-type]
                                             [--tags]
                                             [--validation]

Examples

Create or update a custom resource provider.

az custom-providers resource-provider create -n MyRP -g MyRG \
--action name=ping endpoint=https://test.azurewebsites.net/api routing_type=Proxy \
--resource-type name=users endpoint=https://test.azurewebsites.net/api routing_type="Proxy, Cache" \
--validation validation_type=swagger specification=https://raw.githubusercontent.com/test.json

Required Parameters

--name -n

The name of the resource provider.

--resource-group -g

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

Optional Parameters

--action -a

Add an action to the custom resource provider.

Usage: --action name=ping endpoint="https://test.azurewebsites.net/api/{requestPath}" routing_type=Proxy

name: Required. The name of the action. endpoint: Required. The endpoint URI that the custom resource provider will proxy requests to. routing_type: The routing types that are supported for action requests. Possible values include: 'Proxy'.

Multiple actions can be specified by using more than one --action argument.

--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
--resource-type -r

Add a custom resource type to the custom resource provider.

Usage: --resource-type name=user endpoint="https://test.azurewebsites.net/api/{requestPath}" routing_type="Proxy, Cache"

name: Required. The name of the resource type. endpoint: Required. The endpoint URI that the custom resource provider will proxy requests to. routing_type: The routing types that are supported for resource requests. Possible values include: 'Proxy', 'Proxy,Cache'.

Multiple resource types can be specified by using more than one --resource-type argument.

--tags

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

--validation -v

Add a validation to the custom resource provider.

Usage: --validation specification="https://raw.githubusercontent.com/" validation_type="Swagger"

specification: A link to the validation specification.vThe specification must be hosted on raw.githubusercontent.com. validation_type: The type of validation to run against a matching request. Possible values include: 'Swagger'.

Multiple validations can be specified by using more than one --validation argument.

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 custom-providers resource-provider delete

Experimental

Command group 'custom-providers resource-provider' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the custom resource provider.

az custom-providers resource-provider delete --name
                                             --resource-group
                                             [--no-wait]
                                             [--yes]

Examples

Delete a custom resource provider.

az custom-providers resource-provider delete -g MyRG -n MyRP

Required Parameters

--name -n

The name of the resource provider.

--resource-group -g

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

Optional Parameters

--no-wait

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

Default value: False
--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 custom-providers resource-provider list

Experimental

Command group 'custom-providers resource-provider' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get all the custom resource providers within a resource group or in the current subscription.

az custom-providers resource-provider list [--resource-group]

Examples

List all custom resource providers in the resource group.

az custom-providers resource-provider list -g MyRG

List all custom resource providers in the current subscription.

az custom-providers resource-provider 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 custom-providers resource-provider show

Experimental

Command group 'custom-providers resource-provider' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the properties for the custom resource provider.

az custom-providers resource-provider show --name
                                           --resource-group

Examples

Get a custom resource provider.

az custom-providers resource-provider show -g MyRG -n MyRP

Required Parameters

--name -n

The name of the resource provider.

--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 custom-providers resource-provider update

Experimental

Command group 'custom-providers resource-provider' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the custom resource provider. Only tags can be updated.

az custom-providers resource-provider update --name
                                             --resource-group
                                             [--tags]

Examples

Update the tags for a custom resource provider.

az custom-providers resource-provider update -g MyRG -n MyRP --tags a=b

Required Parameters

--name -n

The name of the resource provider.

--resource-group -g

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

Optional Parameters

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