az apim nv

Hantera namngivna värden för Azure API Management.

Kommandon

Name	Description	Typ	Status
az apim nv create	Skapa ett API Management-namngivet värde.	Kärna	Allmän tillgänglighet
az apim nv delete	Ta bort ett API Management-namngivet värde.	Kärna	Allmän tillgänglighet
az apim nv list	Lista API Management-namngivna värden.	Kärna	Allmän tillgänglighet
az apim nv show	Visa information om ett API Management-namngivet värde.	Kärna	Allmän tillgänglighet
az apim nv show-secret	Hämtar hemligheten för ett API Management-namngivet värde.	Kärna	Allmän tillgänglighet
az apim nv update	Uppdatera ett API Management-namngivet värde.	Kärna	Allmän tillgänglighet
az apim nv wait	Placera CLI i vänteläge tills ett villkor för ett apim-namngivet värde uppfylls.	Kärna	Allmän tillgänglighet

az apim nv create

Skapa ett API Management-namngivet värde.

Azure CLI

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

Exempel

Skapa ett namngivet värde.

Azure CLI

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

Obligatoriska parametrar

--display-name

Visningsnamnet för det namngivna värdet.

--named-value-id

Unikt namn för det namngivna värde som ska skapas.

Måste vara unikt i den aktuella API Management-tjänstinstansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

--if-match

ETag för entiteten.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Standardvärde: False

--secret

Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är "falsk".

Godkända värden: false, true

Standardvärde: False

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--value

Värdet för det namngivna värdet.

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim nv delete

Ta bort ett API Management-namngivet värde.

Azure CLI

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

Obligatoriska parametrar

--named-value-id

Identifierare för NamedValue.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

--yes -y

Fråga inte efter bekräftelse.

Standardvärde: False

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim nv list

Lista API Management-namngivna värden.

Azure CLI

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

Obligatoriska parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim nv show

Visa information om ett API Management-namngivet värde.

Azure CLI

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

Obligatoriska parametrar

--named-value-id

Identifierare för NamedValue.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim nv show-secret

Hämtar hemligheten för ett API Management-namngivet värde.

Azure CLI

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

Obligatoriska parametrar

--named-value-id

Identifierare för NamedValue.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim nv update

Uppdatera ett API Management-namngivet värde.

Azure CLI

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

Exempel

Skapa ett grundläggande API.

Azure CLI

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

Obligatoriska parametrar

--named-value-id

Unikt namn på api:et som ska skapas.

Måste vara unikt i den aktuella API Management-tjänstinstansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

Standardvärde: []

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Standardvärde: False

--if-match

ETag för entiteten.

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

Standardvärde: []

--secret

Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är "falsk".

Godkända värden: false, true

--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

Standardvärde: []

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--value

Värdet för det namngivna värdet.

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim nv wait

Placera CLI i vänteläge tills ett villkor för ett apim-namngivet värde uppfylls.

Azure CLI

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

Exempel

Placera CLI i väntetillstånd tills ett villkor för ett apim-api uppfylls.

Azure CLI

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

Obligatoriska parametrar

--named-value-id

Identifierare för NamedValue.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

Standardvärde: False

--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Vänta tills den har tagits bort.

Standardvärde: False

--exists

Vänta tills resursen finns.

Standardvärde: False

--interval

Avsökningsintervall i sekunder.

Standardvärde: 30

--timeout

Maximal väntetid i sekunder.

Standardvärde: 3600

--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

Standardvärde: False

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc

Standardvärde: json

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.