az apim nv

Reference

Manage Azure API Management Named Values.

Commands

az apim nv create	Create an API Management Named Value.
az apim nv delete	Delete an API Management Named Value.
az apim nv list	List API Management Named Values.
az apim nv show	Show details of an API Management Named Value.
az apim nv show-secret	Gets the secret of an API Management Named Value.
az apim nv update	Update an API Management Named Value.

az apim nv create

Edit

Create an API Management Named Value.

az apim nv create --display-name
                  --named-value-id
                  --resource-group
                  --service-name
                  [--secret {false, true}]
                  [--subscription]
                  [--tags]
                  [--value]

Examples

Create a Named Value.

az apim nv create --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --display-name 'My Named Value' --value 'foo'

Required Parameters

--display-name

The Display name of the Named Value.

--named-value-id

Unique name for the Named Value to be created.

--resource-group -g

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

--service-name -n

The name of the API Management service instance.

Optional Parameters

--secret

Determines whether the value is a secret and should be encrypted or not. Default value is false.

accepted values: false, true

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

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

--value

The value of the Named Value.

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.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az apim nv delete

Edit

Delete an API Management Named Value.

az apim nv delete --named-value-id
                  --resource-group
                  --service-name
                  [--subscription]
                  [--yes]

Required Parameters

--named-value-id

Identifier of the NamedValue.

--resource-group -g

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

--service-name -n

The name of the API Management service instance.

Optional Parameters

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

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.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az apim nv list

Edit

List API Management Named Values.

az apim nv list --resource-group
                --service-name
                [--query-examples]
                [--subscription]

Required Parameters

--resource-group -g

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

--service-name -n

The name of the API Management service instance.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az apim nv show

Edit

Show details of an API Management Named Value.

az apim nv show --named-value-id
                --resource-group
                --service-name
                [--query-examples]
                [--subscription]

Required Parameters

--named-value-id

Identifier of the NamedValue.

--resource-group -g

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

--service-name -n

The name of the API Management service instance.

Optional Parameters

--query-examples

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

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az apim nv show-secret

Edit

Gets the secret of an API Management Named Value.

az apim nv show-secret --named-value-id
                       --resource-group
                       --service-name
                       [--subscription]

Required Parameters

--named-value-id

Identifier of the NamedValue.

--resource-group -g

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

--service-name -n

The name of the API Management service instance.

Optional Parameters

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

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az apim nv update

Edit

Update an API Management Named Value.

az apim nv update --named-value-id
                  --resource-group
                  --service-name
                  [--add]
                  [--force-string]
                  [--if-match]
                  [--remove]
                  [--secret {false, true}]
                  [--set]
                  [--subscription]
                  [--tags]
                  [--value]

Examples

Create a basic API.

az apim nv update --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --value foo

Required Parameters

--named-value-id

Unique name of the api to be created.

--resource-group -g

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

--service-name -n

The name of the API Management service instance.

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

--force-string

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

--if-match

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

--remove

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

--secret

Determines whether the value is a secret and should be encrypted or not. Default value is false.

accepted values: false, true

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

--tags

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

--value

The value of the Named Value.

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.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az apim nv

Please rate your experience

Commands

az apim nv create

Examples

Required Parameters

Optional Parameters

az apim nv delete

Required Parameters

Optional Parameters

az apim nv list

Required Parameters

Optional Parameters

az apim nv show

Required Parameters

Optional Parameters

az apim nv show-secret

Required Parameters

Optional Parameters

az apim nv update

Examples

Required Parameters

Optional Parameters