az apim nv
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
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
The Display name of the Named Value.
Unique name for the Named Value to be created.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the API Management service instance.
Optional Parameters
Determines whether the value is a secret and should be encrypted or not. Default value is false.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The value of the Named Value.
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.
Increase logging verbosity. Use --debug for full debug logs.
az apim nv delete
Delete an API Management Named Value.
az apim nv delete --named-value-id
--resource-group
--service-name
[--subscription]
[--yes]Required Parameters
Identifier of the NamedValue.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the API Management service instance.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
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.
Increase logging verbosity. Use --debug for full debug logs.
az apim nv list
List API Management Named Values.
az apim nv list --resource-group
--service-name
[--query-examples]
[--subscription]Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the API Management service instance.
Optional Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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.
Increase logging verbosity. Use --debug for full debug logs.
az apim nv show
Show details of an API Management Named Value.
az apim nv show --named-value-id
--resource-group
--service-name
[--query-examples]
[--subscription]Required Parameters
Identifier of the NamedValue.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the API Management service instance.
Optional Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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.
Increase logging verbosity. Use --debug for full debug logs.
az apim nv show-secret
Gets the secret of an API Management Named Value.
az apim nv show-secret --named-value-id
--resource-group
--service-name
[--subscription]Required Parameters
Identifier of the NamedValue.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the API Management service instance.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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.
Increase logging verbosity. Use --debug for full debug logs.
az apim nv update
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 fooRequired Parameters
Unique name of the api to be created.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the API Management service instance.
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>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
ETag of the Entity. Not required when creating an entity, but required when updating an entity.
Remove a property or an element from a list. Example: --remove property.list
Determines whether the value is a secret and should be encrypted or not. Default value is false.
Update an object by specifying a property path and value to set. Example: --set property1.property2=
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The value of the Named Value.
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.
Increase logging verbosity. Use --debug for full debug logs.