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 wait

Place the CLI in a waiting state until a condition of an apim named value is met.

az apim nv create

Create an API Management Named Value.

az apim nv create --display-name
                  --named-value-id
                  --resource-group
                  --service-name
                  [--if-match]
                  [--no-wait]
                  [--secret {false, true}]
                  [--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

--if-match

ETag of the Entity.

--no-wait

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

default value: False
--secret

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

accepted values: false, true
default value: False
--tags

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

--value

The value of the Named Value.

az apim nv delete

Delete an API Management Named Value.

az apim nv delete --named-value-id
                  --resource-group
                  --service-name
                  [--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

--yes -y

Do not prompt for confirmation.

default value: False

az apim nv list

List API Management Named Values.

az apim nv list --resource-group
                --service-name

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.

az apim nv show

Show details of an API Management Named Value.

az apim nv show --named-value-id
                --resource-group
                --service-name

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.

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

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.

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

default value: []
--force-string

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

default value: False
--if-match

ETag of the Entity.

--remove

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

default value: []
--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=.

default value: []
--tags

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

--value

The value of the Named Value.

az apim nv wait

Place the CLI in a waiting state until a condition of an apim named value is met.

az apim nv wait --named-value-id
                --resource-group
                --service-name
                [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--interval]
                [--timeout]
                [--updated]

Examples

Place the CLI in a waiting state until a condition of a apim api is met.

az apim nv wait --created --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --resource-group MyResourceGroup

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

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

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False