az apim nv

Azure API Management elnevezett értékek kezelése.

Parancsok

Name	Description	Típus	Állapot
az apim nv create	Hozzon létre egy API Management Named Value értéket.	Core	GA
az apim nv delete	Törölje a névvel ellátott API Management-értéket.	Core	GA
az apim nv list	Az API Management névvel ellátott értékeinek listázása.	Core	GA
az apim nv show	Az API Management named Value részleteinek megjelenítése.	Core	GA
az apim nv show-secret	Lekéri az API Management named Value titkos kódját.	Core	GA
az apim nv update	Api Management named Value frissítése.	Core	GA
az apim nv wait	Helyezze a parancssori felületet várakozási állapotba, amíg egy apim által elnevezett érték feltételének nem teljesül.	Core	GA

az apim nv create

Hozzon létre egy API Management Named Value értéket.

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

Példák

Névvel ellátott érték létrehozása.

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

Kötelező paraméterek

--display-name

Az elnevezett érték megjelenítendő neve.

--named-value-id

A létrehozandó elnevezett érték egyedi neve.

Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--if-match

Az entitás ETagje.

--no-wait

Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.

Tulajdonság	Érték
Alapértelmezett érték:	False

--secret

Meghatározza, hogy az érték titkos-e, és titkosítva kell-e lennie. Az alapértelmezett érték hamis.

Tulajdonság	Érték
Alapértelmezett érték:	False
Elfogadott értékek:	false, true

--tags

Szóközzel elválasztott címkék: key[=value] [key[=value] ...]. Meglévő címkék törlése a "" használatával.

--value

Az elnevezett érték értéke.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

Tulajdonság	Érték
Alapértelmezett érték:	False

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim nv delete

Törölje a névvel ellátott API Management-értéket.

az apim nv delete --named-value-id
                  --resource-group
                  --service-name
                  [--acquire-policy-token]
                  [--change-reference]
                  [--yes]

Kötelező paraméterek

--named-value-id

A NamedValue azonosítója.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--yes -y

Ne kérje a megerősítést.

Tulajdonság	Érték
Alapértelmezett érték:	False

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

Tulajdonság	Érték
Alapértelmezett érték:	False

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim nv list

Az API Management névvel ellátott értékeinek listázása.

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

Kötelező paraméterek

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

Az API Management szolgáltatáspéldány neve.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

Tulajdonság	Érték
Alapértelmezett érték:	False

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim nv show

Az API Management named Value részleteinek megjelenítése.

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

Kötelező paraméterek

--named-value-id

A NamedValue azonosítója.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

Az API Management szolgáltatáspéldány neve.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

Tulajdonság	Érték
Alapértelmezett érték:	False

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim nv show-secret

Lekéri az API Management named Value titkos kódját.

az apim nv show-secret --named-value-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--change-reference]

Kötelező paraméterek

--named-value-id

A NamedValue azonosítója.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

Tulajdonság	Érték
Alapértelmezett érték:	False

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim nv update

Api Management named Value frissítése.

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

Példák

Hozzon létre egy alapszintű API-t.

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

Kötelező paraméterek

--named-value-id

A létrehozandó api egyedi neve.

Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--add

Adjon hozzá egy objektumot az objektumok listájához egy elérési út és egy kulcsértékpár megadásával. Példa: --add property.listProperty <key=value, string or JSON string>.

Tulajdonság	Érték
Paramétercsoport:	Generic Update Arguments
Alapértelmezett érték:	[]

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--force-string

A "set" vagy a "add" használata esetén a JSON-ra való konvertálás helyett őrizze meg a sztringkonstansokat.

Tulajdonság	Érték
Paramétercsoport:	Generic Update Arguments
Alapértelmezett érték:	False

--if-match

Az entitás ETagje.

--remove

Tulajdonság vagy elem eltávolítása a listából. Példa: --remove property.list <indexToRemove> VAGY --remove propertyToRemove.

Tulajdonság	Érték
Paramétercsoport:	Generic Update Arguments
Alapértelmezett érték:	[]

--secret

Meghatározza, hogy az érték titkos-e, és titkosítva kell-e lennie. Az alapértelmezett érték hamis.

Tulajdonság	Érték
Elfogadott értékek:	false, true

--set

Frissítsen egy objektumot egy beállítandó tulajdonság elérési útjának és értékének megadásával. Példa: --set property1.property2=<value>.

Tulajdonság	Érték
Paramétercsoport:	Generic Update Arguments
Alapértelmezett érték:	[]

--tags

Szóközzel elválasztott címkék: key[=value] [key[=value] ...]. Meglévő címkék törlése a "" használatával.

--value

Az elnevezett érték értéke.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

Tulajdonság	Érték
Alapértelmezett érték:	False

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim nv wait

Helyezze a parancssori felületet várakozási állapotba, amíg egy apim által elnevezett érték feltételének nem teljesül.

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

Példák

Helyezze a parancssori felületet várakozási állapotba, amíg az apim api egy feltételének nem teljesül.

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

Kötelező paraméterek

--named-value-id

A NamedValue azonosítója.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--created

Várjon, amíg létre nem jön a "provisioningState" a "Sikeres" helyen.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	False

--custom

Várjon, amíg a feltétel megfelel egy egyéni JMESPath-lekérdezésnek. Pl. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running"?.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments

--deleted

Várjon a törlésig.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	False

--exists

Várjon, amíg az erőforrás létezik.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	False

--interval

Lekérdezési időköz másodpercben.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	30

--timeout

Maximális várakozás másodpercben.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	3600

--updated

Várjon, amíg frissül a provisioningState a következő helyen: "Sikeres".

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	False

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

Tulajdonság	Érték
Alapértelmezett érték:	False

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

Tulajdonság	Érték
Alapértelmezett érték:	False